Get a product's details | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.ecommerce.getProductInfo("id");
}
main();

{
  "createdAt": "2017-05-12T12:30:00Z",
  "id": "P11",
  "modifiedAt": "2017-05-12T12:30:00Z",
  "name": "Iphone 11",
  "s3ThumbAnalytics": "string",
  "s3ThumbEditor": "string",
  "brand": "Adidas",
  "categories": [
    "string"
  ],
  "description": "Shoes for sports",
  "imageUrl": "http://mydomain.com/product-absoulte-url/img.jpeg",
  "isDeleted": true,
  "metaInfo": {
    "brand": "addidas",
    "description": "Shoes for sports"
  },
  "parentId": "string",
  "price": 1.1,
  "s3Original": "string",
  "sku": "string",
  "stock": 100,
  "url": "http://mydomain.com/product/electronics/product1"
}

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 informations

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 get 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

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