Booking Example with Insurance & Services

A domestic booking that uses optional fields and additional services — your own reference, contact persons, transport insurance and a delivery notification.

🧪
Try it in the sandbox
This example uses the sandbox (https://api-sandbox.cargoboard.com), so no real transport is triggered. Use an upcoming pickup date.

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",
    "customerOrderCode": "DN-85421651",
    "wantsInsurance": true,
    "valueOfGoodsAmount": 350,
    "valueOfGoodsCurrency": "EUR",
    "incoterm": "STANDARD",
    "shipper": {
        "name": "Producer ABC GmbH & Co. KG",
        "contactPerson": {
            "name": "Jane Doe",
            "phone": "+49 30 12345678",
            "email": "[email protected]"
        },
        "address": {
            "street": "Examplestreet 12a",
            "countryCode": "DE",
            "postCode": "16727",
            "city": "Oberkrämer"
        },
        "pickupOn": "2026-12-01",
        "wantsContactBeforePickup": false
    },
    "consignee": {
        "name": "John Doe",
        "contactPerson": {
            "name": "John Doe",
            "phone": "+49 30 87654321",
            "email": "[email protected]"
        },
        "address": {
            "street": "Examplestreet 5",
            "countryCode": "DE",
            "postCode": "88239",
            "city": "Wangen im Allgäu"
        },
        "wantsContactBeforeDelivery": true,
        "wantsPhoneCallFromDriverBeforeDelivery": false
    },
    "lines": [
        {
            "unitQuantity": 1,
            "unitPackageType": "KT",
            "content": "Vase - fragile",
            "unitLength": 100,
            "unitWidth": 95,
            "unitHeight": 10,
            "unitWeight": 12,
            "wantsPalletExchange": false
        }
    ]
}
'

Optional fields used

Field	Purpose
`customerOrderCode`	Your own reference (e.g. delivery note number) — appears on documents and in tracking webhooks
`wantsInsurance` + `valueOfGoodsAmount` + `valueOfGoodsCurrency`	Transport insurance based on the value of the goods
`contactPerson`	Local contact for pickup and delivery
`consignee.wantsContactBeforeDelivery`	The consignee is contacted to arrange the delivery

All fields are explained in Shipper and Consignee Information and the Place an Order reference.

Response

The response has the same structure as in Booking with minimum details. Each booked additional service — here the delivery notification and the transport insurance — appears as a separate entry in data.costItems.