VTEX · Example Payload

Vtex Listbrand Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Listbrand 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": "ListBrand",
  "method": "GET",
  "path": "/api/catalog-seller-portal/brands",
  "summary": "VTex Get List of Brands",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": "863",
            "name": "Zwilling",
            "isActive": false,
            "createdAt": "2021-01-18T14:41:45.696488+00:00",
            "updatedAt": "2021-01-18T14:41:45.696488+00:00"
          },
          {
            "id": "1298",
            "name": "Zooz Pets",
            "isActive": false,
            "createdAt": "2021-01-18T14:45:32.900176+00:00",
            "updatedAt": "2021-01-18T14:45:32.900176+00:00"
          }
        ],
        "_metadata": {
          "total": 1399,
          "from": 1,
          "to": 10,
          "orderBy": "name,desc"
        }
      }
    }
  ]
}