Product Payload Reference

This document describes the fields returned by the Get Product by ID endpoint.
Fields are ordered from most important to least important, focusing on integration relevance.

Product Payload Reference

This document describes the fields returned by the Get Product by ID endpoint.
Fields are ordered from most important to least important, focusing on integration relevance.

A product is composed of categories, SKUs, prices, images, stock information, and descriptive attributes.

Each SKU may contain its own attributes, images, and stock per seller, while prices and characteristics are defined at the product level.

Structure

Product
├─ Categories []            // Product category assignments (with hierarchy)
├─ Skus []                  // Product variations
│  ├─ Attributes []         // SKU attributes 
│  ├─ Stocks []             // Stock per seller / store
│  ├─ Images []             // SKU images
│
├─ Prices []                // Prices per seller
├─ Images []                // Product-level images
├─ Characteristics []       // Product characteristics
├─ Stocks []                // Aggregated stock per SKU and seller
├─ Tags []                  // Product tags
├─ Installments []          // Installment rules

Detailed

Field	Type	Description
`id`	UUID	Unique identifier of the product.
`code`	string	Main business code used to identify the product.
`referenceCode`	string	Reference code of the product, usually equal to the main code.
`name`	string	Product display name.
`description`	string (HTML)	Full product description in HTML format.
`isActive`	boolean	Indicates whether the product is active and available.
`isDeleted`	boolean	Indicates whether the product has been logically deleted.
`clientId`	string	Client identifier that owns the product.
`brand`	string	Product brand name.
`createDate`	datetime (ISO 8601)	Date when the product was created.
`lastUpdate`	datetime (ISO 8601)	Date of the last product update.
`releaseDate`	datetime (ISO 8601) \| null	Product release date, if applicable.

Commercial & Identification

Field	Type	Description
`auxCode`	string	Auxiliary or secondary product code.
`keywords`	string	Raw keywords string associated with the product.
`keywordsList`	string[]	Normalized list of product keywords.
`maxInstallments`	integer	Maximum number of installments allowed for the product.
`pickupOnly`	boolean	Indicates if the product is restricted to store pickup only.

Dimensions & Weight

Field	Type	Description
`height`	decimal	Product height.
`width`	decimal	Product width.
`lenght`	decimal	Product length.
`weight`	decimal	Product weight.

Field	Type	Description
`categories[].id`	UUID	Category identifier.
`categories[].code`	string	Category business code.
`categories[].name`	string	Category name.
`categories[].parentId`	UUID \| null	Parent category identifier.
`categories[].isActive`	boolean	Indicates whether the category is active.
`categories[].order`	integer	Category display order.
`categories[].createDate`	datetime	Category creation date.
`categories[].lastUpdate`	datetime	Category last update date.

SKUs

Each product may contain one or more SKUs representing sellable variations.

Field	Type	Description
`skus[].id`	UUID	Unique SKU identifier.
`skus[].code`	string	SKU business code.
`skus[].barcode`	string	SKU barcode (EAN/UPC).
`skus[].name`	string	SKU name or variation label.
`skus[].isActive`	boolean	Indicates whether the SKU is active.
`skus[].isDeleted`	boolean	Indicates whether the SKU is deleted.
`skus[].productId`	UUID	Parent product identifier.
`skus[].createDate`	datetime	SKU creation date.
`skus[].lastUpdate`	datetime	SKU last update date.

SKU Images

Field	Type	Description
`skus[].images[].id`	UUID	Image identifier.
`skus[].images[].imageUrl`	string (URL)	Public image URL.
`skus[].images[].order`	integer	Display order of the image.
`skus[].images[].catalogFullImageUrl`	string (URL)	Full catalog image URL.
`skus[].images[].createDate`	datetime	Image creation date.
`skus[].images[].lastUpdate`	datetime	Image last update date.

Pricing

Represents prices per seller.

Field	Type	Description
`prices[].id`	UUID	Price identifier.
`prices[].price`	decimal	Current selling price.
`prices[].oldPrice`	decimal	Previous price before update.
`prices[].sellerId`	UUID	Seller identifier.
`prices[].sellerCode`	string	Seller business code.
`prices[].sellerPointSaleId`	string	Seller point of sale identifier.
`prices[].isActive`	boolean	Indicates whether the price is active.
`prices[].createDate`	datetime	Price creation date.
`prices[].lastUpdate`	datetime	Price last update date.

Stock

Aggregated and per-SKU stock information.

Field	Type	Description
`stocks[].id`	UUID	Stock record identifier.
`stocks[].quantity`	integer	Available quantity for sale.
`stocks[].totalQuantity`	integer	Total quantity including reserved stock.
`stocks[].sellerId`	UUID	Seller identifier.
`stocks[].sellerName`	string	Seller display name.
`stocks[].skuId`	UUID	SKU identifier.
`stocks[].skuCode`	string	SKU business code.
`stocks[].productId`	UUID	Product identifier.
`stocks[].lastUpdate`	datetime	Last stock update timestamp.

Product Characteristics

Attributes that describe the product and may be used for filtering or display.

Field	Type	Description
`characteristics[].id`	UUID	Characteristic identifier.
`characteristics[].key`	string	Characteristic name.
`characteristics[].value`	string	Characteristic value.
`characteristics[].type`	integer	Characteristic type identifier.
`characteristics[].displayOnCatalog`	boolean	Indicates if the characteristic should be displayed in catalog.
`characteristics[].order`	integer	Display order.
`characteristics[].lastUpdate`	datetime	Last update timestamp.

Notes

All date and time fields follow the ISO 8601 standard.
This endpoint is designed to provide the complete and current state of a product.
Consumers should rely on lastUpdate values to manage cache invalidation and synchronization.