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