Skip to navigation

Place an Order

View as Markdown

Create a non-dedicated delivery order. For accounts configured to require collection readiness, the response includes data.requires_ready_for_collection: true. The order waits for a separate POST to /orders-non-dedicated/{id}/ready-for-collection before route planning. This requirement is set on the account and cannot be overridden in the request body. Orders without this requirement continue through the existing flow.

Authentication

AuthorizationBearer

Request

This endpoint expects an object.
product_codestring or nullRequired<=250 characters
A product reference provided by your account manager.
payment_methodenumRequired
Select the method the API should use to process payment for this order.
Allowed values:
order_locationslist of objectsRequired

These are the pickup and drop-off locations for your delivery: the first object being pickup, the second is drop-off. Both are required.

internal_refstring or nullOptional<=250 characters
An order reference provided by your systems.
additional_notesstring or nullOptional
Additional information that will be seen by the delivery driver during order fulfilment.
itemslist of objectsOptional
barcode_generationobjectOptional
Use this to prompt the system to generate barcodes as soon as the order is placed.
brandingobjectOptional
Provide basic branding details. If provided, these will be displayed on our delivery tracking screens.

Response

Created
dataobject
The details of a delivery request placed by a user that sends items using the platform.

Errors

422
Unprocessable Entity Error