Ecommerce

Create orders in batch

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

post/orders/status/batch

Request

Base URL: https://api.brevo.com/v3
URL: https://api.brevo.com/v3/orders/status/batch
Auth: one of:
- API key in header api-key
- API key in header partner-key

Request body

notifyUrlstring

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

historicalboolean

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.

Example request

{
  "orders": [
    {
      "id": "14",
      "createdAt": "2021-07-29T20:59:23.383Z",
      "updatedAt": "2021-07-30T10:59:23.383Z",
      "status": "completed",
      "amount": 308.42,
      "storeId": "ST-21",
      "products": [
        {
          "productId": "P1",
          "quantity": 10,
          "variantId": "P100",
          "price": 99.99
        }
      ],
      "email": "example@brevo.com",
      "billing": {
        "address": "15 Somewhere Road, Brynmenyn",
        "city": "Basel",
        "countryCode": "CA",
        "country": "Canada",
        "phone": "01559 032133",
        "postCode": "4052",
        "paymentMethod": "PayPal",
        "region": "Northwestern Switzerland"
      },
      "coupons": [
        "EASTER15OFF"
      ]
    }
  ],
  "notifyUrl": "https://en.wikipedia.org/wiki/Webhook",
  "historical": true
}

Response

(unresolved $ref)

Changes

No recorded changes to this operation across all 2 revisions of this API.