Skip to main content

ShipmentPackage

Package Information container. For Return Shipments up to and including 20 packages are allowed. US/PR origin return movements are limited to only one package. For Mail Innovations and Simple Rate shipments only one package is allowed.

Properties

NameTypeRequiredDescription
packagingPackagePackagingPackaging container. Container for Packaging Type.
descriptionstrMerchandise description of package. Required for shipment with return service.
pallet_descriptionstrDescription of articles & special marks. Applicable for Air Freight only
num_of_piecesstrNumber of Pieces. Applicable for Air Freight only
unit_pricestrUnit price of the commodity. Applicable for Air Freight only Limit to 2 digit after the decimal. The maximum length of the field is 12 including '.' and can hold up to 2 decimal place. (e.g. 999999999.99)
dimensionsPackageDimensionsDimensions information container. Note: Currently dimensions are not applicable to Ground Freight Pricing. Length + 2*(Width + Height) must be less than or equal to 165 IN or 330 CM. Required for Heavy Goods service. Package Dimension will be ignored for Simple Rate
dim_weightPackageDimWeightDimensional weight of shipment. Please visit ups.com for rules on calculating. There is one implied decimal place (e.g. 115 = 11.5). If dimensions are provided, dimensional weight is ignored. For US/PR/CA shipments, dimensional weight is ignored
package_weightPackagePackageWeightContainer to hold package weight information. Package weight is a required for Ground Freight Pricing shipments and Heavy Goods service. Package Weight will be ignored for Simple Rate.
large_package_indicatorstrPresence of the indicator mentions that the package is Large Package. This is an empty tag, any value inside is ignored.
oversize_indicatorstrPresence/Absence Indicator. Any value is ignored. If present, indicates that the package is over size. Applicable for UPS Worldwide Economy DDU service.
minimum_billable_weight_indicatorstrPresence/Absence Indicator. Any value is ignored. If present, indicates that the package is qualified for minimum billable weight. Applicable for UPS Worldwide Economy DDU service.
reference_numberList[PackageReferenceNumber]
additional_handling_indicatorstrAdditional Handling Required. The presence indicates additional handling is required, the absence indicates no additional handling is required. Additional Handling indicator indicates it's a non-corrugated package.
simple_ratePackageSimpleRateSimpleRate Container
ups_premierPackageUpsPremierUPS Premier Container.
package_service_optionsPackagePackageServiceOptionsPackage Service Options container.
commodityPackageCommodityContainer to hold the Commodity information. It is required if the Ground Freight Pricing Shipment indicator is present in the request.
haz_mat_package_informationPackageHazMatPackageInformationRequired when number of hazmat containers in a package is greater than 1. It indicates whether all the hazmat materials are kept in a single box or multiple boxes. Required when number of hazmat container in a package is greater than 1.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →