Import Walmart Settlement Type Mappings
POST/api/walmart/:integrationInstance/settlement-type-mappings/import
Sets the account and mapping group of many line types at once from a CSV file, in the format Export Walmart Settlement Type Mappings downloads.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Two steps:
- Upload the CSV as multipart form data to
POST /api/store-filewith fieldsfileanddestination=models. The response containsstored_name. - Call this endpoint with that
stored_name.
CSV columns (header row required): Financial Code, Nominal Code, Mapping Group.
How each row is applied:
- The row updates the mapping this store uses for that financial code: its own mapping where it has one, otherwise the mapping shared by all stores.
Nominal Codeacceptscode - name(for example400 - Sales), a bare code (400) or an account name. A blank value clears the account.Mapping Groupis a group name. A blank value leaves the group as it is. A mapping shared by all stores can only use a group shared by all stores.- Rows with no financial code, a financial code this store has never seen, an account that does not exist, or a group that is not found or not allowed are not applied and are listed in
skippedwith their line number and the reason. Nothing is guessed.
Changes are dated like Update Settlement Type Mappings: settlements dated on or after effective_from use the new mappings and are rebuilt; earlier settlements keep the accounts they posted with.
Body:
stored_name(required, string, max 255): the name returned byPOST /api/store-file. The uploaded file is removed after the import attempt.effective_from(optional, nullable, Y-m-d): the date the changes apply from. Defaults to today. Must be after the accounting lock date.
Response: data.updated is the number of rows applied; data.skipped lists the rows that were not.
Errors:
- 400: the uploaded file was not found (upload it again), or the file has no rows.
- 422:
stored_nameis missing, oreffective_fromis not a valid date or falls on or before the accounting lock date.
Authentication: Requires Bearer token and the integrations.update permission.
skipped_posted_count is the number of already-posted documents carrying a changed marketplace-facilitator tax code that the import left as they are; they are flagged in the Ledger's Needs Attention inbox, where Rebuild restates them.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Bad Request
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.