VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
skuId string
balance array
View JSON Schema on GitHub

JSON Schema

vtex-listinventorybysku-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListInventoryBySKU",
  "title": "",
  "required": [
    "skuId",
    "balance"
  ],
  "type": "object",
  "properties": {
    "skuId": {
      "type": "string"
    },
    "balance": {
      "type": "array",
      "items": {
        "title": "Balance",
        "required": [
          "warehouseId",
          "warehouseName",
          "totalQuantity",
          "reservedQuantity",
          "hasUnlimitedQuantity"
        ],
        "type": "object",
        "properties": {
          "warehouseId": {
            "type": "string"
          },
          "warehouseName": {
            "type": "string"
          },
          "totalQuantity": {
            "type": "integer",
            "format": "int32"
          },
          "reservedQuantity": {
            "type": "integer",
            "format": "int32"
          },
          "hasUnlimitedQuantity": {
            "type": "boolean"
          }
        },
        "example": {
          "warehouseId": "1937054",
          "warehouseName": "Estoque A",
          "totalQuantity": 101,
          "reservedQuantity": 9,
          "hasUnlimitedQuantity": false
        }
      },
      "description": ""
    }
  },
  "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 JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-listinventorybysku"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

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

Get an API key

Free tier, no email required.

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