Passer au contenu principal
Utilisez les points de terminaison d’affiliation pour synchroniser votre programme de partenaires avec vos propres systèmes : lister les partenaires, suivre les commandes attribuées et suivre les paiements.
Votre boutique doit être approuvée pour le programme d’affiliation. Faites votre demande dans le tableau de bord, sous Affiliates. En attendant, chaque point de terminaison d’affiliation renvoie 403 avec le code FEATURE_NOT_ENABLED.

Points de terminaison

L’approbation des partenaires, l’examen des conversions signalées et l’envoi des paiements restent dans le tableau de bord.

Montants et identifiants

  • Dans les réponses de l’API, les montants sont des entiers en unités mineures. commission: 499 en USD correspond à 4,99 $.
  • Les charges utiles des webhooks utilisent les unités majeures. commission: 4.99 correspond à 4,99 $.
  • Les partenaires et les paiements utilisent des identifiants publics de 16 caractères. Les conversions utilisent l’invoice_id public de la commande.

Pagination

Les points de terminaison de liste renvoient 25 éléments par page avec un next_cursor. Renvoyez-le dans cursor pour obtenir la page suivante. next_cursor vaut null sur la dernière page.
Chaque liste renvoie aussi counts, le nombre d’enregistrements par statut :

Inviter un partenaire

Réponse (201)
Les clés en lecture seule ne peuvent pas inviter de partenaires.

Attribution des commandes

Une commande est créditée à un partenaire de l’une des façons suivantes, par ordre de priorité :
  1. Coupon partenaire. L’acheteur a utilisé un coupon lié au partenaire.
  2. Lien de suivi. L’acheteur a ouvert un lien partenaire : https://your-store.com/any-page?ref=CODE ou https://your-store.com/r/CODE. La vitrine mémorise le clic pendant la durée de validité du cookie du programme.
  3. API. Vous avez transmis affiliateCode lors de la création de la facture. La conversion a source: "api".
La conversion est rejetée lorsque l’acheteur est le partenaire lui-même, ou lorsqu’un autre coupon est utilisé et que le programme n’autorise pas le cumul de coupons. Elle est signalée pour examen lorsque la commande présente un score de fraude élevé ou que le partenaire reçoit un nombre inhabituel de commandes en peu de temps.

États de commission

Les remboursements annulent automatiquement la commission. commission correspond toujours au montant net.

Webhooks

Abonnez-vous à ces événements dans Developers › Webhooks. Ils utilisent la même enveloppe et le même en-tête PapelShip-Signature que les événements de commande.
affiliate.conversion
affiliate.payout_sent

Erreurs

Les erreurs d’affiliation incluent un code lisible par machine :