Create orders in batch | Brevo API Documentation

Create multiple orders at one time instead of one order at a time

Authentication

api-keystring

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

Request

This endpoint expects an object.

orderslist of objectsRequired

array of order objects

historicalbooleanOptionalDefaults to true

Defines wether 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

Notify Url provided by client_dev to get the status of batch request

Response

batch id created

batchIddouble

Batch ID of the request

countlong or null

Number of orders

1	import requests
2
3	url = "https://api.brevo.com/v3/orders/status/batch"
4
5	payload = { "orders": [
6	{
7	"amount": 308.42,
8	"createdAt": "2021-07-29T20:59:23.383Z",
9	"id": "14",
10	"products": [
11	{
12	"price": 99.99,
13	"productId": "P1",
14	"quantity": 10
15	}
16	],
17	"status": "completed",
18	"updatedAt": "2021-07-30T10:59:23.383Z"
19	}
20	] }
21	headers = {
22	"api-key": "<apiKey>",
23	"Content-Type": "application/json"
24	}
25
26	response = requests.post(url, json=payload, headers=headers)
27
28	print(response.json())

1	{
2	"batchId": 1,
3	"count": 17655
4	}

Authentication

Request

Response

Errors