If you want to get a /quotation for a shipment or if you want to /order a transport you have to provide information for the shipper and the consignee. Here you can find more information about which fields you have to provide and how:

Mandatory fields for a quotation request (minimum)
Mandatory fields for a booking / order request (minimum)
All other fields explained and why you should provide as much information as possible

Important note:
The request body for quotation and booking requests is completely identical. But for a quotation request, significantly less address information is mandatory than for a booking request.

Mandatory fields for a quotation request (Minimum)

To request a /quotation via API, you need at least the following fields in the consignee and shipper:

{
    "shipper": {
        "address": {
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        },
        "pickupOn": "2022-12-23"
    },
    "consignee": {
        "address": {
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        }
    }
}

Mandatory fields for a booking / order request (Minimum)

To book an /order via API, you need at least the following fields in the consignee and shipper:

In addition to the quotation, for booking it is necessary to provide the street and the pickup date:

{
    "shipper": {
        "name": "Producer ABC GmbH & Co. KG",
        "address": {
            "street": "Examplestreet 12a",
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        },
        "pickupOn": "2022-12-23"
    },
    "consignee": {
        "name": "Consignee ABC AG",
        "address": {
            "street": "Examplestreet 12a",
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        }
    }
}

All other fields and why you should provide as much information as possible

In the request body there are many more fields you can fill. The other fields are about additional information or additional products that you can add.
For the processing of your shipment it is always better if you provide us with as much information as possible.

Here is an overview of all possible fields and after that you will find an explanation of them:

{
    "shipper": {
        "name": "Producer ABC GmbH & Co. KG",
        "address": {
            "street": "Examplestreet 12a",
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        },
        "contactPerson": {
            "name": "Mr. Skywalker",
            "phone": "+4917287502631",
            "email": "orders@not-existing-company.com"
        },
        "neutralData": {
            "name": "Selling Company ABC GmbH",
            "street": "Friedrichstraße 1",
            "postCode": "10115",
            "countryCode": "DE",
            "city": "Berlin"
        },
        "pickupAtFrom": "2022-12-23T08:00:00.790Z", //You can use pickupAtFrom and pickupAtUntil OR pickupOn
        "pickupAtUntil": "2022-12-23T14:00:00.790Z",
        "pickupOn": "2022-12-23",
        "wantsTailLiftTruck": true,
        "wantsContactBeforePickup": false,
        "freeTextForPickup": "Lorem ipsum ....",
        "reference": "ABC123"
    },
    "consignee": {
        "name": "Consignee ABC AG",
        "address": {
            "street": "Examplestreet 12a",
            "countryCode": "DE",
            "postCode": "10115",
            "city": "Berlin"
        },
        "contactPerson": {
            "name": "Mr. Skywalker",
            "phone": "+4917287502631",
            "email": "orders@not-existing-company.com"
        },
        "neutralData": {
            "name": "Selling Company ABC GmbH",
            "street": "Friedrichstraße 1",
            "postCode": "10115",
            "countryCode": "DE",
            "city": "Berlin"
        },
        "deliveryOn": "2022-12-29", //set only if you book the product "FIX"
        "isPrivateCustomer": false,
        "wantsTailLiftTruck": true,
        "wantsContactBeforeDelivery": false,
        "wantsPhoneCallFromDriverBeforeDelivery": false,
        "wantsDeliveryWithoutConsigneePresence": true,
        "freeTextForDelivery": "Lorem ipsum ....",
        "reference": "ABC123"
    }
}

Here's an explanation:

contactPerson
You can find the block "contactPerson" in Consignee and Shipper. Here you can enter the name of the local contact, the email address and the phone number.

neutralData
You will also find the block "neutralData". A neutral address serves to conceal the actual pickup or delivery location for the other party. For example, if you don't want that your customer to see that the goods are being picked up directly from the manufacturer instead of from you, you can enter your address at shipper.neutralData and the manufacturer's adress at shipper.name and shipper.address. The truck will never drive to the neutral address.

pickupDate
In total, we have three fields to specify the pickup time. You can either choose "pickupOn" if you want to provide only a day. If you want to provide a specific period of time, use "pickupAtFrom" and "pickupAtUntil".

deliveryOn
The delivery date can be specified in the deliveryOn field. The delivery date may only be specified if the product "FIX" is booked.

wants...
All the "wants..." represent additional products that you can add to your shipment.

isPrivateCustomer
If the customer is a private recipient, please set it to true.

freeTextForPickup or Delivery
Here you can enter text information about the shipper or consignee, such as opening hours or break times.

reference
In the ‘reference’ field at shipper and consignee level, you can enter a reference with which the driver should notify the shipper or consignee.