List Settlements
GET/api/walmart/:integrationInstance/settlements
Lists a Walmart store's settlements, newest first. Each settlement is one bi-weekly Walmart reconciliation report and the single deposit it pays: amount is the report's Total Payable, and lines_total is the sum of its lines (they match for a fully imported report). summary splits the lines into gross sales, gross refunds, commission, tax collected net of tax withheld, other sale amounts (Walmart-funded savings, promo codes), service fees (return shipping, WFS storage) and other adjustments.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.
accounting_readiness lists what holds the settlement back from posting: has_transactions (the report is fully imported), report_balances (its lines add up to the deposit), per_payout_mode_enabled (the store books Walmart sales per settlement), after_accounting_start_date, mappings_configured (every line type has an account, or a fallback account covers it) and currency_conversion_configured. In the list it is a summary (status ready/blocked/done, blockers); in the detail it is the full list of checks.
deposit_status is the accounting provider's view of the settlement's deposit, read from SKU.io's local copy of Xero / QuickBooks (null until the settlement has posted documents). state is one of reconciled, paid, awaiting_deposit_match, not_posted or unavailable; difference is the settlement amount minus what the provider deposited. The same block is available for many settlements at once from GET /api/ledger/settlement-deposits?source_type=walmart_settlement.
Allowed sorts: id, settlement_date, period_end_date, amount, accounting_status (default -settlement_date). Pagination: per_page defaults to 10 (max 100).
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.