POST /orders/status/batch

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

Servers

https://api.brevo.com/v3

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`notifyUrl`	String	No	Notify Url provided by client_dev to get the status of batch request
`orders[]`	Array	Yes	array of order objects
`orders[].id`	String	Yes	Unique ID of the order.
`orders[].storeId`	String	No	ID of store where the order is placed
`orders[].products[]`	Array	Yes
`orders[].products[].price`	Number	Yes	The price of a unit of product
`orders[].products[].productId`	String	Yes	ID of the product.
`orders[].products[].quantity`	Number	Yes	How many pieces of the product the visitor has added to the cart.
`orders[].products[].variantId`	String	No	Product ID of the red color shirts.
`orders[].updatedAt`	String	Yes	Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.
`orders[].identifiers`	Object	No	Identifies the contact associated with the order.
`orders[].identifiers.loyalty_subscription_id`	String	No	loyalty_subscription_id associated with the order
`orders[].identifiers.phone_id`	String	No	Phone number of the contact associated with the order
`orders[].identifiers.ext_id`	String	No	ext_id associated with the order
`orders[].identifiers.email_id`	String	No	Email of the contact associated with the order
`orders[].billing`	Object	No	Billing details of an order.
`orders[].billing.region`	String	No	Exact region (state/province) for delivery and billing.
`orders[].billing.paymentMethod`	String	No	How the visitor will pay for the item(s), e.g. paypal, check, etc.
`orders[].billing.postCode`	String	No	Postcode for delivery and billing.
`orders[].billing.phone`	String	No	Billing phone number.
`orders[].billing.country`	String	No	Billing country name.
`orders[].billing.countryCode`	String	No	Billing country 2-letter ISO code.
`orders[].billing.address`	String	No	Full billing address.
`orders[].billing.city`	String	No	Exact city of the address.
`orders[].amount`	Number	Yes	Total amount of the order, including all shipping expenses, tax and the price of items.
`orders[].metaInfo`	Object	No	Meta data of order to store additional detal such as custom message, customer type, source.
`orders[].coupons[]`	Array	No	Coupons applied to the order. Stored case insensitive.
`orders[].createdAt`	String	Yes	Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.
`orders[].status`	String	Yes	State of the order.
`historical`	Boolean	No	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. Default value: true

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.