Update product
Updates an existing product.
❗ Although some fields are not required to get a response 200 OK, if you don't send a field or send its value as empty or null, all previously configured information will be deleted, and boolean fields will turn to false. So, to update a product, you should get its data using the Get product by ID endpoint and use it as a template for the current request body.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Catalog | Content | Product and SKU Management |
There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.
❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.
Path parameters
Product's unique numerical identifier.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Request body
Example request
{
"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": "2019-01-01T00:00:00",
"KeyWords": "Zoom,Stefan,Janoski",
"Title": "Zoom Stefan Janoski Canvas RM SB Varsity Red",
"IsActive": true,
"TaxCode": "12345",
"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,
"Score": 1
}Response
OK