Produkty - seznamy

pro práci s produkty lze využívat webhooky.
více o produktech v Upgates e-shopech naleznete zde.

Kompletní seznam

GET

/api/v2/products

Vrátí kompletní seznam produktů.

Pokud není parametr page definováno, vrací vždy stranu 1. Pokud není definován parametr language ani languages, vrací produkty a data ve všech jazycích.

Kompletní seznam › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

language

string

jazyk. Vrací pouze produkty v aktivním jazyce a pouze s daty, které se vážou na jazyk (např. ceny a texty atd.). Pokud není definováno, vrací produkty a data ve všech jazycích

languages

QueryParameterArrayString

jazyky. Vrací pouze produkty v aktivních jazycích a pouze s daty, které se vážou na jazyk (např. ceny a texty atd.). Pokud není definováno, vrací produkty a data ve všech jazycích. Jazyky oddělujte středníkem ; nebo jako pole

pricelist

string

název ceníku. Vrátí produkty pouze s tímto ceníkem

variants_yn

boolean

když je FALSE nevrací varianty

page

integer

stránka

Default: 1

Kompletní seznam › 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 produkty

GET/api/v2/products

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

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "action_currently_yn": 0,
      "code_supplier": "code_supplier",
      "supplier": "supplier",
      "ean": "ean",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "add_images_into_variants_yn": true,
      "set_yn": true,
      "in_set_yn": true,
      "exclude_from_search_yn": true,
      "descriptions": [
        {
          "language": "cz",
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "url": "https://www.example.com/path/to/resource",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url",
          "unit": "unit"
        }
      ],
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "stock": 0,
      "stock_position": "stock_position",
      "limit_orders": "0",
      "availability_id": 0,
      "availability": "availability",
      "availability_type": "OnRequest",
      "variants_exists_yn": true,
      "variants_stock": 0,
      "variants_availability_id": 0,
      "variants_availability": "variants_availability",
      "variants_availability_type": "variants_availability_type",
      "weight": 0,
      "shipment_group": "shipment_group",
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0,
          "name": "name"
        }
      ],
      "groups": [
        {}
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0,
          "vat": 0,
          "recycling_fee": 0
        }
      ],
      "vats": {
        "key": 0
      },
      "variants": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "ean": "ean",
          "variant_id": 0,
          "product_code": "product_code",
          "product_id": 0,
          "active_yn": true,
          "main_yn": true,
          "can_add_to_basket_yn": true,
          "stock": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "availability_type": "OnRequest",
          "weight": 0,
          "image": "image",
          "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
                }
              ]
            }
          ],
          "stocks": [
            {
              "stock_id": 0,
              "code": "code",
              "position": "position",
              "quantity": 0
            }
          ],
          "prices": [
            {
              "language": "cz",
              "pricelists": [
                {
                  "name": "name",
                  "price_original": 0,
                  "product_discount": 0,
                  "price_sale": 0
                }
              ],
              "price_purchase": 0,
              "price_common": 0,
              "vat": 0,
              "recycling_fee": 0
            }
          ],
          "metas": [
            {
              "key": "key",
              "type": "checkbox",
              "value": "value"
            }
          ]
        }
      ],
      "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

Zjednodušený seznam

GET

/api/v2/products/simple

Vrací zjednodušený seznam produktů bez rozšířených dat.

Zjednodušený seznam › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

variants_yn

boolean

pokud FALSE, nevrací varianty (variants)

page

integer

stránka

Default: 1

Zjednodušený seznam › 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[]

GET/api/v2/products/simple

curl --request GET \
  --url /api/v2/products/simple

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "code_supplier": "code_supplier",
      "supplier": "supplier",
      "ean": "ean",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "set_yn": true,
      "in_set_yn": true,
      "exclude_from_search_yn": true,
      "manufacturer": "manufacturer",
      "manufacturer_id": 0,
      "stock": 0,
      "stock_position": "stock_position",
      "availability_id": 0,
      "availability": "availability",
      "availability_type": "OnRequest",
      "variants_exists_yn": true,
      "variants_stock": 0,
      "variants_availability_id": 0,
      "variants_availability": "variants_availability",
      "variants_availability_type": "variants_availability_type",
      "limit_orders": "0",
      "weight": 0,
      "shipment_group": "shipment_group",
      "add_images_into_variants_yn": true,
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "groups": [
        {}
      ],
      "variants": [
        {
          "code": "code",
          "variant_id": 0,
          "product_code": "product_code",
          "product_id": 0,
          "code_supplier": "code_supplier",
          "ean": "ean",
          "active_yn": true,
          "main_yn": true,
          "can_add_to_basket_yn": true,
          "stock": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "availability_type": "OnRequest",
          "weight": 0,
          "image": "image",
          "stocks": [
            {
              "stock_id": 0,
              "code": "code",
              "position": "position",
              "quantity": 0
            }
          ]
        }
      ],
      "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

Ceny

GET

/api/v2/products/prices

Vrací seznam produktů s cenami a cenami variant.

Ceny › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

language

string

jazyk. Vrací pouze produkty v aktivní jazyce a pouze s daty, které se vážou na jazyk (např. ceny a texty atd.). Pokud není definováno, vrací produkty a data ve všech jazycích

languages

QueryParameterArrayString

pricelist

string

název ceníku, vrací pouze ceny v zadaném ceníku

variants_yn

boolean

pokud FALSE, nevrací varianty

page

integer

stránka

Default: 1

Ceny › 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[]

GET/api/v2/products/prices

curl --request GET \
  --url /api/v2/products/prices

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "action_currently_yn": true,
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0,
          "vat": 0,
          "recycling_fee": 0
        }
      ],
      "variants": [
        {
          "code": "code",
          "variant_id": 0,
          "action_currently_yn": true,
          "prices": [
            {
              "language": "cz",
              "pricelists": [
                {
                  "name": "name",
                  "price_original": 0,
                  "product_discount": 0,
                  "price_sale": 0
                }
              ],
              "price_purchase": 0,
              "price_common": 0,
              "vat": 0,
              "recycling_fee": 0
            }
          ]
        }
      ],
      "admin_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Parametry

GET

/api/v2/products/parameters

Vrací seznam produktů s parametry a parametry variant.

Parametry › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

language

string

jazyk. Vrací pouze produkty v aktivní jazyce a pouze s daty, které se vážou na jazyk (např. ceny a texty atd.). Pokud není definováno, vrací produkty a data ve všech jazycích

languages

QueryParameterArrayString

variants_yn

boolean

pokud FALSE, nevrací varianty (variants)

page

integer

stránka

Default: 1

Parametry › 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[]

GET/api/v2/products/parameters

curl --request GET \
  --url /api/v2/products/parameters

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "parameters": [
        {
          "name": {
            "cz": "cz"
          },
          "values": [
            {
              "cz": "cz"
            }
          ]
        }
      ],
      "parameters_new": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "code",
          "variant_id": 0,
          "parameters": [
            {
              "name": {
                "cz": "cz"
              },
              "values": [
                {
                  "cz": "cz"
                }
              ]
            }
          ],
          "parameters_new": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "name": "name"
                }
              ],
              "values": [
                {
                  "id": 0,
                  "descriptions": [
                    {
                      "language": "cz",
                      "value": "value"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "admin_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Štítky

GET

/api/v2/products/labels

Vrací seznam produktů se štítky.

Štítky › path Parameters

code

string · required

kód produktu

Štítky › 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 produkty

GET/api/v2/products/labels

curl --request GET \
  --url /api/v2/products/labels

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "variants": [
        {
          "code": "code",
          "variant_id": 0,
          "labels": [
            {
              "label_id": 0,
              "name": {
                "cz": "cz"
              },
              "active_currently_yn": true,
              "active_yn": true,
              "active_from": "2026-04-28",
              "active_to": "2026-04-28"
            }
          ]
        }
      ],
      "admin_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Soubory

GET

/api/v2/products/files

Vrací seznam produktů se soubory.

Soubory › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

language

Language

kód jazyka dle ISO 639-1

languages

QueryParameterArrayString

jazyky oddělené ; nebo jako pole

with_files_yn

boolean

pokud TRUE, vrátí pouze produkty se soubory

page

integer

stránka

Default: 1

Soubory › 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 produkty

GET/api/v2/products/files

curl --request GET \
  --url /api/v2/products/files

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "products": [
    {
      "code": "code",
      "product_id": 0,
      "files": [
        {
          "file_id": 0,
          "url": "https://www.example.com/path/to/resource",
          "position": 0,
          "titles": [
            {
              "language": "cz",
              "title": "title"
            }
          ],
          "languages": [
            {
              "language": "cz",
              "selected_yn": true
            }
          ]
        }
      ],
      "admin_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Související

GET

/api/v2/products/related

Vrací produkty pouze s vazbami na související, alternativní, příslušenství, dárky a sady.

Související › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

last_update_time_from

DateTime · date-time

vrátí produkty změněné od tohoto data

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

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

archived_yn

boolean

vrátí pouze archivované nebo nearchivované produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

exclude_from_search_yn

boolean

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

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

page

integer

stránka

Default: 1

Související › 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[]

Varianty

GET

/api/v2/products/variants

Vrací seznam variant produktů podle zadaných filtrů.

Varianty › path Parameters

code

string · required

kód produktu

Varianty › query Parameters

codes

QueryParameterArrayString

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

product_id

string

ID produktu

product_ids

QueryParameterArrayInt

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

variant_codes

QueryParameterArrayString

kódy variant oddělené středníkem ; (v případě použití tohoto parametru vrací produkt, který obsahuje požadovanou variantu)

active_yn

boolean

vrátí pouze aktivní nebo neaktivní produkty

can_add_to_basket_yn

boolean

lze přidat do košíku

in_stock_yn

boolean

vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi

language

Language

kód jazyka dle ISO 639-1

languages

QueryParameterArrayString

jazyky oddělené ; nebo jako pole

pricelist

string

název ceníku, vrací pouze ceny v zadaném ceníku

page

integer

stránka

Default: 1

Varianty › 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[]

GET/api/v2/products/variants

curl --request GET \
  --url /api/v2/products/variants

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "variants": [
    {
      "code": "code",
      "variant_id": 0,
      "product_code": "product_code",
      "product_id": 0,
      "action_currently_yn": true,
      "parameters": [
        {
          "name": {
            "cz": "cz"
          },
          "values": [
            {
              "cz": "cz"
            }
          ]
        }
      ],
      "parameters_new": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "code_supplier": "code_supplier",
      "ean": "ean",
      "active_yn": true,
      "main_yn": true,
      "can_add_to_basket_yn": true,
      "stock": 0,
      "stock_position": "stock_position",
      "availability_id": 0,
      "availability": "availability",
      "availability_type": "OnRequest",
      "weight": 0,
      "image": "image",
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0,
          "vat": 0,
          "recycling_fee": 0
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Produkty Produkty - recenze a hodnocení