Skip to main content

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, the weekly digest opt-in, how long FBA losses and ledger discrepancies settle before they count as real, and whether reimbursed-unit COGS is posted. Settings that were never saved fall back to defaults: every category enabled, no minimum, no default assignee, digest off, a 30-day settle window, reimbursed-unit COGS off.

Required scope: recovery:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

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 in enabled_categories but 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.

  • discrepancy_settle_days (integer, 0–60, default 30) — days an FBA loss or ledger discrepancy is shown as settling before it counts as unresolved. Amazon researches misplaced units for up to 30 days and can take up to 45 days to reimburse.
  • reimbursement_cogs_enabled (boolean, default false) — whether the cost of units Amazon reimbursed is posted to the COGS – FBA reimbursed units account.
  • reimbursement_cogs_account_mapped (boolean, read-only) — whether the COGS – FBA reimbursed units nominal code is mapped; reimbursement_cogs_enabled cannot be turned on until it is.

Re-measurement settings (request: optional; response: always present):

  • remeasure_value_floor (number, default 50) — a re-measurement is worth one of Amazon's monthly slots only when correcting the size is worth at least this much a year (future fees saved + refundable overcharge).
  • remeasure_monthly_limit (integer, default 20) — Amazon's re-measurement limit per month.

Request​

Responses​

OK

Response Headers
    Content-Type