VTEX · Example Payload

Vtex Getsellersbyregion Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getsellersbyregion 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": "GetSellersByRegion",
  "method": "GET",
  "path": "/api/checkout/pub/regions/{regionId}",
  "summary": "VTex Get sellers by region or address",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "v2.1BB18CE648B5111D0933734ED83EC783",
        "sellers": [
          {
            "id": "abacaba",
            "name": "Abacaba Store",
            "logo": null
          },
          {
            "id": "abacaba2",
            "name": "Abacaba VTEX Outlet",
            "logo": null
          },
          {
            "id": "abacaba3",
            "name": "Abacaba VTEX Mall",
            "logo": null
          }
        ]
      }
    }
  ]
}