Skip to navigation

Create orders in batch

View as Markdown

Creates multiple orders in one request instead of one order at a time. Each order is stored as a new entry rather than replacing a previous order with the same id, so Get order details can return several entries with the same id.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

This endpoint expects an object.
orderslist of objectsRequired
array of order objects
historicalbooleanOptionalDefaults to true

Defines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual.

notifyUrlstringOptional
Webhook URL to receive the status of the batch request

Response

batch id created
batch_iddouble or null
Batch ID of the request
countlongOptional
Number of orders

Errors

400
Bad Request Error