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.

Request body examples

Type 1

Request to create a product, associating it to a new Category and a new Brand by using CategoryPath and BrandName:

{
    "Name": "Black T-Shirt",
    "CategoryPath": "Mens/Clothing/T-Shirts",
    "BrandName": "Nike",
    "RefId": "31011706925",
    "Title": "Black T-Shirt",
    "LinkId": "tshirt-black",
    "Description": "This is a cool Tshirt",
    "ReleaseDate": "2022-01-01T00:00:00",
    "IsVisible": true,
    "IsActive": true,
    "TaxCode": "",
    "MetaTagDescription": "tshirt black",
    "ShowWithoutStock": true,
    "Score": 1
}

Type 2

Request to create a product, associating it to an existing CategoryId and BrandId:

{
   "Name": "insert product test",
   "DepartmentId": 1,
   "CategoryId": 2,
   "BrandId": 2000000,
   "LinkId": "insert-product-test",
   "RefId": "310117869",
   "IsVisible": true,
   "Description": "texto de descrição",
   "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis",
   "ReleaseDate": "2019-01-01T00:00:00",
   "KeyWords": "teste,teste2",
   "Title": "product de teste",
   "IsActive": true,
   "TaxCode": "",
   "MetaTagDescription": "tag test",
   "SupplierId": 1,
   "ShowWithoutStock": true,
   "AdWordsRemarketingCode": null,
   "LomadeeCampaignCode": null,
   "Score": 1
}

Response body example

{
   "Id": 52,
   "Name": "insert product test",
   "DepartmentId": 1,
   "CategoryId": 2,
   "BrandId": 2000000,
   "LinkId": "insert-product-test",
   "RefId": "310117869",
   "IsVisible": true,
   "Description": "texto de descrição",
   "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis",
   "ReleaseDate": "2019-01-01T00:00:00",
   "KeyWords": "teste,teste2",
   "Title": "product de teste",
   "IsActive": true,
   "TaxCode": "",
   "MetaTagDescription": "tag test",
   "SupplierId": 1,
   "ShowWithoutStock": true,
   "AdWordsRemarketingCode": null,
   "LomadeeCampaignCode": null,
   "Score": 1
}

📘

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.

Language
Authentication
URL
Click Try It! to start a request and see the response here!