Get Recovery Settings
GET/api/amazon/unified/recovery/settings/:integrationInstance
Returns the Amazon Recovery settings for one Amazon integration: which reimbursement categories are checked for new opportunities, the minimum opportunity amount, the default assignee and the weekly digest opt-in. Settings that were never saved fall back to defaults: every category enabled, no minimum, no default assignee, digest off.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Response fields:
integration_instance_id,integration_instance_name,currency(the integration's primary currency).enabled_categories(object) — every category key mapped to true/false. Categories: warehouse_lost, warehouse_damaged, customer_return_not_received, customer_return_damaged, customer_return_refund_mismatch, inbound_shortage, removal_order_discrepancy, fba_fee_overcharge, chargeback_reversal, destroyed_without_authorization, return_not_restocked, underpaid_reimbursement, reimbursed_then_returned.categories(array) — the switchable toggles as a list of{value, label, enabled}for display. Retired categories (customer_return_refund_mismatch) appear inenabled_categoriesbut not in this list.min_amount(number) — minimum potential amount for a new opportunity to be surfaced (0 = no minimum). Opportunities whose amount is unknown because the unit cost is missing are never hidden by the minimum. A platform-wide minimum may also apply; the larger of the two wins.default_assignee_user_id(integer|null) — user who receives claim-window expiry alerts for unassigned cases (instead of all admins) and is added to the weekly digest recipients.weekly_digest_opt_in(boolean) — whether a weekly recovery digest email is sent for this integration.last_sourcing_cost_export_at(ISO 8601|null) — when the sourcing-cost file was last downloaded.
Returns 404 when the ID is not an Amazon integration instance.
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.