Az automata folyamatokat 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 getAutomatism illetve setAutomatism végpontokhoz, GET illetve SET jelöléssel láttuk el ezeket a mezőket.
Action enum SET
A setAutomatism 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
Az automata folyamat egyedi azonosítója. SET végpontnál csak azonosító adatként használható, nem módosítható.
Name string GET SET
Az automata folyamat neve. Két ugyanolyan nevű folyamatot nem lehet létrehozni. Maximális hossza 255 karakter.
Active enum GET SET
Megmutatja, hogy az automatizmus aktív vagy inaktív-e.
Használható értékek
yes no
Schedule object GET SET
Beállíthatod az automatizmushoz, hogy az eseményhez meghatározott műveletet időzítve vagy azonnal hajtsa végre a rendszer.
Schedule.Type enum GET SET
Az automatizmus időzítésének típusa. Meghatározhatod, hogy az esemény bekövetkezésekor azonnal vagy egy későbbi időpontban, időzítve menjen végbe a művelet. Azonnali végrehajtás esetén az esemény bekövetkezésétől számított maximum öt percen belül hajtja végre a szerver a műveletet.
Schedule.Unit enum GET SET
Az időzítés mértékegysége.
Használható értékek
minute hour day
Schedule.Value integer GET SET
Az időzítés értéke. Perc alapú időzítés esetében a minimum beállítható érték 20 perc.
Event object GET SET
Az automatizmushoz beállított esemény. A getAutomatism válaszban látható az esemény típusa illetve az eseményhez meghatározott szabályok is.
Event.Type enum GET SET
Az esemény típusa.
Használható értékek
order_send Megrendelés leadás vásárló felületen
order_status_modify Megrendelés státuszváltás
order_modify_admin Megrendelés módosítása adminisztrátor által
order_add_admin Megrendelés létrehozása adminisztrátor által
order_send_thirdparty Megrendelés beérkezése külső rendszerből
order_delete Megrendelés törlése
abandoned_cart Elhagyott kosár
newsletter_subscribe Hírlevél feliratkozás
newsletter_subscribe_auth Hírlevél feliratkozás megerősítése
newsletter_unsubscribe Hírlevél leiratkozás
customer_registration Vásárló regisztráció
customer_modification Vásárló adatmódosítás
customer_modify_admin Vásárló módosítás admin által
customer_delete Vásárló törlés
successful_payment Sikeres fizetés
opinion_send Vélemény írás
Event.Rules object GET SET
Az eseményhez tartozó szabályok. Az automatizmushoz több szabályt is definiálhatunk. A szabályok között ÉS logikai kapcsolat van, egy szabályon belül a vizsgált értékek között VAGY logikai kapcsolat van. Ha a getAutomatism válaszban nem szerepel egy szabály sem, akkor az automatizmushoz definiált műveletet mindenképpen elvégzi a rendszer.
Event.Rules.Rule object GET SET
Egy szabályt leíró mező, melyben meghatározhatsz a szabályban vizsgált entitást, a vizsgálat során felhasznált relációt, a vizsgált értékek és entitás között. Minden eseménynél más-más entitáshoz tudsz szabályokat definiálni, erről bővebb információt az entitás fejezetben olvashatsz.
Event.Rules.Rule.Relation enum GET SET
Az esemény szabályokhoz meghatározható reláció a vizsgálandó entitás és a vizsgált értékek között. Entitásonként változó, hogy milyen relációt definiálhatsz.
Használható relációk
Döntés
Reláció csoport decision
yes Igen
no Nem
Egyenlőség
Reláció csoport equality
equal Egyenlő
not_equal Nem egyenlő
Szöveg
Reláció csoport string
equal Egyenlő
not_equal Nem egyenlő
starts_with Ezzel kezdődik
ends_with Erre végződik
contains Tartalmazza
Szám
Reláció csoport number
equal Egyenlő
not_equal Nem egyenlő
less_than Kisebb, mint
greater_than Nagyobb, mint
less_than_or_equal Kisebb vagy egyenlő, mint
greather_than_or_equal Nagyobb vagy egyenlő, mint
Az entitás bekezdésben minden entitáshoz egy reláció csoportot jelöltünk meg, amit az esemény paraméterek mellett tűntetünk fel.
Event.Rules.Rule.Entity enum GET SET
A vizsgált entitás, vagyis esemény paraméter, amire a szabályt létrehozod. Például megrendelés leadáskor az egyik ilyen vizsgált esemény paraméter a megrendelés végösszege lehet vagy a vásárló számlázási országa. A továbbiakban összefoglaljuk, melyik eseménynél milyen esemény paraméterekhez lehet szabályokat megfogalmazni.
Megrendelés leadás
order_send eseményhez az alábbi esemény paraméterek használhatók.
total_ordered_amount number Vásárló összköltése
total number Megrendelés végösszege
number_of_orders number Vásárló megrendeléseinek száma
currency equality Pénznem
email string Email cím
ordered_products_sku string Megrendelt termék cikkszáma
shipping_method string Szállítási mód neve
payment_method string Fizetési mód neve
customer_group equality Vásárló csoport
customer_shipping_name string Szállítási név
customer_shipping_zip string Szállítási irányítószám
customer_shipping_county string Szállítási megye
customer_shipping_country equality Szállítási ország
customer_shipping_city string Szállítási város
customer_billing_name string Számlázási név
customer_billing_zip string Számlázási irányítószám
customer_billing_county string Számlázási megye
customer_billing_country equality Számlázási ország
customer_billing_city string Számlázási város
newsletter_auth decision Hírlevél feliratkozás megerősítve
Megrendelés beérkezése külső rendszerből
order_send_thirdparty eseményhez a Megrendelés leadás esemény paraméterei használhatók illetve egy plusz esemény paraméter is, amely a source_of_order vagyis a Megrendelés forrása. Jelenleg három szűrési lehetőség van erre.
arukereso_hu Árukereső.hu kosárprogramban leadott megrendelések
emag_api eMAG Marketplace megrendelések
unas_api Unas API-val kezelt megrendelések
Kosárelhagyás
abandoned_cart eseményhez az alábbi esemény paraméterek használhatók.
customer_shipping_name string Szállítási név
customer_shipping_zip string Szállítási irányítószám
customer_shipping_county string Szállítási megye
customer_shipping_country equality Szállítási ország
customer_shipping_city string Szállítási város
customer_billing_name string Számlázási név
customer_billing_zip string Számlázási irányítószám
customer_billing_county string Számlázási megye
customer_billing_country equality Számlázási ország
customer_billing_city string Számlázási város
newsletter_up decision Hírlevélre feliratkozott
item_num number Kosárban lévő termékek száma
total_price number Kosárban lévő termékek összértéke
number_of_orders number Vásárló megrendeléseinek száma
products_sku string Kosárban lévő termék cikkszáma
products_name string Kosárban lévő termék neve
products_price number Kosárban lévő termék ára
currency string Pénznem
customer_group string Vásárló csoport
customer_email string Email cím
newsletter_auth decision Hírlevél feliratkozás megerősítve
Hírlevélre feliratkozás
newsletter_subscribe eseményhez az alábbi esemény paraméterek használhatók.
email string Feliratkozó email címe
name string Feliratkozó neve
customer_language string Feliratkozó által használt nyelv
Hírlevélről leiratkozás
newsletter_unsubscribe eseményhez az alábbi esemény paraméterek használhatók.
email string Feliratkozó email címe
customer_language string Feliratkozó által használt nyelv
Vásárló regisztráció / módosítás
customer_registration és customer_modification eseményhez az alábbi esemény paraméterek használhatók.
contact_name string Kapcsolattartó név
contact_phone string Kapcsolattartó telefonszáma
contact_mobile string Kapcsolattartó mobiltelefonszáma
email string Email cím
customer_shipping_name string Szállítási név
customer_shipping_zip string Szállítási irányítószám
customer_shipping_county string Szállítási megye
customer_shipping_country equality Szállítási ország
customer_shipping_city string Szállítási város
customer_billing_name string Számlázási név
customer_billing_zip string Számlázási irányítószám
customer_billing_county string Számlázási megye
customer_billing_country equality Számlázási ország
customer_billing_city string Számlázási város
newsletter_auth decision Hírlevél feliratkozás megerősítve
newsletter_up decision Hírlevélre feliratkozott
Vásárló módosítása adminisztrátor által és Vásárló törlés
customer_modify_admin és customer_delete eseményekhez az alábbi esemény paraméter használható fel.
email string Email cím
Sikeres fizetés
successful_payment eseményhez a Megrendelés leadás eseménynél leírt esemény paraméterek használhatók fel.
Event.Rules.Rule.Values object GET SET
Az összehasonlítandó értékeket tartalmazó mező.
Event.Rules.Rule.Values.Value string GET SET
Egy összehasonlítandó értéket tartalmazó mező. Bizonyos esetekben ez a mező nem csak nyers értékeket tartalmaz, hanem további XML mezőket. Például, ha az automatizmushoz beállított összehasonlítandó érték egy vásárló csoport, akkor a vásárló csoport azonosítója illetve neve szerepel ebben a mezőben. További mintakéréseket a példák fejezetben olvashatsz.
Operation object GET SET
Az automatizmusokhoz meghatározhatunk műveleteket, melyeket egy esemény bekövetkezésének hatására végzünk el abban az esetben, ha az eseményhez meghatározott feltételek, szabályok teljesülnek.
Operation.Type enum GET SET
Rendszerünkben jelenleg öt művelet típus választható.
email E-mail küldés
webhook Webhook
change_customer_group Vásárló csoportba helyezés
change_order_status Megrendelés státusz váltás. Csak successful_payment eseménynél használható
change_invoice_status Megrendelés számlázási státusz váltás. Csak successful_payment eseménynél használható
Operation.Config object GET SET
A művelethez tartozó beállítások. Műveletenként változó a beállításokat tartalmazó Config mező felépítése.
Operation.Config.NewsletterTemplate object GET SET
E-mail küldés művelet esetén használható. A hírlevél sablonok közül kell választani egyet.
Operation.Config.NewsletterTemplate.Id integer GET SET
E-mail küldés művelet esetén használható. A hírlevél sablon egyedi azonosítója
Operation.Config.NewsletterTemplate.Name string GET
E-mail küldés művelet esetén használható. A hírlevél sablon neve.
Operation.Config.Directuser enum GET SET
E-mail küldés művelet esetén használható. Beállítható, hogy ki kapja meg a küldött emailt. yes opció esetén meghatározott email címekre lehet elküldeni az e-mailt, ellenkező esetben a vásárlónak, aki például a megrendelést leadta a vásárló felületen vagy módosította adatait a profiljában.
Értékkészlete
yes no
Operation.Config.DirectUserEmails object GET SET
E-mail küldés művelet esetén használható. Az e-mail címeket tartalmazó mező.
Operation.Config.DirectUserEmail string GET SET
E-mail küldés művelet esetén használható. Egy e-mail címet tartalmazó mező.
Operation.Config.WebhookUrl string GET SET
A webhook művelethez be kell állítani az URL-t, amire a POST kérést küldi ki a rendszer az esemény bekövetkezését követően. A POST kérés tartalma egy JSON illetve a webhook-hoz tartozó HTTP fejlécek. A webhook-okat érdemes ellenőrizni a fogadó oldalon. Ehhez kapcsolódóan információkat a Webhook ellenőrzés fejezetben olvashatsz. A webhook hívás maximum 2 percig futhat.
Operation.Config.CustomerGroup object GET SET
Vásárló csoportba helyezés művelet esetén használható. A vásárló csoportot leíró mező.
Operation.Config.CustomerGroup.Id integer GET SET
Vásárló csoportba helyezés művelet esetén használható. A vásárló csoport egyedi azonosítója.
Operation.Config.CustomerGroup.Name string GET
Vásárló csoportba helyezés művelet esetén használható. A vásárló csoport neve.
Operation.Config.OrderStatus integer GET SET
Megrendelés státusz váltás művelet esetén használható. A megrendelés státusz egyedi azonosítója.
Operation.Config.InvoiceStatus enum GET SET
Számlázási státusz váltás művelet esetében használható. A számlázási státusz értéke.
Értékkészlete
0 Nem számlázható
1 Számlázható
2 Számlázva
