Produkty

unikátním identifikátorem produktů a variant je kód (code).
pokud produkt nemá vyplněný kód, není možné jej založit, editovat a ani mazat.
pro práci s produkty lze využívat webhooky.
více o produktech v Upgates e-shopech naleznete zde.

POZOR!
Kód produktu není povinný. Doporučujeme využívat při komunikaci spíše ID.

Aktualizace produktu

PUT

/api/v2/products

produkty a varianty se párují podle hodnoty code, ta musí být unikátní
pokud bude jakákoliv hodnota u variant null dědí se od produktu
štítky u variant - když budou mít atributy active_yn, active_from, active_to hodnotu NULL, bude se štítek dědit z produktu
maximální počet produktů a variant při jednom požadavku je 100 (max. 100 variant na produkt)
při překročení limitu se všechny položky ignorují

Aktualizace produktu › Request Body

object[]

pole objektů s produkty

Aktualizace produktu › Responses

200

object[]

pole objektů s produkty

PUT/api/v2/products

curl --request PUT \
  --url /api/v2/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {
      "code": "code",
      "code_supplier": "code_supplier",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "ean": "ean",
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "stock": 0,
      "stock_increment": 0,
      "stock_position": "stock_position",
      "limit_orders": "0",
      "availability_id": 0,
      "availability": "availability",
      "manufacturer_id": 0,
      "manufacturer": "manufacturer",
      "weight": 0,
      "shipment_group": "shipment_group",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "add_images_into_variants_yn": true,
      "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
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0
        }
      ],
      "vats": {},
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "parameters": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "active_yn": true,
          "main_yn": true,
          "ean": "ean",
          "stock": 0,
          "stock_increment": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "can_add_to_basket_yn": true,
          "image": {
            "file_id": 0,
            "url": "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
                }
              ]
            }
          ],
          "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
            }
          ],
          "labels": [
            {
              "label_id": 0,
              "name": {
                "cz": "cz"
              },
              "active_currently_yn": true,
              "active_yn": true,
              "active_from": "2026-04-28",
              "active_to": "2026-04-28"
            }
          ],
          "parameters": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "name": "name"
                }
              ],
              "values": [
                {
                  "id": 0,
                  "descriptions": [
                    {
                      "language": "cz",
                      "value": "value"
                    }
                  ]
                }
              ]
            }
          ],
          "metas": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "related": [
        "string"
      ],
      "accessories": [
        "string"
      ],
      "alternative": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "products": [
    {
      "code": "code",
      "code_supplier": "code_supplier",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "ean": "ean",
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "stock": 0,
      "stock_increment": 0,
      "stock_position": "stock_position",
      "limit_orders": "0",
      "availability_id": 0,
      "availability": "availability",
      "manufacturer_id": 0,
      "manufacturer": "manufacturer",
      "weight": 0,
      "shipment_group": "shipment_group",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "add_images_into_variants_yn": true,
      "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
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0
        }
      ],
      "vats": {},
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "parameters": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "active_yn": true,
          "main_yn": true,
          "ean": "ean",
          "stock": 0,
          "stock_increment": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "can_add_to_basket_yn": true,
          "image": {
            "file_id": 0,
            "url": "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
                }
              ]
            }
          ],
          "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
            }
          ],
          "labels": [
            {
              "label_id": 0,
              "name": {
                "cz": "cz"
              },
              "active_currently_yn": true,
              "active_yn": true,
              "active_from": "2026-04-28",
              "active_to": "2026-04-28"
            }
          ],
          "parameters": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "name": "name"
                }
              ],
              "values": [
                {
                  "id": 0,
                  "descriptions": [
                    {
                      "language": "cz",
                      "value": "value"
                    }
                  ]
                }
              ]
            }
          ],
          "metas": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "related": [
        "string"
      ],
      "accessories": [
        "string"
      ],
      "alternative": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "products": [
    {
      "product_id": 0,
      "code": "code",
      "product_url": "https://www.example.com/path/to/resource",
      "updated_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ],
      "variants": [
        {
          "variant_id": 0,
          "code": "code",
          "updated_yn": true,
          "messages": [
            {
              "object": "object",
              "property": "property",
              "message": "message",
              "level": "info"
            }
          ]
        }
      ]
    }
  ]
}

json

application/json

Vytvoření produktů

POST

/api/v2/products

produkty a varianty se párují podle hodnoty code, ta musí být unikátní
pokud bude jakákoliv hodnota u variant null dědí se od produktu
štítky u variant - když budou mít atributy active_yn, active_from, active_to hodnotu NULL, bude se štítek dědit z produktu
maximální počet produktů a variant založených při jednom požadavku je 100 (100 produktů celkem a max. 100 variant na produkt)
při překročení limitu se všechny položky ignorují

Vytvoření produktů › Request Body optional

object[]

pole objektů s produkty

Vytvoření produktů › Responses

200

object[]

POST/api/v2/products

curl --request POST \
  --url /api/v2/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {
      "code": "code",
      "code_supplier": "code_supplier",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "ean": "ean",
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "stock": 0,
      "stock_position": "stock_position",
      "limit_orders": "0",
      "availability_id": 0,
      "availability": "availability",
      "manufacturer_id": 0,
      "manufacturer": "manufacturer",
      "weight": 0,
      "shipment_group": "shipment_group",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "add_images_into_variants_yn": true,
      "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
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0
        }
      ],
      "vats": {},
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "parameters": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "active_yn": true,
          "main_yn": true,
          "ean": "ean",
          "stock": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "can_add_to_basket_yn": true,
          "image": {
            "file_id": 0,
            "url": "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
                }
              ]
            }
          ],
          "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
            }
          ],
          "labels": [
            {
              "label_id": 0,
              "name": {
                "cz": "cz"
              },
              "active_currently_yn": true,
              "active_yn": true,
              "active_from": "2026-04-28",
              "active_to": "2026-04-28"
            }
          ],
          "parameters": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "name": "name"
                }
              ],
              "values": [
                {
                  "id": 0,
                  "descriptions": [
                    {
                      "language": "cz",
                      "value": "value"
                    }
                  ]
                }
              ]
            }
          ],
          "metas": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "related": [
        "string"
      ],
      "accessories": [
        "string"
      ],
      "alternative": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "products": [
    {
      "code": "code",
      "code_supplier": "code_supplier",
      "active_yn": true,
      "archived_yn": true,
      "replacement_product_code": "replacement_product_code",
      "ean": "ean",
      "descriptions": [
        {
          "language": "cz",
          "active_yn": true,
          "title": "title",
          "short_description": "short_description",
          "long_description": "long_description",
          "seo_title": "seo_title",
          "seo_description": "seo_description",
          "seo_url": "seo_url"
        }
      ],
      "stock": 0,
      "stock_position": "stock_position",
      "limit_orders": "0",
      "availability_id": 0,
      "availability": "availability",
      "manufacturer_id": 0,
      "manufacturer": "manufacturer",
      "weight": 0,
      "shipment_group": "shipment_group",
      "can_add_to_basket_yn": true,
      "adult_yn": true,
      "add_images_into_variants_yn": true,
      "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
            }
          ]
        }
      ],
      "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
            }
          ]
        }
      ],
      "stocks": [
        {
          "stock_id": 0,
          "code": "code",
          "position": "position",
          "quantity": 0
        }
      ],
      "categories": [
        {
          "category_id": 0,
          "code": "code",
          "main_yn": true,
          "position": 0
        }
      ],
      "prices": [
        {
          "language": "cz",
          "pricelists": [
            {
              "name": "name",
              "price_original": 0,
              "product_discount": 0,
              "price_sale": 0
            }
          ],
          "price_purchase": 0,
          "price_common": 0
        }
      ],
      "vats": {},
      "labels": [
        {
          "label_id": 0,
          "name": {
            "cz": "cz"
          },
          "active_currently_yn": true,
          "active_yn": true,
          "active_from": "2026-04-28",
          "active_to": "2026-04-28"
        }
      ],
      "parameters": [
        {
          "id": 0,
          "descriptions": [
            {
              "language": "cz",
              "name": "name"
            }
          ],
          "values": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "value": "value"
                }
              ]
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "active_yn": true,
          "main_yn": true,
          "ean": "ean",
          "stock": 0,
          "stock_position": "stock_position",
          "availability_id": 0,
          "availability": "availability",
          "can_add_to_basket_yn": true,
          "image": {
            "file_id": 0,
            "url": "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
                }
              ]
            }
          ],
          "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
            }
          ],
          "labels": [
            {
              "label_id": 0,
              "name": {
                "cz": "cz"
              },
              "active_currently_yn": true,
              "active_yn": true,
              "active_from": "2026-04-28",
              "active_to": "2026-04-28"
            }
          ],
          "parameters": [
            {
              "id": 0,
              "descriptions": [
                {
                  "language": "cz",
                  "name": "name"
                }
              ],
              "values": [
                {
                  "id": 0,
                  "descriptions": [
                    {
                      "language": "cz",
                      "value": "value"
                    }
                  ]
                }
              ]
            }
          ],
          "metas": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ],
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "related": [
        "string"
      ],
      "accessories": [
        "string"
      ],
      "alternative": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "products": [
    {
      "product_id": 0,
      "code": "code",
      "product_url": "https://www.example.com/path/to/resource",
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ],
      "variants": [
        {
          "variant_id": 0,
          "code": "code",
          "inserted_yn": true,
          "messages": [
            {
              "object": "object",
              "property": "property",
              "message": "message",
              "level": "info"
            }
          ]
        }
      ]
    }
  ]
}

json

application/json

Smazání produktů

DELETE

/api/v2/products

Smazání jednoho produktu pomocí code nebo více produktů pomocí query parametru codes.

Smazání produktů › query Parameters

code

string

kód produktu

codes

QueryParameterArrayString

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

Smazání produktů › Responses

200

object[]

pole objektů s produkty

Produkt

GET

/api/v2/products/{code}

Produkt › path Parameters

code

string · required

kód produktu

Produkt › 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/{code}

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

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

Detail produktu (zjednodušený)

GET

/api/v2/products/{code}/simple

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

Detail produktu (zjednodušený) › path Parameters

code

string · required

kód produktu

Detail produktu (zjednodušený) › 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/{code}/simple

curl --request GET \
  --url /api/v2/products/:code/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

Detail produktu (ceny)

GET

/api/v2/products/{code}/prices

Detail produktu (ceny) › path Parameters

code

string · required

kód produktu

Detail produktu (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/{code}/prices

curl --request GET \
  --url /api/v2/products/:code/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

Detail produktu (parametry)

GET

/api/v2/products/{code}/parameters

Detail produktu (parametry) › path Parameters

code

string · required

kód produktu

Detail produktu (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/{code}/parameters

curl --request GET \
  --url /api/v2/products/:code/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

Detail produktu (štítky)

GET

/api/v2/products/{code}/labels

Detail produktu (štítky) › 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

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.

variants_yn

boolean

pokud FALSE, nevrací varianty (variants)

page

integer

stránka

Default: 1

Detail 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/{code}/labels

curl --request GET \
  --url /api/v2/products/:code/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

Detail produktu (soubory)

GET

/api/v2/products/{code}/files

Detail produktu (soubory) › path Parameters

code

string · required

kód produktu

Detail produktu (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/{code}/files

curl --request GET \
  --url /api/v2/products/:code/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

Detail produktu (související)

GET

/api/v2/products/{code}/related

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

Detail produktu (související) › path Parameters

code

string · required

kód produktu

Detail produktu (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[]

Přidání obrázku

POST

/api/v2/products/{code}/images

Nahraje obrázek k produktu přes form-data. Soubor se posílá v poli file.

Přidání obrázku › path Parameters

id

string · required

ID produktu

Přidání obrázku › Request Body

file

string · binary · required

obsah souboru (obrázek)

file_name

string

název souboru (volitelné)

Přidání obrázku › Responses

200

object

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

Fronta obrázků ke stažení

GET

/api/v2/products/images-queue

Vrací seznam obrázků, který čeká na stažení na pozadí.

Jsou to obrázky, které byly přidány přes API endpoint vytvoření produktu nebo aktualizace produktu.

Obrázky, které se nepodařilo stáhnout (mají attempts_count větší než 5), se po 14 dnech mažou.

Pokud není parametr page definováno, vrací vždy stranu 1.

Fronta obrázků ke stažení › query Parameters

code

string

kód produktu

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 ; nebo jako pole

page

integer

stránka

Default: 1

Fronta obrázků ke stažení › Responses

200

object[]

chybové zprávy

Smazání variant

DELETE

/api/v2/products/variants

Smaže varianty podle kódů.

Smazání variant › query Parameters

codes

QueryParameterArrayString · required

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

Smazání variant › Responses

200

object[]

pole objektů s variantami

Platby Produkty - seznamy