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: 499inUSDentspricht 4,99 $. - Webhook-Payloads verwenden die Hauptwährungseinheit.
commission: 4.99entspricht 4,99 $. - Partner und Auszahlungen verwenden 16-stellige öffentliche IDs. Conversions verwenden die öffentliche
invoice_idder Bestellung.
Paginierung
Listen-Endpunkte liefern 25 Einträge pro Seite mit einemnext_cursor. Geben Sie ihn als cursor zurück, um die nächste Seite zu erhalten. Auf der letzten Seite ist next_cursor gleich null.
counts, die Anzahl der Datensätze pro Status:
Partner einladen
Antwort (201)
So werden Bestellungen zugeordnet
Eine Bestellung wird einem Partner auf einem der folgenden Wege gutgeschrieben, in der Reihenfolge ihrer Priorität:- Partner-Gutschein. Der Käufer hat einen Gutschein verwendet, der an den Partner gebunden ist.
- Tracking-Link. Der Käufer hat einen Partner-Link geöffnet:
https://your-store.com/any-page?ref=CODEoderhttps://your-store.com/r/CODE. Die Storefront merkt sich den Klick für die Dauer des Cookie-Zeitfensters des Programms. - API. Sie haben beim Erstellen der Rechnung
affiliateCodeübergeben. Die Conversion hatsource: "api".
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 denselbenPapelShip-Signature-Header wie Bestellereignisse.
affiliate.conversion
affiliate.payout_sent
Fehler
Affiliate-Fehler enthalten einen maschinenlesbarencode: