Get order details

GET

https://api.brevo.com/v3/orders

GET

/v3/orders

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        "api-key": "YOUR_API_KEY_HERE",
    });
    await client.ecommerce.getOrders({});
}
main();

{
  "count": 1,
  "orders": [
    {
      "amount": 2000,
      "billing": {
        "address": "Sec 62, Noida",
        "city": "Noida",
        "country": "India",
        "countryCode": "IN",
        "paymentMethod": "Net banking",
        "phone": 9238283982,
        "postCode": 110001,
        "region": "North India"
      },
      "contact_id": 2,
      "coupons": [
        "flat50",
        "flat40"
      ],
      "createdAt": "2021-12-31T11:42:35.638Z",
      "email": "testvisitor@sendinblue.com",
      "id": "order1803",
      "identifiers": {
        "ext_id": "ab12",
        "loyalty_subscription_id": "1234"
      },
      "products": [
        {
          "price": 100,
          "productId": 21,
          "quantity": 2,
          "quantityFloat": 0,
          "sku": "SKU-001",
          "variantId": "P100"
        },
        {
          "price": 100,
          "productId": 21,
          "quantity": 0,
          "quantityFloat": 2.52,
          "variantId": "P15756"
        }
      ],
      "shipping": {
        "address": "Plot 4, Sector 18",
        "city": "Noida",
        "country": "India",
        "countryCode": "IN",
        "name": "Jane Doe",
        "phone": 9238283983,
        "postCode": 201301,
        "region": "Uttar Pradesh"
      },
      "status": "complete",
      "storeId": "123",
      "updatedAt": "2022-03-03T14:48:31.867Z"
    }
  ]
}

Get all the orders

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Query parameters

limitlongOptional<=100Defaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document in the page

sortenumOptionalDefaults to desc

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

Allowed values:

secondarySortByModifiedAtbooleanOptionalDefaults to false

When true, orders with the same createdAt are then ordered by their updatedAt, in the same direction as sort. Use it to get a stable order when paging through the results with limit and offset. Default is false.

modifiedSincestringOptional

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.

createdSincestringOptional

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

Errors

400

Bad Request Error