Skip to main content

Per-SKU object

FieldTypeDescription
skustringProduct SKU
immediate_inventoryobjectSellable quantity right now, by region
future_inventoryobjectIncoming PO quantity by region and ETA
refreshed_atstring (ISO 8601)When this row was last computed

immediate_inventory

KeyMeaning
usaUnits sellable now for USD orders
canadaUnits sellable now for CAD orders
Values reflect warehouse and Shopify availability after open orders are allocated. A SKU can show 0 in one region while still having future incoming quantity.

future_inventory

Each region contains an array of ETA lines, sorted by expected_date ascending:
{ "expected_date": "2026-06-27", "quantity": 50 }
FieldMeaning
expected_dateArrival date (YYYY-MM-DD). null when no ETA is on file (sorted last)
quantityUncommitted incoming units expected on that date
Multiple purchase-order lines with the same date in a region are summed into one entry.

Regional mapping

Order currencyAPI region key
USDusa
CADcanada

Data freshness

refreshed_at is updated when inventory is recomputed (warehouse syncs, order transforms, and a nightly full refresh). Treat it as a freshness indicator, not a cache TTL — poll at the rate your integration requires.