Produkty


Základní informace

Základní informace k API, autentizaci, stavové kódy, HTTP metody, datové typy a další najdete na API v2 základní informace

Aktualizace produktu

Požadavek

  • URI: /api/v2/products
  • HTTP metoda: PUT
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • tělo:
    • produkty se párují podle hodnoty code
    • pokud bude jakákoliv hodnota u variant null dědí se od produktu
    • products (array) - pole objektů s produkty
      • code (string) - kód produktu, páruje se podle existující hodnoty v databázi
      • active_yn (bool) - zobrazit produkt na webu
      • archived_yn (bool) - archivovaný produkt
      • replacement_product_code (string) - kód náhradního produktu, pouze pokud je produkt archivovaný
      • stock (float) - počet jednotek na skladě, v případě mínusové hodnoty se zapíše 0
      • availability (string) - název dostupnosti. Neimportuje se u položek s nastavením dostupnosti dle stavu zásob. Pokud však v tomto případě stav zásob není definován (hodnota stock musí být prázdná nebo úplně chybět), dostupnost se importuje
      • can_add_to_basket_yn (bool) - lze přidat do košíku
      • prices (array) - pole objektů s cenami
        • language (language) - specifikace jazykové mutace
        • pricelists (array) - pole objektů s ceníky
          • name (string) - název ceníku, pokud je při importu prázdné, chápe se jako výchozí ceník
          • price_original (float) - původní cena, základní ceníková cena od které se odvozují další
          • product_discount (float) - sleva na produkt v procentech
          • price_sale (float) - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
        • price_purchase (float) - nákupní cena, interní údaj pro orientaci administrátora
        • price_common (float) - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
      • variants (array) - pole objektů s variantami
        • code (string) - kód varianty, páruje se podle existující hodnoty v databázi
        • active_yn (bool) - zobrazit variantu na webu
        • stock (float) - počet jednotek na skladě, v případě mínusové hodnoty se zapíše 0
        • availability (string) - název dostupnosti. Neimportuje se u položek s nastavením dostupnosti dle stavu zásob. Pokud však v tomto případě stav zásob není definován (hodnota stock musí být prázdná nebo úplně chybět), dostupnost se importuje
        • can_add_to_basket_yn (bool) - lze přidat do košíku
        • prices (array) - pole objektů s cenami
          • language (language) - specifikace jazykové mutace
          • pricelists (array) - pole objektů s ceníky
            • name (string) - název ceníku, pokud je při importu prázdné, chápe se jako výchozí ceník
            • price_original (float) - původní cena, základní ceníková cena od které se odvozují další
            • product_discount (float) - sleva na produkt v procentech
            • price_sale (float) - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
          • price_purchase (float) - nákupní cena, interní údaj pro orientaci administrátora
          • price_common (float) - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
  • příklad požadavku

    PUT /api/v2/orders HTTP/1.1
    Content-Type: application/json
    Authorization: Basic dGVzdDp0ZXN0
    
    {
        "products": [
            {
                "code": "",
                "active_yn": "",
                "archived_yn": "",
                "replacement_product_code": "",
                "can_add_to_backet_yn": "",
                "stock": "",
                "availability": "",
                "prices": [
                    {
                        "language": "",
                        "pricelists": [
                            {
                                "name": "",
                                "price_original": "",
                                "product_discount": "",
                                "price_sale": ""
                            }
                        ],
                        "price_purchase": "",
                        "price_common": ""
                    }
                ],
                "variants": [
                    {
                        "code": "",
                        "active_yn": "",
                        "can_add_to_backet_yn": "",
                        "stock": "",
                        "availability": "",
                        "prices": [
                            {
                                "language": "",
                                "pricelists": [
                                    {
                                        "name": "",
                                        "price_original": "",
                                        "product_discount": "",
                                        "price_sale": ""
                                    }
                                ],
                                "price_purchase": "",
                                "price_common": ""
                            }
                        ]
                    }
                ]
            }
        ]
    }
    

Odpověď

  • tělo:
    • products (array) - pole objektů s produkty
      • code (string) - kód produktu
      • product_url (string) - URL adresa kde se nachází produkt
      • updated_yn (bool) - příznak jestli se produkt aktualizoval
      • messages (array) - pole objektů chybových zpráv a upozornění při zpracování produktu
        • object (string) - název objektu (část JSONu) kterého se zpráva týká
        • property (string) - hodnota které se zpráva týká
        • message (string) - text zprávy
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "products": [
            {
                "code": "",
                "product_url": "",
                "updated_yn": "",
                "messages": [
                    {
                        "object": "",
                        "property": "",
                        "message": ""
                    }
                ]
            }
        ]
    }
    

Seznam produktů

  • URI: /api/v2/products/{code} ?codes={codes} &&last_update_time_from={last_update_time_from} &page={page} &status={status} &active_yn={active_yn} &archived_yn={archived_yn} &in_stock_yn={in_stock_yn} &language={language}
  • HTTP metoda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametry (musí být definovám alespoň jeden parametr):
    • code (string) - kód produktu
    • codes (string) - kódy produktů oddělené středníkem ;
    • variant_codes (string) - 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 (date) - vrátí produkty změněné od tohoto data
    • active_yn (bool) - vrátí pouze aktivní nebo neaktivní produkty
    • archived_yn (bool) - vrátí pouze archivované nebo nearchivované produkty
    • in_stock_yn (bool) - vrátí pouze produkty skladem nebo produkty s ostatními dostupnostmi
    • language (language) - jazyk, vrací pouze produkty v aktivní jazyce, a pouze s daty které se vážou na jazyk (např. ceny a texty). Pokud není definováno, vrací produkty a data ve všech jazycích
    • pricelist (string) - název ceníku, vrátí produkty pouze s tímto ceníkem
    • page (int) - stránka, pokud není definováno, vrací vždy stranu 1

Odpověď

Seznam produktů je dostupný po jednotlivých stranách, výstup je omezen na 50 položek na stránku. Pokud bude jakákoliv hodnota u variant null dědí se od produktu.

  • tělo:

    • current_page (int) - aktuální strana
    • current_page_items (int) - počet položek na aktuální straně
    • number_of_pages (int) - celkový počet stran
    • number_of_items (int) - celkový počet položek
    • products (array) - pole objektů s produkty
      • code (string) - kód produktu, páruje se podle existující hodnoty v databázi
      • code_supplier (string) - kód dodavatele
      • ean (string) - EAN
      • product_id (int) - interní ID produktu
      • active_yn (bool) - zobrazit produkt na webu
      • archived_yn (bool) - archivovaný produkt
      • replacement_product_code (string) - kód náhradního produktu, pouze pokud je produkt archivovaný
      • can_add_to_basket_yn (bool) - lze přidat do košíku
      • descriptions (array) - pole objektů s texty
        • language (language) - specifikace jazykové mutace
        • title (string) - název produktu
        • short_description (string) - krátký popis, bez HTML formátování
        • long_description (string) - dlouhý popis, může obsahovat formátování pouze pomocí HTML značek
        • url (string) - URL adresa produktu
      • stock (float) - počet jednotek na skladě
      • availability (string) - název dostupnosti
      • manufacturer (string) - výrobce
      • images (array) - pole objektů s cenami
        • url (string) - URL adresa obrázku
        • main_yn (bool) - hlavní obrázek
        • list_yn (bool) - seznamový obrázek
        • position (int) - pozice obrázku
        • titles (array) - pole objektů s popisky
          • language (language) - specifikace jazykové mutace
          • title (string) - popisek obrázku
      • prices (array) - pole objektů s cenami
        • language (language) - specifikace jazykové mutace
        • pricelists (array) - pole objektů s ceníky
          • name (string) - název ceníku, pokud je při importu prázdné, chápe se jako výchozí ceník
          • price_original (float) - původní cena, základní ceníková cena od které se odvozují další
          • product_discount (float) - sleva na produkt v procentech
          • product_discount_real - reálná sleva na produkt použitá pro výpočet výsledné ceny , vypočítává se takto:
            • hodnota slevy na produkt (product_discount) + sleva na výrobce + sleva na kategorii (bere se sleva z hlavní kategorie ve které je produkt zařazen). Výsledná hodnota slevy se omezí na hodnotu z nastavení Maximální procento slevy.
          • price_sale (float) - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
          • price_with_wat - koncová cena s DPH
          • price_without_vat - koncová cena bez DPH
        • price_purchase (float) - nákupní cena, interní údaj pro orientaci administrátora
        • price_common (float) - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
      • variants (array) - pole objektů s variantami
        • code (string) - kód varianty
        • code_supplier (string) - kód dodavatele
        • ean (string) - EAN
        • variant_id (int) - interní ID varianty
        • active_yn (bool) - zobrazit variantu na webu
        • can_add_to_basket_yn (bool) - lze přidat do košíku
        • stock (float) - počet jednotek na skladě
        • availability (string) - název dostupnosti
        • image (string) - URL adresa produktu
        • prices (array) - pole objektů s cenami
          • language (language) - specifikace jazykové mutace
          • pricelists (array) - pole objektů s ceníky
            • name (string) - název ceníku
            • price_original (float) - původní cena, základní ceníková cena od které se odvozují další
            • product_discount (float) - sleva na produkt v procentech
            • product_discount_real - reálná sleva na produkt použitá pro výpočet výsledné ceny , vypočítává se takto:
              • hodnota slevy na produkt (product_discount) + sleva na výrobce + sleva na kategorii (bere se sleva z hlavní kategorie ve které je produkt zařazen). Výsledná hodnota slevy se omezí na hodnotu z nastavení Maximální procento slevy.
            • price_sale (float) - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
            • price_with_wat - koncová cena s DPH
            • price_without_vat - koncová cena bez DPH
          • price_purchase (float) - nákupní cena, interní údaj pro orientaci administrátora
          • price_common (float) - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "current_page": "",
        "current_page_items": "",
        "number_of_pages": "",
        "number_of_items": "",
        "products": [
            {
                "code": "",
                "code_supplier": "",
                "ean": "",
                "product_id": "",
                "active_yn": "",
                "archived_yn": "",
                "replacement_product_code": "",
                "can_add_to_basket_yn": "",
                "manufacturer": "",
                "stock": "",
                "availability": "",
                "descriptions": [
                    {
                        "language": "",
                        "title": "",
                        "short_description": "",
                        "long_description": "",
                        "url": ""
                    }
                ],
                "images": [
                    {
                        "url": "",
                        "main_yn": "",
                        "list_yn": "",
                        "position": "",
                        "titles": [
                            {
                                "language": "",
                                "title": ""
                            }
                        ]
                    }
                ],
                "prices": [
                    {
                        "language": "",
                        "pricelists": [
                            {
                                "name": "",
                                "price_original": "",
                                "product_discount": "",
                                "product_discount_real": "",
                                "price_sale": "",
                                "price_with_wat": "",
                                "price_without_vat": ""
                            }
                        ],
                        "price_purchase": "",
                        "price_common": ""
                    }
                ],
                "variants": [
                    {
                        "code": "",
                        "code_supplier": "",
                        "ean": "",
                        "variant_id": "",
                        "active_yn": "",
                        "can_add_to_basket_yn": "",
                        "stock": "",
                        "availability": "",
                        "image": "",
                        "prices": [
                            {
                                "language": "",
                                "pricelists": [
                                    {
                                        "name": "",
                                        "price_original": "",
                                        "product_discount": "",
                                        "product_discount_real": "",
                                        "price_sale": "",
                                        "price_with_wat": "",
                                        "price_without_vat": ""
                                    }
                                ],
                                "price_purchase": "",
                                "price_common": ""
                            }
                        ]
                    }
                ]
            }
        ]
    }