VTEX · Example Payload

Vtex Post Apicatalogpvtproduct Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Apicatalogpvtproduct Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "post-apicatalogpvtproduct",
  "method": "POST",
  "path": "/api/catalog/pvt/product",
  "summary": "VTex Create product with category and brand",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "New category and brand",
      "example": {
        "Id": 42,
        "Name": "Black T-Shirt",
        "CategoryPath": "Mens/Clothing/T-Shirts",
        "DepartmentId": 1,
        "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": "12345",
        "MetaTagDescription": "tshirt black",
        "ShowWithoutStock": true,
        "LomadeeCampaignCode": null,
        "Score": 1
      }
    },
    {
      "contentType": "application/json",
      "name": "Associating it to an existing category and brand",
      "example": {
        "Id": 42,
        "Name": "Black T-Shirt",
        "DepartmentId": 1,
        "CategoryId": 2,
        "BrandId": 2000000,
        "LinkId": "insert-product-test",
        "RefId": "310117869",
        "IsVisible": true,
        "Description": "texto de descri\u00e7\u00e3o",
        "DescriptionShort": "Utilize o CEP 04548-005 para frete gr\u00e1tis",
        "ReleaseDate": "2019-01-01T00:00:00",
        "KeyWords": "teste,teste2",
        "Title": "product de teste",
        "IsActive": true,
        "TaxCode": "12345",
        "MetaTagDescription": "tag test",
        "SupplierId": null,
        "ShowWithoutStock": true,
        "AdWordsRemarketingCode": null,
        "LomadeeCampaignCode": null,
        "Score": 1
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": 42,
        "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": "2020-01-01T00:00:00",
        "KeyWords": "Zoom,Stefan,Janoski",
        "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re",
        "IsActive": true,
        "TaxCode": "",
        "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.",
        "SupplierId": 1,
        "ShowWithoutStock": true,
        "AdWordsRemarketingCode": "",
        "LomadeeCampaignCode": "",
        "Score": 1
      }
    }
  ]
}