List Inventory Holds
GET/api/v2/inventory/holds
Returns paginated inventory holds (reservations). By default shows active holds (not released, not expired).
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Status filter (resolved from filter_groups, filter[status], or top-level status param):
- active: Not released and not expired (default)
- partially_released: Has released_quantity > 0 but not fully released yet
- released: Fully released holds
- expired: Expired holds
- expiring_soon: Expiring within the next 7 days
- all: All holds regardless of status
Available sorts: id, quantity, released_quantity, created_at, expires_at, released_at (default: -created_at)
Request
Responses
- 200
- 401
- 403
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.