inventory

get allocation matrix

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.

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

Query parameters

variant_idsstring required
Example:variant_id_1,variant_id_2,variant_id_3

Comma-separated list of variant IDs to include in the matrix (max 50, min 1). Always required.

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

The allocation matrix

dataobject

Allocation matrix data

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.