Sendinblue API Data Model
Products |
Return all your productsRetrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.
Catalog: Brevo
Schema: Ecommerce
Primary Keys: id
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Products. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
alternativePrice[eq] |
|
☐ |
|
Alternative price filter for products equals to particular amount |
alternativePrice[gt] |
|
☐ |
|
Alternative price filter for products greater than particular amount |
alternativePrice[gte] |
|
☐ |
|
Alternative price filter for products greater than and equals to particular amount |
alternativePrice[lt] |
|
☐ |
|
Alternative price filter for products less than particular amount |
alternativePrice[lte] |
|
☐ |
|
Alternative price filter for products less than and equals to particular amount |
alternativePrice[ne] |
|
☐ |
|
Alternative price filter for products not equals to particular amount |
createdSince |
|
☐ |
|
Filter (urlencoded) the products created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** |
isDeleted |
|
☐ |
|
Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned. |
modifiedSince |
|
☐ |
|
Filter (urlencoded) the products modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** |
name |
|
☐ |
|
Filter by product name, minimum 3 characters should be present for search. |
price[eq] |
|
☐ |
|
Price filter for products equals to particular amount |
price[gt] |
|
☐ |
|
Price filter for products greater than particular amount |
price[gte] |
|
☐ |
|
Price filter for products greater than and equals to particular amount |
price[lt] |
|
☐ |
|
Price filter for products less than particular amount |
price[lte] |
|
☐ |
|
Price filter for products less than and equals to particular amount |
price[ne] |
|
☐ |
|
Price filter for products not equals to particular amount |
search |
|
☐ |
|
Search products simultaneously across SKU, name, and ID fields. Results are returned in the following priority order: **exact SKU match** > **SKU prefix match** > **name match** > **ID match**. For example, `?search=123` on products with `{sku: "123"}` and `{sku: "123456"}` returns the exact SKU match first. |
sortByField |
|
☐ |
|
Sort the results by a specific field. Default sort field is `created_at` when not passed.(Values: created_at, name, price, id) |
Columns of Table Function
The columns of the table function Products are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
alternativePrice |
double |
|
☐ |
Alternative price of the product |
brand |
varchar2(128) |
|
☐ |
Brand of the product |
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) |
description |
varchar2(3000) |
Description |
☐ |
Description of the product |
id |
varchar2 |
ID |
☐ |
Product ID for which you requested the details |
imageUrl |
varchar2 |
|
☐ |
Absolute URL to the cover image of the product |
isDeleted |
char |
|
☐ |
Product deleted from the shop's database but not from Brevo |
metaInfo |
varchar2 |
|
☐ |
Meta data of product such as description, vendor, producer, stock level, etc. |
modifiedAt |
varchar2 |
Modified Date |
☐ |
Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) |
name |
varchar2 |
Name |
☐ |
Name of the product for which you requested the details |
parentId |
varchar2 |
|
☐ |
Parent product id of the product |
price |
double |
|
☐ |
Price of the product |
s3Original |
varchar2 |
|
☐ |
S3 url of original image |
s3ThumbAnalytics |
varchar2 |
|
☐ |
S3 thumbnail url of original image in 120x120 dimension for analytics section |
s3ThumbEditor |
varchar2 |
|
☐ |
S3 thumbnail url of original image in 600x400 dimension for editor section |
sku |
varchar2 |
|
☐ |
Product identifier from the shop |
stock |
decimal |
|
☐ |
Current stock value of the product from the shop's database |
url |
varchar2 |
URL |
☐ |
URL to the product |
