Export Shopify Payout Type Mappings
GET/api/shopify/:integrationInstance/payout-type-mappings/export
Downloads the store's payout type mappings as a CSV file, one row per financial code. Each row shows the mapping this store uses: its own mapping where it has one, otherwise the mapping shared by all stores. Financial codes found in the store's imported payouts but not yet listed are added first, so the file is complete. Rows are ordered by financial code.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Columns:
Financial Code: the line type.Nominal Code: the account ascode - name(for example400 - Sales), blank when unmapped.Mapping Group: the group name, blank when none is assigned.
The file uses the same columns Import Shopify Payout Type Mappings reads, so it can be edited and uploaded again.
Response: text/csv file download (shopify-payout-type-mappings-YYYY-MM-DD_HHMMSS.csv), not JSON.
Authentication: Requires Bearer token.
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.