API ReferenceInventory History

Get Location Inventory Snapshot

Returns a snapshot of all materials stocked at a location, optionally as of a specific point in time. If at is omitted, defaults to the current server time. Results are paginated and sortable. Invalid sortBy values silently fall back to NAME_ASC.

Requires scope: inventory_history:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

locationIdUUIDRequired
Location ID.

Query parameters

atdatetimeOptional

ISO 8601 timestamp to evaluate inventory at. Defaults to current server time if omitted. Example: 2026-03-01T00:00:00Z

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

sortBystringOptional

Sort order for results. One of: NAME_ASC, NAME_DESC, QUANTITY_ASC, QUANTITY_DESC. Defaults to NAME_ASC. Invalid values silently fall back to NAME_ASC.

Response

This endpoint returns an object.
itemsobject
Paginated list of inventory line items at this location.
locationobject
Reference to the location this snapshot is for.
snapshotAtdatetime

ISO 8601 timestamp at which the snapshot was evaluated. null means current state.

grandTotalCostdouble

Sum of totalCost across all items in the snapshot.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error