For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
      • POSTCreate/Update a product
      • GETGet a product's details
      • POSTCreate products in batch
      • GETReturn all your products
      • POSTCreate a product alert for a contact
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
EcommerceProducts

Get a product's details

GET
https://api.brevo.com/v3/products/:id
GET
/v3/products/:id
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.ecommerce.getProductInfo("id");
8}
9main();
1{
2  "createdAt": "2017-05-12T12:30:00Z",
3  "id": "P11",
4  "modifiedAt": "2017-05-12T12:30:00Z",
5  "name": "Iphone 11",
6  "s3ThumbAnalytics": "string",
7  "s3ThumbEditor": "string",
8  "brand": "Adidas",
9  "categories": [
10    "string"
11  ],
12  "description": "Shoes for sports",
13  "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
14  "isDeleted": true,
15  "metaInfo": {
16    "brand": "addidas",
17    "description": "Shoes for sports"
18  },
19  "parentId": "string",
20  "price": 1.1,
21  "alternativePrice": 1.1,
22  "s3Original": "string",
23  "sku": "string",
24  "stock": 100,
25  "url": "http://mydomain.com/product/electronics/product1"
26}

Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a 404 error if no product matches the provided ID.

Was this page helpful?
Previous

Create products in batch

Next
Built with

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

idstringRequired
Product ID

Response

Product details
createdAtstring

Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)

idstringformat: "string"
Product ID for which you requested the details
modifiedAtstring

Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestringformat: "string"
Name of the product for which you requested the details
s3ThumbAnalyticsstringformat: "string"
S3 thumbnail url of original image in 120x120 dimension for analytics section
s3ThumbEditorstringformat: "string"
S3 thumbnail url of original image in 600x400 dimension for editor section
brandstring<=128 characters
Brand of the product
categorieslist of strings

Category ID-s of the product

descriptionstring<=3000 characters
Description of the product
imageUrlstringformat: "string"
Absolute URL to the cover image of the product
isDeletedboolean
Product deleted from the shop's database but not from Brevo
metaInfoobject
Meta data of product such as description, vendor, producer, stock level, etc.
parentIdstringformat: "string"
Parent product id of the product
pricedouble
Price of the product
alternativePricedouble
Alternative price of the product
s3Originalstringformat: "string"
S3 url of original image
skustringformat: "string"
Product identifier from the shop
stockdouble
Current stock value of the product from the shop's database
urlstringformat: "string"
URL to the product

Errors

400
Bad Request Error
404
Not Found Error