Manage product categories

After accessing the eCommerce platform you can start defining the categories that your products will be associated to. Note that this should ideally be the first object type you import into your account.

Create a category

To create a category, go to the eCommerce > Create/Update a category in the API reference. Below you find an example of body parameters which can be used to create or update a category.

cURL Request

1
curl --request POST \
2
     --url https://api.brevo.com/v3/categories \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
     "id": "CAT123",
8
     "name": "Electronics",
9
     "url": "http://mydomain.com/category/electronics"
10
     "updateEnabled": false
11
}

The cURL request shows us what parameters will be used to create a category. Below, you can see some default values mentioned for each parameter.

Body parameters

Update a category

You can update a category by changing the boolean value to true in the updateEnabled attribute when you are creating the category.

1
{
2
     "updateEnabled": true
3
}

You can then change the name and url of the category and then run it to update the respective category.

Response codes

Retrieving all categories

You can retrieve the categories you added by calling the eCommerce > Return all your categories API endpoint in the API reference. Below you can see the attributes used for returning all your categories.

cURL Request

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

The parameters to retrieve all categories are as following:

Retrieving a category details

You can get a category’s details by entering the id for the category in the get a category details endpoint.

1
curl --request GET \
2
     --url https://api.brevo.com/v3/categories/CAT123 \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

There is only one attribute for this endpoint mentioned below:

Creating categories in a batch

You can use this to send your product categories in batches so you don’t have to add every category individually. Below you can find a cURL request for creating categories in a batch.

1
curl --request POST \
2
     --url https://api.brevo.com/v3/categories/batch \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
     "updateEnabled": true
8
}

We can use the cURL request to call the batch endpoint for categories. Note the boolean attribute updateEnabled is included to enable or disable updates for all the categories being imported.

Categories is an array of objects. It has further sub-attributes.

JSON Payload

1
{"categories":[{
2
    "id": "CAT123",
3
    "name": "Example Category 1",
4
    "url": "http://shop.com/category/example1"
5
},
6
{
7
    "id": "CAT234",
8
    "name": "Example Category 2",
9
    "url": "http://shop.com/category/example2"
10
},
11
{
12
    "id": "CAT345",
13
    "name": "Example Category 3",
14
    "url": "http://shop.com/category/example3"
15
    }
16
],
17
"updateEnabled": true
18
}