Create product with category and brand
This endpoint allows two types of request:
Type 1: Creating a new product as well as a new category path (including subcategories) and a new brand by using CategoryPath and BrandName parameters.
Type 2: Creating a new product given an existing BrandId and an existing CategoryId.
When creating a product, regardless of the type of request, if there is a need to create a new product with a specific custom product ID, specify the Id (integer) in the request body. Otherwise, VTEX will generate the ID automatically.
📘 Onboarding guide
Check the new Catalog onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.
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.
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
{
"Id": 42,
"Name": "Black T-Shirt",
"CategoryPath": "Mens/Clothing/T-Shirts",
"DepartmentId": 1,
"BrandName": "Acme",
"RefId": "31011706925",
"Title": "Black T-Shirt",
"LinkId": "tshirt-black",
"Description": "A classic black t-shirt made from soft, breathable cotton",
"ReleaseDate": "2025-07-01T00:00:00",
"IsVisible": true,
"IsActive": true,
"TaxCode": "12345",
"MetaTagDescription": "Very cool t-shirt for sports",
"ShowWithoutStock": true,
"Score": 1
}Response
OK