Zoznam objednávok (API metóda orders)

API metóda

Metóda orders umožňuje čítať zoznam províznych objednávok.

Endpoint

GET

URL: https://api.wedos.as/partner/orders
Poznámka: Zoznam objednávok vrátane stavov a provízií pre partnera.

Čo z toho dostaneš: v položke results pole záznamov (objednávky).

Možné stavy objednávky

pending – vybavuje sa
done – vybavená
canceled – stornovaná
honoured – pripísaná
refused – zamietnutá

pending – čaká sa na zaplatenie alebo vybavenie
done – vybavená, provízia ešte nepripísaná
cancelled – objednávka zrušená (zákazník alebo dodávateľ)
honoured – provízia je už pripísaná na provízny účet
refused – zamietnutá pre porušenie podmienok

Údaje o objednávke

Vysvetlenie jednotlivých údajov uvedených pri objednávke:

ID – ID objednávky
advertiserId – ID inzerenta
orderNum – číslo objednávky pridelené inzerentom
createdDate – dátum a čas vytvorenia objednávky
textCampaignId – ID textovej kampane
boardId – ID reklamnej plochy

entryId – ID príchodu (prekliku)
customId – používateľské ID
status – stav objednávky
amount – suma objednávky
currency – mena objednávky
partnerCommission – provízia pre partnera (v mene partnera)
partnerCurrency – mena partnera
doneDate – dátum a čas vybavenia objednávky
honouredDate – dátum a čas pripísania provízie na provízny účet

Vstupné parametre (GET)

Pomocou vstupných parametrov možno filtrovať a stránkovať záznamy.

Filtrovanie

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID vráti iba záznamy, ktorých ID je väčšie než uvedená hodnota.

Stránkovanie

page
count

Tip: keď chceš ťahať len novinky, kombinuj lastID + rozumný count.

Výstupné dáta

Metóda vracia v položke results pole záznamov objednávok.

Príklad odpovede (skrátený)

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

Príklad požiadaviek

Všetky objednávky (prvých 100)

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

Objednávky v stave pending

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

Objednávky s ID väčším než 1234

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

Ak máš problém alebo otázku k províznemu systému, napíš na affiliate@wedos.com.