Dokumentace API - Produkty

Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům 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 a varianty 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ě
    • stock_position (string) - pozice na skladě
    • 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
    • adult_yn (bool) - pouze pro dospělé
    • 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ě
      • stock_position (string) - pozice na skladě
      • 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
    • metas (array) - pole objektů s vlastnimi poli
      • key (string) - klíč vlastního pole. Vlastní pole musí být v administraci založeno.
      • value (string) - hodnota vlastního pole. Použít v případě kdy je hodnota vlastního pole společná pro všechny jazyky
      • values (array) - pole hodnot vlastního pole podle jazykových mutací
        • language (language) - jazyk hodnoty
        • value (string) - hodnota
    • creation_time (date) - čas vytvoření produktu
    • last_update_time (date) - čas poslední aktualizace produktu
  • variants (array) - pole objektů s variantami (viz. varianty v produktu). Možno poslat i bez produktu, pouze jako seznam variant.

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

Seznam produktů

• URI: /api/v2/products/
• URI: /api/v2/products/simple - vrací pouze zjednodušené produkty
• URI: /api/v2/products/prices - vrací pouze produkty s kódem, cenami, kódem variant a cenami variant
• URI: /api/v2/products/parameters - vrací pouze produkty s kódem, parametry, kódem variant a parametry variant
• URI: /api/v2/products/labels - vrací pouze produkty s kódem, štítky, kódem variant a štítky variant
• URI: /api/v2/products/related - vrací pouze produkty s kódem, a položky related, accessories, alternative, gifts, sets
• HTTP metoda: GET
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry:
  • 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
    • adult_yn (bool) - pouze pro dospělé
    • 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
      • seo_title (string) - SEO titulek produktu
      • seo_description (string) - META popisek stránky produktu
      • seo_url (string) - vlastní koncovka URL adresy
      • unit (string) - název jednotky v daném jazyce
    • manufacturer (string) - výrobce
    • stock (float) - počet jednotek na skladě
    • stock_position (string) - pozice na skladě
    • availability (string) - název dostupnosti
    • availability_type (string) - typ dostupnosti, hodnoty mohou být:
      • OnRequest - na dotaz
      • NotAvailable - není skladem
      • InStock - skladem
      • Custom - vlastní
    • weight (int) - váha v gramech
    • shipment_group (string) - skupina doprav
    • images (array) - pole objektů s obrázky
      • 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
    • categories (array) - pole objektů s kategoriemi
      • category_id (int) - ID kategorie
      • code (string) - kód kategorie
      • main_yn (bool) - příznak hlavní kategorie, pokud je true, je tato kategorie u tohoto produktu hlavní
      • position (int) - pozice produktu v kategorii
      • name (string) - pouze orientační název kategorie, není zaručeno z jakého jazyka se vezme
    • groups (array) - skupiny do kterých je produkt zařazen
    • prices (array) - pole objektů s cenami
      • language (language) - specifikace jazykové mutace
      • currency (currency) - měna
      • 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_vat - 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
      • recycling_fee (float) - recyklační poplatek
    • vats (object) - objekt s DPH v jednotlivých zemích (klíč každé položky v objektu je typu country), pouze pokud je aktivní OSS
    • parameters (array) - pole objektů s parametry
      • name (object) - objekt s názvy parametrů v jednotlivých jazycích (klíč každé položky v objektu je typu language)
      • values (array) - pole objektů s hodnoty parametrů v jednotlivých jazycich (klíč každé položky v objektu je typu language)
    • labels (array) - pole objektů se štítky
      • name (object) - objekt s názvy štítků v jednotlivých jazycích (klíč každé položky v objektu je typu language)
      • active_currently_yn (bool) - štítek aktuálně aktivní, zohledňuje i data od a do
      • active_yn (bool) - štítek aktivní
      • active_from (date) - štítek aktivní od data
      • active_to (date) - štítek aktivní do data
    • 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ě
      • stock_position (string) - pozice na skladě
      • availability (string) - název dostupnosti
      • availability_type (string) - typ dostupnosti, hodnoty mohou být:
        • OnRequest - na dotaz
        • NotAvailable - není skladem
        • InStock - skladem
        • Custom - vlastní
      • weight (string) - váha v gramech
      • image (string) - URL adresa produktu
      • prices (array) - pole objektů s cenami
        • language (language) - specifikace jazykové mutace
        • currency (currency) - měna
        • 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_vat - 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
      • parameters (array) - pole objektů s parametry
        • name (object) - objekt s názvy parametrů v jednotlivých jazycích (klíč každé položky v objektu je typu language)
        • values (array) - pole objektů s hodnoty parametrů v jednotlivých jazycich (klíč každé položky v objektu je typu language)
      • labels (array) - pole objektů se štítky
        • name (object) - objekt s názvy štítků v jednotlivých jazycích (klíč každé položky v objektu je typu language)
        • active_currently_yn (bool) - štítek aktuálně aktivní, zohledňuje i data od a do
        • active_yn (bool) - štítek aktivní
        • active_from (date) - štítek aktivní od data
        • active_to (date) - štítek aktivní do data
      • metas (array) - pole objektů s vlastními poli variant
        • key (string) - klíč vlastního pole
        • type (string) - typ vlastního pole (hodnoty mohou být: radio, checkbox, input, date, email, number, select, multiselect, textarea, formatted)
        • value (string) - hodnota vlastního pole, v případě kdy je hodnota vlastního pole společná pro všechny jazyky
        • values (array) - pole objektů s hodnotami, v případě kdy není hodnota vlastního pole společná pro všechny jazyky
          • language (language) - specifikace jazykové mutace
          • value (string) - hodnota
    • related (array) - související produkty, pole kódů produktů. Pokud je k produktu přiřazen produkt který nemá kód, v seznamu nebude.
    • accessories (array) - příslušenství, pole kódů produktů. Pokud je k produktu přiřazen produkt který nemá kód, v seznamu nebude.
    • alternative (array) - alternativní produkty, pole kódů produktů. Pokud je k produktu přiřazen produkt který nemá kód, v seznamu nebude.
    • gifts (array) - dárky, pole kódů produktů. Pokud je k produktu přiřazen produkt který nemá kód, v seznamu nebude.
    • sets (array) - sady, pole kódů produktů. Pokud je k produktu přiřazen produkt který nemá kód, v seznamu nebude.
    • metas (array) - pole objektů s vlastními poli produktů
      • key (string) - klíč vlastního pole
      • type (string) - typ vlastního pole (hodnoty mohou být: radio, checkbox, input, date, email, number, select, multiselect, textarea, formatted)
      • value (string) - hodnota vlastního pole, v případě kdy je hodnota vlastního pole společná pro všechny jazyky
      • values (array) - pole objektů s hodnotami, v případě kdy není hodnota vlastního pole společná pro všechny jazyky
        • language (language) - specifikace jazykové mutace
        • value (string) - hodnota
    • admin_url (string) - URL do detailu produktu v administraci

Smazání produktů

• URI: /api/v2/products/{code}/?codes={code}
• HTTP metoda: DELETE
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry (musí být definovám alespoň jeden parametr):
  • codes (string) - kódy produktů oddělené středníkem ; nebo jako pole

Odpověď

• tělo:
  • products (array) - pole objektů s produkty
    • code (string) - kód produktu
    • deleted_yn (bool) - příznak jestli se produkt smazal
    • messages (array) - pole objektů chybových zpráv a upozornění
      • 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

Smazání variant

• URI: /api/v2/products/variants/?codes={code}
• HTTP metoda: DELETE
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry (musí být definovám alespoň jeden parametr):
  • codes (string) - kódy variant oddělené středníkem ; nebo jako pole

Odpověď

• tělo:
  • variants (array) - pole objektů s variantami
    • code (string) - kód varianty
    • deleted_yn (bool) - příznak jestli se varianta smazala
    • messages (array) - pole objektů chybových zpráv a upozornění
      • 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