VTEX · Example Payload

Vtex Brand Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Brand 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": "Brand",
  "method": "GET",
  "path": "/api/catalog_system/pvt/brand/{brandId}",
  "summary": "VTex Get brand by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": 7000000,
        "name": "Pedigree",
        "isActive": true,
        "metaTagDescription": "Pedigree",
        "imageUrl": null
      }
    }
  ]
}