VTEX · Example Payload

Vtex Getbyaccount Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getbyaccount 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

{
  "operationId": "GetByAccount",
  "method": "GET",
  "path": "/api/vlm/account/stores",
  "summary": "VTex Get stores",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": 1213,
          "name": "ambientecrm",
          "hosts": [
            "loja.ambientecrm.com.br",
            "www.ambientecrm.com.br"
          ]
        },
        {
          "id": 213,
          "name": "ambienteqa",
          "hosts": [
            "loja.blackbox.com.br",
            "www.blackbox.com.br"
          ]
        }
      ]
    }
  ]
}