POST /products
Create a new ecommerce product or update an existing one, identified by the mandatory id field. When updateEnabled is false (the default), the endpoint inserts a new product and returns 201; if the product ID already exists, a 400 error is returned. When updateEnabled is true, the endpoint performs an upsert, returning 201 for a new product or 204 for an update. The name field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The metaInfo object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.
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 |
|---|---|---|---|
price |
Number | No |
Price of the product |
stock |
Number | No |
Current stock value of the product from the shop's database |
description |
String | No |
Description of the product |
url |
String | No |
URL to the product |
brand |
String | No |
Brand of the product |
updateEnabled |
Boolean | No |
Facilitate to update the existing product in the same request (updateEnabled = true) Default value: false |
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. |
imageUrl |
String | No |
Absolute URL to the cover image of the product |
id |
String | Yes |
Product ID for which you requested the details |
parentId |
String | No |
Parent product id of the product |
name |
String | Yes |
Mandatory in case of creation. Name of the product, as displayed in the shop |
sku |
String | No |
Product identifier from the shop |
categories[] |
Array | No |
Category ID-s of the product |
deletedAt |
String | No |
UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database |
isDeleted |
Boolean | No |
product deleted from the shop's database |
alternativePrice |
Number | No |
Alternative price of the product |
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.