Liste der Bestellungen (API-Methode orders)

API-Methode

Methode orders ermöglicht dir, die Liste der Provisionsbestellungen zu lesen.

Endpoint

GET

URL: https://api.wedos.as/partner/orders
Hinweis: Liste der Bestellungen einschließlich Status und Provisionen für den Partner.

Was du davon hast: im Element results ein Array von Datensätzen (Bestellungen).

Mögliche Bestellstatus

pending – wird bearbeitet
done – bearbeitet
canceled – storniert
honoured – gutgeschrieben
refused – abgelehnt

pending – wartet auf Zahlung oder Bearbeitung
done – bearbeitet, Provision noch nicht gutgeschrieben
cancelled – Bestellung storniert (Kunde oder Lieferant)
honoured – die Provision ist bereits dem Provisionskonto gutgeschrieben
refused – wegen Verstoßes gegen die Bedingungen abgelehnt

Angaben zur Bestellung

Erläuterung der einzelnen Angaben zu einer Bestellung:

ID – ID der Bestellung
advertiserId – ID des Werbetreibenden
orderNum – vom Werbetreibenden vergebene Bestellnummer
createdDate – Datum und Uhrzeit der Erstellung der Bestellung
textCampaignId – ID der Textkampagne
boardId – ID der Werbefläche

entryId – ID des Zugangs (Klicks)
customId – Benutzer-ID
status – Status der Bestellung
amount – Betrag der Bestellung
currency – Währung der Bestellung
partnerCommission – Provision für den Partner (in der Währung des Partners)
partnerCurrency – Währung des Partners
doneDate – Datum und Uhrzeit der Bearbeitung der Bestellung
honouredDate – Datum und Uhrzeit der Gutschrift der Provision auf dem Provisionskonto

Eingabeparameter (GET)

Mit den Eingabeparametern kannst du die Datensätze filtern und paginieren.

Filterung

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID gibt nur Datensätze zurück, deren ID größer als der angegebene Wert ist.

Paginierung

page
count

Tipp: Wenn du nur Neuigkeiten abrufen willst, kombiniere lastID + einen vernünftigen count.

Ausgabedaten

Die Methode gibt im Element results ein Array von Bestelldatensätzen.

Beispielantwort (gekürzt)

{
  "results": [
    {
      "ID": 500895,
      "advertiserId": 2,
      "createdDate": "2017-05-23 10:35:27",
      "entryId": 50000272,
      "textCampaignId": 300000,
      "boardId": null,
      "customId": null,
      "orderNum": "8011700019",
      "amount": 14,
      "currency": "CZK",
      "partnerCommission": 3.5,
      "partnerCurrency": "CZK",
      "status": "canceled",
      "doneDate": null,
      "honouredDate": null
    },
    {
      "ID": 500894,
      "advertiserId": 2,
      "createdDate": "2017-05-19 14:50:33",
      "entryId": 50000271,
      "textCampaignId": 300000,
      "boardId": null,
      "customId": null,
      "orderNum": "8151700025",
      "amount": 4445,
      "currency": "CZK",
      "partnerCommission": 1422.4,
      "partnerCurrency": "CZK",
      "status": "honoured",
      "doneDate": "2017-05-19 14:51:08",
      "honouredDate": "2017-05-22 11:31:57"
    }
  ],
  "page": 1,
  "count": 100,
  "filteredCount": 624,
  "totalCount": 624,
  "requestId": "1495624713.2655.11284"
}

Beispielanfragen

Alle Bestellungen (erste 100)

https://api.wedos.as/partner/orders

Bestellungen mit dem Status pending

https://api.wedos.as/partner/orders?status=pending

Bestellungen mit einer ID größer als 1234

https://api.wedos.as/partner/orders?lastID=1234

Wenn du ein Problem oder eine Frage zum Provisionssystem hast, schreib an affiliate@wedos.com.