VTEX · Example Payload

Vtex Get Bannersfacets Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Bannersfacets 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": "get-bannersfacets",
  "method": "GET",
  "path": "/banners/{facets}",
  "summary": "VTex Get list of banners registered for query",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "banners": [
          {
            "id": "summersale",
            "name": "Summer Sale",
            "area": "1",
            "html": "<h1>This is a test</h1>"
          }
        ]
      }
    }
  ]
}