Skip to main content

Packaging Schema

Represents packaging details for a shipment.

Fields

FieldTypeRequiredDescription
total_packagesnumberNoTotal number of packages
total_gross_weight_kgnumberNoTotal gross weight in kilograms
packagesPackage[]NoDetailed package breakdown

Package Object

FieldTypeRequiredDescription
typestringYesPackage type (see below)
quantitynumberYesNumber of packages of this type
gross_weight_kgnumberNoGross weight per package
length_cmnumberNoLength in centimeters
width_cmnumberNoWidth in centimeters
height_cmnumberNoHeight in centimeters

Package Types

CodeDescription
CARTONCardboard carton
PALLETWooden/plastic pallet
CRATEWooden crate
DRUMSteel/plastic drum
BAGBag/sack
BUNDLEBundle/bale
CONTAINER_2020-foot container
CONTAINER_4040-foot container

Example

{
"total_packages": 10,
"total_gross_weight_kg": 500,
"packages": [
{
"type": "CARTON",
"quantity": 8,
"gross_weight_kg": 50,
"length_cm": 60,
"width_cm": 40,
"height_cm": 30
},
{
"type": "PALLET",
"quantity": 2,
"gross_weight_kg": 50,
"length_cm": 120,
"width_cm": 100,
"height_cm": 150
}
]
}