ShipmentShipmentServiceOptions
Container for Shipment Service Options.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| saturday_delivery_indicator | str | ❌ | Saturday delivery indicator. The presence indicates Saturday delivery is requested and the absence indicates Saturday delivery is not requested. This is an empty tag, any value inside is ignored. |
| saturday_pickup_indicator | str | ❌ | Saturday pickup indicator. The presence indicates Saturday pickup is requested and the absence indicates Saturday pickup is not requested. This is an empty tag, any value inside is ignored. |
| cod | ShipmentServiceOptionsCod | ❌ | COD container Indicates COD is requested. Shipment COD is only available for EU origin countries or territories and for shippers account type Daily Pickup and Drop Shipping. Not available to shipment with return service. |
| access_point_cod | ShipmentServiceOptionsAccessPointCod | ❌ | Access Point COD indicates COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type. Shipment Access Point COD is valid only for countries or territories within E.U. Not valid with (Shipment) COD. Not available to shipment with return service. |
| deliver_to_addressee_only_indicator | str | ❌ | Presence/Absence Indicator. Any value inside is ignored. DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package. Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point". |
| direct_delivery_only_indicator | str | ❌ | Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the ship to address on the shipping label. This accessorial is not valid with Shipment Indication Type "01 - Hold For Pickup At UPS Access Point" and "02 - UPS Access Pointâ„¢ Delivery". |
| notification | List[ShipmentServiceOptionsNotification] | ❌ | |
| label_delivery | ShipmentServiceOptionsLabelDelivery | ❌ | Container for the Label Delivery accessorial. Note - LabelDelivery is not applicable for GFP and Mail Innovations Forward shipment. Required for shipments with either Electronic Return Label Return Service or ImportControl Electronic LabelMethod type. Optional for shipments with Print Return Label Return Service or ImportControl Print LabelMethod type or Forward movement. If this container is present for shipments with either Electronic Return Label Return Service or ImportControl Electronic LabelMethod type, either of the LabelLinksIndicator or EMail container should be provided. For shipments with Print Return Label Return Service or ImportControl Print LabelMethod type or Forward movement, only LabelLinksIndicator is valid option for LabelDelivery container. |
| international_forms | ShipmentServiceOptionsInternationalForms | ❌ | International Forms information. |
| delivery_confirmation | ShipmentServiceOptionsDeliveryConfirmation | ❌ | Delivery Confirmation container. Valid for forward shipments only. Refer to Delivery Confirmation Origin-Destination Pairs in the Appendix for a list of valid values. |
| return_of_document_indicator | str | ❌ | The flag indicates the ReturnOfDocument accessorial has been requested. Valid for Poland to Poland forward shipment only. |
| import_control_indicator | str | ❌ | Indicates that the Shipment is an ImportControl shipment. |
| label_method | ShipmentServiceOptionsLabelMethod | ❌ | Type of ImportControl Label. This container is applicable only for ImportControl shipments. This container is applicable only for ImportControl shipments. |
| commercial_invoice_removal_indicator | str | ❌ | CommercialInvoiceRemovalIndicator allows a shipper to dictate UPS to remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee. |
| up_scarbonneutral_indicator | str | ❌ | UPS carbon neutral indicator presence at shipment level is required to create carbon neutral Shipments. |
| pre_alert_notification | List[ShipmentServiceOptionsPreAlertNotification] | ❌ | |
| exchange_forward_indicator | str | ❌ | Exchange forward indicator presence at shipment level is required to create exchange forward Shipments. In the label routing Instruction text will be defaulted to "EXCHANGE-LIKE ITEM ONLY". |
| hold_for_pickup_indicator | str | ❌ | Hold For Pickup indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. |
| dropoff_at_ups_facility_indicator | str | ❌ | Drop off At UPS Facility indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. |
| lift_gate_for_pick_up_indicator | str | ❌ | Lift Gate For Pick Up indicator. The empty tag means indicator is present. Lift Gate for Pickup is not allowed with Drop Off At UPS Facility for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. When both Hold for Pickup and Drop Off At Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. |
| lift_gate_for_delivery_indicator | str | ❌ | Lift Gate For Delivery indicator. The empty tag means indicator is present. Lift Gate for Delivery is not allowed with Hold For Pickup for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. When both Hold for Pickup and Drop Off At UPS Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. |
| sdl_shipment_indicator | str | ❌ | The presence of the tag SDLShipmentIndicator indicates Shipment is SDL. SDLShipmentIndicator presence means EEI form/ EEI Filing option required. |
| epra_release_code | str | ❌ | Package Release code allows the consignee or claimant to pick-up a package at a UPS Access Pointâ„¢. The shipper must provide the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. Package Release Code is only valid with ShipmentIndicationType 01 - Hold for Pickup at UPS Access Pointâ„¢. The release code must be between length 4 and 6 and only contain numbers. |
| restricted_articles | ShipmentServiceOptionsRestrictedArticles | ❌ | Restricted Articles container. |
| inside_delivery | str | ❌ | Inside delivery accessory. Valid values: 01 - White Glove 02 - Room of Choice 03 - Installation Default is Room of Choice. Shippers account needs to have a valid contract for Heavy Goods Service. |
| item_disposal | str | ❌ | Presence/Absence indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the customer would like items disposed. Shippers account needs to have a valid contract for Heavy Goods Service. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs