Quarantine Serial Numbers
POST/api/v2/serial-numbers/quarantine
Hold one or more serials (recall / damage / inspection). Quarantined serials are excluded from availability and cannot be allocated or shipped until released.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body: serial_number_ids (array of ids — required unless apply_to_all), apply_to_all (boolean, optional), filters (object, with apply_to_all), reason (optional, max 255).
Acting on every filtered serial. Instead of serial_number_ids, send apply_to_all: true with filters — the same filters the list accepts (bare keys such as status / warehouse_id / search, and/or filter_groups). Every serial those filters match is targeted.
Response. Returns quarantined and skipped counts: only serials that are on hand (In Stock, Allocated or Committed) can be quarantined, the rest are skipped. When none of the serials can be quarantined, the call fails with 422 and the same counts.
Request
Responses
- 200
- 401
- 403
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.