Skip to navigation
API ReferenceReports

Dead Shelf Analysis

Returns materials at a specific location that have had no quantity changes for an extended period. Optionally filter by material name.

Ordered by least recently updated first. This report does not accept a sort parameter.

Requires scope: reports:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

locationIdUUIDRequired
Location ID to analyze for stagnant inventory.

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

searchstringOptional

Filter by material name (partial match).

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error