A kategóriák kezeléséhez az ebben a fejezetben megtalálható adatszerkezetnek megfelelően kapod a getCategory kérésre a választ, illetve ilyen formában kell beküldened a setCategory kérést. Az egyes mezőkhöz külön található leírás is. Feltüntetjük, hogy melyik adattag használható a getCategory illetve setCategory végpontokhoz, GET illetve SET jelöléssel láttuk el ezeket a mezőket. LANG jelöléssel láttuk el azokat az adatokat a leírásban, amelyeknél a kérés során különböző nyelveken is alkalmazható a lekérdezés és a módosítás. A Lang adatot setCategory kérés esetén az egyes Category node-okon belül kell elhelyezni.
Az egyes mezőknél a magyarázat mellett az is látható, hogy a konkrét adat milyen tartalmi szinten érhető el: minimal, normal vagy full. Itt csak a minimális elérési szinteket jelöljük, azaz ha egy adat elérhető például normal szinten, akkor ugyancsak szerepelni fog a válaszban full esetén is. Ha egy konkrét adatnál nincs külön jelölés, akkor az már minimal szinten is elérhető.
Action SET enum
setCategory API hívás esetén a művelet típusa.
Használható értékek
add Hozzáadás
modify Módosítás
delete Törlés
State enum GET
A kategória állapota.
Lehetséges értékek
live Létező kategória
deleted Törölt kategória
Id integer GET SET
A kategória egyedi azonosítója. Automatikusan generált adat, setCategory funkció esetében csak azonosításra szolgál.
Name string normal GET SET LANG
A kategória neve.
NameOnPage string normal GET SET LANG
A kategória neve a kategória oldalon.
Url string GET LANG
A kategória teljes URL-je.
SefUrl string normal GET SET LANG
A kategóriához beállított keresőbarát URL.
AltUrl string GET SET LANG
Alternatív URL, ha megadásra került, úgy a kategóriát ide irányítja át a rendszer a vásárló felületen.
AltUrlBlank enum normal GET SET
Új ablakban nyíljon e meg az alternatív URL.
Megjelenő értékek
yes no
Display object normal GET SET
Adott kategória hol legyen látható.
Display.Page string GET SET
Kategória oldalon megjelenjen e a kategória vagy sem.
Használható értékek
yes no
Kategória menüben megjelenjen e a kategória vagy sem.
Használható értékek
yes no
DisableFilter string normal GET SET
Adott kategóriában a szűrő opció tiltva van-e vagy sem.
Használható értékek
yes no
PublicInterval object GET SET
A kategória publikus időszaka.
PublicInterval.Start string GET SET
A kategória publikus időszakának kezdeti dátuma. Elvárt formátum Y.m.d H:i:s
PublicInterval.End string GET SET
A kategória publikus időszakának lejárati dátuma. Elvárt formátum Y.m.d H:i:s
NotVisibleInLanguage object full GET SET
A kategória melyik áruházi nyelven nem elérhető.
NotVisibleInLanguage.Language string full GET SET
A tiltott nyelv angol nyelvű megnevezése (pl. hungarian, english stb.).
PageLayout object GET SET
A kategóriához tartozó egyedi oldal kinézet sablonok.
PageLayout.ProductList integer GET SET
Termék lista oldal egyedi sablon azonosítója.
PageLayout.CategoryList integer GET SET
Kategória oldalhoz tartozó egyedi kinézet sablon azonosítója.
ArticleOrder string GET SET
A kategóriához tartozó termékek sorrendje a listában.
FeaturedProducts object GET SET
A kategóriához tartozó kiemelt termékek.
FeaturedProducts.Skus object GET SET
A kategóriához tartozó kiemelt termékek listája.
FeaturedProducts.Skus.Sku string GET SET
A kategóriához tartozó egy konkrét kiemelt termékek cikkszáma.
FeaturedProducts.OrderTypes object GET SET
Azon termék sorrendezési típusok, melyeknél a kategóriához tartozó kiemelt termékeka lista elején jelennek meg.
FeaturedProducts.OrderTypes.OrderType string GET SET
Egy konkrét sorrendezési típus.
Parent object GET SET
Szülő kategória adatok.
Parent.Id integer GET SET
Szülő kategória egyedi azonosítója.
Parent.Tree string normal GET SET LANG
Szülő kategória fa, "|" (pipe; bill. kombinációja AltGr + W) jelekkel elválasztva.
Order integer GET SET
Egyedi sorrend érték.
Products object GET
Termék adatok.
Products.Active integer GET
A kategóriában megtalálható aktív termék száma.
Products.New integer GET
A kategóriában megtalálható új termékek száma.
Texts object normal GET SET
Kategória szövegek.
Texts.Top string normal GET SET LANG
Kategória felett megjelenő szöveg.
Texts.Bottom string normal GET SET LANG
Kategória alatt megjelenő szöveg.
Kategória menüben látható szöveg.
Meta object normal GET SET
Kategóriához tartozó meta adatok.
Meta.Keywords string normal GET SET LANG
Kategóriához tartozó kulcsszó (keywords) meta tag tartalma.
Meta.Description string normal GET SET LANG
Kategóriához tartozó leírás (description) meta tag tartalma.
Meta.Title string normal GET SET LANG
Kategóriához tartozó cím (title) tag tartalma.
Meta.Robots string normal GET SET
Kategóriához tartozó robots meta tag tartalma.
AutomaticMeta string normal GET
Amennyiben nincs manuálisan beállított meta adat, úgy a rendszer az alapbeállítások szerint generál automatikus meta adatokat.
AutomaticMeta.Keywords string normal GET SET
Automatikusan generált kulcsszó (keywords) tartalma.
AutomaticMeta.Description string normal GET SET
Automatikusan generált leírás (description) tartalma.
AutomaticMeta.Title string normal GET SET
Automatikusan generált cím (title) tartalma.
CreateTime unix timestamp GET
A kategória létrehozásának időpontja időbélyeg (Unix timestamp) formátumban.
LastModTime unix timestamp GET
A kategória utolsó módosításának időpontja időbélyeg (Unix timestamp) formátumban.
Image object normal GET SET
Kategória kép adatok.
Image.Url string normal GET
Kategória kép elérési URL.
Image.OG string GET SET LANG
Kategória OG Image elérési URL.
Image.Version string SET
Kép verzió. Csak setCategory végpontnál használható. A meglévő kép módosításakor értelmezett. Kérünk, hogy kép verziót valóban csak indokolt esetben küldj, azaz képet csak akkor cserélj az áruházban, ha az valóban változott, így elkerülhetők az alábbi limitációk!
Limitációk
Ha 5 alkalommal küldtél már kép verziót, azt követően hetente egyszer fogjuk csak feldolgozni a kép verzió frissítést.
Ha 10 alkalommal volt már kép verzió megadás, azt követően két hetente egyszer dolgozzuk fel a kérést.
Ha 15 alkalommal volt kép verzió megadva, havonta egyszer dolgozzuk fel kérést.
Ha 20 alkalom vagy annál többször, úgy pedig csak kéthavonta egyszer dolgozzuk fel a képfrissítési kérést.
A felsorolt limitációkat kategóriánként kell értelmezni.
Image.Import object SET
Az importálandó kép. Csak setCategory végpontnál használható, időzítve töltjük át a képeket, ha még nincs kép rögzítve a termékhez.
Image.Import.Url string SET
Az importálandó kép URL-je.
Tags string full GET SET
Kategóriához tartozó címkék, melyekkel pl. szűrést lehet végezni kategória lista oldalakon.
Tags.Tag string full GET SET LANG
A kategóriához tartozó címke.
History object GET
Adott kategórián elvégzett műveletek egy hónapra visszamenőleg.
History.Event object GET
Ez a mező egy kategóriához kapcsolódó eseményt ír le.
History.Event.Action enum GET
A műveletet leíró mező.
Megjelenő értékek
add Hozzáadás
modify Módosítás
delete Törlés
History.Event.Time GET unix time
Az esemény időpontja.
History.Event.Id integer GET
A kategória egyedi azonosítója.
