Skip to main content

List Settlement Data

GET 
/api/amazon/unified/settlement-data

List Amazon settlement report lines across integration instances, with their type mapping, mapping group, and landed-cost matching state.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Landed-cost fields on each line:

  • landed_cost_status: matched_existing (linked to an existing bill), created_new (a bill was auto-created), awaiting_bill (waiting for a manual bill), unmatched (no matching shipment found), legacy_shipment (the shipment only exists as a legacy FBA inbound shipment; bills are not auto-created from legacy shipments), or null (not a landed-cost line / not evaluated yet).
  • landed_cost_link: the warehouse transfer or purchase order the shipment resolves to — {type: warehouse_transfer|purchase_order, id, number}. Includes via_legacy: true when resolved through a legacy FBA inbound shipment.
  • landed_cost_bill_id: the linked bill id when the line is matched to a bill.

Filters: filter[search], filter[settlement_id], filter[transaction_type], filter[amount_type], filter[shipment_id], filter[order_id], filter[merchant_order_id] (the seller order id you sent Amazon, e.g. a Multi-Channel Fulfillment order #20445.1), filter[mapping_group_name], filter[landed_cost_link] (has_link, warehouse_transfer, purchase_order), plus advanced filter groups. Sort: sort (prefix with - for descending; default -posted_date_time). Allowed: id, settlement_id, transaction_type, order_id, merchant_order_id, sku, amount_type, amount_description, amount, quantity_purchased, marketplace_name, adjustment_id, shipment_id, fulfillment_id, promotion_id, posted_date_time, created_at, updated_at. Pagination: page, per_page (default 10). Use integration_instance_ids (comma-separated) to scope instances.

Request​

Responses​

OK

Response Headers
    Content-Type