VTEX · Example Payload

Vtex Brandlist Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Brandlist 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

Raw ↑ 
{
  "operationId": "BrandList",
  "method": "GET",
  "path": "/api/catalog_system/pvt/brand/list",
  "summary": "VTex Get brand list",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": 9280,
          "name": "Brand",
          "isActive": true,
          "metaTagDescription": "Brand",
          "imageUrl": null
        },
        {
          "id": 2000000,
          "name": "Orma Carbon",
          "isActive": true,
          "metaTagDescription": "Orma Carbon",
          "imageUrl": null
        },
        {
          "id": 2000001,
          "name": "Pedigree",
          "isActive": true,
          "metaTagDescription": "",
          "imageUrl": null
        }
      ]
    }
  ]
}