A kuponokat az alább látható adatszerkezet segítségével tudod kezelni. Az itt látható módon kell kérést intézni a szerverhez, ahol az egyes mezőkhöz külön található leírás arról, hogy melyik adattag használható a getCoupon illetve setCoupon végpontokhoz, GET illetve SET jelöléssel láttuk el ezeket a mezőket.
Action enum SET
A setCoupon kérésben az API műveletet határozhatod meg.
Használható értékek
add Hozzáadás
modify Módosítás
delete Törlés
Id string GET SET
A kupon egyedi azonosítója, mely egyben a kódja is. SET végpontnál, új kupon létrehozása esetén kötelezően megadható elem, míg meglévő kupon módosítása során csak azonosító adatként használható, nem módosítható.
BaseType string GET SET
A kupon típusa.
Használható értékek
product Termék kedvezmény
total Végösszeg kedvezmény
shipping Ingyenes szállítás
giftcard Ajándékkártya
Type enum GET SET
A kupon jellege.
FONTOS megkötések az adattag használatára vonatkozóan:
- Ingyenes szállítás és ajándékkártya típus esetén nincs értelmezve.
- Végösszeg kedvezmény típus esetén CSAK [amount] és [percent] használható.
- A speciális százalékos opciók CSAK termék kedvezmény típus esetén használhatók!
Használható értékek
amount Összegszerű (A kupon kedvezmények összege maximum a megadott összeg lehet)
amount_multi Összegszerű (Minden terméknél külön-külön felhasználható)
percent Százalékos
percent_mostexpensive Százalékos (a termék árától függően) - Csak a legmagasabb egységárú termék teljes mennyiségére
percent_mostexpensive_one Százalékos (a termék árától függően) - Csak a legmagasabb egységárú termékből 1db-ra
percent_mostexpensive_item Százalékos (a termék árától függően) - Csak a legmagasabb összértékű tételre
percent_cheapest Százalékos (a termék árától függően) - Csak a legalacsonyabb egységárú termék teljes mennyiségére
percent_cheapest_one Százalékos (a termék árától függően) - Csak a legalacsonyabb egységárú termékből 1db-ra
percent_cheapest_item Százalékos (a termék árától függően) - Csak a legalacsonyabb összértékű tételre
DiscountFrom string GET SET
Az adott kupon felhasználása során a kedvezményt melyik árból vonjuk le.
Használható értékek
actual_price Aktuális árból, ha van akciós ár, akkor abból is
base_price_discount_forbidden Alapárból, de csak akkor, ha nincs akciós ár
base_price_if_cheaper_than_sale Alapárból, de csak akkor, ha kuponnal alacsonyabb ár lesz, mint az akciós ár
Template enum GET SET
Az adott kupon sablon-e a rendszerben vagy sem. Kupon sablon közvetlenül nem érvényesíthető vagy használható fel, de készíthető belőle manuálisan vagy automatikusan normál kupon. Meglévő kupon esetén nem módosítható.
Használható értékek
yes Igen
no Nem
SendOrderStatus enum GET SET
Csak kuponsablon esetén értelmezett. Automatikus kupon generálás során megadható, hogy melyik rendelési státuszba váltás során generálódjon a tényleges kupon a sablonból.
Value string GET SET
A kupon értéke. Ingyenes szállítás típus esetén nincs értelmezve.
UsedAmount integer GET SET
Ajándékkártya típus esetén értelmezett. A kiállított kupon felhasznált értékét mutatja.
NumberOfUses integer GET
Hányszor használták fel a kupon a vásárlások során. Template esetén nem értelmezett.
OrderKey string GET SET
Ajándékkártya típus esetén értelmezett. Azon rendelés azonosítóját tartalmazza, melyben a kupont érvényesítette a vásárló.
PercentMaximumValue string GET SET
Százalékos jelleg esetén a kupon kedvezmény maximális értéke.
Dates object GET SET
A módhoz tartozó időbeli korlátozás.
Dates.Date object GET SET
Egy konkrét idő sáv adatait tartalmazza.
Dates.Date.Start date GET SET
Az időbeli korlát kezdeti időpontja, az elvárt formátum YYYY.MM.DD. HH:MM:SS. Ha nincs meghatározva (nyitott intervallum), akkor egy kötőjelet kell megadni értékként.
Dates.Date.End date GET SET
Az időbeli korlát végidőpontja, az elvárt formátum YYYY.MM.DD. HH:MM:SS. Ha nincs meghatározva (nyitott intervallum), akkor egy kötőjelet kell megadni értékként.
TimeStart date GET SET
A megadható időintervallum kezdeti időpontja, az elvárt formátum HH:MM.
TimeEnd date GET SET
A megadható időintervallum végidőpontja, az elvárt formátum HH:MM.
Days string GET SET
Megadtható, hogy mely napokon legyen elérhető a mód, a nap sorszámait szükséges megadni vesszővel elválasztva. pl. 1,5,6,12
Months string GET SET
Megadtható, hogy mely hónapokon legyen elérhető a mód, a hónap neveket szükséges megadni vesszővel elválasztva angol nyelven. pl. april,july,december
Weekdays string GET SET
Megadtható, hogy a hét mely napjain legyen elérhető a mód, a napok neveit szükséges megadni vesszővel elválasztva angol nyelven. pl. monday,friday,sunday
OnlyHolidays enum GET SET
A mód csak munkaszüneti napokon legyen elérhető.
Használható értékek
yes Igen
no Nem
ExceptHolidays enum GET SET
A mód csak munkaszüneti napok kivételével legyen elérhető.
Használható értékek
yes Igen
no Nem
OnlyOpeningHours enum GET SET
A mód csak nyitvatartási időben legyen elérhető.
Használható értékek
yes Igen
no Nem
ExceptOpeningHours enum GET SET
A mód csak nyitvatartási időn kívül legyen elérhető.
Használható értékek
yes Igen
no Nem
MaxUsabilityInOrders integer GET SET
A kupon mennyi rendelésben érvényesíthető összesen.
MaxUsabilityPerCustomer integer GET SET
Egy vásárló mennyi rendelésben használhatja fel a kupont.
UsabilityForNewCustomers enum GET SET
Új vásárló használhatja-e a kupont vagy sem (azaz első rendelés során érvényesíthető-e a kupon).
Használható értékek
new Új vásárló
old Visszatérő vásárló
everyone Bárki
CustomerTypes object GET SET
A kupon mely vásárló típushoz van rendelve.
CustomerTypes.CustomerType enum GET SET
A konkrét vásárló típus.
Használható értékek
private Magánszemély
company Cég
other_customer_without_tax_number Egyéb, adószámmal nem rendelkező vásárló
MinimumOrderValue object GET SET
Milyen rendelési összeg felett lehessen felhasználni a kupont.
MinimumOrderValueByProducts string GET SET
Mennyi legyen a kupon által érintett termékek összege a kosárban a kupon érvényre jutásához.
MinimumItemCount object GET SET
Legalább ennyi tételnek kell a kosárban lennie, hogy felhasználható legyen.
AllowedForSubscriber enum GET SET
Csak hírlevélre feliratkozó használhatja-e fel a kupont vagy sem.
Használható értékek
everyone Nem, mindenki felhasználhatja.
registered_and_subscribed Igen, csak regisztrált vásárlóként feliratkozó használhatja.
subscribed Igen, bármilyen feliratkozó használhatja.
Customer object GET SET
Kupon vásárlóhoz kötése (email cím).
Groups object GET SET
Vásárló csoporthoz kötött kuponok esetén találhatók meg ez alatt a konkrét csoport adatok.
Groups.Group object GET SET
Egy konkrét vásárló csoport adatai.
Groups.Group.Id object GET SET
Egy konkrét vásárló csoport azonosítója az áruházban.
Használható értékek
0 Mindenki számára elérhető.
-1 Csak a csoporton kívüliek számára elérhető.
csoport azonosító Az adott csoport számára elérhető.
Groups.Group.Name object GET
Egy konkrét vásárló csoport neve az áruházban.
Search integer GET SET
Azon kereső kifejezés, ami szerepel a termék nevében, melyre érvényesa kupon.
Adminisztrátori megjegyzés.
Notification enum GET SET
Ajándékkártya esetén értelmezett, a vásárló számára kiküldött emailben ez a plusz tartalom jelenik meg a kupon kódja mellett.
DisableForSaleProducts enum GET SET
Akciós termékre a kupon beváltható-e vagy sem.
Használható értékek
yes Igen
no Nem
DisableWhenQtyDiscount enum GET SET
Mennyiségi kedvezmény esetén a kupon beváltható-e vagy sem.
Használható értékek
yes Igen
no Nem
DisableWhenPointUse enum GET SET
Pontfelhasználás esetén a kupon beváltható-e vagy sem.
Használható értékek
yes Igen
no Nem
AllowCouponCombination enum GET SET
Beváltható-e más kuponokkal együtt.
Használható értékek
yes Igen
no Nem
DisableOnSale enum GET SET
Csak végösszeg kedvezmény esetén értelmezett. Ha akciós termék is van a kosárban a végösszeg kupon beváltható-e vagy sem.
Használható értékek
yes Igen
no Nem
UsableFor object GET SET
Csak termék kedvezmény típus esetén értelmezett. Megadható, hogy konkrétan melyik termékre vagy kategóriára legyen érvényesíthető a kupon.
UsableFor.Type string GET SET
A jelzett termékekre illetve kategóriákra érvényes vagy nem érvényes a kupon.
Használható értékek
allow Érvényes
deny Nem érvényes
UsableFor.Products object GET SET
Mely termékekre érvényesíthető a kupon.
UsableFor.Products.Product object GET SET
Egy konkrét termék adatai, melyre érvényesíthető a kupon.
UsableFor.Products.Product.Sku string GET SET
A termék cikkszáma.
UsableFor.Products.Product.Name string GET
A termék neve.
UsableFor.Categories object GET SET
Mely kategóriák termékeire érvényesíthető a kupon.
UsableFor.Categories.Category object GET SET
Egy konkrét kategória adatai, melynek termékeire érvényesíthető a kupon.
UsableFor.Categories.Category.Id string GET SET
A kategória azonosítója.
UsableFor.Categories.Category.Name string GET
A kategória neve.
AllowedShippingMethods object GET SET
Ingyenes szállítás típusú kupon esetén a kuponhoz kapcsolt szállítási módok adatai.
AllowedShippingMethods.AllowedShippingMethod object GET SET
Egy konkrét szállítási mód adatai.
AllowedShippingMethods.AllowedShippingMethod.Id string GET SET
A szállítási mód azonosítója.
AllowedShippingMethods.AllowedShippingMethod.Name string GET
A szállítási mód neve.
CouponUrl string GET
A kupon közvetlen URL-je, melyen keresztül egyből érvényesíthető a kupon az áruházban (pl. landing page-ek, hírlevelek használata során a vásárló átirányításával).
CreateTime string GET
A kupon generálás időpontja timestamp-ként megjelenítve.
