Return all your products | Brevo API Documentation

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

{
  "count": 2,
  "products": [
    {
      "createdAt": "2022-06-30T10:29:16.078Z",
      "id": "7498033266862",
      "modifiedAt": "2022-06-30T10:29:16.078Z",
      "name": "Alpina Panoma Classic",
      "s3ThumbAnalytics": "https://img-ecom.mailinblue.com/path-to-analytics/img.jpg",
      "s3ThumbEditor": "https://img-ecom.mailinblue.com/path-to-editor/img.jpg",
      "categories": [
        "279638835374",
        "279502848174"
      ],
      "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
      "isDeleted": true,
      "price": 49.95,
      "s3Original": "https://img-ecom.mailinblue.com/path-to-original/img.jpg",
      "sku": "186622-9",
      "stock": 100,
      "url": "https://mydomain.com/products/alpina-panoma-classic"
    },
    {
      "createdAt": "2022-06-30T10:29:16.078Z",
      "id": "7498033266862",
      "modifiedAt": "2022-06-30T10:29:16.078Z",
      "name": "Alpina Panoma Classic2",
      "s3ThumbAnalytics": "https://img-ecom.mailinblue.com/path-to-analytics/img.jpg",
      "s3ThumbEditor": "https://img-ecom.mailinblue.com/path-to-editor/img.jpg",
      "categories": [
        "2d79638835374",
        "27d9502848174"
      ],
      "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
      "isDeleted": true,
      "metaInfo": {
        "brand": "addidas",
        "description": "Shoes for sports"
      },
      "price": 49.95,
      "s3Original": "https://img-ecom.mailinblue.com/path-to-original/img.jpg",
      "sku": "186622-9",
      "stock": 350,
      "url": "https://mydomain.com/products/alpina-panoma-classic2"
    }
  ]
}

Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Pagination defaults to 50 products per page (maximum 1000), and the response includes a count field with the total number of matching products.

Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.

Authentication

api-keystring

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

Query parameters

limitlongOptional<=1000Defaults 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:

idslist of stringsOptional

Filter by product ids

namestringOptional

Filter by product name, minimum 3 characters should be present for search.

price[lte]doubleOptional

Price filter for products less than and equals to particular amount

price[gte]doubleOptional

Price filter for products greater than and equals to particular amount

price[lt]doubleOptional

Price filter for products less than particular amount

price[gt]doubleOptional

Price filter for products greater than particular amount

price[eq]doubleOptional

Price filter for products equals to particular amount

price[ne]doubleOptional

Price filter for products not equals to particular amount

categorieslist of stringsOptional

Filter by categories ids

modifiedSincestringOptional

Filter (urlencoded) the products 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 products 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.

sortByFieldenumOptional

Sort the results by a specific field. Default sort field is created_at when not passed.

Allowed values:

isDeletedstringOptional

Filter products by their deletion status. If false is passed, only products that are not deleted will be returned.

Response

All products listed

countlong

Number of products

productslist of objects

Errors

400

Bad Request Error