Update Consignment Aging Settings
PUT/api/consignment/settings
Update the consignment aging-alert configuration. All fields are optional; only the provided fields are changed.
Fields:
- aging_alerts_enabled (boolean): send aging alerts when consigned stock ages past the threshold.
- aging_threshold_days (integer, 1-3650): age in days on consignment at which unsold stock is flagged.
- aging_auto_return_enabled (boolean): automatically return flagged stock to the supplier. Off by default — returning consigned stock is irreversible.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Content-Type
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 Content
Response Headers
Content-Type
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.