Update Payout Type Mappings
PUT/api/shopify/:integrationInstance/payout-type-mappings
Updates individual payout type mappings, assigning or clearing the general-ledger account and mapping group of each. Fields omitted from a mapping entry are left unchanged; pass null to clear an assignment.
Authentication: Requires Bearer token.
Request body:
- mappings (required, array, min 1): mapping updates to apply.
- mappings[].id (required, integer): ID of an existing payout type mapping.
- mappings[].nominal_code_id (optional, nullable, integer): general-ledger account to assign; must reference an existing account. Pass null to clear.
- mappings[].shopify_payout_mapping_group_id (optional, nullable, integer): payout mapping group to assign; must reference an existing group. Pass null to clear.
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 Entity
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.