A megrendelések kezeléséhez az ebben a fejezetben megtalálható adatszerkezetnek megfelelően kapod a getOrder kérésre a választ, illetve ilyen formában kell beküldened a setOrder 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 getOrder illetve setOrder végpontokhoz a GET
illetve SET
jelölések mentén.
Action enum
SET
Az API hívásban használt művelet, csak setOrder végpont esetén használható.
Használható értékek
add
Hozzáadás
modify
Módosítás
Key string
GET
SET
A megrendelés azonosítója. A setOrder funkciónál csak azonosításra használható. Korábban törölt rendelés azonosítóját újra kioszthatjuk!
InternalKey string
GET
Amennyiben a rendelést eredetileg egy külső rendszerben adták le (pl. Emag, Árukereső.hu), ebben az adattagban látható az Unas rendszerbeli rendelés azonosító (ilyen rendelésnél a normál Key mezőben a külső rendszerbeli rendelés azonosító található).
Id string
GET
A megrendelés egyedi azonosítója. A setOrder funkciónál azonosításra NEM használható, erre a célra a Key node-ot kell használni.
Date string
GET
SET
A megrendelés időpontja. A setOrder funkciónál csak új megrendelés rögzítésekor használható.
DateMod string
GET
A megrendelés utolsó módosításának időpontja.
Lang string
GET
A megrendelés során használt nyelv, setOrder végpont használatakor új rendelés rögzítése során az Unas áruház vásárló felületi alapnyelve lesz a használt nyelv.
Customer object
GET
SET
A vásárló adatai.
Customer.Id integer
GET
SET
A vásárló egyedi azonosítója. A válaszban akkor szerepel, ha regisztrált vásárló adta le a megrendelést, setOrder esetén csak azonosításra használható.
Customer.Email string
GET
SET
A vásárló e-mail címe, ha a vásárlóhoz tartozik e-mail cím.
Customer.EmailWarning string
GET
Ha az email cím nem létezik, vagy a létezését nem lehetett ellenőrizni, akkor node értéke 1
.
Customer.Username string
GET
SET
A vásárló felhasználóneve, ha a vásárlóhoz tartozik felhasználónév.
Customer.Contact object
GET
SET
A kapcsolattartó adatai.
Customer.Contact.Name string
GET
SET
A kapcsolattartó neve.
Customer.Contact.Phone string
GET
SET
A kapcsolattartó telefonszáma.
Customer.Contact.Mobile string
GET
SET
A kapcsolattartó mobiltelefon száma.
Customer.Addresses object
GET
SET
A megrendeléshez tartozó szállítási és számlázási címek.
Customer.Addresses.Invoice object
GET
SET
A vásárló számlázási címe.
Customer.Addresses.Invoice.Name string
GET
SET
A számlázási címhez tartozó név.
Customer.Addresses.Invoice.ZIP string
GET
SET
A számlázási címhez tartozó irányító szám.
Customer.Addresses.Invoice.City string
GET
SET
A számlázási címhez tartozó város.
Customer.Addresses.Invoice.Street string
GET
SET
A pontos számlázási cím.
Customer.Addresses.Invoice.StreetName string
GET
SET
A számlázási címhez tartozó közterület neve.
Customer.Addresses.Invoice.StreetType string
GET
SET
A számlázási címhez tartozó közterület jellege.
Customer.Addresses.Invoice.StreetNumber string
GET
SET
A számlázási címhez tartozó házszám, emelet ajtó stb.
Customer.Addresses.Invoice.County string
GET
SET
A számlázási címhez tartozó megye.
Customer.Addresses.Invoice.Country string
GET
SET
A számlázási címhez tartozó ország.
Customer.Addresses.Invoice.CountryCode string
GET
SET
A számlázási címhez tartozó országkód.
Customer.Addresses.Invoice.TaxNumber string
GET
SET
A vásárló adószáma.
Customer.Addresses.Invoice.EUTaxNumber string
GET
SET
A vásárló EU adószáma.
Customer.Addresses.Invoice.CustomerType enum
GET
SET
A vásárló típusa.
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ó - használata áruházi beállítástól is függ!
Customer.Addresses.Shipping object
GET
SET
A vásárló szállítási címe.
Customer.Addresses.Shipping.Name string
GET
SET
A szállítási címhez tartozó név.
Customer.Addresses.Shipping.ZIP string
GET
SET
A szállítási címhez tartozó irányítószám.
Customer.Addresses.Shipping.City string
GET
SET
A szállítási címhez tartozó város.
Customer.Addresses.Shipping.Street string
GET
SET
A pontos szállítási cím.
Customer.Addresses.Shipping.StreetName string
GET
SET
Szállítási címhez tartozó közterület neve.
Customer.Addresses.Shipping.StreetType string
GET
SET
Szállítási címhez tartozó közterület jellege.
Customer.Addresses.Shipping.StreetNumber string
GET
SET
Szállítási címhez tartozó házszám, emelet, ajtó.
Customer.Addresses.Shipping.County string
GET
SET
A szállítási címhez tartozó megye.
Customer.Addresses.Shipping.Country string
GET
SET
A szállítási címhez tartozó ország.
Customer.Addresses.Shipping.CountryCode string
GET
SET
A szállítási címhez tartozó ország kódja.
Customer.Addresses.Shipping.DeliveryPointID string
GET
SET
Átvételi pontra szállításkor az átvételi pont azonosítója.
Customer.Addresses.Shipping.AltDeliveryPointID string
GET
Átvételi pontra szállítás esetén ha a szállító cég további azonosítót is kezel, annak értéke látható itt.
Customer.Addresses.Shipping.DeliveryPointGroup string
GET
SET
Átvételi pontra szállításkor az átvételi pont csoport azonosítója.
Customer.Addresses.Shipping.DeliveryPointSubGroup string
GET
SET
Átvételi pont csoport típusa (posta, postapont, csomagautomata), csak a DeliveryPointGroup megadásával együtt használható.
Customer.Addresses.Shipping.RecipientName string
GET
SET
Átvételi pontra szállításkor az átvevő neve.
Customer.Group object
GET
SET
A vásárlóhoz tartozó csoport adatai.
Customer.Group.Id integer
GET
SET
A vásárló csoport egyedi azonosítója.
Customer.Group.Name string
GET
SET
A vásárló csoport neve.
Customer.Group.ForeignID integer
GET
Vásárló csoport külső azonosítója.
Customer.Params object
GET
SET
A vásárló által a regisztrációkor kitöltött vásárló paraméterek.
Customer.Params.Param object
GET
SET
Egy vásárló paraméter.
Customer.Params.Param.Id object
GET
SET
A vásárló paraméter azonosítója.
Customer.Params.Param.Name string
GET
SET
A vásárló paraméter neve.
Customer.Params.Param.Value string
GET
SET
A vásárló paraméter értéke.
Items object
GET
SET
A rendelt tételek.
Items.Item object
GET
SET
Egy rendelés tétel.
Items.Item.Id string
GET
SET
A megrendelt termék egyedi azonosítója.
Items.Item.Sku string
GET
SET
A megrendelt termék cikkszáma.
Items.Item.Name string
GET
SET
A megrendelt termék neve.
Items.Item.Variants.Variant object
GET
SET
Választható tulajdonság.
Items.Item.Variants.Variant.Id integer
GET
SET
A választható tulajdonság sorszáma.
Items.Item.Variants.Variant.Name string
GET
SET
A választható tulajdonság neve.
Items.Item.Variants.Variant.Value string
GET
SET
A választható tulajdonság értéke.
Items.Item.ProductParams object
GET
A termékhez tartozó termék paraméterek.
Items.Item.ProductParams.ProductParam object
GET
Egy termék paraméter.
Items.Item.ProductParams.ProductParam.Id integer
GET
A termék paraméter egyedi azonosítója.
Items.Item.ProductParams.ProductParam.Name string
GET
A termék paraméter neve.
Items.Item.ProductParams.ProductParam.Value string
GET
A termék paraméter értéke.
Items.Item.ProductParams.ProductParam.Url string
GET
Vásárló által feltölthető fájl paraméter esetén a feltöltött fájl URL-je.
Items.Item.Unit string
GET
SET
A megrendelt termék mennyiségi egysége.
Items.Item.Quantity float
GET
SET
A megrendelt termék mennyisége.
Items.Item.PriceNet float
GET
SET
A megrendelt termék nettó ára.
Items.Item.PriceGross float
GET
SET
A megrendelt termék bruttó ára.
Items.Item.Vat string
GET
A megrendelt termék áfa kulcsa (pl. 27%).
Items.Item.Status string
GET
SET
A rendelési tétel státusza.
Items.Item.PlusStatuses object
GET
SET
További tétel státuszok.
Items.Item.PlusStatuses.Status object
GET
SET
Egy további tétel státusz.
Items.Item.PlusStatuses.Status.Id integer
GET
SET
A további tétel státusz egyedi azonosítója.
Items.Item.PlusStatuses.Status.Name integer
GET
SET
A további tétel státusz neve.
Items.Item.PlusStatuses.Status.Value string
GET
SET
A további tétel státusz értéke.
Items.Item.PlusStatuses.Status.Public enum
GET
SET
A vásárló láthatja-e a további tétel státuszt.
Használható értékek
yes
no
Items.Item.Control object
GET
SET
Tétel ellenőrzés.
Items.Item.Control.Quantity float
GET
SET
Ellenőrzött mennyiség.
Items.Item.Control.User string
GET
SET
Az ellenőrzést végző felhasználó.
Items.Item.StockConsumptions object
GET
Megrendelés leadásakor melyik raktárakról milyen mennyiségben fogyasztottunk.
Items.Item.StockConsumptions.StockConsumption object
GET
Egy raktár fogyasztást leíró node.
Items.Item.StockConsumptions.StockConsumption.Id string
GET
A raktár egyedi azonosítója. Főraktár esetében main_stock
lesz a node értéke.
Items.Item.StockConsumptions.StockConsumption.Name string
GET
A raktár neve. Főraktár esetében Main stock
lesz a node értéke.
Items.Item.StockConsumptions.StockConsumption.Quantity float
GET
A raktárról fogyasztott mennyiség.
Currency string
GET
SET
A megrendelés pénznem kódja.
ExchangeValue string
GET
SET
Megrendelés során érvényre jutott árfolyam szorzó, csak az alappénznemtől eltérő pénznem esetén értelmezett. A setOrder végpontnál csak új megrendelés rögzítésekor használható.
Type string
GET
SET
A megrendelés típusa.
Status string
GET
SET
A megrendelés státusza - setOrder végpont használata esetén ez lehet a státusz neve vagy ID-ja is.
StatusDetails string
GET
SET
A megrendelés státusz részletei.
StatusDateMod string
GET
A megrendelés státusz utolsó módosításának időpontja.
StatusEmail string
SET
Beállítható a mező segítségével, hogy küldjön-e a rendszer státusz e-mailt. Csak setOrder végpontnál használható.
Lehetséges értékek
yes
no
StatusID string
GET
A megrendelés státusz egyedi azonosítója.
Authenticated string
GET
A megrendelést visszaigazolta-e a vásárló. Ha nem kötelező visszaigazolni a megrendelést, úgy mindig yes
érték szerepel ebben a mezőben.
Lehetséges értékek
yes
no
Payment object
GET
SET
A vásárló által választott fizetési mód.
Payment.Id integer
GET
SET
A fizetési mód egyedi azonosítója.
Payment.Name integer
GET
SET
A fizetési mód egyedi neve.
Payment.Type enum
GET
SET
A fizetési mód típusa.
Használható értékek
cod
Utánvét
cash
Készpénz
coupon
Kupon
credit
Hitel
check
Csekk
bankcard
Bankkártya
bankcard_offline
Bankkártya
other
Egyéb
popup
Bankkártya
transfer
Átutalás
voucher
Utalvány
bnpl
Halasztott fizetés (Buy Now Pay Later)
qvik
Qvik (QR kód, link)
bankcard_qvik
Bankkártya vagy qvik
Payment.Status enum
GET
A fizetés státusza.
Használható értékek
unpaid
Kifizetésre vár
paid
Fizetett
partly paid
Részben fizetett
overpaid
Túlfizetés
Payment.Paid float
GET
A fizetett összeg.
Payment.Pending float
GET
Függőben lévő összeg.
Payment.Unpaid float
GET
Fizetetlen összeg.
Payment.Transactions object
GET
A speciális fizetési módokhoz tartozó tranzakciókat tartalmazó mező.
Payment.Transactions.Transaction object
GET
Egy tranzakció adatait tartalmazó mező.
Payment.Transactions.Transaction.Id string
GET
SET
A tranzakció egyedi azonosítója. Manuális tranzakció rögzítésekor a mező értéke manual
.
Payment.Transactions.Transaction.AuthCode integer
GET
A tranzakció engedély száma.
Payment.Transactions.Transaction.Status enum
GET
A tranzakció státusza.
Lehetséges értékek
start
Fizetés indításra vár
redirect
Átirányítva a fizetési oldalra
finish
A tranzakció lezárult
pending
Fizetés függőben
fault
Fizetési hiba
Payment.Transactions.Transaction.Date integer
GET
SET
A tranzakció dátuma. A setOrder végpontnál akkor használható, ha a tranzakció azonosító értéke manual
Payment.Transactions.Transaction.Amount double
GET
SET
A tranzakció összege. A setOrder végpontnál akkor használható, ha a tranzakció azonosító értéke manual
Payment.Transactions.Transaction.AmountRefund double
GET
Visszatérített összeg.
Payment.ForeignID string
GET
A tranzakció külső azonosítója. Nem minden esetben áll rendelkezésre.
Shipping object
GET
SET
A vásárló által választott szállítási mód.
Shipping.Id integer
GET
SET
A szállítási mód egyedi azonosítója.
Shipping.Name string
GET
SET
A szállítási mód neve.
Shipping.PackageNumber string
GET
SET
Csomagazonosító.
Shipping.ForeignID integer
GET
SET
A szállítási mód külső azonosítója.
Invoice object
GET
SET
A számlázással kapcsolatos adatok.
Invoice.Status enum
GET
SET
A számlázás állapota.
Használható értékek
0
Nem számlázható
1
Számlázható
2
Számlázva
Invoice.StatusText string
GET
A számlázás állapota szövegesen.
Invoice.Number string
GET
SET
A számla sorszáma.
Invoice.Url string
GET
SET
A számla közvetlen URL-je.
Storno object
GET
SET
Stornó számlához tartozó adatok.
Storno.Number string
GET
SET
A stornó számla sorszáma.
Storno.Url string
GET
SET
A stornó számla közvetlen URL-je.
Params object
GET
SET
Megrendelés paramétereket leíró mező.
Params.Param object
GET
SET
Egy megrendelés paramétert leíró mező.
Params.Param.Id integer
GET
SET
A megrendelés paraméter egyedi azonosítója.
Params.Param.Name string
GET
SET
A megrendelés paraméter neve.
Params.Param.Value string
GET
SET
A megrendelés paraméter értéke.
Referer string
GET
SET
A vásárló erről az oldalról érkezett a webáruház vásárló felületére.
UTM string
GET
UTM adatok
UTM.Source string
GET
utm_source
UTM.Medium string
GET
utm_medium
UTM.Campaign string
GET
utm_campaign
UTM.Content string
GET
utm_content
Coupon string
GET
SET
A vásárló által felhasznált kupon kódja. A setOrder használat esetén csak új megrendelés leadásakor állítható be.
Weight float
GET
A megrendelés össztömege kilogrammban. A termékek és a csomagolás tömege alapján kalkulált érték.
Info object
GET
A megrendeléssel kapcsolatos egyéb információk.
Info.MergedFrom object
GET
Amennyiben összevont megrendelésről van szó, itt jelennek meg a különböző forrás rendelések azonosítói.
Info.MergedFrom.Key string
GET
Egy forrás megrendelés egyedi azonosítója.
Info.SeparatedTo object
GET
Amennyiben szétbontott megrendelésről van szó, itt jelennek meg a különböző cél rendelések azonosítói.
Info.SeparatedTo.Key string
GET
Egy cél megrendelés egyedi azonosítója
Info.SeparatedFrom object
GET
Szétbontott rendelések esetén, ha az aktuális rendelés egy cél rendelés, itt jelenik meg az eredeti forrás rendelés.
Info.SeparatedFrom.Key string
GET
Az adott megrendelést ebből a forrás megrendelésből bontotta szét az adminisztrátor.
Info.CopiedFrom object
GET
Amennyiben másolt megrendelésről van szó, itt jelenik meg a forrás rendelés azonosítója.
Info.CopiedFrom.Key string
GET
Egy forrás megrendelés egyedi azonosítója.
A megrendeléshez tartozó megjegyzések.
Egy megjegyzést leíró mező.
A megjegyzés típusa.
Használható értékek
customer
Normál vásárlói megjegyzés
customer_shipping
Vásárló által a szállítónak átadott megjegyzés
admin
Adminisztrátori megjegyzés (vásárló nem látja)
A megjegyzés szövege.
SumPriceGross float
GET
A megrendelés bruttó végösszege.