Skip to main content
Version: v1.0.0(int)

E108: Get finished goods inventory summary

GET /api/finished-goods-inventory/summary

Returns net on-hand, demand, allocated, and available quantities per SKU and location, computed from the ledger. Richer than the materials summary because of the DEMAND / ALLOCATE rollups from the SO lifecycle. Triggered from the Finished Goods Inventory page.

Authentication

Standard tenant route. Requires Authorization: Bearer <firebase-id-token> and X-Org-Id: <org-id>. Access: Member. Also reachable with an org-scoped PAT.

Request

No body. Optional filters narrow the rollup:

  • ?skuId= — one SKU.
  • ?locationId= — one location.

Response — 200 OK

{
"data": [
{ "skuId": "uuid", "locationId": "uuid", "onHand": "480", "demand": "50", "allocated": "30", "available": "400" }
]
}

onHand nets the inflow events (RECEIVE / PRODUCE / ADJUST) against the outflow events (CONSUME / DISPOSE / TRANSFER) and their reversals; demand and allocated roll up the SO lifecycle; available = on-hand − allocated. Numeric values arrive as strings.

Errors

Standard envelope only.

Workflow

Calls W108 Get finished goods inventory summary.