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
  }
}