Zum Hauptinhalt springen
Mit den Affiliate-Endpunkten synchronisieren Sie Ihr Partnerprogramm mit Ihren eigenen Systemen: Partner auflisten, zugeordnete Bestellungen nachverfolgen und Auszahlungen verfolgen.
Ihr Shop muss für das Affiliate-Programm freigeschaltet sein. Beantragen Sie dies im Dashboard unter Affiliates. Bis dahin liefert jeder Affiliate-Endpunkt 403 mit dem Code FEATURE_NOT_ENABLED.

Endpunkte

Das Freigeben von Partnern, das Prüfen markierter Conversions und das Senden von Auszahlungen erfolgen weiterhin im Dashboard.

Beträge und IDs

  • Beträge in API-Antworten sind Ganzzahlen in der kleinsten Währungseinheit. commission: 499 in USD entspricht 4,99 $.
  • Webhook-Payloads verwenden die Hauptwährungseinheit. commission: 4.99 entspricht 4,99 $.
  • Partner und Auszahlungen verwenden 16-stellige öffentliche IDs. Conversions verwenden die öffentliche invoice_id der Bestellung.

Paginierung

Listen-Endpunkte liefern 25 Einträge pro Seite mit einem next_cursor. Geben Sie ihn als cursor zurück, um die nächste Seite zu erhalten. Auf der letzten Seite ist next_cursor gleich null.
Jede Liste liefert außerdem counts, die Anzahl der Datensätze pro Status:

Partner einladen

Antwort (201)
Schlüssel mit reinem Lesezugriff können keine Partner einladen.

So werden Bestellungen zugeordnet

Eine Bestellung wird einem Partner auf einem der folgenden Wege gutgeschrieben, in der Reihenfolge ihrer Priorität:
  1. Partner-Gutschein. Der Käufer hat einen Gutschein verwendet, der an den Partner gebunden ist.
  2. Tracking-Link. Der Käufer hat einen Partner-Link geöffnet: https://your-store.com/any-page?ref=CODE oder https://your-store.com/r/CODE. Die Storefront merkt sich den Klick für die Dauer des Cookie-Zeitfensters des Programms.
  3. API. Sie haben beim Erstellen der Rechnung affiliateCode übergeben. Die Conversion hat source: "api".
Die Conversion wird abgelehnt, wenn der Käufer der Partner selbst ist oder wenn ein anderer Gutschein verwendet wird und das Programm keine Kombination von Gutscheinen erlaubt. Sie wird zur Prüfung markiert, wenn die Bestellung einen hohen Betrugs-Score hat oder der Partner in kurzer Zeit ungewöhnlich viele Bestellungen erhält.

Provisionsstatus

Rückerstattungen machen die Provision automatisch rückgängig. commission ist immer der Nettobetrag.

Webhooks

Abonnieren Sie diese Ereignisse unter Entwickler › Webhooks. Sie verwenden denselben Umschlag und denselben PapelShip-Signature-Header wie Bestellereignisse.
affiliate.conversion
affiliate.payout_sent

Fehler

Affiliate-Fehler enthalten einen maschinenlesbaren code: