v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Ecommerce

Managing the status of the order

Manages the transactional status of the order

post/orders/status

Request body

idstring required

Unique ID of the order.

createdAtstring required

Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.

updatedAtstring required

Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.

statusstring required

State of the order.

amountnumber required

Total amount of the order, including all shipping expenses, tax and the price of items.

storeIdstring

ID of store where the order is placed

emailstring

Email of the contact, Mandatory if "phone" field is not passed in "billing" parameter.

couponsstring[]

Coupons applied to the order. Stored case insensitive.

Example request

{
  "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"
  ]
}

Response

Order Event posted