A fizetési és szállítási módokat 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 getMethod illetve setMethod végpontokhoz, GET
illetve SET
jelöléssel láttuk el ezeket a mezőket.
Action enum
SET
A setMethod 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 integer
GET
SET
A mód egyedi azonosítója. SET
végpontnál, új mód létrehozása esetén kötelezően megadható elem, míg meglévő mód módosítása során csak azonosító adatként használható, nem módosítható.
ProviderId string
GET
A fizetési és szállítási módhoz kapcsolódó szolgáltató azonosítója (pl. gls_hu vagy otp_hu).
Name string
GET
SET
A mód megnevezése.
Active string
GET
SET
A mód állapota, miszerint aktív (választható) vagy sem az áruházban.
Type string
GET
SET
A mód típusa.
Használható értékek
payment
Fizetési mód
shipping
Szállítási mód
SubType string
GET
SET
A fizetési mód típusa (szállítási módnál nem értelmezett!).
Használható értékek
transfer
Átutalás
cash
Készpénz
cod
Utánvét
check
Csekk
credit
Áruhitel
bankcard
Bankkártya
popup
Bankkártya (megjelenését tekintve az áruház felületén felugró ablakban)
coupon
Kupon
bnpl
Halasztott fizetés (Buy Now Pay Later)
qvik
Qvik (QR kód, link)
bankcard_qvik
Bankkártya vagy qvik
Text string
GET
SET
A módhoz tartozó, vásárlók által is látható rövid leírás.
AlterText string
GET
SET
A módhoz tartozó alternatív leírás, mely a megrendelés visszaigazoló emailben jelenik meg.
Order integer
GET
SET
A vásárló felületen a választható módok listájának sorrendjét meghatározó érték.
OrderStatus integer
GET
SET
Ha a megrendeléshez ezt a módot választja a vásárló, akkor a kiválasztott státuszba kerül a megrendelés.
OrderType string
GET
SET
Ha az adott mód csak bizonyos megrendelés típus esetén alkalmazható, azt ezen adat tartalmazza.
ForeignKey string
GET
SET
A módhoz tartozó külső azonosító.
DisplayOnContactPage string
GET
SET
Az adott mód megjelenik-e az Információk oldalon.
Használható értékek
yes
Igen
yes_force
Igen, még akkor is, ha nem aktív
no
Nem
Tax float
GET
SET
A módhoz tartozó ÁFA kulcs (0 és 100 közötti érték lehet).
PaymentHandlingOnNewOrder string
GET
SET
A fizetési mód választása során egy új rendelés rögzítésekor be legyen kapcsolva automatikusan a fizetés kezelés vagy sem (szállítási módnál nem értelmezett!).
Használható értékek
default
Áruházi alapbeállítás
yes
Igen
no
Nem
DeliveryPointGroup string
GET
SET
A szállítási módhoz tartozó átvételi pont csoport neve (fizetési módnál nem értelmezett!).
Weight float
GET
SET
A szállítási módhoz tartozó tömeg, mint a csomagolás tömege (fizetési módnál nem értelmezett!).
Limitations object
GET
SET
A módhoz tartozó különböző korlátozások.
Limitations.MinWeight float
GET
SET
A módhoz tartozó megengedett minimum tömeg.
Limitations.MaxWeight float
GET
SET
A módhoz tartozó megengedett maximum tömeg.
Limitations.MinPrice float
GET
SET
A módhoz tartozó megengedett minimum rendelési összeg.
Limitations.MaxPrice float
GET
SET
A módhoz tartozó megengedett maximum rendelési összeg.
Limitations.MinVolume float
GET
SET
A szállítási módhoz tartozó megengedett minimum térfogat (fizetési módnál nem értelmezett!).
Limitations.MaxVolume float
GET
SET
A szállítási módhoz tartozó megengedett maximum térfogat (fizetési módnál nem értelmezett!).
Limitations.MinWidth float
GET
SET
A szállítási módhoz tartozó megengedett minimum szélesség (fizetési módnál nem értelmezett!).
Limitations.MaxWidth float
GET
SET
A szállítási módhoz tartozó megengedett maximum szélesség (fizetési módnál nem értelmezett!).
Limitations.MinHeight float
GET
SET
A szállítási módhoz tartozó megengedett minimum magasság (fizetési módnál nem értelmezett!).
Limitations.MaxHeight float
GET
SET
A szállítási módhoz tartozó megengedett maximum magasság (fizetési módnál nem értelmezett!).
Limitations.MinDepth float
GET
SET
A szállítási módhoz tartozó megengedett minimum hosszúság (fizetési módnál nem értelmezett!).
Limitations.MaxDepth float
GET
SET
A szállítási módhoz tartozó megengedett maximum hosszúság (fizetési módnál nem értelmezett!).
Limitations.Area object
GET
SET
A módhoz tartozó területi korlátozás.
Limitations.Area.Name string
GET
SET
A módhoz tartozó területi korlátozás megnevezése.
Limitations.Currency string
GET
SET
A fizetési módhoz tartozó pénznem, csak ennek választása esetén alkalmazható a mód a megrendelés során (szállítási módnál nem értelmezett!).
Limitations.AllProductIsOnStock string
GET
SET
Adott mód csak akkor választható a megrendelési folyamatban, ha minden kosárban levő termék van raktáron.
Limitations.NotAllProductIsOnStock string
GET
SET
Adott mód csak akkor választható a megrendelési folyamatban, ha van olyan termék a kosárban, ami nincs raktáron.
Limitations.Dates object
GET
SET
A módhoz tartozó időbeli korlátozás.
Limitations.Dates.Date object
GET
SET
Egy konkrét idő sáv adatait tartalmazza.
Limitations.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.
Limitations.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.
Limitations.CustomerGroups object
GET
SET
A módhoz tartozó vásárló csoport szintű korlátozás (csak adott csoport vásárlói számára elérhető a mód).
Limitations.CustomerGroups.CustomerGroup object
GET
SET
Egy konkrét vásárló csoport.
Limitations.CustomerGroups.CustomerGroup.Id integer
GET
SET
A vásárló csoport azonosítója.
Limitations.CustomerGroups.CustomerGroup.Name string
GET
SET
A vásárló csoport neve.
Limitations.CustomerTypes object
GET
SET
A módhoz tartozó vásárló típus alapú korlátozás.
Limitations.CustomerTypes.CustomerType string
GET
SET
Egy adott 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ó
Limitations.AvailableInLanguages object
GET
SET
A módhoz tartozó nyelv szintű korlátozás.
Limitations.AvailableInLanguages.Language string
GET
SET
Egy adott nyelv (pl. hu, en stb.).
Limitations.UseWithSubscription string
GET
SET
Termék előfizetési mol esetén az adott mód hogyan alkalmazható ebből a szempontból. Alapértelmezetten minden esetben használéható, választható a mód a rendelési folyamatban.
Használható értékek
cart_without_subscription
Ha nincs előfizetés a kosárban
cart_with_subscription
Ha van előfizetés a kosárban
ShippingFee object
GET
SET
A szállítási módhoz tartozó szállítási költség (fizetési módnál nem értelmezett!).
ShippingFee.Type string
GET
SET
A szállítási módhoz tartozó szállítási költség típusa.
Használható értékek
amount
Végösszeg szerinti szállítási költség
weight
Tömeg szerinti szállítási költség
product_count
Termék mennyiség szerinti szállítási költség
fix_amount
Fix szállítási költség
fix_text
Fix szöveg megjelenítése a szállítási költségnél
ShippingFee.Fee object
GET
SET
A szállítási költséghez tartozó konkrét értékek.
ShippingFee.Fee.LowerLimit string
GET
SET
Az amount
, weight
és product_count
szállítási költség típushoz tartozó érték alsó határa (fix_text
és fix_amount
esetén nincs értelmezve).
ShippingFee.Fee.UpperLimit string
GET
SET
Az amount
, weight
és product_count
szállítási költség típushoz tartozó érték felső határa (fix_text
és fix_amount
esetén nincs értelmezve).
ShippingFee.Fee.Amount string
GET
SET
A fix_amount
, amount
, weight
és product_count
szállítási költség típushoz tartozó érték.
ShippingFee.Fee.Text string
GET
SET
A fix_text
szállítási költség típushoz tartozó érték.
AdditionalCosts object
GET
SET
A fizetési módhoz tartozó kezelési költség értékek (szállítási módnál nem értelmezett!).
AdditionalCosts.Amount float
GET
SET
A fizetési módhoz tartozó összegszerű kezelési költség.
AdditionalCosts.Percent float
GET
SET
A fizetési módhoz tartozó százalékos kezelési költség.
AdditionalCosts.Min float
GET
SET
A fizetési módhoz tartozó minimális kezelési költség.
AdditionalCosts.Max float
GET
SET
A fizetési módhoz tartozó maximum kezelési költség.
Creation string
GET
SET
A mód létrehozásának időpontja.
Modification string
GET
SET
A mód utolsó módosításának időpontja.
CustomData string
GET
Integráció specifikus adatok.