ShipmentResponseShipmentResults
Shipment Results container.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| billing_weight | ShipmentResultsBillingWeight | ✅ | Billing Weight container. |
| disclaimer | List[ShipmentResultsDisclaimer] | ❌ | Disclaimer would be used to provide more information to shipper regarding the processed shipment. This would be used to notify shipper about possible taxes and duties that might have been added or might apply to the shipment. This field would be returned only if TaxInformationIndicator is present in a request. NOTE: For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| shipment_charges | ShipmentResultsShipmentCharges | ❌ | Shipment charges Container. Shipment charges info. |
| negotiated_rate_charges | ShipmentResultsNegotiatedRateCharges | ❌ | Negotiated Rates Charge Container. For tiered rates and promotional discounts, if a particular shipment based on zone, origin, destination or even shipment size doesn't qualify for the existing discount then no negotiated rates container will be returned. Published rates will be the applicable rate. |
| frs_shipment_data | ShipmentResultsFrsShipmentData | ❌ | Ground Freight Pricing Shipment data container. Ground Freight Pricing shipment data is only guaranteed to be returned for Ground Freight Pricing shipments only. |
| rating_method | str | ❌ | RatingMethod is to indicate whether the Shipment was rated as shipment level or package level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. Valid values: 01 = Shipment level 02 = Package level |
| billable_weight_calculation_method | str | ❌ | BillableWeightCalculationMethod is to indicate whether the billable weight calculation method utilized was - the package level or shipment level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. Valid values: 01 = Shipment Billable Weight 02 = Package Billable Weight |
| shipment_identification_number | str | ❌ | Returned UPS shipment ID number.1Z Number of the first package in the shipment. |
| 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 and would be played back in response for second phase of Mail Innovations Dual Return Shipment. If the shipment is a Package return shipment, the package tracking number will be concatenated with the system time (in the format YYYY-MM-DDHH.MM.SS.NNN) and followed by service code. If the shipment is an MI Returns shipment, the Mail Manifest ID (MMI) will be concatenated with the system time. |
| bar_code_image | str | ❌ | Bar Code Image will be returned as Base 64 encoded graphic image. Bar Code Image will be returned if BarCodeImageIndicator or BarCodeAndLabelIndicator is present. |
| package_results | List[ShipmentResultsPackageResults] | ❌ | Returned Package Information. NOTE: For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| control_log_receipt | List[ShipmentResultsControlLogReceipt] | ❌ | Container for the High Value reports when forward shipments have declared value between $999 and $50,000 USD. \nTwo copies of high value report needs to be pointed out. NOTE: For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| form | ShipmentResultsForm | ❌ | Container tag for the International forms image. Form is returned for following shipments - Forward shipments, Shipments with PRL ReturnService, Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707. |
| cod_turn_in_page | ShipmentResultsCodTurnInPage | ❌ | The container of the COD Turn In Page. |
| high_value_report | ShipmentResultsHighValueReport | ❌ | Container for the High Value Report generated for ImportControl or Return shipments with high package declared value. |
| label_url | str | ❌ | URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LabelURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment Print/Electronic Return shipment. Forward shipment except for Mail Innovations Forward. |
| local_language_label_url | str | ❌ | URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LocalLanguageLabelURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment Print/Electronic Return shipment. Forward shipment except for Mail Innovations Forward. Not returned if LabelLinksIndicator is requested with Locale element. |
| receipt_url | str | ❌ | URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. ReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment Print/Electronic Return shipment. |
| local_language_receipt_url | str | ❌ | URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LocalLanguageReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment Print/Electronic Return shipment. Not returned if LabelLinksIndicator is requested with Locale element. |
| dg_paper_image | List[str] | ❌ | Dangerous Good Paper Image in pdf format. One multipage PDF document will be returned that will contain all required Dangrous Goods shipping paper copies for all Dangerous Goods packages. Only returned when DGSignatoryInfo is present. NOTE: For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
| master_carton_id | str | ❌ | Master Carton ID. MasterCartonID will be return if MasterCartonIndicator is present in request. |
| roar_rated_indicator | str | ❌ | Informational only |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs