API – seznamy, filtrování, stránkování

zpět na přehled API

Některé API metody vrací seznam nějakých položek (příchody, objednávky, pohyby na provizním účtu aj.). Tyto metody mají společné funkce a společné vstupní parametry a výstupní data.

Výstupní data

Součástí výsledku volání metod pro čtení seznamů jsou vždy následující položky:

• results – pole objektů s jednotlivými položkami seznamu
• page – číslo stránky (viz. dále stránkování)
• count – počet vrácených položek
• filteredCount – počet všech položek, které odpovídají aktuálnímu filtru (viz. dále filtrování)
• totalCount – počet všech položek

Příklad odpovědi (konkrétní položky zde nejsou uvedeny):

{
    "results": [
        ...
    ],
    "page": 1,
    "count": 10,
    "filteredCount": 18,
    "totalCount": 624,
    "requestId": "..."
}

Toto konkrétně znamená, že v databázi pro aktuálního partnera existuje celkem 624 položek (např. objednávek), z toho 18 odpovídá nastaveným filtrům a vráceno bylo prvních 10 (první stránka, stránkování po 10 položkách).

Filtrování

V požadavku na seznam lze uvést jeden nebo více filtrů. Ty se uvádí jako GET parametry. Podle toho se vyberou položky, které jsou vráceny.

Všechny metody vracející seznam nabízí následující filtry:

• ID – vypsání pouze položky s konkrétním ID záznamu
• lastID – vypsání pouze položek, jejich ID je větší než uvedenému číslo – vhodné pro vypsání pouze nových položek od poslední známé

Například požadavek na vypsání objednávek, jejichž ID je větší než 1234, vypadá takto:

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

Stránkování

Položky seznamů lze stránkovat, tedy vracet jen po určitých počtech. API umožňuje vrácení nejvýše 1000 položek při jednom volání. Výchozí stránkování je 100 položek.

Pro stránkování a/nebo omezení počtu vracených položek lze použít tyto vstupní GET parametry:

• page – číslo stránky (výchozí 1)
• count – počet vracených položek, tj. velikost stránky (výchozí 100)

Příklad výpisu 10 položek na druhé stránce (tedy položky 11 až 20):

https://api.wedos.as/partner/orders?page=2&count=10

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ář.