inventory

Requires permission inventory:stock_level:read.

Returns one stock line (one product variant in one warehouse) by ID, or null when it does not exist in your organization. Needs the stock level read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Inventory($id: ID!) {
  inventory(id: $id) {
    id
    batchNumber
    serialNumber
    createdAt
    availableQuantity
    averageCost
    lastMovement {
      id
      batchNumber
      movementNumber
      serialNumber
      status
      type
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Inventory($id: ID!) {\n  inventory(id: $id) {\n    id\n    batchNumber\n    serialNumber\n    createdAt\n    availableQuantity\n    averageCost\n    lastMovement {\n      id\n      batchNumber\n      movementNumber\n      serialNumber\n      status\n      type\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "inventory": {
      "id": "id",
      "batchNumber": "string",
      "serialNumber": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "availableQuantity": 0,
      "averageCost": 0,
      "lastMovement": {
        "id": "id",
        "batchNumber": "string",
        "movementNumber": "string",
        "serialNumber": "string",
        "status": "CANCELLED",
        "type": "ADJUSTMENT"
      }
    }
  }
}

inventory(
  id: ID!
): Inventory

Arguments

inventory.id ● ID! non-null scalar

The ID of the inventory record.

Type

Inventory object

The stock of one product variant in one warehouse.