Catalog structure

The structure of the product catalog can be described from the elements present in the SearchProduct API request. Each catalog item contains detailed information about a specific product. Let's analyze the structure and describe each element:

blocked: Indicates whether the product is blocked or not. If it is blocked, it could mean that the product is currently not available or has some restriction.

id: It is the unique identifier of the product in the source, which can be used to reference the product in other parts of the system.

name: Refers to the name of the product.

productDescription: Describes the product in more detail, providing additional information about its features, functionality or any other relevant information.

externalUrl: It is the URL of the product in the ecommerce, allowing the customer to directly access the online product page.

mainVariant: Represents the main variant of the product. Contains information specific to that variant, such as:

id: Unique identifier of the variant.

externalImageURL: Variant image URL, allowing customers to preview what the product will look like.

erpId: Product identifier in the ERP (Enterprise Resource Planning) system.

name: Name of the variant.

visible: Indicates whether the variant is visible in the catalog or not.

price: Price of the variant without discount.

salePrice: Price of the variant at a discount, if any promotion is in effect.

quantity: Quantity available in stock for this variant.

sellerId: Identifier of the marketplace partner providing this variant.

sellerName: Name of the marketplace partner.

variations: Represents variations of the main variant, such as color, size, among others. Each variation contains a key and a corresponding value.

variants: Represents other variants available for the product, following the same structure described for the main variant. These variants may have differences in characteristics such as color, size, model, among others.

sellOutOfStock: Indicates whether the sale of the product is allowed even when there is no stock available.

This product catalog structure provides a complete description of each item, including essential information such as name, description, price, images, stock and variations. Based on this information, it is possible to create a detailed and attractive presentation of the products in the catalog, facilitating the selection and purchase decision by the customers.