Create Lot Retention Sample
POST/api/v2/fifo-layers/:fifoLayer/retention-samples
Record a reserve sample held against a lot.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Omit retain_until to let the 21 CFR 111.83 clock compute it. Supplying it is treated as a deliberate override and is flagged as such, so a computed date can be told apart from a chosen one.
A sample with status sent_to_lab must name the lab holding it.
Stock effect. A reserve sample takes its units off the shelf: creating one places an inventory hold for quantity, so those units leave available-to-sell. inventory_hold_id and held_quantity report it. The hold is released when the sample's status becomes returned, and when the sample is deleted. A discarded sample KEEPS its hold — the units were destroyed, so releasing them would return stock that no longer exists to available-to-promise; write them off with a separate inventory adjustment. quantity is always in stock units; unit is a descriptive note. Retaining more than the lot has available returns 422.
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 Content
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.