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

{
  "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
          }
        ]
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/vtex-inventorybysku-example"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.