Learn more about products in VTEX catalog.

Data Model

Field Description Required Format Default
Id Product ID. If not provided, it will be generated automatically (sequence) No Integer AutoIncrement
Name Product name Yes String (150) -
DepartmentId Department ID according to the product's category. This field should not be provided during product creation. No String -
CategoryId Category ID associated with this product. Yes Integer -
BrandId Brand ID associated with this product Yes Integer null
LinkId String to be used to build the product URL. If it not informed, it will be generated automatically according to product's name replacing spaces and special characters with hyphens (`-`) No String(255) Product Name
RefId Product reference code No String(200) null
IsVisible Show/Hide product in search result and product page but can be added into shopping cart. Usually applicable for gifts. No Boolean (true/false) false
Description Product description No String null
DescriptionShort Product short description. This information is presented by:
  • Store Framework: $product.DescriptionShort control
  • Classic CMS:

    And can be displayed on both the product page and the shelf.

No String null
ReleaseDate Used to assist in the ordering of the search result of the site. Using the O=OrderByReleaseDateDESC query string, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections. No DateTime null
KeyWords Store Framework: Deprecated

Classic CMS: Synonyms of terms related to product. "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive.

No String null
Title Product title tag. It is displayed in the browser tab and corresponds to the title of the product page. This field is important for SEO. No String (150) null
IsActive Activate/Inactivate product No Boolean (true/false) false
TaxCode Product fiscal number. Usually used for tax calculation. No String (50) null
MetaTagDescription Brief description of the product for SEO. It's recommended that you don't exceed 150 characters. No String null
SupplierId Deprecated No Integer null
ShowWithoutStock If true, activates "Notify Me" form when the product is out of stock. No Boolean (true/false) false
AdWordsRemarketingCode Deprecated No String null
LomadeeCampaignCode Deprecated No String null
Score Value used to set the priority on the search result page. No Integer null

API integration

Create a product

Use the Create product API endpoint to insert a new product.

Example request

Body:

{
    "Id": null,
    "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "DepartmentId": 2000089,
    "CategoryId": 2000090,
    "BrandId": 12121219,
    "LinkId": "stefan-janoski-canvas-varsity-red",
    "RefId": "sr_1_90",
    "IsVisible": true,
    "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.",
    "ReleaseDate": "2020-01-01T00:00:00",
    "KeyWords": "Zoom,Stefan,Janoski",
    "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "IsActive": true,
    "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "ShowWithoutStock": true,
}

Response:

{
    "Id": 42,
    "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "DepartmentId": 2000089,
    "CategoryId": 2000090,
    "BrandId": 12121219,
    "LinkId": "stefan-janoski-canvas-varsity-red",
    "RefId": "sr_1_90",
    "IsVisible": true,
    "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.",
    "ReleaseDate": "2020-01-01T00:00:00",
    "KeyWords": "Zoom,Stefan,Janoski",
    "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re",
    "IsActive": true,
    "TaxCode": "",
    "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "SupplierId": 1,
    "ShowWithoutStock": true,
    "AdWordsRemarketingCode": null,
    "LomadeeCampaignCode": null,
    "Score": 1
}

🚧

We recommend not sending the product ID (Id field), leaving VTEX to manage the creation of IDs. The ID that is generated can be retrieved in the request's response and must be stored in the system for future updates of this product.

Update a product

If you have already created a Product and want to change it, use the Update product API request, sending in the Id of the product already created.

Example request

Body:

{
    "Id": 42,
    "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "DepartmentId": 2000089,
    "CategoryId": 2000090,
    "BrandId": 12121219,
    "LinkId": "stefan-janoski-canvas-varsity-red",
    "RefId": "sr_1_90",
    "IsVisible": true,
    "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.",
    "ReleaseDate": "2020-01-01T00:00:00",
    "KeyWords": "Zoom,Stefan,Janoski",
    "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re",
    "IsActive": true,
    "TaxCode": "",
    "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "SupplierId": 1,
    "ShowWithoutStock": true,
    "AdWordsRemarketingCode": null,
    "LomadeeCampaignCode": null,
    "Score": 1
}

Response:

{
    "Id": 42,
    "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "DepartmentId": 2000089,
    "CategoryId": 2000090,
    "BrandId": 12121219,
    "LinkId": "stefan-janoski-canvas-varsity-red",
    "RefId": "sr_1_90",
    "IsVisible": true,
    "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.",
    "ReleaseDate": "2020-01-01T00:00:00",
    "KeyWords": "Zoom,Stefan,Janoski",
    "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
    "IsActive": true,
    "TaxCode": "",
    "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.",
    "SupplierId": 1,
    "ShowWithoutStock": true,
    "AdWordsRemarketingCode": null,
    "LomadeeCampaignCode": null,
    "Score": 1
}

❗️

Keep in mind

  • If you need to change any product field, it is necessary to send the other fields, otherwise, the fields not entered will be deleted. Therefore, we suggest that before making a change, you should get the product data for the same Id and use the response as a template to make the change.
  • When creating or updating products note that any product must be associated with the lowest level of category tree.

Did this page help you?