Skip to main content
The Affiliate API is for affiliates, not store owners. If you promote a store through its affiliate programme, you can read your own account with it: your balance, the discount your code gives on each product, the orders you referred and the payouts the store has made to you. It does not use merchant API keys, and merchant keys don’t work on it.

​
Creating a key

  1. Sign in to the store’s customer dashboard with the email you’re an affiliate under
  2. Open Affiliates, then API keys
  3. Click Create key, name it, and optionally restrict it to your server’s IP addresses
  4. Copy the key
The key is shown once and can’t be retrieved later. Only a hash of it is stored. Keep it on your server: anyone holding it can read your affiliate account.
A key belongs to one affiliate account on one store. If you’re an affiliate of several stores, create a key on each. You can hold up to 10 keys per store, and revoking one in the dashboard stops it working immediately.

​
What a key can read

Every endpoint reads the account the key belongs to. None of them takes a store or affiliate ID, and no key can read another affiliate’s data.

​
Advertising your discount

Your account has a headline discount rate, but the store can give each product its own rate or turn the discount off for it. Advertise what GET /affiliate/discounts returns, not the headline. It is calculated exactly the way checkout calculates it, so it is what your buyers will see taken off. The affiliate discount is applied after any coupon, to the amount the coupon leaves.

​
When authentication fails

Both return the standard error envelope, with code set to AccessDenied. See Responses & Errors.
Last modified on October 23, 2026