Update / easy.affiliate REST-API (Orders)

📝 Einleitung 
 Um Orders automatisiert im easy.affiliate-System bearbeiten zu können, stellt die easy Marketing GmbH eine Webservice-API zur Verfügung. Diese ermöglicht es, bestehende Orders im Nachgang zu bearbeiten, sobald sie den Validierungsprozess durchlaufen. 
 Jedem User stehen hierfür ein Authentifizierungs-Token und eine Login_id zur Verfügung, die über das Frontend abgerufen werden können. 
 
 User-ID: Wo ist die User-ID hinterlegt? (Siehe Frontend-Profil) 
 Access-Token: Wo ist der Access-Token hinterlegt? (Siehe API-Einstellungen) 
 
 
 Endpunkte 
 
 
 
 Zielgruppe 
 URL 
 
 
 
 
 Admin 
 https://SUBDOMAIN.de/ws/V6/admin/JSON/Orders 
 
 
 Advertiser 
 https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Orders 
 
 
 
 
 Beispiele 
 Beispiel mit cURL 
 curl -X PUT \
 -H "Content-Type: application/json" \
 -H "X-Network-ID: -1" \
 -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" \
 -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" \
 -d '[{ "campaign_id": 1, "id": 12345, "status": 1, "turnover":100.00, "commission":12.34 },{ "campaign_id": 1, "ordertoken":"123a456b", "status": 2, "turnover": 0.00 }]' \
 https://DOMAIN/ws/V6/admin/JSON/Orders
 
 
 Codebeispiel 
 Mit der folgenden Methode können mehrere Orders geupdatet werden. Ein Beispielaufruf sieht folgendermaßen aus: 
 Headers 
 
 
 
 Variable 
 Wert / Bedeutung 
 
 
 
 
 Content-Type 
 application/json 
 
 
 X-Network-ID 
 -1 
 
 
 X-Auth-Token 
 ADMIN_APIUSER_TOKEN 
 
 
 X-Auth-ID 
 ADMIN_APIUSER_LOGIN_ID 
 
 
 
 Body 
 [
 {
 "id": "12345",
 "campaign_id": 1,
 "status": 1,
 "turnover": 10.00,
 "commission": 0.99
 },
 {
 "ordertoken": "123a456b",
 "campaign_id": 1,
 "trigger_id": 1, 
 "status": 2,
 "turnover": 9.99,
 "cancel_reason": "Storno Grund"
 }
]
 
 
 Variablenerläuterung 
 Headers 
 
 
 
 Variable 
 Bedeutung 
 Datentyp 
 
 
 
 
 Content-Type 
 Der Content-Type des Requests 
 String 
 
 
 X-NETWORKID 
 Hier wird die ID des Mandanten eingetragen. Wenn nur ein Mandant vorhanden ist oder mandantenübergreifend gearbeitet wird, muss der Wert “-1” eingetragen werden. 
 Integer 
 
 
 X-AUTH-TOKEN 
 Hier wird der API-Authentifizierungs-Token des Admin Nutzers hinterlegt. 
 String 
 
 
 X-AUTH-ID 
 Hier wird die ID des Admin Nutzers hinterlegt. 
 Integer 
 
 
 
 
 Body 
 
 Im nachfolgenden werden die Standard-Parameter aufgelistet. Es ist aber über die API möglich, alle zur Verfügung stehenden Parameter zu updaten. 
 
 
 
 
 Parameter 
 Erklärung 
 Datentyp 
 Pflichtfeld 
 
 
 
 
 id 
 Hier wird die Transaktionsid hinterlegt. Aufbau: "id":"ID" 
 String 
 Ja (oder ordertoken ) 
 
 
 ordertoken 
 Hier wird der Ordertoken hinterlegt. Aufbau: "ordertoken":"ORDERTOKEN" 
 String 
 Ja (oder id ).* 
 
 
 campaign_id 
 Hier wird die Campaign_id hinterlegt. Aufbau: "campaign_id":CAMPAIGN_ID 
 Integer 
 Ja 
 
 
 trigger_id 
 Hier wird die Trigger ID hinterlegt. Aufbau: "trigger_id":TRIGGER_ID 
 Integer 
 Nein, nur falls ordertoken genutzt wird. 
 
 
 status 
 Hier wird der Status hinterlegt. Werte: -5 (ausstehende Nachbuchung), 0 (offen), 1 (bestätigt), 2 (storniert) 
 Integer 
 Nein 
 
 
 turnover 
 Hier wird der Bestellwert der Transaktion in Kampagnenwährung hinterlegt. Aufbau: "turnover":TURNOVER 
 Float 
 Nein 
 
 
 original_turnover 
 Hier wird der Bestellwert der Transaktion in Fremdwährung hinterlegt. Aufbau: "original_turnover":TURNOVER_IN_FREMDWÄHRUNG 
 Float 
 Nein 
 
 
 commission 
 Hier wird die Provisionshöhe in Kampagnenwährung hinterlegt, falls Sie die Commission selbst berechnen möchten. 
 Float 
 Nein 
 
 
 cancel_reason 
 Übergeben Sie den Stornogrund. Aufbau: "cancel_reason":"Stornogrund" 
 String 
 Nein 
 
 
 
 *) Hinweis: Wird der ordertoken genutzt, ist neben der campaign_id auch die trigger_id ein Pflichtfeld.