20. 01. 2023

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 data
- last_update_time_from (date) - pouze kategorie u kterých došlo ke změně od data
- code (string) - kód kategorie
- codes (string) - kódy kategorií oddělené středníkem ;
- active_yn (bool) - aktivní / neaktivní
- language (language) - jazyk kategorie
- page (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í strana
- current_page_items (int) - počet položek na aktuální straně
- number_of_pages (int) - celkový počet stran
- number_of_items (int) - celkový počet položek
- categories (array) - pole objektů s kategoriemi
  - code (string) - kód kategorie
  - category_id (int) - ID kategorie
  - parent_id (int) - ID nadřazené kategorie
  - position (int) - pozice v nadřazené kategorii
  - active_yn (bool) - zobrazit kategorii na webu
  - type (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 tagu type_of_items manufacturer.
  - label (string) - název štítku. Bere se v úvahu pouze pokud je hodnota tagu type_of_items label.
- show_in_menu_yn (bool) - zobrazit kategorii v menu
  - descriptions (array) - pole objektů s texty
    - language (language) - specifikace jazykové mutace
    - name - název kategorie
    - name_h1 (string) - nadpis stránky v kategorii
    - description_text (string) - text stránky
    - url (string) - url kategorie
    - link_url (string) - url adresa na kterou bude vést kategorie. bere se v úvahu pouze pokud je hodnota tagu type linkcategory.
  - images (array) - pole objektů s cenami
    - url (string) - URL adresa obrázku
    - main_yn (bool) - hlavní obrázek
    - list_yn (bool) - seznamový obrázek
    - position (int) - pozice obrázku
    - titles (array) - pole objektů s popisky
      - language (language) - specifikace jazykové mutace
      - title (string) - popisek obrázku
  - creation_time (date) - datum a čas vytvoření
  - last_update_time (date) - datum a čas poslední změny
  - admin_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": "",
        }
    ]
}

Další zdroje informací