VTEX · Example Payload

Vtex Inventorybysku Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Inventorybysku 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": "InventoryBySku",
  "method": "GET",
  "path": "/api/logistics/pvt/inventory/skus/{skuId}",
  "summary": "VTex List inventory by SKU",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "skuId": "2390059",
        "balance": [
          {
            "warehouseId": "1937054",
            "warehouseName": "Estoque A",
            "totalQuantity": 101,
            "reservedQuantity": 9,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "avl",
            "warehouseName": "Estoque InStore",
            "totalQuantity": 100,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "1448dc2",
            "warehouseName": "Estoque C",
            "totalQuantity": 100,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "140ac66",
            "warehouseName": "Estoque B",
            "totalQuantity": 100,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "pickuppoint",
            "warehouseName": "PickupPoint",
            "totalQuantity": 100,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "pickuppoint_2",
            "warehouseName": "PickupPoint 2",
            "totalQuantity": 200,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          },
          {
            "warehouseId": "15bfc76",
            "warehouseName": "Estoque Principal",
            "totalQuantity": 1011,
            "reservedQuantity": 0,
            "hasUnlimitedQuantity": false
          }
        ]
      }
    }
  ]
}