A product is a generic definition of an item that is part of your store’s Catalog, for instance, a shirt.

Products may vary by model, color, size, among other characteristics. Therefore, it would be possible to have the same product (shirt) in different models, like short or long sleeves, gray or pink color, sizes S, M or L.

Each variation, such as a long sleeve gray size S shirt, will correspond to a Stock Keeping Unit (SKU), which is the actual item in the inventory that customers can purchase. Before creating SKUs, you must create a product.

Try the interactive version of this article by accessing this link. Code will be highlighted and focused for your convenience.

To insert a new product, use the Create product API endpoint.

When creating or updating products, note that any product must be associated with their corresponding category in the more specific category level.

We recommend leaving VTEX to automatically generate an ID, by not including a custom product ID in the Id field of the request body. The generated ID can be retrieved in the request's response and must be stored in the system for future updates of this product.

Request body example

Response body example

In case 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.

If you need to change any product field, it is necessary to send all the other fields in the request. Otherwise, all previously configured information from blank fields will be deleted. Therefore, 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.

Request body example

Response body example