---
title: "get allocation matrix"
method: GET
path: "/api/v1/inventory/allocation-matrix"
tags: ["inventory"]
---

# get allocation matrix

`GET /api/v1/inventory/allocation-matrix`

## Request

- Base URL: `https://api.app.tightly.io`
- URL: `https://api.app.tightly.io/api/v1/inventory/allocation-matrix`
- Auth: HTTP bearer

Stock spread across warehouses for the variants requested: the locations as columns, one row per variant, and a cell per pair carrying on-hand quantity, days and weeks of cover and a health word. Built for finding imbalances between sites.

`variant_ids` is required and takes the variants to compare. Health is `critical`, `caution` or `healthy`, the same three words get_inventory_table serves.

Scope: `inventory:read`.

## Query parameters

- `variant_ids` string, required

## Headers

- `Tightly-Version` string

## Response `200`

The allocation matrix

- object
  - `data` object: Allocation matrix data
  - `message` object: severity, service and desc.

## Other responses

- `400`: Bad Request - missing or invalid variant_ids
- `401`: No usable key: malformed, unknown, revoked, expired or stopped. One refusal covers all five, telling a caller which is which maps the surface for them. A request with no Authorization header at all is refused 400 before any key is looked for.
- `403`: The key may not reach this operation. `scope_missing` when the key does not hold Stock; `organization_mismatch` when the path names an organisation that is not the key's; `ip_not_allowed` when the caller's address is outside the key's allowlist.
- `404`: Data not found
- `429`: The key has spent its allowance for this minute. 600 reads and 120 writes a minute, counted per key, refused calls included. `Retry-After` says how long to wait.
- `503`: The database is briefly out of reach, which is what a failover or a full connection pool looks like from outside. Wait the seconds `Retry-After` names and send the request again. A read is safe to repeat. A write is not, because the connection was lost in the middle of it, so read the object back before sending it a second time. Branch on the status rather than on `code`, which is `POSTGRES_UNAVAILABLE` from one of the two seams that raise this and `SERVICE_UNAVAILABLE` from the other.

---

[API](https://skmtc.dev/tightly/apis/tightly-api.md) · [All operations](https://skmtc.dev/tightly/apis/tightly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tightly/apis/tightly-api/revisions/199f7eb35afb?raw)