Skip to main content

Get Realtime Inventory Pivot

GET 
/api/reporting/realtime-inventory/pivot

Returns the wide (pivot) shape of the realtime inventory report: one row per SKU, one column per warehouse and one column per sales channel, plus a totals block per row. The channel columns carry both the SKU-side quantity and the channel-side quantity so sync drift is visible per SKU per channel.

Rows are grouped and paginated at the SKU level (default 25 per page); warehouse and channel cells are keyed by the ids listed in columns.

Filters: filter[search] (product SKU or name), filter[warehouse_id], and numeric advanced filters on available, on_hold, allocated, in_transit, total, inbound, projected_total, backorder_planned, backorder_awaiting_receipt and backorder (the sum of the two backorder columns). Numeric filters accept either the bare key (filter[available]) or an operator suffix: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty — e.g. filter[available.greater_than]=100.

Legacy top-level search and warehouse_id params are auto-normalized into filter[].

Sort: product_sku (default), product_name, available, on_hold, allocated, in_transit, total, inbound, projected_total, backorder_planned, backorder_awaiting_receipt, backorder, on_hand. Prefix with - for descending. Per-warehouse and per-channel columns are not sortable.

Authentication: Requires Bearer token

Request​

Responses​

OK

Response Headers
    Content-Type