Manage products

After importing your product categories, manage your product inventory using the steps below.

Requirements

To create and manage products in your eCommerce store, you need access to the Brevo eCommerce app. If you haven’t activated the eCommerce platform on your account, see eCommerce > Add the eCommerce App.

Create a product

To integrate your store with Brevo, create products. See the API endpoint reference at eCommerce > Create/Update a product.

The cURL request is:

$
curl --request POST \
>
     --url https://api.brevo.com/v3/products \
>
     --header 'accept: application/json' \
>
     --header 'content-type: application/json' \
>
     --data '
>
{
>
     "categories": [
>
          "CAT123"
>
     ],
>
     "metaInfo": {
>
          "description": "A smartphone"
>
     },
>
     "id": "P11",
>
     "name": "Iphone 11",
>
     "url": "http://mydomain.com/product/electronics/product1",
>
     "imageUrl": "http://mydomain.com/product-absolute-url/img.jpeg",
>
     "sku": "P1",
>
     "price": 500,
>
     "parentId": "P3",
>
     "updateEnabled": true
>
}'

Use the cURL request above to create a product. Parameters used to create a product:

Create products in a batch

When you have multiple products to create, use the endpoint eCommerce > Creates the products in a batch. Instead of calling the single-product endpoint multiple times, create them all in one batch. The cURL request for batch product creation is:

$
curl --request POST \
>
     --url https://api.brevo.com/v3/products/batch \
>
     --header 'accept: application/json' \
>
     --header 'content-type: application/json' \
>
     --data

1
{
2
     "products": [
3
          {
4
               "categories": [
5
                    "CAT123"
6
               ],
7
               "metaInfo": {
8
                    "Vendor": "Samsung"
9
               },
10
               "id": "P12",
11
               "name": "Samsung S22",
12
               "url": "http://mydomain.com/product/electronics/product1",
13
               "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
14
               "sku": "P2",
15
               "price": 600,
16
               "parentId": "P01"
17
          },
18
          {
19
               "categories": [
20
                    "CAT123"
21
               ],
22
               "metaInfo": {
23
                    "vendor": "Samsung"
24
               },
25
               "id": "P3",
26
               "name": "Samsung S21",
27
               "url": "http://mydomain.com/product/electronics/product1",
28
               "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
29
               "sku": "P33",
30
               "price": 300,
31
               "parentId": "P4"
32
          }
33
     ],
34
     "updateEnabled": true
35
}

The parameters match those in Create a product, but products are sent in batches. Parameters for creating products in batches:

Update a product

To update an existing product, set updateEnabled to true. The field accepts true or false. Products cannot be updated when this field is false.

1
"updateEnabled": true

To allow later updates, set this field to true when creating the product.

Responses you should expect

See the list of errors here.

Retrieving all products

Test the API to get all products at eCommerce > Return all your products. The cURL request is below.

$
curl --request GET \
>
     --url 'https://api.brevo.com/v3/products?limit=50&offset=0&sort=desc' \
>
     --header 'accept: application/json'

The parameters for this endpoint are:

How to get a product’s details?

Get a specific product’s details by sending a GET request with the product ID. Test this endpoint at eCommerce > Get a product’s details.

$
curl --request GET \
>
     --url https://api.brevo.com/v3/products/P11 \
>
     --header 'accept: application/json' \

The cURL request above sends the request to the endpoint. id is the only parameter for this endpoint — it is the product’s unique identifier.