Skip to main content

List Settlement Type Mappings

GET 

/api/walmart/:integrationInstance/settlement-type-mappings

Lists every settlement line type with its account and mapping group as this store resolves them: the store's own override where one exists, otherwise the global mapping (is_override tells which). The common Walmart line types are listed (and pre-assigned to the Walmart Sales or Walmart Fees group) before any report carries them, and every line type found in the store's imported reports is added unmapped.

Required scope: accounting:read

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

Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.

Allowed sorts: id, transaction_type, amount_type, financial_code, created_at (default financial_code). Pagination: per_page defaults to 10.

Filter by mapping group with filter[mapping_group_id] (a group ID; operator forms such as filter[mapping_group_id.is_one_of]=2,5 work too). filter[search] matches transaction type, amount type, transaction description and financial code; a number also matches the mapping ID exactly, and search_columns=id restricts the search to the ID.

Tax fields on each mapping: tax_class (facilitator_collected, facilitator_remitted, seller_collected, tax_on_fees, or null when the code is not tax), tax_class_label, and needs_review (true when a tax-like code is mapped somewhere it should not be and has not been acknowledged).

Request​

Responses​

OK

Response Headers
    Content-Type