Manage products

After importing your product categories you can easily manage your product inventory through the following steps.

Requirements

To create and manage your eCommerce store products you need to have access to the Brevo eCommerce app. If you have not already activated the eCommerce platform on your account you can go to eCommerce > Add the eCommerce App.

Create a product

To integrate your store with Brevo you will need to create products. You can check out the API endpoint reference for creating products in eCommerce > Create/Update a product.

The cURL request to do so is the following:

1
curl --request POST \
2
     --url https://api.brevo.com/v3/products \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
     "categories": [
8
          "CAT123"
9
     ],
10
     "metaInfo": {
11
          "description": "A smartphone"
12
     },
13
     "id": "P11",
14
     "name": "Iphone 11",
15
     "url": "http://mydomain.com/product/electronics/product1",
16
     "imageUrl": "http://mydomain.com/product-absolute-url/img.jpeg",
17
     "sku": "P1",
18
     "price": 500,
19
     "parentId": "P3",
20
     "updateEnabled": true
21
}'

You can use this cURL request to create a product. You can find the parameters used in creating a product below.

Create products in a batch

Lets say you have multiple products to create, you can use the endpoint eCommerce > Creates the products in a batch. Instead calling the enpoint multiple times, you can instead create them all in one single batch. The cURL request for batch products creation is as follows:

1
curl --request POST \
2
     --url https://api.brevo.com/v3/products/batch \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --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 are the same as the ones in Create a product, only the products are in batches. The parameters used in creating products in batches are mentioned below:

Update a product

To update an existing product, we need to change the parameter updateEnabled to true. It allows two boolean fields, true and false. We cannot update the product if the field is set to false.

1
"updateEnabled": true

If you choose to update the product parameters later, you can set this field to true when you are creating the product.

Responses you should expect

You can find a list of errors here.

Retrieving all products

You can test the API to get all the products by going to eCommerce > Return all your products. You can find the cURL request below:

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

The parameters for this endpoint are:

How to get a product’s details?

You can get a specific product’s details by sending a GET request with the product id of that item. You can test this API endpoint at eCommerce > Get a product’s details.

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

The cURL request above is responsible for sending the request to the endpoint. id is the only parameter for this endpoint, it is a unique identifier for the product.