Skladové karty

Strom skladových kariet v.1

Rozhranie dodáva informáciu o strome skladových kariet.

  • URL: GET /interface/{db}/eshop/v1/strom
  • Status: implementované
  • Bearer: áno

Zastaraná funkcia. Použite v2.

Strom skladových kariet v.2

Rozhranie dodáva informáciu o strome skladových kariet. Voči predchádzajúcej verzii dodáva aj popis a ID súvisiaceho obrázku.

  • URL: GET /interface/{db}/eshop/v2/strom
  • Status: implementované (API 2.3.0, program 5.33.0.25)
  • Bearer: áno

ID súvisiaceho obrázku sa používa tak, že ak je položka id_image číslo, tak je možné si pomocou funkcie Obrázok ku skladovej karte stiahnuť jej obsah.

{
    "items": [
        {
            "tree_id": 1,
            "nazov": "Tovar",
            "parent_id": 0,
            "poradie": 2,
            "vnorenie": 1,
            "popis": "",
            "id_image": null,
            "version": "662133"
        },
        ...
    ]
}

Typy skladových kariet

Funkcia dodá zoznam typov skladových kariet.

  • URL: GET /interface/{db}/eshop/v1/karty/typy
  • Status: implementované (API 2.0.0, program 5.30.0.19)
  • Bearer: áno

Zoznam štandardných typov skladových kariet. Okrem toho sa môžu v zozname objaviť aj užívateľsky definované typy. Tie v existujúcej verzii programu Optivus fungujú ako skladové karty typu tovar.

  • 1 - Tovar
  • 2 - Služba
  • 90 - Variant

Zoznam skladových kariet v.1

Vráti zoznam skladových kariet.

  • URL: GET /interface/{db}/eshop/v1/karty
  • Status: implementované
  • Bearer: áno

Zastaraná funkcia. Použite v2, v3 alebo v4.

Zoznam skladových kariet v.2

Vráti zoznam skladových kariet. Zoznam skladových kariet sa upraví o nové položky.

  • URL: GET /interface/{db}/eshop/v2/karty
  • Status: implementované (API 2.0.0, program 5.30.0.19)
  • Bearer: áno

Zoznam skladových kariet obsahuje voči v1 aj položku:

  • typ
  • eshop_hidden - Od verzie programu 5.36.0.31 funkcia vracia aj stĺpec eshop_hidden, ktorým sa dá nastaviť, že daná karta nemá byť priamo nájditeľná zákazníkom. Slúži to ako informácia najmä pre vytváranie variantov.

Zoznam skladových kariet v.3

Vráti zoznam skladových kariet. Zoznam skladových kariet sa upraví o nové položky.

  • URL: GET /interface/{db}/eshop/v3/karty
  • Status: implementované (API 2.7.2, program 5.56.0.54)
  • Bearer: áno

Parametre:

  • id=X (voliteľný) - Dodá informáciu o konkrétnej skladovej karte.
  • mnozstvo=1 (voliteľný) - Dodá aj celkové množstvo na sklade.
  • smnozstvo=1 (voliteľný) - Dodá aj množstvá na jednotlivých skladoch.
  • eshop_hidden=VALUE (voliteľný) - Filtruje podľa tohto stĺpca. VALUE môže byť 0 alebo 1.
  • cislo=VALUE (voliteľný) - Filtruje podľa tohto stĺpca ako podreťazec.
  • nazov=VALUE (voliteľný) - Filtruje podľa tohto stĺpca ako podreťazec.

Zoznam skladových kariet obsahuje voči v.2 aj položku:

  • dlehota - Dodacia lehota. V Optivuse je to ako číselník, v tomto poli sa nachádza textový popis z číselníka.
  • vyrobca - Výrobca. V Optivuse je to ako číselník, v tomto poli sa nachádza textový popis z číselníka.
  • mnozstvo - Množstvo tovaru celkovo. Vypočítané množstvo je pre celý sklad. Vďaka tomu máte presné informácie o celkovom stave danej firmy a celkových rezerváciách a dodávkach.
  • smnozstvo - Množstvo tovaru po jednotlivých skladoch. Dodáva sa iba množstvo na jednotlivých skladoch.

{
  "items": [
    {
      "karta_id": 2,
      "tree_id": 1,
      "datum": "2017-12-11T00:00:00.000Z",
      "cislo": "SK2017/000002",
      "cislo2": null,
      "nazov": "Pšenica",
      "nazov_vseobecne": null,
      "popis": "",
      "dph": 20,
      "id_produkt": null,
      "kod": "99779977",
      "cena_priemer": 0.209852216749,
      "cena_last": 0.209852216749,
      "typ": 1,
      "eshop_hidden": false,
      "vyrobca": "JRD",
      "dlehota": "Do 14 dní",
      "version": "14866021",
      "Row#": "1",
      "mnozstvo": {
        "mnozstvo": 1024,
        "mnozstvo_obj": 26,
        "mnozstvo_naceste": 100,
        "mnozstvo_hypot": 1098
      },
      "smnozstvo": [
        {
          "sklad_id": 1,
          "mnozstvo": 1008
        },
        {
          "sklad_id": 4,
          "mnozstvo": 12
        }
      ]
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 100,
    "maximum": 1
  }
}

Zoznam skladových kariet v.4

Vráti zoznam skladových kariet. Zoznam skladových kariet sa upraví o nové položky.

  • URL: GET /interface/{db}/eshop/v4/karty
  • Status: rozpracované (API 3.0.1, program 5.91.0.63)
  • Bearer: áno

Parametre:

  • id=X (voliteľný) - Dodá informáciu o konkrétnej skladovej karte.
  • idlist=1,2,3...N (voliteľný) - Filter obmedzí karty len na tieto ID. Môžete to využiť napríklad na získanie zoznamu kariet, ktoré sú variantami danej skladovej karty. Musíte dodržať syntax celých čísel, oddelených čiarkami. API zo zoznamu odstráni všetko, čo nezodpovedá celému číslu a len z toho si vytvorí filter.
  • mnozstvo=1 (voliteľný) - Dodá aj celkové množstvo na sklade v položke mnozstvo.
  • smnozstvo=1 (voliteľný) - Dodá aj množstvá na jednotlivých skladoch v polozke smnozstvo.
  • obrazky=1 (voliteľný) - Dodá zoznam obrázkov v položke obrazky. Zoznam obrázkov je identický s funkciou Zoznam obrázkov.
  • pdf=1 (voliteľný) - Dodá zoznam PDF v položke pdf. Zoznam PDF je identický s funkciou Zoznam PDF.
  • premenne=1 (voliteľný) - Dodá zoznam premenných v položke premenne. Zoznam je identický s funkciou Zoznam premenných.
  • variant=1 (voliteľný) - Dodá zoznam variantov v položke variant. Zoznam je identický s funkciou Karta s variantom.
  • ceny=1 (voliteľný) - Dodá predajné ceny v položke ceny. Informácia je identická s funkciou Predajné ceny v.2.
  • eshop_hidden=VALUE (voliteľný) - Filtruje podľa tohto stĺpca. VALUE môže byť 0 alebo 1.
  • cislo=VALUE (voliteľný) - Filtruje podľa tohto stĺpca ako podreťazec.
  • nazov=VALUE (voliteľný) - Filtruje podľa tohto stĺpca ako podreťazec.

Zoznam skladových kariet obsahuje voči v.3 aj položku:

  • obrazky - Zoznam obrázkov ku skladovej karte.
  • pdf - Zoznam PDF ku skladovej karte.
  • premenne - Zoznam užívateľských premenných ku skladovej karte.
  • variant - Zoznam variantov ku skladovej karte. Položka sa objaví iba vtedy, keď je položka typ=90.
  • ceny - Predajné ceny.

Pripravovaná funkcia.

{
    "items": [
        {
            "karta_id": 8,
            "tree_id": 2,
            "datum": "2021-03-03T23:00:00.000Z",
            "cislo": "SK2021/00003",
            "cislo2": null,
            "nazov": "Chobotnica",
            "nazov_vseobecne": null,
            "popis": "",
            "dph": 20,
            "id_produkt": null,
            "kod": "kod 1",
            "cena_priemer": 5,
            "cena_last": 10,
            "typ": 1,
            "eshop_hidden": false,
            "vyrobca": null,
            "dlehota": null,
            "version": "31356",
            "Row#": "1",
            "mnozstvo": {
                "mnozstvo": 116,
                "mnozstvo_obj": 10,
                "mnozstvo_naceste": 0,
                "mnozstvo_hypot": 106
            },
            "smnozstvo": [
                {
                    "sklad_id": 1,
                    "mnozstvo": 115
                }
            ],
            "obrazky": [
                {
                    "id_image": 12,
                    "popis": "Mackova hlava",
                    "default_image": true,
                    "filename": "macko_head.jpg",
                    "sirka": 150,
                    "vyska": 148,
                    "velkost": 6213,
                    "crc": -2099506931,
                    "version": "31339"
                },
                {
                    "id_image": 13,
                    "popis": "Béla Bartók",
                    "default_image": false,
                    "filename": "bela-bartok.jpg",
                    "sirka": 400,
                    "vyska": 203,
                    "velkost": 6597,
                    "crc": 481488140,
                    "version": "31342"
                }
            ],
            "pdf": [],
            "premenne": [
                {
                    "id_property": 7,
                    "value": 1,
                    "name": "pm_int",
                    "id_kind": 1
                },
                {
                    "id_property": 8,
                    "value": 2.4,
                    "name": "pm_double",
                    "id_kind": 2
                },
                {
                    "id_property": 10,
                    "value": true,
                    "name": "pm_bool",
                    "id_kind": 3
                },
                {
                    "id_property": 11,
                    "value": "2023-07-24T08:00:00.000Z",
                    "name": "pm_datetime",
                    "id_kind": 4
                },
                {
                    "id_property": 9,
                    "value": "Pokusný text",
                    "name": "pm_text",
                    "id_kind": 5
                }
            ],
            "ceny": {
                "cena_predajna": 5.5,
                "cena_priemer": 5,
                "cena_last": 10,
                "zlava": [
                    {
                        "podmienka": 1,
                        "hodnota": 5,
                        "zlava": 25.5
                    }
                ],
                "ceny": [
                    {
                        "firma_id": 11,
                        "zlava": 10,
                        "popis": "Cenová hladina cenova hladina 10"
                    }
                ],
                "akcie": [
                    {
                        "popis": "Akcia 1A",
                        "cena_predajna": 2,
                        "zaciatok": "2023-07-24T22:00:00.000Z",
                        "koniec": "2023-07-30T22:00:00.000Z",
                        "firma_id": []
                    }
                ]
            }
        },
    ...
    "paging": {
        "offset": 0,
        "limit": 100,
        "maximum": 5
    }
}


{
    "items": [
        {
            "karta_id": 17,
            "tree_id": 5,
            "datum": "2021-08-10T22:00:00.000Z",
            "cislo": "SK2021/00012",
            "cislo2": null,
            "nazov": "Ponožky",
            "nazov_vseobecne": null,
            "popis": "",
            "dph": 20,
            "id_produkt": null,
            "kod": null,
            "cena_priemer": null,
            "cena_last": null,
            "typ": 90,
            "eshop_hidden": false,
            "vyrobca": null,
            "dlehota": null,
            "version": "31359",
            "Row#": "2",
            "mnozstvo": {
                "mnozstvo": 0,
                "mnozstvo_obj": 0,
                "mnozstvo_naceste": 0,
                "mnozstvo_hypot": 0
            },
            "smnozstvo": [
                {
                    "sklad_id": 1,
                    "mnozstvo": 0
                }
            ],
            "obrazky": [],
            "pdf": [],
            "premenne": [],
            "variant": {
                "variants": [
                    {
                        "id_variant": 1,
                        "variant": "Farba",
                        "items": [
                            {
                                "id_item": 1,
                                "item": "Červená"
                            },
                            {
                                "id_item": 2,
                                "item": "Modrá"
                            }
                        ]
                    }
                ],
                "items": [
                    {
                        "id_variants": 1,
                        "id_karta_variant": 18,
                        "id_variant": 1,
                        "id_item": 1
                    },
                    {
                        "id_variants": 2,
                        "id_karta_variant": 19,
                        "id_variant": 1,
                        "id_item": 2
                    }
                ]
            },
            "ceny": {
                "cena_predajna": 0,
                "cena_priemer": null,
                "cena_last": null,
                "zlava": [],
                "ceny": [],
                "akcie": [
                    {
                        "popis": "Akcia 1A",
                        "cena_predajna": 2,
                        "zaciatok": "2023-07-24T22:00:00.000Z",
                        "koniec": "2023-07-30T22:00:00.000Z",
                        "firma_id": []
                    }
                ]
            }
        },
        {
            "karta_id": 18,
            "tree_id": 5,
            "datum": "2021-08-10T22:00:00.000Z",
            "cislo": "SK2021/00013",
            "cislo2": null,
            "nazov": "Ponožka červená",
            "nazov_vseobecne": null,
            "popis": "",
            "dph": 20,
            "id_produkt": null,
            "kod": "11111",
            "cena_priemer": 4.907407407408001,
            "cena_last": 5,
            "typ": 1,
            "eshop_hidden": true,
            "vyrobca": null,
            "dlehota": null,
            "version": "31362",
            "Row#": "3",
            "mnozstvo": {
                "mnozstvo": -2,
                "mnozstvo_obj": 7,
                "mnozstvo_naceste": 0,
                "mnozstvo_hypot": -9
            },
            "smnozstvo": [
                {
                    "sklad_id": 1,
                    "mnozstvo": -2
                }
            ],
            "obrazky": [],
            "pdf": [],
            "premenne": [],
            "ceny": {
                "cena_predajna": 5.3981,
                "cena_priemer": 4.907407407408001,
                "cena_last": 5,
                "zlava": [],
                "ceny": [],
                "akcie": [
                    {
                        "popis": "Akcia 1A",
                        "cena_predajna": 2,
                        "zaciatok": "2023-07-24T22:00:00.000Z",
                        "koniec": "2023-07-30T22:00:00.000Z",
                        "firma_id": []
                    }
                ]
            }
        },
        {
            "karta_id": 19,
            "tree_id": 5,
            "datum": "2021-08-10T22:00:00.000Z",
            "cislo": "SK2021/00014",
            "cislo2": null,
            "nazov": "Ponožka modrá",
            "nazov_vseobecne": null,
            "popis": "Modré ponožky majú modrú farbu.",
            "dph": 20,
            "id_produkt": null,
            "kod": null,
            "cena_priemer": 10,
            "cena_last": 10,
            "typ": 1,
            "eshop_hidden": true,
            "vyrobca": null,
            "dlehota": null,
            "version": "31365",
            "Row#": "4",
            "mnozstvo": {
                "mnozstvo": 2,
                "mnozstvo_obj": 1,
                "mnozstvo_naceste": 1,
                "mnozstvo_hypot": 2
            },
            "smnozstvo": [
                {
                    "sklad_id": 1,
                    "mnozstvo": 2
                }
            ],
            "obrazky": [],
            "pdf": [],
            "premenne": [],
            "ceny": {
                "cena_predajna": 11,
                "cena_priemer": 10,
                "cena_last": 10,
                "zlava": [],
                "ceny": [],
                "akcie": [
                    {
                        "popis": "Akcia 1A",
                        "cena_predajna": 2,
                        "zaciatok": "2023-07-24T22:00:00.000Z",
                        "koniec": "2023-07-30T22:00:00.000Z",
                        "firma_id": []
                    }
                ]
            }
        },
    ...
    "paging": {
        "offset": 0,
        "limit": 100,
        "maximum": 5
    }
}

Predajná cena v.1

Rozhranie dodáva zoznam cien pre skladovú kartu.

  • URL: GET /interface/{db}/eshop/v1/karty/ceny
  • Status: implementované
  • Bearer: áno

Podmienka nadobúda hodnoty 1 alebo 2. Obvykle sa na jednej skladovej karte nekombinujú, užívateľ používa alebo jeden, alebo druhý zľavový model.

  • 1 - znamená zľava na jednotkové množstvo.
  • 2 - znamená zľavu podľa (ceny bez DPH * množstvo).

{
    "cena_predajna": 0.22,
    "cena_priemer": 0.2,
    "cena_last": 0.2,
    "zlava": [
        {
            "podmienka": 1,
            "hodnota": 100,
            "zlava": 5
        }
    ]
}

Predajná cena v.2

Tu je popísané ziskanie podrobnejšieho cenníka so zľavami. Zľavy pochádzajú z cenových hladín, alebo z nastavenie na firme podľa typu skladovej karty. Pre e-shop je to dodávané v jednej tabuľke, ktorá obsahuje zoznam zliav pre všetky firmy. Zliav pre jednu firmu môže byť aj viac. V Optivuse sa to nastaviť dá. Pri predaji v e-shope je známa firma, ktorá nakupuje. Podľa firmy môžno vyhľadať, ktoré zľavy možno pre ňu použiť.

Optivus na zľavy uplatňuje politiku, že dá vždy najvýhodnejšiu zľavu pre zákazníka.

  • URL: GET /interface/{db}/eshop/v2/karty/ceny
  • Status: implementované (API 2.2.0, program 5.32.0.22)
    • Od verzie API 2.4.0 vracia aj akcie
  • Bearer: áno

Cenové hladiny

Cenová hladina sa použije ak daná skladová karta patrí do nejakej cenovej hladiny.

  • Nastavenie v cenových hladinách.
    • Je v danom strome.
    • Je ako konkrétna karta určená.
    • K tomu máme percentuálnu zľavu.
    • Ak je firma v danej cenovej hladine, môže získať túto konkrétnu zľavu.
  • Nastavenie na firmách podľa typu skladovej karty.
    • Toto je hrubšie nastavenie kompletnej zľavy pre firmu podľa typu skladovej karty.
    • uplatňuje sa na všetky skladové karty daného typu.

Toto sa páruje s firmami, ktoré majú nastavenú presne túto cenovú hladinu. V nasledujúcom príklade máme skladovú kartu (je typu tovar), na ktorý je predajná cena 0,22 EUR. Ak kupujú rôzne firmy, mal by sa uplatniť nasledovný zoznam zliav (Toto je doporučenie na zľavy, tak ako je aplikované v programe Optivus. Správanie e-shopu sa môže správať podľa svojich potrieb.).

  • Firma 100 - Nie je v položke ceny a v položke zlava možno uplatniť množstevnú zľavu. Kupuje 1 ks.
    • Neuplatní sa žiadna zľava, lebo nebola splnená podmienka množstva.
  • Firma 100 - Nie je v položke ceny a v položke zlava možno uplatniť množstevnú zľavu. Kupuje 101 ks.
    • Uplatní sa zľava 5 % z položky zľava, lebo bola splnená podmienka minimálneho množstva.
  • Firma 15 - Má dve zľavy v položke ceny. Kupuje 1 ks.
    • Uplatní sa zľava 3 %, pretože je to výhodnejšia zľava z tých dvoch, ktoré pripadajú do úvahy.
  • Firma 15 - Má dve zľavy v položke ceny. Kupuje 101 ks. Čiže možno aplikovať aj množstevnú zľavu.
    • Možno uplatniť množstevnú zľavu.
    • Možno uplatniť zľavu z cenovej hladiny.
    • Uplatní sa zľava 5 %, pretože je to výhodnejšia zľava z tých troch, ktoré pripadajú do úvahy.
  • Firma 20 - Má jednu zľavu v položke ceny. Kupuje 1 ks.
    • Uplatní sa zľava 3 %, pretože to je jediná zľava, ktorá sa dá uplatniť.

{
    "cena_predajna": 0.22,
    "cena_priemer": 0.2,
    "cena_last": 0.2,
    "zlava": [
        {
            "podmienka": 1,
            "hodnota": 100,
            "zlava": 5
        }
    ],
    "ceny": [
      {
        "zlava": 2,
        "firma_id": 15,
        "popis": "Cenová hladina 2%"
      },
      {
        "zlava": 3,
        "firma_id": 15,
        "popis": "Zľava na tovar"
      },
      {
        "zlava": 3,
        "firma_id": 20,
        "popis": "Zľava na tovar"
      }
    ]
}

Akcie

Akcie sú špeciálnym príkladom ceny, ktorá je nastavená pre skladovú kartu na konkrétne obdobie. Akcia sa môže týkať všetkých firiem, alebo vybranej skupiny firiem.

  • popis - Popis akcie.
  • cena_predajna - Predajná cena bez DPH.
  • zaciatok - Dátum začiatku akcie.
  • koniec - Dátum konca akcie. Ak je null, potom je akcia neobmedzená časovo.
  • firma_id - Pole ID firiem. Ak je pole nulovej dĺžky, potom je to akcia pre všetky firmy. Ináč je to zoznam ID všetkých firiem, ktorých sa akcia týka. Ak je to zoznam ID, potom je ten zoznam v programe Optivus nastavený ako kategória firiem.

{
    "cena_predajna": 400,
    "cena_priemer": 200,
    "cena_last": 200,
    "zlava": [
        {
            "podmienka": 1,
            "hodnota": 50,
            "zlava": 15
        },
        {
            "podmienka": 1,
            "hodnota": 500,
            "zlava": 20
        }
    ],
    "ceny": [],
    "akcie": [
        {
            "popis": "Akcia 280",
            "cena_predajna": 280,
            "zaciatok": "2018-09-05T00:00:00.000Z",
            "koniec": null,
            "firma_id": [
                2,
                3,
                12,
                14,
                360
            ]
        }
    ]
}

Zoznam skladov, z ktorých sa rátajú množstvá na sklade

Rozhranie dodáva zoznam skladov, ktoré majú v Optivuse nastavený parameter Počítať množstvo tovaru pre E-shop. Toto funguje iba pre funkciu Množstvo tovaru na sklade v.2.

  • URL: GET /interface/{db}/eshop/v1/karty/sklady
  • Status: implementované (API 2.5.0, program 5.35.0.29)
  • Bearer: áno

{
    "items": [
        {
            "eshop_mnozstvo": true,
            "nazov": "Hlavný sklad",
            "popis": "",
            "sklad_id": 1,
            "zrusena": false
        }
    ]
}

Množstvo tovaru na sklade v.1

Rozhranie dodáva množstvo tovaru pre skladovú kartu. Množstvá su počítané na dohodnutom sklade, ktorý je v konfigurácii API. Obvykle to je Hlavný sklad.

  • URL: GET /interface/{db}/eshop/v1/karty/mnozstvo
  • Status: implementované
  • Bearer: áno

Parametre:

  • id - Získanie stavu konkrétnej skladovej karty na dohodnutom sklade.
  • sklad_id - Nastavenie konkrétneho skladu. Ak použijete tento parameter, potom sa bude ignorovať nastavenie z dohodnutého skladu a použije sa len tento sklad. (API 2.7.0, program 5.49.2.50)

{
    "mnozstvo": 0,
    "mnozstvo_hypot": -48,
    "mnozstvo_naceste": 20,
    "mnozstvo_obj": 68
}

Množstvo tovaru na sklade v.2

Rozhranie dodáva množstvo tovaru pre skladovú kartu. Zohľadňuje sa nastavenie v programe Optivus. Aké sklady sú nastavené pre výpočet sa dá skontrolovať funkciou Zoznam skladov.

  • URL: GET /interface/{db}/eshop/v2/karty/mnozstvo
  • Status: implementované (API 2.5.0, program 5.35.0.29)
  • Bearer: áno

Parametre:

  • id - Získanie stavu konkrétnej skladovej karty na dohodnutom sklade.
  • sklad_id - Nastavenie konkrétneho skladu. Ak použijete tento parameter, potom sa bude ignorovať nastavenie zo zonamu skladov a použije sa len tento sklad. (API 2.7.0, program 5.49.2.50)

{
    "mnozstvo": 0,
    "mnozstvo_hypot": -48,
    "mnozstvo_naceste": 20,
    "mnozstvo_obj": 68
}

Typ produktu

Rozhranie dodáva informácie o typoch produktov, na ktoré sú naviazané užívateľské premenné. Karta s rôznym typom produktu má iné užívateľské premenné.

  • URL: GET /interface/{db}/eshop/v1/typ_produktu
  • Status: implementované
  • Bearer: áno

GET /interface/{db}/eshop/v1/karty/premenne

Rozhranie dodáva zoznam užívateľských premenných pre skladové karty.

  • Status: implementované
  • Bearer: áno

GET /interface/{db}/eshop/v1/karty/premenne/kind

Rozhranie dodáva zoznam typov premenných.

  • Status: implementované
  • Bearer: áno

Všetky premenné

Rozhranie dodáva zoznam všetkých užívateľských premenných ku skladovej karte.

  • URL: GET /interface/{db}/eshop/v1/karty/premenne/all
  • Status: implementované
  • Bearer: áno

Dodané parametre:

  • id_property
  • id_ref (od v. API 3.0.1)
  • value
  • name (od v. API 3.0.1)
  • id_kind (od v. API 3.0.1)

[
    {
        "id_property": 7,
        "id_ref": 8,
        "value": 1,
        "name": "pm_int",
        "id_kind": 1
    },
    {
        "id_property": 8,
        "id_ref": 8,
        "value": 2.4,
        "name": "pm_double",
        "id_kind": 2
    },
    {
        "id_property": 10,
        "id_ref": 8,
        "value": true,
        "name": "pm_bool",
        "id_kind": 3
    },
    {
        "id_property": 11,
        "id_ref": 8,
        "value": "2023-07-24T08:00:00.000Z",
        "name": "pm_datetime",
        "id_kind": 4
    },
    {
        "id_property": 9,
        "id_ref": 8,
        "value": "Pokusný text",
        "name": "pm_text",
        "id_kind": 5
    }
]

Zoznam obrázkov ku skladovej karte

Rozhranie umožňuje pracovať so zoznamom obrázkov ku skladovým kartám.

  • URL: GET /interface/{db}/eshop/v1/karty/obrazky/subor
  • Status: implementované
  • Bearer: áno

Parametre:

  • id - Získanie obrázku s id_image=id.
  • karta_id - Získanie obrázkov ku skladovej karte.

Obrázok ku skladovej karte

Rozhranie dodá požadovaný obrázok. Od verzie API 2.3.0 vracia obrázok iba vtedy, ak má v programe zaškrtnuté odosielať do e-shopu.

  • URL: GET /interface/{db}/eshop/v1/karty/obrazky/subor
  • Status: implementované
  • Bearer: nie

Zoznam PDF ku skladovej karte

Rozhranie umožňuje pracovať so zoznamom PDF ku skladovým kartám. Zobrazuje iba tie PDF, ktoré majú v programe zaškrtnuté odosielať do e-shopu.

  • URL: GET /interface/{db}/eshop/v1/karty/pdf/subor
  • Status: implementované (API 2.7.3, program 5.77.0.60)
  • Bearer: áno

Parametre:

  • id - Získanie obrázku s id_image=id.
  • karta_id - Získanie obrázkov ku skladovej karte.

PDF ku skladovej karte

Rozhranie dodá požadované PDF. Vracia súbor iba vtedy, ak má v programe zaškrtnuté odosielať do e-shopu.

  • URL: GET /interface/{db}/eshop/v1/karty/pdf/subor
  • Status: implementované (API 2.7.3, program 5.77.0.60)
  • Bearer: nie

Súvisiace skladové karty

Funkcia dodá zoznam súvisiacich skladových kariet.

  • URL: GET /interface/{db}/eshop/v2/karty/suvisi
  • Status: implementované (API 2.0.0, program 5.30.0.19)
  • Bearer: áno
  • Parametre:
    • id: ID skladovej karty
    • all: Dodá aj také skladové karty, ktoré nie sú označená ako export do eshopu. Implicitná hodnota je false.

Príklad vrátenej odpovede. Položka eshop signalizuje, či je daná skladová karta exportovaná do e-shopu. Ak je tam false, potom by e-shop nemal takú kartu ponúkať, nakoľko nevie, čo je to za skladovú kartu.

{
  "items": [
    {
      "id": 101,
      "cislo": "SK2017/00001",
      "nazov": "Zemiaky",
      "eshop": true
    },
    {
      "id": 102,
      "cislo": "SK2019/00001",
      "nazov": "Jačmeň",
      "eshop": false
    }
  ]
}

Karta s variantom

Funkcia dodá informácie o všetkých variantoch danej skladovej karty.

  • URL: GET /interface/{db}/eshop/v1/karty/variant
  • Status: implementované (API 2.0.0, program 5.30.0.19)
  • Bearer: áno
  • Parametre:
    • id: ID skladovej karty

Toto je jednorozmerný variant. Daná skladová karta má variant Farba (Modrá, Červená). Výsledkom musí byť v objednávke id skladovej karty 33 (variant Farba Modrá) alebo 34 (variant Farba Žltá).

{
  "variants": [
    {
      "id_variant": 1,
      "variant": "Farba",
      "items": [
        {
          "id_item": 1,
          "item": "Modrá"
        },
        {
          "id_item": 2,
          "item": "žltá"
        }
      ]
    }
  ],
  "items": [
    {
      "id_variants": 1,
      "id_karta_variant": 33,
      "id_variant": 1,
      "id_item": 1
    },
    {
      "id_variants": 1,
      "id_karta_variant": 34,
      "id_variant": 1,
      "id_item": 2
    }
  ]
}

Toto je dvojrozmerný variant. V e-shope si musí kupujúci zakliknúť dva varianty a až potom sa dostaneme k ID skladovej karty.

{
  "variants": [
    {
      "id_variant": 1,
      "variant": "Farba",
      "items": [
        {
          "id_item": 1,
          "item": "Modrá"
        },
        {
          "id_item": 2,
          "item": "Žltá"
        }
      ]
    },
    {
      "id_variant": 2,
      "variant": "Veľkosť",
      "items": [
        {
          "id_item": 3,
          "item": "L"
        },
        {
          "id_item": 4,
          "item": "XL"
        }
      ]
    }
  ],
  "items": [
    {
      "id_variants": 1,
      "id_karta_variant": 33,
      "id_variant": 1,
      "id_item": 1
    },
    {
      "id_variants": 2,
      "id_karta_variant": 33,
      "id_variant": 2,
      "id_item": 3
    },
    ...
  ]
}

Overenie statusu skladovej karty

Funkcia dodá informácie o aktuálnom statuse skladovej karty voči e-shopu. Pomocou nej možno overiť, či daná skladová karta existuje a či je v e-shope alebo nie.

  • URL: GET /interface/{db}/eshop/v1/karty/status
  • Status: implementované (API 2.7.0, program 5.49.0.48)
  • Bearer: áno
  • Parametre:
    • id: ID skladovej karty

Návratové hodnoty:

  • 400 - Skladová karta s daným id sa nenašla. To znamená, ze takáto karta nie je v databáze. Alebo tam nikdy nebola, alebo bola vymazaná.
  • 200 - Našli sa údaje o skladovej karte. V takom prípade je možné z vrátenej odpovede zistiť, či má byť karta v e-shope alebo nie.
    • eshop_send - Ak je true, tak by táto karta mala byť v e-shope.
    • eshop_hidden - Ak je true a eshop_send je tiež true, potom sa jedná o skladovú kartu, ktorá sa síce prenáša do e-shopu, ale nemala by byť zobrazovaná v zozname. Jedná sa o špeciálne karty, ktoré sú variantou a smú sa použiť iba pri vytvorení objednávky.

{
    "karta_id": 25,
    "eshop_send": false,
    "eshop_hidden": false
}