PartnerBoost-API-Dokumentation
Integrieren Sie Ihre Systeme in die PartnerBoost-Plattform für das Partnermanagement. Über unsere API können Sie Transaktionen verwalten, Berichte erstellen, Werbemittel bearbeiten und Ihren Produkt-Datafeed programmgesteuert verwalten.
Übersicht
Die händlerseitigen Funktionen von PartnerBoost wurden offiziell in die OpenClaw-Plattform integriert. Durch die Nutzung der Funktionen „KI-Gehirn + automatisierter Betrieb“ von OpenClaw bietet sie Händlern im grenzüberschreitenden E-Commerce operative Dienstleistungen im Stil eines digitalen KI-Mitarbeiters. Händler können Auftragsdatenabfragen, Leistungsanalysen, die Überprüfung von Kanaleffekten, Rechnungsprüfungen, das Partner-Medienmanagement und andere Vorgänge schnell und einfach durch Anweisungen in natürlicher Sprache erledigen, ohne sich manuell im Backend anmelden zu müssen, um Berichte zu exportieren. Dies verbessert die Effizienz der Affiliate-Marketing-Abläufe erheblich und ermöglicht einen Effizienzsprung vom manuellen Betrieb hin zur intelligenten Interaktion.
Anleitung – OpenClaw
OpenClaw Skill 安装指引
一、获取 API Key
在开始查询前,请先准备好 PARTNERBOOST_API_KEY:
- 主账号:登录 PartnerBoost(PB)平台,在「设置」或「API 管理」页面直接查看并复制 API Key。
- 子账号:联系主账号管理员,在 PB 平台内为你分配 API Key。
二、创建飞书企业应用
- 进入飞书开放平台:https://open.feishu.cn/app
-
点击创建企业自建应用,按指引完成基础创建流程。
-
左侧菜单栏点击添加应用能力,在右侧找到机器人并点击「添加」。
-
左侧菜单栏点击凭证与基础信息,复制 App ID 及 App Secret 备用。
三、在阿里云创建 OpenClaw 实例
-
阿里云搜索「OpenClaw」,进入购买页面:https://www.aliyun.com/benefit/scene/openclaw
-
选择适配配置,完成购买。
-
等待实例创建完成,点击管理 OpenClaw。
-
依次完成 OpenClaw 使用步骤 1→2→3,填入飞书应用的 App ID 和 App Secret。
四、安装 PartnerBoost Brand Skill
- 打开飞书,搜索并找到已创建的 OpenClaw 应用机器人。
-
发送以下指令(将
PARTNERBOOST_API_KEY替换为你的实际 Key):帮我安装这个技能 https://github.com/partnerboost-tech-team/partnerboost-brand 然后初始化他,我的key是 PARTNERBOOST_API_KEY
- 等待机器人提示技能安装成功。
-
发送指令重启,重启 OpenClaw 使配置生效。
- 重启完成后即可正常使用,支持查询订单、合作媒体、业绩数据等功能。
PartnerBoost OpenClaw Skill Installation Guide
Content generated by AI1. Obtain Your API Key
Before starting, ensure you have your PARTNERBOOST_API_KEY ready:
- Primary Account: Log in to the PartnerBoost (PB) platform. Go to the "Settings" or "API Management" page to view and copy your API Key.
- Sub-Account: Contact your primary account administrator to have an API Key assigned to you within the PB platform.
2. Create a Discord Bot
- Go to the Discord Developer Portal: https://discord.com/developers/applications
- Click "New Application", enter a name, and create it.
-
Navigate to the "Bot" tab in the left sidebar:
- Click "Reset Token" to generate your Bot Token. (Copy and save it immediately; it will not be shown again).
- Under the "Privileged Gateway Intents" section, toggle ON the
MESSAGE CONTENT INTENT(This is required for the bot to read your commands).
-
Navigate to "OAuth2" → "URL Generator":
- Scopes: Select
bot. - Bot Permissions: Select
Administrator(or specific messaging permissions). - Copy the generated URL, paste it into your browser, and invite the bot to your Discord server.
- Scopes: Select
- Go to "General Information" and copy the Application ID (Client ID) for later use.
3. Create an OpenClaw Instance on AWS
- Log in to the AWS Management Console and navigate to the EC2 dashboard.
-
Launch Instance:
- Name:
OpenClaw-Server. - OS (AMI): Select
Ubuntu 22.04 LTS(Recommended). - Instance Type: Select
t3.medium(2 vCPU, 4GB RAM) or higher. - Security Group: Ensure ports TCP 80, 443, and the specific OpenClaw WebUI port are open.
- Name:
-
Deploy OpenClaw:
- Connect to your instance via SSH and install Docker.
- Pull and run the OpenClaw image.
-
Initialization:
- Access the OpenClaw WebUI via your instance's Public IP in a browser.
- Enter your Discord Bot Token and Application ID during the setup steps.
- Complete the basic configuration and dashboard initialization.
4. Install PartnerBoost Brand Skill
- Open Discord and go to the server where your OpenClaw bot is present.
-
Send the following command to the bot (Replace
[YOUR_API_KEY]with your actual key):Command:
Please install this skill https://github.com/partnerboost-tech-team/partnerboost-brand and initialize it. My key is [YOUR_API_KEY] - Wait for the bot to reply: "Skill installation successful."
- Send the command
restartto apply the changes. - Once restarted, the bot is ready. You can now query orders, affiliate partners, and performance data.
Anwendungsfälle
Anwendungsfall 1: Leistungsbeurteilung und Optimierung der Personalbesetzung
Anweisung: Überprüfen Sie die PB-Bestelldaten der letzten drei Monate und unterbreiten Sie Vorschläge zur Optimierung der Bestellungen.
KI-Funktion: Ruft automatisch Bestelldaten ab → analysiert den ROI über alle Kanäle hinweg → identifiziert Medien mit hoher Konversionsrate → gibt Empfehlungen für Provisionsanpassungen und die Optimierung der Platzierung.
Anwendungsfall 2: Auftragsüberwachung in Echtzeit
Beispielaufgabe: Wie entwickeln sich die jüngsten Bestellungen? Fassen Sie die erfolgreichsten Vertriebskanäle zusammen.
KI-Funktion: Erfasst wichtige Bestellkennzahlen → markiert ungewöhnliche Bestellungen (Rückerstattungen, verdächtige Transaktionen) → erstellt eine Liste hochwertiger Vertriebskanäle.
Anwendungsfall 3: Schnelle Rechnungsabfrage
Beispielanweisung: Überprüfe meine Rechnung vom letzten Monat.
KI-Funktion: Ruft Rechnungen für den ausgewählten Monat direkt ab → zeigt Provisionsdetails und Abrechnungsstatus an, ohne sich im Backend anzumelden.
Anwendungsfall 4: Verwaltung von Partnermedien
Beispielanweisung: Mit welchen Werbemedien arbeite ich derzeit zusammen?
KI-Funktion: Listet alle Partner-Werbemedien auf und stellt die Ressourcenstruktur übersichtlich dar.
Häufig gestellte Fragen
Frage 1: Wer kann PartnerBoost Skills nutzen?
A: Alle Händler, die PartnerBoost integriert haben, können es aktivieren.
Frage 2: Auf welche Daten kann die KI zugreifen?
A: Es unterstützt zentrale Betriebsdaten wie Auftragsdaten, Absatzvolumen, Konversionsrate, Kanalleistung, Rechnungsdaten und Partnermedien.
Frage 3: Wie wird die Datensicherheit gewährleistet?
A: Der gesamte Datenzugriff und alle Datenverarbeitungsvorgänge erfolgen im Rahmen der Händlerautorisierung unter Einhaltung der Sicherheitsstandards der Plattform, und es werden keine Geschäftsdaten weitergegeben.
Frage 4: Was kann die KI außer der Abfrage von Daten noch tun?
A: Es kann Daten automatisch analysieren, Platzierungsvorschläge unterbreiten und ungewöhnliche Bestellungen überwachen. In Zukunft wird es die Erstellung von Kampagnen, die Auswahl von Influencern, die Erstellung von Marketingmaterialien und vieles mehr unterstützen.
Frage 5: Was passiert, wenn die Konfiguration fehlschlägt oder die Funktion nicht verfügbar ist?
A: Bitte überprüfen Sie, ob Sie bei ClawHub angemeldet sind und die PartnerBoost-Fähigkeiten korrekt hinzugefügt haben. Sollte das Problem weiterhin bestehen, wenden Sie sich bitte an den PartnerBoost-Kundendienst oder Ihren Kundenbetreuer.
Authentifizierung
Die PartnerBoost-API unterstützt derzeit eine Reihe verschiedener Aktionen. Alle Anfragen sollten als HTTPS-GET- oder POST-Anfrage (JSON) an folgende Adresse gesendet werden:
Erforderliche Parameter
Gebot- Ihre Marken-IdentifikationsnummerToken- Einmaliger Token, der bei der Einrichtung des Kontos für die API-Nutzung vergeben wirdAktion- Eine der unterstützten AktionenVersion- Derzeit 1.0
Erforderliche Kopfzeilen
Inhaltstyp- application/jsonX-PARTNERBOOST-DATE- Das aktuelle Datum in UTC (Universal Time Coordinated)X-PARTNERBOOST-AUTHENTIFIZIERUNG- Der berechnete Authentifizierungs-Hash
Authentifizierungs-Hash
Der Authentifizierungs-Hash ist ein SHA-256-Hash im 64-stelligen Hexadezimalformat der Zeichenfolge:
Für die folgenden Werte:
- API-Aktion: order/new
- Token: a25fb1225425ae360ec2922286e7bd01
- API-Schlüssel: 65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
- UTC-Datum: Fr, 07. Jan. 2022 07:21:16 GMT
- String zu Hash: a25fb1225425ae360ec2922286e7bd01;order/new;Fr, 07. Jan. 2022 07:21:16 GMT;65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
Korrekte HTTP-Header
- X-PARTNERBOOST-DATE: Fr, 07. Jan. 2022 07:21:16 GMT
- X-PARTNERBOOST-AUTHENTICATION: c0603ea2f4bd66eaac5e6fbbd2093ea6426d7e13e0a8cc4f5550368f55f7e64a
Transaktions-API
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Bestellnummer |
Ihre individuelle Bestellnummer | 201000000001 | Ja | Zeichenkette |
pbtid |
PartnerBoost-Klick-Track-Code | x_xxxxx | Nein | Zeichenkette |
ist_Neukunde |
Ist Neukunde der Marke | falsch | Nein | bool |
uid |
Die Identität des Nutzers in der Marke | 453215 | Nein | Zeichenkette |
Währung |
Währung der Bestellung | USD | Ja | Zeichenkette |
trans_time |
Bearbeitungszeit der Bestellung | Do, 20. Jan. 2022, 05:27:30 Uhr GMT | Ja | Zeichenkette |
Betrag |
Tatsächlicher Bestellbetrag | 111.55 | Nein | doppelt |
Menge |
Anzahl der Produkte | 1 | Nein | int |
Anmerkung |
Eine beliebige Nachricht | Nein | Zeichenkette | |
Gutscheincode |
Durch Kommas getrennte Liste von Gutscheincodes | ZVKD234,ZVKA111 | Nein | Zeichenkette |
skus |
SKU-Liste (erforderlich, wenn die Bestellung eine SKU enthält) | Array | Nein | Array |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Bestellnummer |
Ihre individuelle Bestellnummer | 201000000001 | Ja | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Bestellnummer |
Ihre individuelle Bestellnummer | 201000000001 | Ja | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
medium_id |
Angaben zum Herausgeber | LDC000123 | Ja | Zeichenkette |
Währung |
Währung der Bestellung | USD | Ja | Zeichenkette |
trans_time |
Bearbeitungszeit der Bestellung | Do, 20. Jan. 2022, 05:27:30 Uhr GMT | Ja | Zeichenkette |
Provision |
Provision für den Verlag | 11.15 | Ja | doppelt |
Anmerkung |
Eine beliebige Nachricht | Nein | Zeichenkette |
Berichts-API
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Startzeit |
Startzeitstempel | 1650351153 | Nein | int |
Endzeit |
Endzeitstempel | 1670351153 | Nein | int |
erstens |
Erstens | 0 | Nein | int |
Seitengröße |
Seitengröße von 20 bis 100 | 20 | Nein | int |
publisher_id |
Verlags-ID | Nein | Zeichenkette | |
Kanal-ID |
Kanal-ID | Nein | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
id |
Transfer-ID (entweder „id“ oder „pbtid“ muss angegeben werden) | 720078 | Nein | int |
pbtid |
Tracking-Flag aus der Landing-URL (entweder „id“ oder „pbtid“ ist erforderlich) | pb_xxxx | Nein | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Startzeit |
Zeitstempel der Transaktion | 1650351153 | Nein | int |
Endzeit |
Zeitstempel der Transaktion | 1670351153 | Nein | int |
Seitenzahl |
Seitenzahl | 1 | Nein | int |
Seitengröße |
Seitengröße von 20 bis 100 | 20 | Nein | int |
sort_dir |
enum(absteigend, aufsteigend), Standard ist absteigend | Beschreibung | Nein | enum |
sort_col |
enum(Transaktions-ID, Provision, Betrag) | transid | Nein | enum |
Status |
enum(new, void, effective) | Nein | enum | |
Typ |
Transaktionsart | Nein | enum |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Grenze |
Anzahl pro Seite (max. 200, Standard 100) | 100 | Nein | int |
Cursor |
Cursor für die Paginierung | 1 | Ja | Zeichenkette |
Startdatum |
Startdatum (JJJJMMTT) | 20241101 | Nein | Zeichenkette |
Enddatum |
Enddatum (JJJJMMTT) | 20241101 | Nein | Zeichenkette |
Bestellstatus |
Bestellstatus | neu, ungültig, gemischt, gesperrt, bezahlt | Nein | Zeichenkette |
Artikelnummer-Status |
Status der Artikelnummer/ASIN | neu, ungültig, gesperrt, bezahlt | Nein | Zeichenkette |
Transaktionsart |
Transaktionsart | Bonus, manuell hinzugefügt, normal | Nein | Zeichenkette |
publisher_id |
Verlags-ID | Nein | Zeichenkette | |
Gruppen-ID |
Den Verlagen zugewiesene Gruppen-ID | 323 | Nein | Zeichenkette |
Kreative API
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Typ |
Typ | BILD/TEXT/GUTSCHEIN | Ja | Zeichenkette |
Status |
Status | Geplant/Aktiv/Abgelaufen | Nein | Array |
Datenschutz |
Berechtigung | ÖFFENTLICH/PRIVAT | Nein | Array |
Stichwort |
Stichwort | Test | Nein | Zeichenkette |
Seitenzahl |
Seitenzahl | 1 | Nein | int |
Seitengröße |
Seitengröße | 10 | Nein | int |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Typ |
Typ | BILD/TEXT/GUTSCHEIN | Ja | Zeichenkette |
Startzeit |
Startzeit | 1680241332 | Ja | Zeichenkette |
Endzeit |
Ende | 1682574132 | Ja | Zeichenkette |
Link |
Link (erforderlich, wenn type == TEXT) | https://www.example.com | Nein | Zeichenkette |
Inhalt |
Inhalt (erforderlich, wenn type == TEXT) | Test | Nein | Zeichenkette |
Bilder |
Bilder (erforderlich, wenn type == IMAGE) | Array | Nein | Array |
Titel |
Titel | Test | Nein | Zeichenkette |
Datenschutz |
Datenschutz | ÖFFENTLICH/PRIVAT | Nein | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
id |
ID | 132505 | Ja | Zeichenkette |
Titel |
Titel | Test | Nein | Zeichenkette |
Startzeit |
Startzeit | 1680241332 | Nein | Zeichenkette |
Endzeit |
Ende | 1682574132 | Nein | Zeichenkette |
Datenschutz |
Datenschutz | ÖFFENTLICH/PRIVAT | Nein | Zeichenkette |
Datenfeed-API
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Abrufzeitraum |
Abrufzeitraum (NIE, TÄGLICH, WÖCHENTLICH, MONATLICH) | TÄGLICH | Ja | Zeichenkette |
fetch_url |
URL abrufen | http://www.yousite.com/datafeed.xml | Ja | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Name |
Produktname | Produktname | Ja | Zeichenkette |
URL |
Produkt-URL | http://www.yousite.com/product/1 | Ja | Zeichenkette |
Bild |
Produktbild | http://www.yousite.com/product/1.jpg | Ja | Zeichenkette |
Artikelnummer |
Produkt-SKU (eindeutig) | Artikelnummer | Ja | Zeichenkette |
Preis |
Produktpreis | 100 | Ja | Zahl |
Währung |
Währungscode (ISO 4217) | USD | Ja | Zeichenkette |
Beschreibung |
Produktbeschreibung | Produktbeschreibung | Nein | Zeichenkette |
Kategorie |
Produktkategorie | Kategorie | Nein | Zeichenkette |
alter Preis |
Produkt Alter Preis | 100 | Nein | Zahl |
Marke |
Produktmarke | Marke | Nein | Zeichenkette |
gtin |
Globale Handelsnummer | 9783161484100 | Nein | Zeichenkette |
mpn |
Hersteller-Teilenummer | CR2032 | Nein | Zeichenkette |
Verfügbarkeit |
Produktverfügbarkeit | Auf Lager | Nein | Zeichenkette |
Publisher-API
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
publisher_id |
Verlags-ID | 9527 | Nein | int |
Kanal-ID |
Kanal-ID | 9527 | Nein | int |
Status |
Status | beigetreten | Nein | Zeichenkette |
| Schlüssel | Titel | Beispiel | Erforderlich | Typ |
|---|---|---|---|---|
Benutzername |
Benutzer-ID (Entweder „userId“ oder „site_ids“ muss angegeben werden) | 40828 | Ja | Zeichenkette |
Site-IDs |
Site-IDs (Entweder userId oder site_ids ist erforderlich) | 40828 | Ja | Zeichenkette |
mail_id |
E-Mail-Adresse | 40828 | Nein | Zeichenkette |
automatisch genehmigen |
Automatisch genehmigen | 1 | Nein | int |
Status |
Status (angenommen/freigegeben/beendet/abgelehnt) | übernehmen | Ja | Zeichenkette |
Authentifizierung
Anfragen an die Publisher-API sollten an den folgenden Endpunkt gerichtet werden:
HTTP-Anfragemethoden
- POST application/x-www-form-urlencoded
- POST application/json
- HOLEN
Rückgabeformat
- JSON (Standard)
- XML
Erforderlicher Parameter
Token- Dein Kanal-API-Token (zu finden in deinem Publisher-Dashboard)
Jeder Kanal verfügt über einen eigenen API-Token. Du findest deine Token im Publisher-Dashboard unter „Tools“ > „API“.
Gängige Ergebniscodes
| Code | Beschreibung |
|---|---|
0 |
Erfolg |
1000 |
Der Verlag existiert nicht |
1001 |
Ungültiges Token |
1002 |
Anrufhäufigkeit zu hoch |
1003 |
Erforderliche Parameter fehlen oder das Format ist falsch |
Transaktion
Rufen Sie detaillierte Transaktionen, den Provisionsstatus und vieles mehr ab.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Startdatum |
Beginn des Transaktionszeitraums. Entweder der Transaktionszeitraum oder der Validierungszeitraum ist obligatorisch. | 01.01.2024 |
Enddatum |
Ende des Transaktionszeitraums | 31.01.2024 |
Validierungsdatum (Beginn) |
Beginn des Validierungszeitraums. Entweder der Transaktionszeitraum oder der Validierungszeitraum ist obligatorisch. | 01.01.2024 |
Gültigkeitsende |
Ende des Gültigkeitszeitraums | 31.01.2024 |
Optionale Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Typ |
Ausgabeformat: JSON (Standard) oder XML | json |
Bestellnummer |
Bestellnummer | ORD123456 |
Status |
Status der Kommission: Ausstehend, Genehmigt, Abgelehnt, Normal, Alle | Genehmigt |
uid |
Ihre benutzerdefinierte Tracking-Variable | tracking123 |
brand_id |
Markenidentität | 66303 |
mcid |
Eindeutige Kennung für die Marke | ulike0 |
Seite |
Inhaltsverzeichnis der aktuellen Seite | 1 |
Grenze |
Anzahl der Transaktionen pro Seite (max. 2000) | 100 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
Kanal-ID |
Kanal-ID |
Gesamtseitenzahl |
Gesamtseitenzahl |
Gesamtanzahl |
Gesamtzahl der Verkaufstransaktionen |
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Händlername |
Markenname |
Bestellnummer |
Bestellnummer |
Bestellzeit |
Transaktionsdauer |
Verkaufsbetrag |
Verkaufssumme |
Verkaufsprovision |
Verkaufsprovision |
Status |
Status der Kommission |
uid |
Ihre benutzerdefinierte Tracking-Variable |
Auf „Melden“ klicken
Detailliertes Klickprotokoll abrufen.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Startdatum |
Startdatum und -zeit | 01.01.2024 00:00:00 |
Enddatum |
Enddatum und -zeit | 01.01.2024 01:00:00 |
Der Zeitraum zwischen Start- und Enddatum darf eine Stunde nicht überschreiten. Maximal 10 Anfragen pro Minute.
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
Kanal-ID |
Kanal-ID |
Gesamtseitenzahl |
Gesamtseitenzahl |
Gesamtanzahl der Artikel |
Gesamtzahl der Transaktionen, aufgeschlüsselt nach Posten |
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Händlername |
Markenname |
uid |
Ihre benutzerdefinierte Tracking-Variable |
Klickzeit |
Der Zeitpunkt, zu dem der Kunde auf Ihren Link klickt (UTC+8) |
click_ref |
Eine eindeutige Transaktionsreferenz-ID |
Kommission
Zeigt die genehmigte Provisionsaufschlüsselung nach Marken auf monatlicher Basis an.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Startdatum |
Startdatum | 01.01.2024 |
Enddatum |
Enddatum | 31.01.2024 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Verkaufsprovision |
Verkaufsprovision |
Abrechnungsdatum |
Datum, an dem die Provision genehmigt und zur Auszahlung bereit ist |
Anmerkung |
Zeitraum, in dem der Betrag generiert wird |
Abrechnungs-ID |
Die eindeutige ID weist auf eine vom Händler genehmigte Provision hin |
Verwenden Sie die Abrechnungs-ID, um die Provisionsaufschlüsselung nach Transaktionen pro Marke abzurufen.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Abrechnungs-ID |
Die eindeutige ID weist auf eine vom Händler genehmigte Provision hin | 12345 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Händlername |
Markenname |
Bestellnummer |
Bestellnummer |
Bestellzeit |
Transaktionsdauer |
Verkaufsbetrag |
Verkaufssumme |
Verkaufsprovision |
Verkaufsprovision |
Status |
Status der Kommission |
uid |
Ihre benutzerdefinierte Tracking-Variable |
prod_id |
Produkt-ID |
Bestelleinheit |
Bestellmenge |
Abrechnungs-ID |
Die eindeutige ID kennzeichnet eine genehmigte Provision |
Validierungsdatum |
Datum der Transaktionsbestätigung |
Zahlung
Zeigt Ihren Zahlungsverlauf an.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Zahlungs-ID |
Zahlungs-ID (payment_id oder paid_date_begin und paid_date_end sind Pflichtangaben) | 12345 |
Zahlungsbeginn |
Beginn des Zahlungszeitraums (JJJJ-MM-TT) | 01.01.2024 |
Zahlungsdatum (Ende) |
Zahlungsdatum (JJJJ-MM-TT) | 31.01.2024 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
Zahlungs-ID |
Die Zahlungs-ID, die Sie unter „Zahlungsverlauf“ finden |
Antragsdatum |
Datum, an dem die Zahlung angelegt wurde |
Zahlungsdatum |
Datum, an dem die Zahlung als beglichen markiert wird |
Zahlungsart |
Zahlungsart |
Zahlungsdetails |
Kontoinformationen |
Rechnung |
Rechnungsdaten |
Betrag |
Zahlungsbetrag |
Zeigt Ihre detaillierte Zahlungsübersicht an.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Zahlungs-ID |
Zahlungs-ID (payment_id oder paid_date_begin und paid_date_end sind Pflichtangaben) | 12345 |
Zahlungsbeginn |
Beginn des Zahlungszeitraums (JJJJ-MM-TT) | 01.01.2024 |
Zahlungsdatum (Ende) |
Zahlungsdatum (JJJJ-MM-TT) | 31.01.2024 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Betrag |
Provisionsbetrag oder Bonusbetrag |
Validierungsdatum |
Datum der Genehmigung der Provision |
Typ |
Die Art der Vergütung kann eine Provision oder ein Bonus sein |
Anmerkung |
Zeitraum, in dem der Betrag generiert wird |
Abrechnungs-ID |
Die eindeutige ID kennzeichnet eine genehmigte Provision |
Händlername |
Name des Händlers |
Zahlungs-ID |
Die Zahlungs-ID, die Sie unter „Zahlungsverlauf“ finden |
Zahlungsdatum |
Datum, an dem die Zahlung als beglichen markiert wird |
sign_id |
Eindeutige Kennung speichern |
Monetarisierung
Überprüfen Sie den Status der Markendaten und rufen Sie Kampagnenlinks ab, um Ihren Traffic zu monetarisieren.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optionale Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Typ |
Ausgabeformat: JSON (Standard) oder XML | json |
Markentyp |
Markentypen: TikTok, DTC, Amazon, Walmart, Indirekt | DTC |
Genehmigungsart |
Nach Genehmigungsart filtern: Automatisch, Manuell | Auto |
Angebotsart |
Nach Preismodell der Marke filtern: CPS, CPA, CPC, CPL, CPX, CPM | CPS |
Beziehung |
Nach aktuellem Status der Markenbeziehung filtern: Angenommen, Ausstehend, Abgelehnt, Keine Beziehung | Mitglied seit |
Kategorien |
Nach Markenkategorien filtern | Bekleidung |
Gutschein
Holen Sie sich aktuelle Gutscheine und Angebote von verschiedenen Marken.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Gutschein-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optionale Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Markentyp |
3 Vertriebskanäle: D2C, Amazon, indirekter Vertrieb | D2C |
brand_id |
Markenidentität | 66303 |
mcid |
Eindeutige Kennung für die Marke | ulike0 |
Spur |
Tracking-Code im Tracking-Link | Track 123 |
Typ |
Es gibt zwei Arten von Gutscheinen: Gutscheine oder Angebote | Gutschein |
Land |
Die Länder, in denen der Gutschein eingelöst werden kann | US |
Herkunftskategorie |
Kategorie des Händlers, der den Gutschein anbietet | Bekleidung |
Ebene |
Stufe 1–4, wobei Stufe 1 die höchste ist | 1 |
Sprache |
Sprache des Gutscheins | de |
pro Seite |
Anzahl der Einträge pro Seite (Standard: 50, maximal 2000) | 100 |
Seite |
Aktueller Seitenindex (beginnt bei 1) | 1 |
Erstellt am |
Erstellungsdatum (JJJJ-MM-TT) | 01.01.2024 |
aktualisiert am |
Aktualisierungsdatum (JJJJ-MM-TT) | 01.01.2024 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
creative_id |
Kreative ID |
brand_id |
Markenidentität |
Einschränkungen |
Einschränkungen für Gutscheine |
Stichwörter |
Stichwörter |
Bild |
Bild des Gutscheins |
Miniaturansicht |
Miniaturbild |
smart_url |
Intelligente URL |
Datenfeed
Produktdaten von den Marken abrufen.
Erforderliche Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Token |
Ihr Kanal-API-Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optionale Parameter
| Schlüssel | Beschreibung | Beispiel |
|---|---|---|
Typ |
Ausgabeformat: JSON (Standard) oder XML | json |
Markentyp |
Markentypen: TikTok, DTC, Walmart | DTC |
brand_id |
Markenidentität | 66303 |
mcid |
Eindeutige Kennung für die Marke | ulike0 |
Seite |
Aktuelle Seite – Inhaltsverzeichnis | 1 |
Grenze |
Anzahl der Produkte pro Seite (max. 100) | 50 |
Stichwörter |
Stichwörter | Hemd |
Preisspanne |
Eine der folgenden Optionen: „0–75“, „75–150“, „150–300“, „300–500“, „500–1000“, „1000+“ | 75–150 |
Mindestrabatt |
Einer von 75, 50, 25, 10 | 25 |
Rückgabeparameter
| Schlüssel | Beschreibung |
|---|---|
Name |
Produktname |
Beschreibung |
Produktbeschreibung |
brand_id |
Markenidentität |
mcid |
Eindeutige Kennung für die Marke |
Händlername |
Der Name des Händlers, der dieses Produkt verkauft |
URL |
Die ursprüngliche Produkt-URL |
Bild |
Der Link zum Produktbild |
Artikelnummer |
Artikelnummer des Produkts |
Kategorie |
Produktkategorie |
Preis |
Aktueller Preis des Produkts |
Tracking-URL |
Affiliate-Tracking-URL |
tracking_url_short |
Kurze Affiliate-Tracking-URL |
tracking_url_smart |
Intelligente Affiliate-Tracking-URL |
aktualisiert am |
Zeitpunkt der letzten Aktualisierung |
Amazon
Basis-URL der Amazon Publisher API: https://amazon-service.partnerboost.com/amazon_api. Alle folgenden Endpunkte verwenden BEITRAG mit JSON-Inhalt application/json.
Amazon-Produkte nach Kriterien filtern und suchen (Seitenanzahl, Land, Marke, ASINs, Sonderangebote usw.).
Erstellen Sie Tracking-Links anhand der Produkt-IDs, die von der „Get Products“-API zurückgegeben werden.
Erstellen Sie Produkt-Tracking-Links anhand von ASINs und Marktplätzen.
Führen Sie die Amazon-Marken auf, mit denen Sie zusammenarbeiten (mit Seitenangabe).
Erstellen Sie Tracking-Links für den Shop anhand von Marken-IDs (Geboten).
Überprüfen Sie, ob Werbelinks weiterhin anhand der Link-ID nachverfolgt werden können.
Bestellkonversions-/Leistungsbericht für Tracking-Links (Datumsbereich, Marktplatz, ASINs, Anzeigengruppen, Bestell-IDs).
ASINs des Amazon-Partnerprogramms filtern und suchen (Region, Seiten).
ASINs von Amazon Creator Connection (ACC)-Kampagnen filtern und suchen.
