Zoznam objednávok (objednávky metódy API)

metóda API

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

Koncový bod

ZÍSKAŤ

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

Čo získate: v poli výsledkov zoznam záznamov (objednávok).

Možné stavy objednávky

vybavuje sa –spracúva sa
hotové – dokončené
zrušené – zrušené
uhradené – pripísané
zamietnuté –odmietnuté

čaká na platbu alebo spracovanie
vybavené – spracované, provízia ešte nebola pripísaná
zrušené – objednávka zrušená (zákazník alebo dodávateľ)
vybavené – provízia už pripísaná na provízny účet
zamietnuté – zamietnuté z dôvodu porušenia podmienok

Podrobnosti objednávky

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

ID – ID objednávky
advertiserId – identifikačný kód inzerenta
orderNum – číslo objednávky pridelené inzerentom
createdDate – dátum a čas vytvorenia objednávky
textCampaignId – ID textovej kampane
boardId – identifikátor reklamného priestoru

entryId – identifikačný kód záznamu (prekliknutie)
customId – ID používateľa
stav – stav objednávky
suma – suma objednávky
mena – mena objednávky
partnerCommission – provízia pre partnera (v mene partnera)
partnerCurrency – mena partnera
doneDate – dátum a čas dokončenia objednávky
honouredDate – dátum a čas, kedy bola provízia pripísaná na provízny účet

Vstupné parametre (GET)

Záznamy môžete filtrovať a stránkovať pomocou vstupných parametrov.

Filtrovanie

ID
advertiserId
textCampaignId
boardId
entryId
customId
stav

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

Stránkovanie

strana
počet

Tip: ak chcete stiahnuť len novinky, skombinujte lastID + primeraný počet.

Výstupné údaje

Metóda vráti pole záznamov objednávok v položke výsledkov.

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 čakajúce

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

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

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

Ak máte akékoľvek problémy alebo otázky týkajúce sa provízneho systému, napíšte na adresu affiliate@wedos.com.