VTEX · Example Payload

Vtex Warehousebyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Warehousebyid 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": "WarehouseById",
  "method": "GET",
  "path": "/api/logistics/pvt/configuration/warehouses/{warehouseId}",
  "summary": "VTex List warehouse by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "id": "15bfc76",
        "name": "Estoque Principal",
        "warehouseDocks": [
          {
            "dockId": "1a8bce3",
            "time": "3.00:00:00",
            "cost": 5
          }
        ],
        "pickupPointIds": [
          1,
          2,
          3
        ],
        "priority": 0,
        "isActive": true
      }
    }
  ]
}