Články

více o článcích v Upgates e-shopech naleznete zde.

Seznam článků

GET

/api/v2/articles

Seznam článků je dostupný po jednotlivých stranách. Výstup je omezen na 100 položek na stránku.

Seznam článků › query Parameters

creation_time_from

DateTime · date-time

pouze články vytvořené od zadaného data

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

last_update_time_from

DateTime · date-time

pouze články, u kterých došlo ke změně od zadaného data

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

active_yn

boolean

aktivní / neaktivní

language

Language

jazyk

kód jazyka dle ISO 639-1

category_code

string

pouze články patřící do kategorie s kódem

with_subcategories_yn

boolean

specifikace filtru category_code, rozšiřuje i o články z podkategorie

page

integer

stránka

Default: 1

Seznam článků › 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 články

GET/api/v2/articles

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

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "articles": [
    {
      "article_id": 0,
      "active_yn": true,
      "creation_time": "2026-04-28T13:57:48+02:00",
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "descriptions": [
        {
          "language_id": "cz",
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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"
        }
      ]
    }
  ]
}

json

application/json

Aktualizace článků

PUT

/api/v2/articles

Aktualizace článků › Request Body

object[] · required

pole objektů s články

Aktualizace článků › Responses

200

object[]

pole objektů s články

PUT/api/v2/articles

curl --request PUT \
  --url /api/v2/articles \
  --header 'Content-Type: application/json' \
  --data '
{
  "articles": [
    {
      "article_id": 0,
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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

{
  "articles": [
    {
      "article_id": 0,
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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

{
  "articles": [
    {
      "article_id": 0,
      "updated_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření článků

POST

/api/v2/articles

Vytvoření článků › Request Body

object[] · required

pole objektů s články

Vytvoření článků › Responses

200

object[]

pole objektů s články

POST/api/v2/articles

curl --request POST \
  --url /api/v2/articles \
  --header 'Content-Type: application/json' \
  --data '
{
  "articles": [
    {
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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

{
  "articles": [
    {
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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

{
  "articles": [
    {
      "article_id": 0,
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání článků

DELETE

/api/v2/articles

Smazání článků › query Parameters

id

integer

ID konkrétního článku ke smazání

ids

QueryParameterArrayInt

ID článků oddělené středníkem ; nebo jako pole

Smazání článků › Responses

200

object[]

pole objektů se články

Detail článku

GET

/api/v2/articles/{id}

Detail článku › path Parameters

id

integer · required

ID konkrétního článku v URL cestě

Detail článku › 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 články

GET/api/v2/articles/{id}

curl --request GET \
  --url /api/v2/articles/:id

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "articles": [
    {
      "article_id": 0,
      "active_yn": true,
      "creation_time": "2026-04-28T13:57:48+02:00",
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "descriptions": [
        {
          "language_id": "cz",
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "bottom_description": "bottom_description",
          "url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "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"
        }
      ]
    }
  ]
}

json

application/json

Ceníky Dostupnosti

Seznam článků

GET

/api/v2/articles

Seznam článků je dostupný po jednotlivých stranách. Výstup je omezen na 100 položek na stránku.

Seznam článků › query Parameters

creation_time_from

DateTime · date-time

pouze články vytvořené od zadaného data

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

last_update_time_from

DateTime · date-time

pouze články, u kterých došlo ke změně od zadaného data

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

active_yn

boolean

aktivní / neaktivní

language

Language

jazyk

kód jazyka dle ISO 639-1

category_code

string

pouze články patřící do kategorie s kódem

with_subcategories_yn

boolean

specifikace filtru category_code, rozšiřuje i o články z podkategorie

page

integer

stránka

Default: 1

Seznam článků › 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 články

Detail článku

GET

/api/v2/articles/{id}

Detail článku › path Parameters

id

integer · required

ID konkrétního článku v URL cestě

Detail článku › 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 články