Quarantine Lot
POST/api/inventory-expiry/lots/:fifoLayer/quarantine
Quarantine a lot — remove its quantity from available-to-promise via a reversible inventory hold (no stock movement). quantity is optional — when omitted the layer's full remaining available quantity is held. Returns the review record including the inventory_hold_id.
Authentication: Requires Bearer token. Scope: scope.rw:inventory (write) + permission inventory.adjust.
Path param: fifoLayer — the FIFO layer (lot) id, route-model-bound.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.