Dokumentácia API - Produkty

Základné informácie

Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie

Aktualizácia produktu

Požiadavka

  • URI: /api/v2/products
  • HTTP metóda: PUT
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • telo:
    • produkty a varianty sa párujú podľa hodnoty code
    • pokiaľ bude akákoľvek hodnota u variantov null dedí sa od produktu
    • products (array) - pole objektov s produktmi
      • code (string) - kód produktu, páruje sa podľa existujúcej hodnoty v databáze
      • active_yn (bool) - zobraziť produkt na webe
      • archived_yn (bool) - archivovaný produkt
      • replacement_product_code (string) - kód náhradného produktu, len pokiaľ je produkt archivovaný
      • stock (float) - počet jednotiek na sklade
      • stock_position (string) - pozícia na sklade
      • availability (string) - názov dostupnosti. Neimportuje sa pri položkách s nastavením dostupnosti podľa stavu zásob. Pokiaľ však v tomto prípade stav zásob nie je definovaný (hodnota stock musí byť prázdna alebo úplne chýbať), dostupnosť sa importuje
      • can_add_to_basket_yn (bool) - je možné pridať do košíka
      • adult_yn (bool) - len pre dospelých
      • prices (array) - pole objektov s cenami
        • language (language) - špecifikácie jazykovej mutácie
        • pricelists (array) - pole objektov s cenníkmi
          • name (string) - názov cenníka, pokiaľ je pri importe prázdne, chápe sa ako východiskový cenník
          • price_original (float) - pôvodná cena, základná cenníková cena, od ktorej sa odvodzujú ďalšie
          • product_discount (float) - zľava na produkt v percentách
          • price_sale (float) - akčná cena, exportuje sa len vtedy, pokiaľ je produkt v akcii (štítok akcie)
        • price_purchase (float) - nákupná cena, interný údaj pre orientáciu administrátora
        • price_common (float) - bežná cena, pre orientáciu pri nákupe, môže to byť napr. cena v kamenných obchodoch
      • variants (array) - pole objektov s variantmi
        • code (string) - kód variantu, páruje sa podľa existujúcej hodnoty v databáze
        • active_yn (bool) - zobraziť variant na webe
        • stock (float) - počet jednotiek na sklade
        • stock_position (string) - pozícia na sklade
        • availability (string) - názov dostupnosti. Neimportuje sa pri položke s nastavením dostupnosti podľa stavu zásob. Pokiaľ však v tomto prípade stav zásob nie je definovaný (hodnota stock musí byť prázdna alebo úplne chýbať), dostupnosť sa importuje
        • can_add_to_basket_yn (bool) - je možné pridať do košíka
        • prices (array) - pole objektov s cenami
          • language (language) - špecifikácie jazykovej mutácie
          • pricelists (array) - pole objektov s cenníkmi
            • name (string) - názov cenníka, pokiaľ je pri importe prázdne, chápe sa ako východiskový cenník
            • price_original (float) - pôvodná cena, základná cenníková cena, od ktorej sa odvodzujú ďalšie
            • product_discount (float) - zľava na produkt v percentách
            • price_sale (float) - akčná cena, exportuje sa len vtedy, pokiaľ je produkt v akcii (štítok akcie)
          • price_purchase (float) - nákupná cena, interný údaj pre orientáciu administrátora
          • price_common (float) - bežná cena, pre orientáciu pri nákupe, môže to byť napr. cena v kamenných obchodoch
      • metas (array) - pole objektov s vlastnými poľami
        • key (string) - kľúč vlastného poľa. Vlastné pole musí byť v administrácii založené.
        • value (string) - hodnota vlastného poľa. Použiť v prípade, kedy je hodnota vlastného poľa spoločná pre všetky jazyky
        • values (array) - pole hodnôt vlastného poľa podľa jazykových mutácií
          • language (language) - jazyk hodnoty
          • value (string) - hodnota
      • creation_time (date) - čas vytvorenia produktu
      • last_update_time (date) - čas poslednej aktualizácie produktu
    • variants (array) - pole objektov s variantmi (viď varianty v produkte). Možné poslať aj bez produktu, len ako zoznam variantov.

Odpoveď

  • telo:
    • products (array) - pole objektov s produktmi
      • code (string) - kód produktu
      • product_url (string) - URL adresa, kde sa nachádza produkt
      • updated_yn (bool) - príznak, či sa produkt aktualizoval
      • messages (array) - pole objektov chybových správ a upozornení pri spracovaní produktu
        • object (string) - názov objektu (časť JSON), ktorého sa správa týka
        • property (string) - hodnota, ktorej sa správa týka
        • message (string) - text správy

Zoznam produktov

  • URI: /api/v2/products/
  • URI: /api/v2/products/simple - vracia len zjednodušené produkty
  • URI: /api/v2/products/prices - vracia len produkty s kódom, cenami, kódom variantov a cenami variantov
  • URI: /api/v2/products/parameters - vracia len produkty s kódom, parametrami, kódom variantov a parametrami variantov
  • URI: /api/v2/products/labels - vracia len produkty s kódom, štítkami, kódom variantov a štítkami variantov
  • URI: /api/v2/products/related - vracia len produkty s kódom, a položkami related, accessories, alternative, gifts, sets
  • HTTP metóda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametre:
    • code (string) - kód produktu
    • codes (string) - kódy produktov oddelené bodkočiarkou ;
    • variant_codes (string) - kódy variantov oddelené bodkočiarkou ; (v prípade použitia tohto parametra, vracia produkt, ktorý obsahuje požadovaný variant)
    • last_update_time_from (date) - vráti produkty zmenené od tohto dátumu
    • active_yn (bool) - vráti len aktívne alebo neaktívne produkty
    • archived_yn (bool) - vráti len archivované alebo nearchivované produkty
    • in_stock_yn (bool) - vráti len produkty skladom alebo produkty s ostatnými dostupnosťami
    • language (language) - jazyk, vracia len produkty v aktívnom jazyku a len s údajmi, ktoré sa viažu na jazyk (napr. ceny a texty). Pokiaľ nie je definované vracia produkty a údaje vo všetkých jazykoch
    • pricelist (string) - názov cenníka, vráti produkty len s týmto cenníkom
    • page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1

Odpoveď

Zoznam produktov je dostupný po jednotlivých stranách, výstup je obmedzený na 50 položiek na stránku. Pokiaľ bude akákoľvek hodnota pri variante null dedí sa od produktu.

  • telo:
    • current_page (int) - aktuálna strana
    • current_page_items (int) - počet položiek na aktuálnej strane
    • number_of_pages (int) - celkový počet strán
    • number_of_items (int) - celkový počet položiek
    • products (array) - pole objektov s produktmi
      • code (string) - kód produktu, páruje sa podľa existujúcej hodnoty v databáze
      • code_supplier (string) - kód dodávateľa
      • ean (string) - EAN
      • product_id (int) - interné ID produktu
      • active_yn (bool) - zobraziť produkt na webe
      • archived_yn (bool) - archivovaný produkt
      • replacement_product_code (string) - kód náhradného produktu, len pokiaľ je produkt archivovaný
      • can_add_to_basket_yn (bool) - je možné pridať do košíka
      • adult_yn (bool) - len pre dospelých
      • descriptions (array) - pole objektov s textom
        • language (language) - špecifikácie jazykovej mutácie
        • title (string) - názov produktu
        • short_description (string) - krátky popis, bez HTML formátovania
        • long_description (string) - dlhý popis, môže obsahovať formátovanie len pomocou HTML značiek
        • url (string) - URL adresa produktu
        • unit (string) - názov jednotky v danom jazyku
      • manufacturer (string) - výrobca
      • stock (float) - počet jednotiek na sklade
      • stock_position (string) - pozícia na sklade
      • availability (string) - názov dostupnosti
      • availability_type (string) - typ dostupnosti, hodnoty môžu byť:
        • OnRequest - na dopyt
        • NotAvailable - nie je skladom
        • InStock - skladom
        • Custom - vlastné
      • weight (int) - váha v gramoch
      • shipment_group (string) - skupina dopravy
      • images (array) - pole objektov s obrázkami
        • url (string) - URL adresa obrázka
        • main_yn (bool) - hlavný obrázok
        • list_yn (bool) - zoznamový obrázok
        • position (int) - pozícia obrázka
        • titles (array) - pole objektov s popiskami
          • language (language) - špecifikácie jazykovej mutácie
          • title (string) - popis obrázka
      • categories (array) - pole objektov s kategóriami
        • category_id (int) - ID kategórie
        • code (string) - kód kategórie
        • main_yn (bool) - príznak hlavnej kategórie, pokiaľ je true, je táto kategória pri tomto produkte hlavná
        • position (int) - pozícia produktu v kategórii
        • name (string) - len orientačný názov kategórie, nie je zaručené z akého jazyka sa vezme
      • groups (array) - skupiny, do ktorých je produkt zaradený
      • prices (array) - pole objektov s cenami
        • language (language) - špecifikácie jazykovej mutácie
        • currency (currency) - mena
        • pricelists (array) - pole objektov s cenníkmi
          • name (string) - názov cenníka, pokiaľ je pri importe prázdne, chápe sa ako východiskový cenník
          • price_original (float) - pôvodná cena, základná cenníková cena, od ktorej sa odvodzujú ďalšie
          • product_discount (float) - zľava na produkt v percentách
          • product_discount_real - reálna zľava na produkt použitá pre výpočet výslednej ceny, vypočítava sa takto:
            • hodnota zľavy na produkt (product_discount) + zľava na výrobcu + zľava na kategóriu (berie sa zľava z hlavnej kategórie, v ktorej je produkt zaradený). Výsledná hodnota zľavy sa obmedzí na hodnotu z nastavenia Maximálne percento zľavy.
          • price_sale (float) - akčná cena, exportuje sa len vtedy, pokiaľ je produkt v akcii (štítok akcie)
          • price_with_vat - koncová cena s DPH
          • price_without_vat - koncová cena bez DPH
        • price_purchase (float) - nákupná cena, interný údaj pre orientáciu administrátora
        • price_common (float) - bežná cena, pre orientáciu pri nákupe, môže to byť napr. cena v kamenných obchodoch
        • recycling_fee (float) - recyklačný poplatok
      • vats (object) - objekt s DPH v jednotlivých krajinách (kľúč každej položky v objekte je typu country), len pokiaľ je aktívne OSS
      • parameters (array) - pole objektov s parametrami
        • name (object) - objekt s názvami parametrov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
        • values (array) - pole objektov s hodnotami parametrov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
      • labels (array) - pole objektov so štítkami
        • name (object) - objekt s názvami štítkov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
        • active_currently_yn (bool) - štítok aktuálne aktívny, zohľadňuje aj údaje od a do
        • active_yn (bool) - štítok aktívny
        • active_from (date) - štítok aktívny od dátumu
        • active_to (date) - štítok aktívny do dátumu
      • variants (array) - pole objektov s variantmi
        • code (string) - kód variantu
        • code_supplier (string) - kód dodávateľa
        • ean (string) - EAN
        • variant_id (int) - interné ID variantu
        • active_yn (bool) - zobraziť variant na webe
        • can_add_to_basket_yn (bool) - je možné pridať do košíka
        • stock (float) - počet jednotiek na sklade
        • stock_position (string) - pozícia na sklade
        • availability (string) - názov dostupnosti
        • availability_type (string) - typ dostupnosti, hodnoty môžu byť:
          • OnRequest - na dopyt
          • NotAvailable - nie je skladom
          • InStock - skladom
          • Custom - vlastné
        • weight (string) - váha v gramoch
        • image (string) - URL adresa produktu
        • prices (array) - pole objektov s cenami
          • language (language) - špecifikácie jazykovej mutácie
          • currency (currency) - mena
          • pricelists (array) - pole objektov s cenníkmi
            • name (string) - názov cenníka
            • price_original (float) - pôvodná cena, základná cenníková cena, od ktorej sa odvodzujú ďalšie
            • product_discount (float) - zľava na produkt v percentách
            • product_discount_real - reálna zľava na produkt použitá pre výpočet výslednej ceny, vypočítava sa takto:
              • hodnota zľavy na produkt (product_discount) + zľava na výrobcu + zľava na kategóriu (berie sa zľava z hlavnej kategórie, v ktorej je produkt zaradený). Výsledná hodnota zľavy sa obmedzí na hodnotu z nastavenia Maximálne percento zľavy.
            • price_sale (float) - akčná cena, exportuje sa len vtedy, pokiaľ je produkt v akcii (štítok akcie)
            • price_with_vat - koncová cena s DPH
            • price_without_vat - koncová cena bez DPH
          • price_purchase (float) - nákupná cena, interný údaj pre orientáciu administrátora
          • price_common (float) - bežná cena, pre orientáciu pri nákupe, môže to byť napr. cena v kamenných obchodoch
        • parameters (array) - pole objektov s parametrami
          • name (object) - objekt s názvami parametrov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
          • values (array) - pole objektov s hodnotami parametrov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
        • labels (array) - pole objektov so štítkami
          • name (object) - objekt s názvami štítkov v jednotlivých jazykoch (kľúč každej položky v objekte je typu language)
          • active_currently_yn (bool) - štítok aktuálne aktívny, zohľadňuje aj údaje od a do
          • active_yn (bool) - štítok aktívny
          • active_from (date) - štítok aktívny od dátumu
          • active_to (date) - štítok aktívny do dátumu
        • metas (array) - pole objektov s vlastnými poľami variantov
          • key (string) - kľúč vlastného poľa
          • type (string) - typ vlastného poľa (hodnoty môžu byť: radio, checkbox, input, date, e-mail, number, select, multiselect, textarea, formatted)
          • value (string) - hodnota vlastného poľa, v prípade kedy je hodnota vlastného poľa spoločná pre všetky jazyky
          • values (array) - pole objektov s hodnotami, v prípade kedy nie je hodnota vlastného poľa spoločná pre všetky jazyky
            • language (language) - špecifikácie jazykovej mutácie
            • value (string) - hodnota
      • related (array) - súvisiace produkty, pole kódov produktov. Pokiaľ je k produktu priradený produkt, ktorý nemá kód, v zozname nebude.
      • accessories (array) - príslušenstvo, pole kódov produktov. Pokiaľ je k produktu priradený produkt, ktorý nemá kód, v zozname nebude.
      • alternative (array) - alternatívne produkty, pole kódov produktov. Pokiaľ je k produktu priradený produkt, ktorý nemá kód, v zozname nebude.
      • gifts (array) - darčeky, pole kódov produktov. Pokiaľ je k produktu priradený produkt, ktorý nemá kód, v zozname nebude.
      • sets (array) - sady, pole kódov produktov. Pokiaľ je k produktu priradený produkt, ktorý nemá kód, v zozname nebude.
      • metas (array) - pole objektov s vlastnými poľami produktov
        • key (string) - kľúč vlastného poľa
        • type (string) - typ vlastného poľa (hodnoty môžu byť: radio, checkbox, input, date, e-mail, number, select, multiselect, textarea, formatted)
        • value (string) - hodnota vlastného poľa, v prípade, kedy je hodnota vlastného poľa spoločná pre všetky jazyky
        • values (array) - pole objektov s hodnotami, v prípade, kedy nie je hodnota vlastného poľa spoločná pre všetky jazyky
          • language (language) - špecifikácie jazykovej mutácie
          • value (string) - hodnota
      • admin_url (string) - URL do detailu produktu v administrácii

Zmazanie produktov

  • URI: /api/v2/products/{code}/?codes={code}
  • HTTP metóda: DELETE
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametre (musí byť definovaný aspoň jeden parameter):
    • codes (string) - kódy produktov oddelené bodkočiarkou ; alebo ako pole

Odpoveď

  • telo:
    • products (array) - pole objektov s produktmi
      • code (string) - kód produktu
      • deleted_yn (bool) - príznak, či sa produkt zmazal
      • messages (array) - pole objektov chybových správ a upozornení
        • object (string) - názov objektu (časť JSON), ktorého sa správa týka
        • property (string) - hodnota, ktorej sa správa týka
        • message (string) - text správy

Zmazanie variantov

  • URI: /api/v2/products/variants/?codes={code}
  • HTTP metóda: DELETE
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametre (musí byť definovaný aspoň jeden parameter):
    • codes (string) - kódy variantov oddelené bodkočiarkou ; alebo ako pole

Odpoveď

  • telo:
    • variants (array) - pole objektov s variantmi
      • code (string) - kód variantu
      • deleted_yn (bool) - príznak, či sa variant zmazal
      • messages (array) - pole objektov chybových správ a upozornení
        • object (string) - názov objektu (časť JSON), ktorého sa správa týka
        • property (string) - hodnota, ktorej sa správa týka
        • message (string) - text správy
Na tejto stránke

Další zdroje informací

Facebook poradna

Výměna zkušeností, rady a tipy mezi provozovateli e-shopů na systému UPgates.

Přejít do poradny

Akademie

Získejte znalosti od našich specialistů na marketing, obchod, právo a podnikání.

Přejít do akademie

Novinky z Blogu

Co nového jsme pro vás připravili nebo chystáme najdete na blogu.

Přejít do blogu

Nepodařilo se Vám najít tu správnou odpověď?

Kontaktujte naši technickou podporu, která je tu pro vás od pondělí do pátku 8:00 až 16:00 hod.

Zákaznická podpora