Seznam objednávek (API metoda orders)

API metoda

Metoda orders umožňuje číst seznam provizních objednávek.

Endpoint

GET

URL: https://api.wedos.as/partner/orders
Poznámka: Seznam objednávek včetně stavů a provizí pro partnera.

Co z toho dostaneš: v položce results pole záznamů (objednávky).

Možné stavy objednávky

pending – vyřizuje se
done – vyřízena
canceled – stornována
honoured – připsána
refused – zamítnuta

pending – čeká se na zaplacení nebo vyřízení
done – vyřízena, provize ještě nepřipsaná
cancelled – objednávka zrušená (zákazník nebo dodavatel)
honoured – provize už je připsaná na provizní účet
refused – zamítnuta kvůli porušení podmínek

Údaje o objednávce

Vysvětlení jednotlivých údajů uvedených u objednávky:

ID – ID objednávky
advertiserId – ID inzerenta
orderNum – číslo objednávky přidělené inzerentem
createdDate – datum a čas vytvoření objednávky
textCampaignId – ID textové kampaně
boardId – ID reklamní plochy

entryId – ID příchodu (prokliku)
customId – uživatelské ID
status – stav objednávky
amount – částka objednávky
currency – měna objednávky
partnerCommission – provize pro partnera (v měně partnera)
partnerCurrency – měna partnera
doneDate – datum a čas vyřízení objednávky
honouredDate – datum a čas připsání provize na provizní účet

Vstupní parametry (GET)

Pomocí vstupních parametrů lze filtrovat a stránkovat záznamy.

Filtrování

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID vrátí pouze záznamy, jejichž ID je větší než uvedená hodnota.

Stránkování

page
count

Tip: když chceš tahat jen novinky, kombinuj lastID + rozumné count.

Výstupní data

Metoda vrací v položce results pole záznamů objednávek.

Příklad odpovědi (zkrácen)

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

Příklad požadavků

Všechny objednávky (prvních 100)

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

Objednávky ve stavu pending

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

Objednávky s ID větším než 1234

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

Máte-li problém nebo dotaz k proviznímu systému, napište na affiliate@wedos.com.