Here is an example for a booking call for a national shipment, with the minimum request parameters:
curl --request POST \
--url https://api.cargoboard.com/v1/orders \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YOUR KEY HERE' \
--data '
{
"product": "STANDARD",
"shipper": {
"name": "Mustermann GmbH",
"address": {
"street": "Ostrstr. 24",
"countryCode": "DE",
"postCode": "58553",
"city": "Halver"
},
"pickupOn": "2022-02-02"
},
"consignee": {
"name": "Fabian Müller",
"address": {
"street": "Hofstetterstr.4 ",
"countryCode": "DE",
"postCode": "85137",
"city": "Walting"
}
},
"lines": [
{
"unitQuantity": 1,
"unitPackageType": "FP",
"unitLength": 120,
"unitWidth": 80,
"unitHeight": 120,
"unitWeight": 200,
"content": "Werkzeugmaschine"
}
]
}
'
Response:
{
"data": {
"id": "cl06totgo1808298z8jusxj2c2k",
"reference": "D1890790911",
"costItems": [
{
"description": "Frachtkosten",
"type": "SHIPMENT",
"price": {
"amount": 35.69,
"currency": "EUR"
}
}
],
"price": {
"amount": 35.69,
"currency": "EUR"
},
"runtime": {
"daysMin": 1,
"daysMax": 2
},
"delivery": {
"earliest": "2022-03-02T07:00:00.000Z",
"latest": "2022-03-03T15:00:00.000Z"
},
"product": "STANDARD"
},
"links": [
{
"rel": "self",
"method": "POST",
"description": "Place an order.",
"href": "https://api.staging.cargoboard.com/v1/order"
},
{
"rel": "orderCancel",
"method": "POST",
"description": "Cancel an order.",
"href": "https://api.staging.cargoboard.com/v1/order/cancel/c506totgo1808298z8jusxj2c2k"
},
{
"rel": "orderPrintConfirmation",
"method": "GET",
"description": "Print confirmation for an order.",
"href": "https://api.staging.cargoboard.com/v1/order/print-confirmation/c506totgo1808298z8jusxj2c2k"
},
{
"rel": "orderPrintShipmentLabels",
"method": "GET",
"description": "Print shipment labels for an order.",
"href": "https://api.staging.cargoboard.com/v1/order/print-shipment-labels/c506totgo1808298z8jusxj2c2k"
},
{
"rel": "orderTrack",
"method": "GET",
"description": "Track an order.",
"href": "https://api.staging.cargoboard.com/v1/order/track/D7890790911"
}
]
}