ShipmentRequestShipment
Shipment Container
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| shipper | ShipmentShipper | ✅ | Container for the Shipper's information. |
| ship_to | ShipmentShipTo | ✅ | Ship To Container. |
| service | ShipmentService | ✅ | UPS service type. |
| package | List[ShipmentPackage] | ✅ | |
| description | str | ❌ | The Description of Goods for the shipment. Applies to international and domestic shipments. Provide a detailed description of items being shipped for documents and non-documents. Examples: "annual reports" and "9 mm steel screws". Required if all of the listed conditions are true: ShipFrom and ShipTo countries or territories are not the same; The packaging type is not UPS Letter; The ShipFrom and or ShipTo countries or territories are not in the European Union or the ShipFrom and ShipTo countries or territories are both in the European Union and the shipments service type is not UPS Standard. |
| return_service | ShipmentReturnService | ❌ | Type of Return service. When this container exists, the shipment is a return shipment. |
| documents_only_indicator | str | ❌ | Indicates a shipment contains written, typed, or printed communication of no commercial value. If DocumentsOnly is not specified then it implies that the shipment contains non documents or documents of commercial value. Default is a shipment contains non- documents or documents of commercial value. This is an empty tag, any value inside is ignored. Valid only for shipments with different origin and destination countries or territories. The origin country or territory is not US, and the destination country or territory is not CA, PR or MX. |
| alternate_delivery_address | ShipmentAlternateDeliveryAddress | ❌ | AlternateDeliveryAddress Container. Alternate Delivery Address (UPS Access Point Address) required if ShipmentIndicationType is 01 or 02. |
| ship_from | ShipmentShipFrom | ❌ | Ship From Container. Required for return shipment. Required if pickup location is different from the shipper's address. |
| payment_information | ShipmentPaymentInformation | ❌ | Payment information container for detailed shipment charges. The two shipment charges that are available for specification are Transportation charges and Duties and Taxes. It is required for non-Ground Freight Pricing shipments only. |
| frs_payment_information | ShipmentFrsPaymentInformation | ❌ | Container to hold the Payment information for the Ground Freight Pricing Shipments. Required for Ground Freight Pricing Shipments only. |
| freight_shipment_information | ShipmentFreightShipmentInformation | ❌ | Container to hold Freight Shipment information. |
| goods_not_in_free_circulation_indicator | str | ❌ | Goods Not In Free Circulation indicator. This is an empty tag, any value inside is ignored. This indicator is invalid for a package type of UPS Letter and DocumentsOnly. |
| promotional_discount_information | ShipmentPromotionalDiscountInformation | ❌ | PromotionalDiscountInformation container. This container contains discount information that the customer wants to request each time while placing a shipment. |
| dg_signatory_info | ShipmentDgSignatoryInfo | ❌ | DGSignatoryInfo Container DGPaperImage will be returned if DGSignatoryInfo container present |
| shipment_rating_options | ShipmentShipmentRatingOptions | ❌ | ShipmentRatingOptions container. |
| movement_reference_number | str | ❌ | Movement Reference Number (MRN) information. Must contain alphanumeric characters only. Must be a length of 18 characters. The 3rd and 4th Characters must be the Shipper country or territory ISO Code. |
| reference_number | List[ShipmentReferenceNumber] | ❌ | |
| invoice_line_total | ShipmentInvoiceLineTotal | ❌ | Container to hold InvoiceLineTotal Information. Required for forward shipments whose origin is the US and destination is Puerto Rico or Canada. Not available for any other shipments. FOR OTHER DESTINATIONS the InvoiceLineTotal in the International Forms Container must be used. |
| num_of_pieces_in_shipment | str | ❌ | Total number of pieces in all pallets in a UPS Worldwide Express Freight Shipment. It is required for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. Valid values are 1 to 99999. |
| usps_endorsement | str | ❌ | USPS Endorsement. Valid values: 1 = Return Service Requested 2 = Forwarding Service Requested 3 = Address Service Requested 4 = Change Service Requested and 5 = No Service Selected. Note: For International Mail Innovations shipments use No Service Selected. International Mail Innovations shipments are applicable for Priority Mail Innovations and Mail Innovations Economy Mail Innovations services only. Required for Mail Innovations forward shipments. |
| mi_label_cn22_indicator | str | ❌ | Indicates single label with both MI label and CN22 form. International CN22 form is required. |
| sub_classification | str | ❌ | A component encoded on the barcode of the Mail Innovations label. Valid values: IR = Irregular MA = Machineable SubClass is only required if the customer's contract have them subclass the package not UPS. |
| cost_center | str | ❌ | Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. Required for Mail Innovations Return shipments. It is shown on the bottom of the shipping label as reference 2. Cost Center length is alphanumeric with a max length of 30 for Mail Innovations forward shipments. Cost Center length is numeric with a max length of 4 for Mail Innovations Return shipments. |
| cost_center_barcode_indicator | str | ❌ | Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the CostCenter field to be barcoded at the bottom of the label. |
| package_id | str | ❌ | Customer-assigned unique piece identifier that returns visibility events. Required only for Mail Innovations forward shipments. Alpha numeric values only. It is shown on the bottom of the shipping label as reference 1. |
| package_id_barcode_indicator | str | ❌ | Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the PackageID field to be barcoded at the bottom of the label. |
| irregular_indicator | str | ❌ | Mail classification defined by the USPS. Valid values: 1 = Balloon 2 = Oversize 3 = Not Applicable |
| shipment_indication_type | List[ShipmentShipmentIndicationType] | ❌ | |
| mi_dual_return_shipment_key | str | ❌ | MIDualReturnShipmentKey is unique key required to process Mail Innovations Dual Return Shipment. The unique identifier (key) would be returned in response of first phase of Mail Innovations Dual Return Shipments. This unique identifier (key) would be part of request for second phase of Mail Innovations Dual Return Shipments. Format: For Package return shipments, the package tracking number is concatenated with the system time (YYYY-MM-DDHH.MM.SS.NNN), followed by service code. For MI Return shipments, the Mail Manifest ID (MMI) is concatenated with the system time. The unique identifier (key) is required to link the package and the Mail Innovations portion of Dual Return shipment. If unique identifier (key) is empty in the request for UPS Mail Innovations Return Service, the request will be treated as the first phase of the Mail Innovations Dual Returns Request. If the MIDualReturnShipmentIndicator is present with empty or null MIDualReturnShipmentKey in UPS Package Return Shipment, the request will be treated as the first phase of Dual MI Return Label Shipment. This field would be ignored if MIDualReturnShipmentIndicator is not present in UPS Package Return Shipment request. |
| mi_dual_return_shipment_indicator | str | ❌ | MIDualReturnShipmentIndicator is an indicator to identify a Package Shipment is part of UPS Mail Innovations Dual Label Shipment. Its presence means Package Shipment is part of UPS Mail Innovations Dual Label shipment. If the indicator is present in Package Shipment request, shipment would be considered as part of a Dual Mail Innovations Returns. This indicator is not valid with UPS Mail Innovations Returns Service code. |
| rating_method_requested_indicator | str | ❌ | Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator. If present, Billable Weight Calculation method information and Rating Method information would be returned in response. |
| tax_information_indicator | str | ❌ | Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator is an indicator. If present, any taxes that may be applicable to a shipment would be returned in response. If this indicator is requested with NegotiatedRatesIndicator, Tax related information, if applicable, would be returned only for Negotiated Rates and not for Published Rates. The Tax related information includes any type of Taxes, corresponding Monetary Values, Total Charges with Taxes and disclaimers (if applicable) would be returned in response. |
| shipment_service_options | ShipmentShipmentServiceOptions | ❌ | Container for Shipment Service Options. |
| locale | str | ❌ | Represents 5 character ISO Locale that allows the user to request Reference Number Code on Label, Label instructions and Receipt instructions (if applicable) in desired language. Locale is specified by the combination of language code and country or territory code - 2 character language code and 2 character country or territory code seperated by an underscore ('_') character. If Locale element is requested along with LabelLinksIndicator, the URL to retrieve Label and Receipts (if applicable) will be returned in the requested Locale. Please note only LabelURL and ReceiptURL (if applicable) will be returned. LocalLanguageLabelURL and LocalLanguageReceiptURL will not be returned if Locale element is present in request. Queen's English (en_GB) is the default |
| shipment_value_threshold_code | str | ❌ | Shipment Value Threshold Code. 01 = Shipment value is below or equals to threshold value 02 = Shipment value is above threshold value. NA = Not Applicable |
| master_carton_id | str | ❌ | Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy Service: Master Carton Shipment will be created for given Master Carton ID. |
| master_carton_indicator | str | ❌ | Master Carton Indicator. Presence of the indicator means Master Carton ID will be created and returned to client. This is an empty tag, any value inside is ignored. MasterCartonIndicator is only valid with Econmoy Shipment (Service Code 17 or 72). Will be ignored if master carton id present. |
| shipment_date | str | ❌ | User can send up to 7 days in the future with current date as day zero. Format: YYYYMMDD |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs