Skip to main content

Sync Settlements

POST 

/api/walmart/:integrationInstance/settlements/sync

Starts a background import of Walmart's reconciliation reports. With no body it downloads every report Walmart lists that is not imported yet; settlement_dates re-reads the named settlements (a report whose content has not changed is left as it is; a report Walmart returns incomplete, without its PaymentSummary or with a broken page, is not stored and the stored copy is kept). Returns the tracked job ID to follow progress. The same import runs daily on its own.

Required scope: accounting:write

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

Authentication: Requires Bearer token and the integrations.sync permission. Open to API tokens with the accounting:write scope.

Body: settlement_dates (optional array, at most 60, each Y-m-d).

Request​

Responses​

OK

Response Headers
    Content-Type