Create Payout Mapping Group
POST/api/shopify/:integrationInstance/payout-mapping-groups
Creates a payout mapping group scoped to the integration instance. Instance groups are listed ahead of the global defaults and can be used to separate the instance's payout lines into their own financial documents.
Authentication: Requires Bearer token.
Request body:
- name (required, string, max 255): display name for the group.
- document_type (required, string): financial document the group posts to; one of invoice, bill.
- sort_order (optional, integer, min 0): position of the group in ordered listings.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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.