Overview

The affiliate APIs expose store-scoped affiliate memberships, approved global profile details, referral sessions, attributed orders, balances, and affiliate payout administration.

Affiliate payouts are separate from seller platform balance payouts. Amounts and balances are integer USD cents. Referral attribution points to the mutable Order and its InvoiceV2 product line; it does not use the deprecated legacy invoice resource.

Use these token abilities:

• affiliate for reads.
• affiliate:write in addition to affiliate for affiliate approval/rejection and referral review decisions.
• affiliate:payout in addition to affiliate for payout creation and settlement.
• affiliate:sensitive in addition to affiliate for full referral session identifiers.

Payout creation requires an Idempotency-Key. The first request atomically reserves every eligible accepted referral for that affiliate. Replaying the same key returns the same payout instead of creating a duplicate. Payout status changes update the payout and every linked referral in one transaction; identical retries are no-ops.

Payout destinations are masked in API responses. Referral session identifiers are sensitive and should not be logged or exposed to buyers.

Affiliate program configuration and invitations use the separate affiliate configuration surface.

Endpoints

• List affiliates
• Retrieve an affiliate
• Update affiliate status
• List affiliate referrals
• Retrieve or review a referral
• List referral sessions
• List affiliate payouts
• Create an affiliate payout
• Update affiliate payout status