POST /products/batch
Create or update multiple ecommerce products in a single request. The products array accepts up to 100 product objects for creation (or up to 1000 when updateEnabled is true and the account has an increased limit). Each product requires a unique id and name (name is mandatory for creation only). When updateEnabled is false, all products are inserted as new; if any ID already exists, a 400 error is returned. When updateEnabled is true, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
products[] |
Array | Yes |
array of products objects |
products[].price |
Number | No |
Price of the product |
products[].stock |
Number | No |
Current stock value of the product from the shop's database |
products[].description |
String | No |
Description of the product |
products[].url |
String | No |
URL to the product |
products[].brand |
String | No |
Brand of the product |
products[].metaInfo |
Object | No |
Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed 20000 characters. |
products[].imageUrl |
String | No |
Absolute URL to the cover image of the product |
products[].id |
String | Yes |
Product ID for which you requested the details |
products[].parentId |
String | No |
Parent product id of the product |
products[].name |
String | Yes |
Mandatory in case of creation. Name of the product, as displayed in the shop |
products[].sku |
String | No |
Product identifier from the shop |
products[].categories[] |
Array | No |
Category ID-s of the product |
products[].deletedAt |
String | No |
UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database |
products[].isDeleted |
Boolean | No |
product deleted from the shop's database |
products[].alternativePrice |
Number | No |
Alternative price of the product |
updateEnabled |
Boolean | No |
Facilitate to update the existing products in the same request (updateEnabled = true) |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.