Auftragsliste (API-Methode „orders“)

API-Methode

Mit der Methode „orders“ können Sie die Liste der Provisionsaufträge lesen.

Endpunkt

GET

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

Was Sie davon haben: im Punkt „Ergebnisse“ das Feld „Datensätze“ (Bestellungen).

Mögliche Bestellstatus

pending – in Bearbeitung
done – erledigt
canceled – storniert
honoured – gutgeschrieben
refused – abgelehnt

pending – Zahlung oder Bearbeitung steht noch aus
done – erledigt, Provision noch nicht gutgeschrieben
cancelled – Bestellung storniert (Kunde oder Lieferant)
honoured – Provision wurde bereits auf das Provisionskonto gutgeschrieben
refused – wegen Verstoßes gegen die Bedingungen abgelehnt

Bestelldaten

Erläuterung der einzelnen Angaben in der Bestellung:

ID – Bestellnummer
advertiserId – ID des Werbetreibenden
orderNum – vom Werbetreibenden zugewiesene Bestellnummer
createdDate – Datum und Uhrzeit der Auftragserstellung
textCampaignId – ID der Textkampagne
boardId – ID der Werbefläche

entryId – ID des Zugangs (Klicks)
customId – Benutzer-ID
Status – Status der Bestellung
amount – Bestellbetrag
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 Auftragsabwicklung
honouredDate – Datum und Uhrzeit der Gutschrift der Provision auf das Provisionskonto

Eingabeparameter (GET)

Mit Hilfe der Eingabeparameter können Sie die Einträge filtern und paginieren.

Filtern

ID
advertiserId
textCampaignId
boardId
entryId
customId
Status

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

Seitenumbruch

Seite
count

Tipp: Wenn du nur Neuigkeiten abrufen möchtest, kombiniere lastID + einen sinnvollen Count.

Ausgangsdaten

Die Methode gibt in der Position „results“ ein Feld mit Auftragseinträgen zurück.

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"
}

Beispiel für Anforderungen

Alle Bestellungen (die ersten 100)

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

Bestellungen mit Status „ausstehend“

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 Sie ein Problem oder eine Frage zum Provisionssystem haben, schreiben Sie bitte an affiliate@wedos.com.