ShipmentResultsPackageResults
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| tracking_number | str | ✅ | Package 1Z number. For Mail Innovations shipments, please use the USPSPICNumber when tracking packages (a non-1Z number Mail Manifest Id is returned). |
| rate_modifier | PackageResultsRateModifier | ❌ | Container for returned Rate Modifier information. Applies only if SubVersion is 2205 or greater. |
| base_service_charge | PackageResultsBaseServiceCharge | ❌ | Base Service Charge container. Transportation charge = BaseServiceCharge + Fuel charge Returned only if Subversion >=1701. |
| service_options_charges | PackageResultsServiceOptionsCharges | ❌ | Shipment charges info. Shipment charges are only guaranteed to be returned for shipments whose origin country or territory is US or Puerto Rico. |
| shipping_label | PackageResultsShippingLabel | ❌ | The container for UPS shipping label. Returned for following shipments - Forward shipments, Shipments with PRL returns service, Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707. Shipping label wont be returned if BarCodeImageIndicator is present. |
| shipping_receipt | PackageResultsShippingReceipt | ❌ | Supported for following shipments - PRL shipments, Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707. |
| uspspic_number | str | ❌ | USPSPICNumber is USPS Package Identification; it should be used for tracking Mail Innovations shipments. |
| cn22_number | str | ❌ | USPS defined CN22 ID number format varies based on destination country or territory. Not applicable as of Jan 2015. Mail Innovations shipments US to VI, PR, and GU are not considered international. |
| accessorial | List[PackageResultsAccessorial] | ❌ | The container for Accessorial indicators. This information would be returned only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Mid-day service request with Dry Ice or Oversize Pallet and SubVersion greater than or equal to 1707. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Mid-day service. 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. |
| simple_rate | PackageResultsSimpleRate | ❌ | SimpleRate will be returned if Simple Rate present in request |
| form | PackageResultsForm | ❌ | Container tag for the International forms image. Currently this container would be returned for UPS Premium Care shipments. 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. CN22 data for Worlwide economy services will be returned within the PDF417 barcode of the label. |
| itemized_charges | List[PackageResultsItemizedCharges] | ❌ | Itemized Charges are returned only when the subversion element is present and greater than or equal to 1607. Package level itemized charges are only returned for US domestic movements. 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. |
| negotiated_charges | PackageResultsNegotiatedCharges | ❌ | Negotiated Rates Charge Container. These charges are returned when: 1) Subversion is greater than or equal to 1607 2) If negotiated rates were requested for GFP shipments and account number is eligible to receive negotiated rates. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs