Create order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📦 Order Creation & Bundling Workflow

There are two ways to create multiple orders and group them into a single delivery bundle using the orderBundle system:

✅ Preferred Method: Explicit Bundling via orderBundleId

  1. Create the first order without an orderBundleId. The response will include an orderBundle object:
"orderBundle": {
    "id": 2829,
    "bundleId": "VNN1UY7TMSY81P8Q4A2C7"
}
  1. Use the returned bundleId to create additional orders and connect them to the same delivery bundle:
{
    "orderRef": "O-TEST-2",
    "orderBundleId": "VNN1UY7TMSY81P8Q4A2C7",
    ...
}

This method is most versatile, as it allows different orderRefs, dimensions, weight and other customizations per order.

⚡ Alternative Method: Implicit Bundling via load

You can create multiple bundled orders in one request by setting the load value to the desired number:

{
    "orderRef": "O-TEST",
    "load": 2,
    ...
}

  1. The API will generate load number of orders, all bundled under the same orderBundle.
  2. Only one of the created orders is returned in the response.
  3. All orders will have identical specs (dimensions, address, etc.).

Use this for quick bulk creation, but note that it’s less flexible than the explicit bundling method.

📦 Dimension Convention

When specifying package dimensions, we follow a standardized order to avoid confusion:

📦

Length ≥ Width ≥ Height

  • Length: the longest side of the package
  • Width: the middle-sized side
  • Height: the shortest side (typically vertical when the package is upright)

This ordering ensures consistent validation across systems and carriers.
Please make sure to sort dimensions accordingly before sending them in the request.

If dimensions are not ordered correctly, your package may be incorrectly rejected.

Body Params
string
required
Defaults to APPLE-12345

The unique order reference on your platform (<= 100 char)

string
Defaults to iPhone 14 Pro

(<= 100 char)

string
Defaults to A beautiful phone

(<= 100 char)

string
required
Defaults to Steve Jobs

(<= 100 char)

json
required
Defaults to { "street": "IJsbaanpad", "houseNumber": "2", "suffix": "", "postalCode": "1076CV", "city": "Amsterdam", "countryCode": "NL" }

The full address split up in street, houseNumber, suffix, postalCode, city and countryCode (each field <= 100 char, countryCode in ISO1 format is required)

string
required
Defaults to [email protected]

(<= 100 char)

string
Defaults to +31612345678

The full (mobile) phone number starting with the country identifier, e.g. +31 (<= 30 char)

string
required
Defaults to XXXXXXXXXXX

The alphanumeric identification number of your pickup location

string

Message displayed to the rider to specify the delivery location or conditions (<= 100 char)

string
Defaults to false

Set to true if the deliveryAddress is a business

boolean
Defaults to false

Use this only if pickup points are enabled on your account.

string

Use this only if pickup points are enabled on your account.

int32

The length of the package in mm (1000 max)

int32

The width of the package in mm (1000 max)

int32

The height of the package in mm (1000 max)

int32

The weight of te package in grams (20000 max)

string

To explicitly bundle a new order to an existing orderBundle. Only available if all orders in existing bundle are not yet with carrier

int32

To implicitly bundle orders (1 <= load <= 20)

float

Economic order value, in Euros (<= 5 char)

boolean
Defaults to false

Set to true if the order must only be delivered at the specified address

boolean
Defaults to false

Set to true if the order requires a signature on delivery

boolean
Defaults to false

Set to true if the order is a mailbox delivery (Brievenbuspakketje)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json