API ReferenceReports

Inventory Usage Report

Returns inventory movement and adjustment events at a specific location within a date range. fromDate and toDate are required.

Requires scope: reports:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

locationIdUUIDRequired
Location ID to report inventory usage for.

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

fromDatedateRequired

Start of the reporting period (inclusive). ISO 8601 date, e.g. 2026-01-01. Required.

toDatedateRequired

End of the reporting period (inclusive). ISO 8601 date, e.g. 2026-03-20. Required.

sortstringOptional

Sort field and direction (e.g., name,asc or createdAt,desc). Supports Spring Pageable format.

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