API – seznam objednávek (metoda orders)

zpět na přehled API

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

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

Ú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 (viz. uživatelské ID v odkazech a plochách)
• 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 za objednávku na provizní účet

Možné stavy objednávky (hodnota status):

• pending (vyřizuje se) – byla vytvořena, čeká se na zaplacení zákazníkem nebo vyřízení
• done (vyřízena) – objednávka vyřízena, zatím nebyla připsána provize
• canceled (stornována) – objednávka nebyla realizována, byla zrušena zákazníkem nebo dodavatelem
• honoured (připsána) – provize za objednávku byla připsána na provizní účet
• refused (zamítnuta) – objednávka zamítnuta z důvodu porušení podmínek provizního systému

Vstupní parametry (GET)

Pomocí vstupních parametrů lze filtrovat a stránkovat záznamy – viz. Seznamy v API.

Filtrovat lze podle následujících položek:

• ID
• advertiserId
• textCampaignId
• boardId
• entryId
• customId
• status

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

Dále lze ovlivnit počet a stránku vracených záznamů:

• page
• count

Výstupní data

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

Příklad odpovědi (seznam položek 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ů

Vrácení seznamu všech objednávek (resp. prvních 100, což je výchozí stránkování):

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

Vrácení seznamu objednávek ve stavu pending (nevyřízené):

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

Vrácení seznamu objednávek, jejichž ID je větší než 1234:

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

Máte-li jakýkoliv problém či dotaz ohledně provizního systému, využijte diskuzní fórum (veřejně viditelné), pro soukromou komunikaci použijte kontaktní formulář.