Describe your goods: dimensions, weight and package types.
Your goods are described in the lines array. Each line stands for one or more identical handling units — for example three euro pallets of the same size and weight. The lines array is the same for quotations and orders:
{
"lines": [
{
"unitQuantity": 1,
"unitPackageType": "EP",
"unitLength": 120,
"unitWidth": 80,
"unitHeight": 120,
"unitWeight": 250,
"content": "Forklift accessories and battery",
"isStackable": true,
"wantsPalletExchange": true
}
]
}Fields
| Field | Required | Description |
|---|---|---|
unitQuantity | yes | Number of identical units in this line |
unitPackageType | yes | Package type — see below |
unitLength, unitWidth, unitHeight | yes | Dimensions of one unit in centimeters |
unitWeight | yes | Weight of one unit in kilograms |
content | yes | Description of the goods |
isStackable | recommended | Whether the units can be stacked |
wantsPalletExchange | recommended | Whether you want a pallet exchange |
isStackable and wantsPalletExchange are optional, but please set them whenever possible — this has a positive impact on billing.
Package types
The most common values for unitPackageType:
| Value | Package type |
|---|---|
EP | One-way pallet — any wooden or plastic pallet that is not a euro pallet |
FP | Euro pallet (120 × 80 cm) |
GP | Euro box pallet / mesh box pallet (Gitterbox, 123 × 84 cm) |
KI | Wooden crate |
KT | Carton — also used for parcel shipments |
PA | Package / parcel |
CC | Collico |
PARTIE | Part load booked by loading meter — see Book via loading meter |
Rules and limits
| Rule | Value |
|---|---|
| Lines per shipment | 1–100 |
unitQuantity | 1–100 |
unitLength / unitWidth / unitHeight | max. 1,360 / 240 / 300 cm |
wantsPalletExchange: true | only for FP, GP, PARTIE and DIRECT_* |
additionalGitterBoxes | only for GP |
DIRECT_* package types | only with the product DIRECT (DIRECT_TRUCK_40 also with EXPRESS) |
Package types in responsesThe API normalises some package types when it stores an order:
EPwith 80 × 60 cm becomesHP(half pallet), andFP/GPwithout pallet exchange becomeKFP/KGP. You'll see these values when you read the order back.
Special cases
| Shipment | See |
|---|---|
| Dangerous goods (ADR) | Dangerous Goods |
| Large part loads, booked by loading meter | Book via loading meter (ldm) |
| Small packages via the parcel network | Parcel Shipments |
| A complete van or truck | Van/Truck Product |
Support
Questions about shipment data? Contact the Cargoboard API team at [email protected].