VTEX · Schema

Balance

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
warehouseId string
warehouseName string
totalQuantity integer
reservedQuantity integer
hasUnlimitedQuantity boolean
View JSON Schema on GitHub

JSON Schema

vtex-balance-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Balance",
  "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
  }
}

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-balance"
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.