Skip to main content

Create Settlement Type Mapping Override

POST 
/api/amazon/unified/settlement-type-mappings/overrides

Creates a per-instance override for a settlement financial code, replacing the global mapping for that Amazon integration instance only. If an override already exists for the same instance and financial code, it is updated in place (upsert). The global mapping row for the financial code must already exist - otherwise a 404 is returned.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Only the keys present in the request body are applied to the override, so you can override just the nominal code, just the mapping group, or both.

Body fields:

  • integration_instance_id (required, integer) - the Amazon integration instance the override applies to. Must exist.
  • financial_code (required, string) - format "{transaction_type}: {amount_type} - {amount_description}".
  • nominal_code_id (optional, integer or null) - nominal code to use for this instance. Must exist when provided.
  • amazon_settlement_mapping_group_id (optional, integer or null) - settlement mapping group to route this code to for this instance. Must exist when provided.

Returns the created/updated override with its resolved nominalCode and mappingGroup.

Request​

Responses​

OK

Response Headers
    Content-Type