A complete booking request and response with only the mandatory fields.
A booking for a domestic shipment (Halver → Walting, one euro pallet) with only the mandatory fields:
Try it in the sandboxThis example uses the sandbox (
https://api-sandbox.cargoboard.com), so no real transport is triggered. Use an upcoming pickup date — the dates below are examples only.
Request
curl --request POST \
--url https://api-sandbox.cargoboard.com/v1/orders \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YourKeyHere' \
--data '
{
"product": "STANDARD",
"shipper": {
"name": "Producer ABC GmbH & Co. KG",
"address": {
"street": "Examplestreet 12a",
"countryCode": "DE",
"postCode": "58553",
"city": "Halver"
},
"pickupOn": "2024-12-11"
},
"consignee": {
"name": "Consignee ABC AG",
"address": {
"street": "Examplestreet 5",
"countryCode": "DE",
"postCode": "85137",
"city": "Walting"
}
},
"lines": [
{
"unitQuantity": 1,
"unitPackageType": "FP",
"unitLength": 120,
"unitWidth": 80,
"unitHeight": 120,
"unitWeight": 200,
"content": "Machine tool"
}
]
}
'Response
{
"data": {
"id": "cm3328igs04jbqt0dluurnxyl",
"reference": "10374504",
"costItems": [
{
"description": "Frachtkosten",
"type": "SHIPMENT",
"subtype": null,
"price": {
"amount": 94.23,
"currency": "EUR"
},
"pricePartVat": {
"amount": 17.9,
"percentage": 19,
"currency": "EUR"
}
},
{
"description": "Klimaschutzbeitrag",
"type": "CLIMATE_COMPENSATION_SURCHARGE",
"subtype": null,
"price": {
"amount": 0.7,
"currency": "EUR"
},
"pricePartVat": {
"amount": 0.13,
"percentage": 19,
"currency": "EUR"
}
}
],
"pickupOn": "2024-12-11T07:00:00.000Z",
"pickupAtFrom": "2024-12-11T07:00:00.000Z",
"pickupAtUntil": "2024-12-11T15:00:00.000Z",
"price": {
"amount": 94.93,
"currency": "EUR",
"grossAmount": 112.97,
"vatAmount": 18.04
},
"priceStandard": {
"amount": 94.93,
"currency": "EUR"
},
"runtime": {
"daysMin": 1,
"daysMax": 2
},
"delivery": {
"earliest": "2024-12-12T07:00:00.000Z",
"latest": "2024-12-13T15:00:00.000Z"
},
"product": "STANDARD",
"transportType": "GROUPAGE",
"co2Emission": {
"amount": 0.7,
"value": 35.58,
"unit": "KG"
}
},
"links": [
{
"rel": "self",
"method": "POST",
"description": "Place an order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders"
},
{
"rel": "self",
"method": "GET",
"description": "Orders.",
"href": "https://api-sandbox.cargoboard.com/v1/orders"
},
{
"rel": "self",
"method": "GET",
"description": "Order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders/cm3328igs04jbqt0dluurnxyl"
},
{
"rel": "orderCancel",
"method": "POST",
"description": "Cancel an order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders/cm3328igs04jbqt0dluurnxyl/cancel"
},
{
"rel": "orderPrintConfirmation",
"method": "GET",
"description": "Print confirmation for an order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders/cm3328igs04jbqt0dluurnxyl/print-confirmation"
},
{
"rel": "orderPrintShipmentLabels",
"method": "GET",
"description": "Print shipment labels for an order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders/cm3328igs04jbqt0dluurnxyl/print-shipment-labels"
},
{
"rel": "orderTrack",
"method": "GET",
"description": "Track an order.",
"href": "https://api-sandbox.cargoboard.com/v1/orders/10374504/tracking"
}
]
}What's in the response
data.reference— the Cargoboard shipment number. It is used in all communication about the shipment, e.g. with our customer service.data.id— the order ID for follow-up API calls. All order endpoints accept either the order ID or the reference.data.priceanddata.costItems— the booked price and its individual charges.links— follow-up actions: cancel the order, print the order confirmation, print shipment labels (orderPrintShipmentLabels) and track the order (orderTrack).