Create Product with Category and Brand

v1.0.0

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.

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:

json

{
    "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:

json

{
   "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

json

{
   "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 . 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.

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "AdWordsRemarketingCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration."
    },
    "BrandId": {
      "type": "integer",
      "description": "ID of an existing Brand that will be associated with this product. It is mandatory to use either this field or the `BrandName` field."
    },
    "BrandName": {
      "type": "string",
      "description": "Name of the brand that will be associated with this product. It is mandatory to use either this field or the `BrandId` field. If you wish to create a new brand, that is, in case the brand does not exist yet, use this field instead of `BrandId`."
    },
    "CategoryId": {
      "type": "integer",
      "description": "ID of an existing Category that will be associated with this product. It is mandatory to use either this field or the `CategoryPath` field."
    },
    "CategoryPath": {
      "type": "string",
      "description": "Path of categories associated with this product, from the highest level of category to the lowest level, separated by `/`. It is mandatory to use either this field or the `CategoryId` field."
    },
    "Content-Type": {
      "type": "string"
    },
    "Description": {
      "type": "string",
      "description": "Product description."
    },
    "DescriptionShort": {
      "type": "string",
      "description": "Short product description. This information can be displayed on both the product page and the shelf, using the following controls:\r\n Store Framework:  `$product.DescriptionShort`.\r\n Legacy CMS Portal: `<vtex.cmc:productDescriptionShort/>`.\r\n"
    },
    "Id": {
      "type": "integer",
      "description": "Product’s unique numerical identifier. If not informed, it will be automatically generated by VTEX."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Activate (`true`) or inactivate (`false`) product."
    },
    "IsVisible": {
      "type": "boolean",
      "description": "Shows (`true`) or hides (`false`) the product in search result and product pages, but the product can still be added to the shopping cart. Usually applicable for gifts."
    },
    "KeyWords": {
      "type": "string",
      "description": "Store Framework: Deprecated. \r\nLegacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n"
    },
    "LinkId": {
      "type": "string",
      "description": "Slug that will be used to build the product page URL. If it not informed, it will be generated according to the product's name replacing spaces and special characters by hyphens (`-`)."
    },
    "LomadeeCampaignCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration."
    },
    "MetaTagDescription": {
      "type": "string",
      "description": "Brief description of the product for SEO. It is recommended not to exceed 150 characters."
    },
    "Name": {
      "type": "string",
      "description": "Product's name. Limited to 150 characters."
    },
    "RefId": {
      "type": "string",
      "description": "Product Reference Code."
    },
    "ReleaseDate": {
      "type": "string",
      "description": "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."
    },
    "Score": {
      "type": "integer",
      "description": "Value used to set the priority on the search result page."
    },
    "ShowWithoutStock": {
      "type": "boolean",
      "description": "If `true`, activates the [Notify Me](https://help.vtex.com/en/tutorial/setting-up-the-notify-me-option--2VqVifQuf6Co2KG048Yu6e) option when the product is out of stock."
    },
    "SupplierId": {
      "type": "integer"
    },
    "TaxCode": {
      "type": "string",
      "description": "Product tax code, used for tax calculation."
    },
    "Title": {
      "type": "string",
      "description": "Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO."
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "Name"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "AdWordsRemarketingCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration."
    },
    "BrandId": {
      "type": "integer",
      "description": "Brand ID associated with this product."
    },
    "CategoryId": {
      "type": "integer",
      "description": "Category ID associated with this product."
    },
    "DepartmentId": {
      "type": "integer",
      "description": "Department ID according to the product's category."
    },
    "Description": {
      "type": "string",
      "description": "Product description."
    },
    "DescriptionShort": {
      "type": "string",
      "description": "Short product description. This information can be displayed on both the product page and the shelf, using the following controls:\r\n Store Framework:  `$product.DescriptionShort`.\r\n Legacy CMS Portal: `<vtex.cmc:productDescriptionShort/>`.\r\n"
    },
    "Id": {
      "type": "integer",
      "description": "Product’s unique numerical identifier."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Activate (`true`) or inactivate (`false`) product."
    },
    "IsVisible": {
      "type": "boolean",
      "description": "Shows (`true`) or hides (`false`) the product in search result and product pages, but the product can still be added to the shopping cart. Usually applicable for gifts."
    },
    "KeyWords": {
      "type": "string",
      "description": "Store Framework: Deprecated. \r\nLegacy CMS Portal:  Keywords or synonyms related to the product, separated by comma (`,`). \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n"
    },
    "LinkId": {
      "type": "string",
      "description": "Slug that will be used to build the product page URL. If it not informed, it will be generated according to the product's name replacing spaces and special characters by hyphens (`-`)."
    },
    "LomadeeCampaignCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration."
    },
    "MetaTagDescription": {
      "type": "string",
      "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters."
    },
    "Name": {
      "type": "string",
      "description": "Product's name. Limited to 150 characters."
    },
    "RefId": {
      "type": "string",
      "description": "Product Reference Code."
    },
    "ReleaseDate": {
      "type": "string",
      "description": "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."
    },
    "Score": {
      "type": "integer",
      "description": "Value used to set the priority on the search result page."
    },
    "ShowWithoutStock": {
      "type": "boolean",
      "description": "If `true`, activates the [Notify Me](https://help.vtex.com/en/tutorial/setting-up-the-notify-me-option--2VqVifQuf6Co2KG048Yu6e) option when the product is out of stock."
    },
    "SupplierId": {
      "type": "integer"
    },
    "TaxCode": {
      "type": "string",
      "description": "Product tax  code, used for tax calculation."
    },
    "Title": {
      "type": "string",
      "description": "Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO."
    }
  }
}