Overview
Configure affiliate commissions, product restrictions, and invitation onboarding through the API.
Set commission rules for your affiliate program, choose eligible products, and invite people to join. Use an API key with the affiliate ability or OAuth with the operation's payments:read or payments:write scope. Current store permissions also apply.
Endpoints
- Retrieve affiliate program configuration
- Replace affiliate program configuration
- List pending invitations
- Invite an affiliate
Configuration is replaced as one change: either the whole update succeeds or none of it does. When enabled_specific_products is true, send the complete products array. Despite the field name, each ID must identify a product variant in the selected store. An empty array disables every existing store-level product restriction.
Invitation creation emails a single-use onboarding link. The secret link is never returned in API responses. Duplicate invitations and invitations while the program is disabled return a validation error.