API ReferenceAffiliates

Overview

Review affiliate commissions and record payments arranged by your store.

See who refers customers to your store, review the commissions they earn, and manage their payouts. Responses include store memberships, approved profile details, referral sessions, linked orders, and balances.

Affiliate payouts are merchant-managed records of referral commissions. SellApp identifies eligible commissions and records payout state; it does not transfer or hold funds for these payouts. Arrange payment yourself, then record it as paid. Amounts and balances use integer USD cents: 1999 means $19.99. Each referral links to a purchase and its line item.

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 recording payment.
  • 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.

OAuth integrations use the operation's payments:read or payments:write scope with X-STORE. The user's current store permissions must also permit the action.

To change program rules or invite affiliates, use Affiliate program.

Endpoints

On this page