API dokumentáció
Az API kommunikáció HTTP vagy SOAP alapú webszolgáltatásokon keresztül történik. Az API kapcsolat csak akkor használható, ha az áruház üzemeltető a harmadik kiegészítő modult is megrendeli. Minden paraméter XML vagy JSON formátumban küldhető át, a dokumentációban minden példában XML formátumot használunk.
Visszaadja a params változóban meghatározott feltételeknek megfelelő rendelések adatait. Egyszerre maximum 500 rendelés adatait lehet lekérni. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
A params paraméterben meghatározott azonosítóval rendelkező rendelés módosítható a paraméterben megadott értékekkel. A funkció egy XML-lel tér vissza, amiben szerepel a rendelés egyedi azonosítója és a végrehajtott művelet is, illetve az esetleges hiba. Ez a funkció óránként maximum 1000 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Az XML paraméterben egy teljes XML dokumentum stringet adhat meg a getOrder funkciónál meghatározott kimenethez hasonló formátumában. Itt több rendelés is szerepelhet. A funkció egy XML dokumentummal tér vissza, amiben szerepelnek a rendelések egyedi azonosítói és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk. Az XML segítségével csak a setOrder funkciónál meghatározott értékek módosíthatók. A feltölthető maximális XML méret 128MB lehet.
Visszaadja a params paraméterben meghatározott feltételeknek megfelelő termék raktárkészlet adatait. Ez a funkció óránként maximum 1000 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
A params paraméterben meghatározott terméket módosíthatja a paraméterben található értékekkel. A funkció egy XML dokumentummal tér vissza, amiben szerepel a termék egyedi azonosítója, cikkszáma, és a végrehajtott művelet is, illetve az esetleges hiba. Ez a funkció óránként maximum 1000 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Az XML paraméterben egy teljes XML dokumentum stringet adhat meg a getStock funkciónál meghatározott kimenet formátumában. Itt több termék, és több változat is szerepelhet. A funkció egy XML dokumentummal tér vissza, amiben szerepelnek a termékek egyedi azonosítói, cikkszámai, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk. Az XML-ben a setStock funkciónál meghatározott értékeket használhatja. A feltölthető maximális XML méret 128MB lehet.
Visszaadja a params paraméterben meghatározott feltételeknek megfelelő termékek adatait. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk. A válasz XML-ben (megfelelő feltételek esetén) szerepelnek a törölt termékek is, ezekről már csak a törlés tényét tároljuk (1 hónapig), egyéb adatot nem.
A params paraméterben meghatározott terméket módosíthatja meghatározott módon a paraméterben található értékekkel. A funkció egy XML dokumentummal tér vissza, amiben szerepel a termék egyedi azonosítója, cikkszáma, és a végrehajtott művelet is, illetve az esetleges hiba. Amennyiben nem létező cikkszámot ad meg, akkor a termék a megadott adatok alapján új termékként kerül rögzítésre. Ez a funkció óránként maximum 1000 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Az XML paraméterben egy teljes XML dokumentum stringet adhat meg a getProduct funkciónál meghatározott kimenethez hasonló formátumban. Itt több termék is szerepelhet. A funkció egy XML dokumentummal tér vissza, amiben szerepelnek a termékek egyedi azonosítói, cikkszámai, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk. Az XML-ben a setProduct és setStock funkcióknál meghatározott értékeket használjuk fel. A feltölthető maximális XML méret 128MB lehet.
A params paraméterben meghatározott formátumban generálódik egy teljes termék adatbázis. A termék adatbázis felépítése megegyezik az admin felületen a Termékek/Termék adatbázis menüben letölthető adatbázis felépítésével. A funkció egy XML dokumentummal tér vissza, amiben szerepel a generált termék adatbázis URL-je, ezt 1 órán belül kell letölteni. Ez a funkció óránként maximum 3 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Az admin felületen a Termékek/Termék adatbázis menüben vagy a getProductDB funkcióval letöltött adatbázist lehet visszatölteni az áruházba, ennek segítségével a termékek szinte összes adata módosítható, illetve új termkek is rögzíthetők. A funkció egy XML dokumentummal tér vissza, amiben az importtal kapcsolatos statisztikai adatok szerepelnek. Ez a funkció óránként maximum 2 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Visszaadja a params paraméterben meghatározott feltételeknek megfelelő kategóriák adatait. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Visszaadja a params paraméterben meghatározott feltételeknek megfelelő vásárlók adatait. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Visszaadja a params paraméterben meghatározott feltételeknek megfelelő hírlevél igénylők adatait. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
A params paraméterben meghatározott hírlevél igénylőket módosíthatja, feliratkoztathatja, törölheti meghatározott módon a paraméterben található értékekkel. A funkció egy XML dokumentummal tér vissza, amiben szerepel a megadott e-mail cím, és a végrehajtott művelet is, illetve az esetleges hiba. Ez a funkció óránként maximum 1000 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk.
Az XML paraméterben egy teljes XML dokumentum stringet adhat meg a getNewsletter funkciónál meghatározott kimenet formátumában. Itt több e-mail cím is szerepelhet. A funkció egy XML dokumentummal tér vissza, amiben szerepelnek az e-mail címek, és a végrehajtott műveletek is, illetve az esetleges hiba. Hiba észlelése esetén a bemeneti XML feldolgozása leáll, a hibát megelőző helyes adatok alapján a műveletek végrehajtódnak, azt követően azonban nem. Ez a funkció óránként maximum 20 alkalommal használható egy IP címről, 20 egymást követő hibás kérés esetén pedig az IP címet egy órára kitiltjuk. Az XML-ben a setNewsletter funkciónál meghatározott értékeket használhatja.