Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Reclaim expired inventory holds without waiting for the background sweep.

Request body

ExpireReservationsRequest
integer,null (int32)
Maximum reservations to expire (default 500, capped at 5000). Minimum: 0.

Response

ExpireReservationsResponse
integer (int64)
required
Reservations flipped to expired, their units back in quantity_available. Minimum: 0.
boolean
required
Whether the batch came back full, i.e. more may be waiting.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on October 20, 2026