Create Inventory Hold
POST/api/v2/inventory/holds
Creates a single inventory hold (reservation) for a product in a specific warehouse. Deducts from available inventory.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Request Body:
- product_id (required, integer): Product to hold
- warehouse_id (required, integer): Warehouse where inventory is held
- quantity (required, numeric, min 0.0001): Quantity to hold
- reason (required, string, max 255): Reason for the hold
- notes (optional, string): Additional notes
- expires_at (optional, date, must be future): Expiration date for the hold
Requires permission: inventory.adjust
notes is required when reason is other; optional otherwise.
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
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.
Unprocessable Entity
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.