Dokumentácia API - Kategórie
Základné informácie
Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie.
Zoznam kategórií
- URI: /api/v2/categories/?creation_time_from={creation_time_from} &last_update_time_from={last_update_time_from} &code={code} &codes={codes} &active_yn={active_yn} &language={language} &page={page}
- HTTP metóda: GET
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- parametre - slúžia pre filtrovanie výstupu:
- creation_time_from (date) - len kategórie vytvorené od dátumu
- last_update_time_from (date) - len kategórie, pri ktorých došlo k zmene od dátumu
- code (string) - kód kategórie
- codes (string) - kódy kategórií oddelené bodkočiarkou ;
- active_yn (bool) - aktívne / neaktívne
- language (language) - jazyk kategórie
- page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1
Odpoveď
Zoznam kategórií je dostupný po jednotlivých stranách, výstup je obmedzený na 100 položiek na stránku.
- telo:
- current_page (int) - aktuálna strana
- current_page_items (int) - počet položiek na aktuálnej strane
- number_of_pages (int) - celkový počet strán
- number_of_items (int) - celkový počet položiek
- categories (array) - pole objektov s kategóriami
- code (string) - kód kategórie
- category_id (int) - ID kategórie
- parent_id (int) - ID nadradenej kategórie
- position (int) - pozícia v nadradenej kategórii
- active_yn (bool) - zobraziť kategóriu na webe
- type (string) - typ kategórie, možné hodnoty sú:
- homepage - odkaz na hlavnú stránku
- news - odkaz na aktuality
- individual - odkaz na samostatnú stránku
- url - externý odkaz
- site - stránka
- siteWithProducts - stránka s produktmi
- linkCategory - odkaz na kategóriu
- advisor - odkaz na radcu
- type_of_items (string) - Typ položiek, možné hodnoty:
- withoutSubcategories - bez podkategórií (východiskové, v kategórii budú ručne vložené produkty)
- label - štítok (v kategórii budú produkty, ktoré majú aktívny určený štítok)
- manufacturer - výrobca (v kategórii budú produkty, ktoré majú určeného výrobcu)
- manufacturer (string) - názov výrobcu. Berie sa do úvahy len pokiaľ je hodnota tagu type_of_items manufacturer.
- label (string) - názov štítka. Berie sa do úvahy len pokiaľ je hodnota tagu type_of_items label.
- show_in_menu_yn (bool) - zobraziť kategóriu v menu
- descriptions (array) - pole objektov s textami
- language (language) - špecifikácie jazykovej mutácie
- name - názov kategórie
- name_h1 (string) - nadpis stránky v kategórii
- description_text (string) - text stránky
- url (string) - url kategórie
- link_url (string) - url adresa, na ktorú bude viesť kategória. Berie sa do úvahy len pokiaľ je hodnota tagu typu linkcategory.
- images (array) - pole objektov s cenami
- url (string) - URL adresa obrázka
- main_yn (bool) - hlavný obrázok
- list_yn (bool) - zoznamový obrázok
- position (int) - pozícia obrázka
- titles (array) - pole objektov s popiskami
- language (language) - špecifikácia jazykovej mutácie
- title (string) - popis obrázka
- creation_time (date) - dátum a čas vytvorenia
- last_update_time (date) - dátum a čas poslednej zmeny
- admin_url (string) - url do detailu kategórie v administrácii
príklad odpovede (HTTP 200 OK)
