v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Ecommerce

Get order details

Get all the orders

get/orders

Query parameters

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

modifiedSincestring

Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestring

Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

Response

orders fetched successfully

countinteger

Number of orders

Example response

{
  "orders": [
    {
      "contact_id": 187588,
      "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"
      ]
    }
  ],
  "count": 17655
}