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.
accounting:writeGrant 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
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Content
Response Headers
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.