Get Latest Stocktake

GET 
/retail/v1/stock/getlateststocktake

Tier: Public — stable, supported for third-party integration.

Returns per-SKU stock counts as at the latest completed stocktake for a place.

Query parameters (hand-parsed, case-insensitive): placeId (GUID) or placeName — one is required; fields — comma-separated SKU extended-property/dimension names to include per record.

Responses

200

A Stocks.StocktakeResult built from the latest Complete inventory at the place: DateTime is that inventory's creation time (not its completion time); each Stocks.StockRecord's Available = Total − Missing − Reserved, where Reserved counts items whose counted item state was Allocated. If the place exists but has no completed inventory, the response body is null (still HTTP 200).

400

Neither placeId nor placeName was supplied — InvalidValue ("PlaceId or placeName is required in the query") — or the supplied placeId/placeName does not resolve to a place in the caller's organisation — NotFound, field "Place".

401

Caller is not authenticated.

403

Caller does not have Read permission on the Inventory module.