VTEX · Example Payload

Vtex Getbrand Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getbrand 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": "GetBrand",
  "method": "GET",
  "path": "/api/catalog-seller-portal/brands/{brandId}",
  "summary": "VTex Get Brand by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "863",
        "name": "Zwilling",
        "isActive": false,
        "createdAt": "2021-01-18T14:41:45.696488+00:00",
        "updatedAt": "2021-01-18T14:41:45.696488+00:00"
      }
    }
  ]
}