Skip to main content

List Inventory Holds

GET 
/api/v2/inventory/holds

Returns paginated inventory holds (reservations). By default shows active holds (not released, not expired).

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​

Successful response