VTEX · Example Payload

Vtex Allwarehouses Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Allwarehouses 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": "AllWarehouses",
  "method": "GET",
  "path": "/api/logistics/pvt/configuration/warehouses",
  "summary": "VTex List all warehouses",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": [
        {
          "id": "1937054",
          "name": "Estoque A",
          "warehouseDocks": [
            {
              "dockId": "1_1_1",
              "time": "1.00:00:00",
              "cost": 0
            }
          ],
          "pickupPointIds": [
            1,
            2,
            3
          ],
          "priority": 0,
          "isActive": true
        },
        {
          "id": "140ac66",
          "name": "Estoque B",
          "warehouseDocks": [
            {
              "dockId": "139270d",
              "time": "00:00:00",
              "cost": 0
            }
          ],
          "pickupPointIds": [
            1,
            2,
            3
          ],
          "priority": 0,
          "isActive": true
        }
      ]
    }
  ]
}