Kategorie

unikátním identifikátorem kategorie je kód (code) nebo ID (category_id).
pro práci s kategoriemi lze využívat webhooky.
více o kategoriích v Upgates najdete zde.

Seznam kategorií

GET

/api/v2/categories

Seznam kategorií je dostupný po jednotlivých stranách, výstup je omezený na 100 položek na stránku. Seznam kategorií je seřazen podle rodiče a podle pozice, tzn. že první jsou rodičovské kategorie a potom potomci.

Seznam kategorií › query Parameters

creation_time_from

DateTime · date-time

pouze kategorie vytvořené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí kategorie změněné od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

code

string

kód kategorie

codes

QueryParameterArrayString

kódy kategorií oddělené středníkem ; nebo jako pole

category_id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

parent_id

integer

ID nadřazené kategorie

active_yn

boolean

aktivní / neaktivní

exclude_from_search_yn

boolean

příznak vyřadit z vyhledávání

language

Language

jazyk kategorie

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam kategorií › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s kategoriemi

GET/api/v2/categories

curl --request GET \
  --url /api/v2/categories

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "categories": [
    {
      "code": "code",
      "category_id": 0,
      "parent_code": "parent_code",
      "parent_id": 0,
      "position": 0,
      "active_yn": true,
      "type": "homepage",
      "type_of_items": "withSubcategories",
      "target_category_id": 0,
      "manufacturer": "manufacturer",
      "label": "label",
      "show_in_menu_yn": true,
      "exclude_from_search_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "name": "name",
          "name_h1": "name_h1",
          "short_description_text": "short_description_text",
          "description_text": "description_text",
          "bottom_description_text": "bottom_description_text",
          "url": "https://www.example.com/path/to/resource",
          "link_url": "link_url",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "images": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "main_yn": true,
          "list_yn": true,
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ],
      "creation_time": "2026-04-28T13:57:48+02:00",
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "admin_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Aktualizace kategorií

PUT

/api/v2/categories

Kategorie párují podle kódu (code) nebo ID (category_id). Pro správnou aktualizaci je potřeba poslat jeden z těchto údajů. Systémové kategorie které mají "parent_id": NULL nelze aktualizovat!

Aktualizace kategorií › Request Body

object[]

pole objektů s kategoriemi

Aktualizace kategorií › Responses

200

object[]

PUT/api/v2/categories

curl --request PUT \
  --url /api/v2/categories \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "category_id": 0,
      "code": "code",
      "parent_code": "parent_code",
      "parent_id": 0,
      "position": 0,
      "active_yn": true,
      "type": "homepage",
      "type_of_items": "withSubcategories",
      "target_category_id": 0,
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "label": "label",
      "label_id": 0,
      "show_in_menu_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "name": "name",
          "name_h1": "name_h1",
          "short_description_text": "short_description_text",
          "description_text": "description_text",
          "bottom_description_text": "bottom_description_text",
          "link_url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "images": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "main_yn": true,
          "list_yn": true,
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "categories": [
    {
      "category_id": 0,
      "code": "code",
      "parent_code": "parent_code",
      "parent_id": 0,
      "position": 0,
      "active_yn": true,
      "type": "homepage",
      "type_of_items": "withSubcategories",
      "target_category_id": 0,
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "label": "label",
      "label_id": 0,
      "show_in_menu_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "name": "name",
          "name_h1": "name_h1",
          "short_description_text": "short_description_text",
          "description_text": "description_text",
          "bottom_description_text": "bottom_description_text",
          "link_url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "images": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "main_yn": true,
          "list_yn": true,
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "categories": [
    {
      "code": "code",
      "category_id": 0,
      "updated_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření kategorií

POST

/api/v2/categories

Při vytváření stromu kategorií je potřeba poslat kategorie ve správném pořadí, tzn. napřed rodičovské kategorie a potom potomky.

Vytvoření kategorií › Request Body

object[]

pole objektů s kategoriemi

Vytvoření kategorií › Responses

200

object[]

POST/api/v2/categories

curl --request POST \
  --url /api/v2/categories \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "code": "code",
      "parent_code": "parent_code",
      "parent_id": 0,
      "position": 0,
      "active_yn": true,
      "type": "homepage",
      "type_of_items": "withSubcategories",
      "target_category_id": 0,
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "label": "label",
      "label_id": 0,
      "show_in_menu_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "name": "name",
          "name_h1": "name_h1",
          "short_description_text": "short_description_text",
          "description_text": "description_text",
          "bottom_description_text": "bottom_description_text",
          "link_url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "images": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "main_yn": true,
          "list_yn": true,
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "categories": [
    {
      "code": "code",
      "parent_code": "parent_code",
      "parent_id": 0,
      "position": 0,
      "active_yn": true,
      "type": "homepage",
      "type_of_items": "withSubcategories",
      "target_category_id": 0,
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "label": "label",
      "label_id": 0,
      "show_in_menu_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "name": "name",
          "name_h1": "name_h1",
          "short_description_text": "short_description_text",
          "description_text": "description_text",
          "bottom_description_text": "bottom_description_text",
          "link_url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "images": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "main_yn": true,
          "list_yn": true,
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "categories": [
    {
      "code": "code",
      "category_id": 0,
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání kategorií

DELETE

/api/v2/categories

Smaže kategorii včetně všech podkategorií. Nelze mazat systémové root kategorie ("parent_id": null).

Smazání kategorií › query Parameters

id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

code

string

kód kategorie

Smazání kategorií › Responses

200

object[]

pole objektů s kategoriemi

Jazyky Konverzní kódy

Seznam kategorií

GET

/api/v2/categories

Seznam kategorií › query Parameters

creation_time_from

DateTime · date-time

pouze kategorie vytvořené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí kategorie změněné od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

code

string

kód kategorie

codes

QueryParameterArrayString

kódy kategorií oddělené středníkem ; nebo jako pole

category_id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

parent_id

integer

ID nadřazené kategorie

active_yn

boolean

aktivní / neaktivní

exclude_from_search_yn

boolean

příznak vyřadit z vyhledávání

language

Language

jazyk kategorie

kód jazyka dle ISO 639-1

page

integer

stránka

Default: 1

Seznam kategorií › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s kategoriemi

Aktualizace kategorií

PUT

/api/v2/categories

Aktualizace kategorií › Request Body

object[]

pole objektů s kategoriemi

Aktualizace kategorií › Responses

200

object[]

Vytvoření kategorií

POST

/api/v2/categories

Při vytváření stromu kategorií je potřeba poslat kategorie ve správném pořadí, tzn. napřed rodičovské kategorie a potom potomky.

Vytvoření kategorií › Request Body

object[]

pole objektů s kategoriemi

Vytvoření kategorií › Responses

200

object[]

Smazání kategorií

DELETE

/api/v2/categories

Smaže kategorii včetně všech podkategorií. Nelze mazat systémové root kategorie ("parent_id": null).

Smazání kategorií › query Parameters

id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

code

string

kód kategorie

Smazání kategorií › Responses

200

object[]

pole objektů s kategoriemi