Lista zamówień (metoda API orders)

Metoda API

Metoda orders umożliwia odczytanie listy zamówień prowizyjnych.

Punkt końcowy

GET

URL: https://api.wedos.as/partner/orders
Uwaga: Lista zamówień wraz ze statusami i prowizjami dla partnera.

Co z tego uzyskasz: w pozycji wyniki pole rekordów (zamówienia).

Możliwe stany zamówienia

pending – w trakcie realizacji
done – załatwiona
canceled – anulowana
honoured – zaksięgowana
refused – odrzucona

pending – oczekuje na płatność lub realizację
done – zrealizowano, prowizja jeszcze nie została zaksięgowana
cancelled – zamówienie anulowane (klient lub dostawca)
honoured – prowizja została już zaksięgowana na koncie prowizyjnym
refused – odrzucone z powodu naruszenia warunków

Dane dotyczące zamówienia

Objaśnienie poszczególnych danych podanych w zamówieniu:

ID – numer zamówienia
advertiserId – identyfikator reklamodawcy
orderNum – numer zamówienia przypisany przez reklamodawcę
createdDate – data i godzina utworzenia zamówienia
textCampaignId – identyfikator kampanii tekstowej
boardId – identyfikator powierzchni reklamowej

entryId – identyfikator wejścia (kliknięcia)
customId – identyfikator użytkownika
status – status zamówienia
amount – kwota zamówienia
currency – waluta zamówienia
partnerCommission – prowizja dla partnera (w walucie partnera)
partnerCurrency – waluta partnera
doneDate – data i godzina realizacji zamówienia
honouredDate – data i godzina zaksięgowania prowizji na koncie prowizyjnym

Parametry wejściowe (GET)

Za pomocą parametrów wejściowych można filtrować i paginować rekordy.

Filtrowanie

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID zwraca tylko rekordy, których identyfikator jest większy niż podana wartość.

Stronowanie

strona
count

Wskazówka: jeśli chcesz pobierać tylko nowości, połącz lastID + rozsądną liczbę count.

Dane wyjściowe

Metoda zwraca w pozycji results pole rekordów zamówień.

Przykładowa odpowiedź (skrócona)

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

Przykładowe wymagania

Wszystkie zamówienia (pierwsze 100)

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

Zamówienia w stanie oczekującym

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

Zamówienia o numerze identyfikacyjnym powyżej 1234

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

Jeśli masz problem lub pytanie dotyczące systemu prowizyjnego, napisz na adres affiliate@wedos.com.