Dokumentace API - Kategorie
Základní informace
Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace
Seznam kategorií
- 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 metoda: GET
- hlavičky:
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
- parametry - slouží pro filtrování výstupu:
creation_time_from
(date) - pouze kategorie vytvořené od datalast_update_time_from
(date) - pouze kategorie u kterých došlo ke změně od datacode
(string) - kód kategoriecodes
(string) - kódy kategorií oddělené středníkem;
active_yn
(bool) - aktivní / neaktivnílanguage
(language) - jazyk kategoriepage
(int) - stránka, pokud není definováno, vrací vždy stranu 1
Odpověď
Seznam kategorií je dostupný po jednotlivých stranách, výstup je omezen na 100 položek na stránku.
-
tělo:
current_page
(int) - aktuální stranacurrent_page_items
(int) - počet položek na aktuální straněnumber_of_pages
(int) - celkový počet strannumber_of_items
(int) - celkový počet položekcategories
(array) - pole objektů s kategoriemicode
(string) - kód kategoriecategory_id
(int) - ID kategorieparent_id
(int) - ID nadřazené kategorieposition
(int) - pozice v nadřazené kategoriiactive_yn
(bool) - zobrazit kategorii na webutype
(string) - typ kategorie, možné hodnoty jsou:- homepage - odkaz na hlavní stránku
- news - odkaz na aktuality
- individual - odkaz na samostatnou stránku
- url - externí odkaz
- site - stránka
- siteWithProducts - stránka s produkty
- linkCategory - odkaz na kategorii
- advisor - odkaz na rádce
type_of_items
(string) - Typ položek, možné hodnoty:- withoutSubcategories - bez podkategorií (výchozí, v kategorii budou ručně vložené produkty)
- label - štítek (v kategorii budou produkty které mají aktivní určený štítek)
- manufacturer - výrobce (v kategorii budou produkty které mají určeného výrobce)
manufacturer
(string) - název výrobce. Bere se v úvahu pouze pokud je hodnota tagutype_of_items
manufacturer.label
(string) - název štítku. Bere se v úvahu pouze pokud je hodnota tagutype_of_items
label.
show_in_menu_yn
(bool) - zobrazit kategorii v menudescriptions
(array) - pole objektů s textylanguage
(language) - specifikace jazykové mutacename
- název kategoriename_h1
(string) - nadpis stránky v kategoriidescription_text
(string) - text stránkyurl
(string) - url kategorielink_url
(string) - url adresa na kterou bude vést kategorie. bere se v úvahu pouze pokud je hodnota tagutype
linkcategory.
images
(array) - pole objektů s cenamiurl
(string) - URL adresa obrázkumain_yn
(bool) - hlavní obrázeklist_yn
(bool) - seznamový obrázekposition
(int) - pozice obrázkutitles
(array) - pole objektů s popiskylanguage
(language) - specifikace jazykové mutacetitle
(string) - popisek obrázku
creation_time
(date) - datum a čas vytvořenílast_update_time
(date) - datum a čas poslední změnyadmin_url
(string) - url do detailu kategorie v administraci
-
příklad odpovědi (HTTP 200 OK)
HTTP/1.1 200 OK Content-Type: application/json { "current_page": "", "current_page_items": "", "number_of_pages": "", "number_of_items": "", "categories": [ { "code": "", "category_id": "", "parent_id": "", "position": "", "active_yn": "", "type": "", "type_of_items": "", "manufacturer": "", "show_in_menu_yn": "", "descriptions": [ { "language": "", "name": "", "name_h1": "", "description_text": "", "url": "" "lunk_url": "" } ], "images": [ { "url": "", "main_yn": "", "list_yn": "", "position": "", "titles": [ { "language": "", "title": "" } ] } ], "creation_time": "", "last_update_time": "", "admin_url": "", } ] }