Megrendelés rögzítése
Egy megrendelés listában rögzít új megrendelést. Az API híváshoz szükség van egy a listához tartozó megrendelő űrlapra.
Kérés:
https://api.salesautopilot.com/saveOrder/<nl_id>/form/<ns_id>
Paraméterek:
Megrendelő lista azonosítója.
Megrendelő űrlap azonosítója.
A hívás törzsében tudja átadni a megrendelés adatait JSON formátumban. Ha a megrendelés űrlap több termékes űrlap, akkor a hívás törzse az alábbi felépítésű:
Hívás törzse:
{"email" : "test@salesautopilot.hu",
"mssys_firstname" : "János",
"mssys_lastname" : "Kovács",
"mssys_company" : "XYZ Kft.",
"shipping_method" : "2",
"products" : [{
"prod_id" : "23",
"qty" : "1"
},{
"prod_id" : "25",
"qty" : "2"
}
]}
A products
elemben kell átadni a megrendelt termékek azonosítóját (prod_id
) és mennyiségét (qty
).
Ha egyedi árat és/vagy terméknevet szeretne megadni, akkor a products
tömbben adja át a termék árát a prod_price
kulccsal, a termék nevét pedig a prod_name
kulccsal. Ebben az esetben a hívás törzse az alábbihoz hasonlóan fog kinézni:
Hívás törzse:
{"email" : "test@salesautopilot.hu",
"mssys_firstname" : "János",
"mssys_lastname" : "Kovács",
"mssys_company" : "XYZ Kft.",
"shipping_method" : "2",
"products" : [{
"prod_id" : "23",
"qty" : "1",
"prod_price" : "11500",
"prod_name" : "Akciós termék neve #1"
},{
"prod_id" : "25",
"qty" : "2",
"prod_price" : "4500",
"prod_name" : "Akciós termék neve #2"
}
]}
Ha a megrendelés űrlap egytermékes akkor a hívás törzse az alábbi felépítésű:
Kérés törzse:
{"email" : "test@salesautopilot.hu",
"mssys_firstname" : "János",
"mssys_lastname" : "Kovács",
"mssys_company" : "XYZ Kft.",
"shipping_method" : "2",
"prod_id" : "23"}
A törzsben kötelező, hogy szerpeljen a megrendelt termék azonosítója (prod_id</code).
A shipping_method paraméter kötelező, ez a szállítási-,fizetési mód azonosítója. Ezt az azonosítót a bal oldali menü Beállítások / eCommerce / Szállítási és fizetési módok beállításainál találja az első oszlopban.
Válasz
A megrendelés azonosítóját tartalmazza.
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
3
Válasz hiba esetén:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
0
Termék hozzáadása a terméktörzshöz
Új terméket ad hozzá a terméktörzshöz. Csak a terméktözsben szereplő termékeket lehet megrendelni.
Kérés:
https://api.salesautopilot.com/createproduct
A kérés törzse tartalmazza az új termék adatait.
Kérés törzse:
{"prod_name" : "Online Marketing eBook",
"prod_price" : "19000",
"prod_vat_percent" : "27",
"prod_currency" : "HUF",
"prod_sku" : "OME012",
"prodcat_ids" : [12]}
Paraméterek:
Az új termék neve.
Termék ára a megadott pénznemben.
Termék áfa tartalma százalékban.
A termék árának pénzneme. A következő pénznemek támogatottak: EUR, USD, HUF
Termék azonosító kódja.
Termék kategória altömbje.
Válasz
Válasz sikeres hívás esetén:
A hozzáadott termék azonosítóját tartalmazza.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
32
Válasz hiba esetén:
Ha a termék hozzáadása nem sikerült a válasz törzs üres lesz.
HTTP/1.1 200 OK
Terméktörzsben szereplő termék módosítása
A terméktörzsben lévő termék adatait módosítja.
Kérés:
https://api.salesautopilot.com/modifyproduct/<prod_id>
vagy:
https://api.salesautopilot.com/modifyproduct/sku/<sku>
Paraméterek:
A módosítandó termék azonosítója.
A módosítandó termékhez tartozó SKU.
A termék azonosítóját a bal oldali menüből elérhető Beállítások / eCommerce / Termékek kezelése képernyőn találja. Vigye a kurzort a termék neve fölé és megjelenik a termék azonosítója.
A termék törzse tartalmazza a módosítandó termék új adatait.
Kérés törzse:
{"prod_name" : "Online Marketing eBook",
"prod_price" : "21000",
"prod_vat_percent" : "27",
"prod_currency" : "HUF",
"prod_sku" : "OME012",
"prodcat_ids" : {12}}
Paraméterek:
A termék neve.
Termék ára a megadott pénznemben.
Termék áfa tartalma százalékban.
A termék árának pénzneme. A következő pénznemek támogatottak: EUR, USD, HUF
Termék azonosító kódja.
Termék kategória azonosítója.
A termék kategória azonosítót a Termékek kezelése képernyőn a termék létrehozása, vagy a termék szerkesztése ablakban a kategória legördülőben találja, a kategória neve mellett a # jel után.
Válasz
Válasz sikeres hívás esetén:
Ha a módosítás sikeres volt, a válasz törzse "1" lesz.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
1
Válasz hiba esetén:
Ha a termék módosítása nem sikerült a válasz törzse üres lesz.
HTTP/1.1 200 OK
Terméktörzsben szereplő termék adatainak lekérdezése
A terméktörzsben lévő termék adatait adja vissza.
Kérés:
https://api.salesautopilot.com/getproduct/<prod_id>
Paraméterek:
A termék azonosítója.
A termék azonosítóját a bal oldali menüből elérhető Beállítások / eCommerce / Termékek kezelése képernyőn találja. Vigye a kurzort a termék neve fölé és megjelenik a termék azonosítója.
Válasz
Válasz sikeres hívás esetén:
Ha megfelelő termékazonosítót adott vissza, a válasz törzse a termék adatait fogja tartalmazni JSON formátumban.
{"prod_id" : "1",
"prod_name" : "Teszt termék #1",
"prod_price" : "22000",
"prod_vat_percent" : "27",
"prod_currency" : "HUF",
"prod_sku" : "TID01",
"prodcat_name" : "Képzések"}
Válasz hiba esetén:
Ha a termék módosítása nem sikerült a válasz törzse üres lesz.
HTTP/1.1 200 OK
Összes termék lekérdezése
Terméktörzsben szereplő összes termék adatainak lekérdezése
Kérés:
https://api.salesautopilot.com/listproducts
Válasz
Válasz sikeres hívás esetén:
A válasz JSON tömbben, termékenként külön altömbben adja vissza a fiókban lévő összes terméket. Az altömbök kulcsa a termék SalesAutopilot-os azonosítója.
{"4401":{"prod_id" : "4401",
"prod_name" : "Értékesítési rendszerek szeminárium",
"prod_price" : "22000",
"prod_vat_percent" : "27",
"prod_currency" : "HUF",
"prod_sku" : "ERT01",
"prodcat_name" : "Képzések"},
"4402":{"prod_id" : "4402",
"prod_name" : "Bevezető tréning",
"prod_price" : "22000",
"prod_vat_percent" : "27",
"prod_currency" : "HUF",
"prod_sku" : "BEV01",
"prodcat_name" : "Képzések"}
}
Válasz hiba esetén:
Ha a termék módosítása nem sikerült a válasz törzse üres lesz.
HTTP/1.1 200 OK
Termék törlése
Töröl egy terméket a terméktörzsből. A törlés nincs kihatással a korábbi megrendelésekre amelyekben az adott termék szerepel.
Kérés:
https://api.salesautopilot.com/deleteproduct/<prod_id>
Paraméterek:
Termék azonosítója amit törölni szeretne.
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Válasz hiba esetén:
A válasz -1 lesz, ha valamilyen hiba miatt - pl. a megadott termék nem tartozik az ügyfélhez vagy már előzőleg törölve lett - nem sikerül a törlés.
HTTP/1.1 200 OK
-1
Termék hozzáadása meglévő megrendeléshez
Egy megadott megrendeléshez hozzáad egy új terméket. Újraszámolja a megrendelés nettó és bruttó végösszegét.
Kérés:
https://api.salesautopilot.com/orderaddproduct/<nl_id>/<nud_id>
Paraméterek:
Megrendelés lista azonosítója
Megrendelés azonosítója (id)
Kérés törzse:
{"products":[{
"prod_id":5223,
"prod_name":"Vitamin C",
"prod_price":5000,
"tax":27,
"qty":5
}]
}
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Termék törlése meglévő megrendelésből
Egy megadott megrendelésből töröl egy vagy több terméket. A törlés után újraszámolja a megrendelés nettó és bruttó végösszegét.
Kérés:
https://api.salesautopilot.com/orderdelproduct/<nl_id>/<nud_id>
Paraméterek:
Megrendelés lista azonosítója
Megrendelés azonosítója (id)
Kérés törzse a törlendő termékek azonosítója (prod_id):
[12345,12346]
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Termék módosítása meglévő megrendelésben
Egy megadott megrendelésben módosít egy vagy több terméket. Újraszámolja a megrendelés nettó és bruttó végösszegét.
Kérés:
https://api.salesautopilot.com/ordermodproduct/<nl_id>/<nud_id>
vagy:
https://api.salesautopilot.com/ordermodproduct/<nl_id>/orderid/<webshop_order_id>
Paraméterek:
Megrendelés lista azonosítója
Megrendelés azonosítója (id)
Megrendelés azonosítója a webshopban (ha külső rendszerből érkezett a megrendelés)
Kérés törzse:
Egy megrendelés tételnek két paraméterét lehet módosítani az árat (prod_price) és/vagy a mennyiséget (qty). Az adott tételt vagy a belső termék azonosító (prod_id) vagy a termék SKU -ja alapján lehet módosítani.
{"products": [{
"prod_id" : 5223,
"prod_price" : 5000,
"qty" : 5
}]
}
vagy:
{"products": [{
"prod_sku" : "KT8345",
"prod_price" : 5000,
"qty" : 5
}]
}
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Megrendelésben lévő összes termék lekérdezése
Egy megadott megrendelésben lévő összes termék adatait adja vissza a megrendelés azonosítója (id) alapján.
Kérés:
https://api.salesautopilot.com/orderlistallproducts/<nl_id>/<id>
Paraméterek:
Megrendelés lista azonosítója
Megrendelés azonosítója.
Válasz
Válasz sikeres hívás esetén:
[{"oi_id":"1",
"prod_id":"80028",
"oi_sku":"SKU_P1",
"oi_name":"P1",
"oi_price":"100.00",
"oi_quantity":"2",
"oi_netto_sum":"200.00",
"oi_vat_percent":"10",
"oi_brutto_sum":"220.00",
"oi_currency":"USD",
"oi_nud": "3566"
},
{"oi_id":"2",
"prod_id":"80030",
"oi_sku":"SKU_P2",
"oi_name":"P2",
"oi_price":"150.00",
"oi_quantity":"2",
"oi_netto_sum":"300.00",
"oi_vat_percent":"10",
"oi_brutto_sum":"330.00",
"oi_currency":"USD",
"oi_nud": "3566"
}]
Termék lekérdezése meglévő megrendelésből
Egy megadott megrendelésben lévő termék adatait adja vissza a megrendelés elem (oi_id) alapján.
Kérés:
https://api.salesautopilot.com/orderlistproducts/<nl_id>/<oi_id>
Paraméterek:
Megrendelés lista azonosítója
Megrendelés elem azonosítója.
Válasz
Válasz sikeres hívás esetén:
{"oi_id":"1",
"prod_id":"80028",
"oi_sku":"SKU_P1",
"oi_name":"P1",
"oi_price":"100.00",
"oi_quantity":"2",
"oi_netto_sum":"200.00",
"oi_vat_percent":"10",
"oi_brutto_sum":"220.00",
"oi_currency":"USD",
"oi_nud": "3566"
}
Termékkategóriák lekérdezése
Az összes termékkategória vagy azonosító alapján egy adott kategória adatainak lekérdezése.
Kérés:
https://api.salesautopilot.com/listprodcategories/<prodcat_id>
Paraméterek (opcionális):
Termékkategória azonosítója (ha egy adott termékkategória adatait szeretné csak lekérdezni)
Válasz
Válasz sikeres hívás esetén:
[{"prodcat_id":"3159",
"prodcat_name":"Bed & Bath",
"c_id":"10217",
"prodcat_order":"0"},
{"prodcat_id":"8",
"prodcat_name":"Kurzus",
"c_id":"10217",
"prodcat_order":"1"}]
Válasz hiba esetén:
Ha nincs még termékkategórai vagy az adott prodcat_id-nek megfelelő kategória, akkor a válasz törzse üres lesz.
HTTP/1.1 200 OK
Termékkategória létrehozása
Létrehoz egy termékkategóriát a megadott néven.
Kérés:
https://api.salesautopilot.com/createprodcategory
Kérés törzse:
{"prodcat_name" : "Bed & Bath"}
Válasz
Válasz sikeres hívás esetén a termékkategória azonosítója:
HTTP/1.1 200 OK
12345
Termékkategória módosítása
Létrehoz egy termékkategóriát a megadott néven.
Kérés:
https://api.salesautopilot.com/modprodcategory/<prodcat_id>
Paraméterek:
Módosítandó termékkategória azonosítója
Kérés törzse:
{"prodcat_name" : "Bed and Bath"}
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Válasz hiba esetén:
HTTP/1.1 200 OK
0
Termékkategória törlése
Törli a megadott azonosítójú termékkategóriát.
Kérés:
https://api.salesautopilot.com/delprodcategory/<prodcat_id>
Paraméterek:
A törlendő termékkategória azonosítója
Válasz
Válasz sikeres hívás esetén:
HTTP/1.1 200 OK
1
Válasz hiba esetén:
HTTP/1.1 200 OK
0
Kupon érvényességének lekérdezése
Lehetőség van egy kupon kód érvényességének ellenőrzésére és a kedvezmény mértékének lekérdezésére. Ehhez a lentebb részletezett formában át kell adni a kupon kódot és a rendelt termékeket.
Kérés:
https://api.salesautopilot.com/couponcheck
Kérés törzse:
{"coupon_code" : "OK12561",
"products": [{
"prod_id" : "55",
"quantity" : "2",
"price" : "25000"}]}
Paraméterek:
Kupon kód.
Rendelt termékek altömbben átadva. Az altömb elemei a következők:
Termék egyedi azonosítója.
Az adott termékből rendelt darabszám.
Termék ára. Csak akkor kell átadni, ha különbözik a terméktörzsben tárolt ártól.
Válasz
Válasz sikeres hívás esetén a kupon kedvezmény nettó és bruttó értéke lesz az alábbi formában:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"netto_discount": "2000",
"brutto_discount": "2540"}
Válasz hiba esetén:
HTTP/1.1 200 OK
0
Webshop megrendelések fogadása
Webáruház SalesAutopilot-tal történő összekötéséhez használja ezt a metódust. Amikor a webáruházban történik egy megrendelés amelynek adatait át szeretné adni a SalesAutopilot-nak, hívja meg ezt a metódust. A bal oldali menüt Beállítások / Integráció / Webshop integráció beállítások menüpontjában tudja beállítani, hogy a termék vagy termékkategória megfeleltetést szeretne használni.
Termék megfeleltetést akkor használjon, ha webáruháza maximum 100 terméket tartalmaz. Ebben az esetben minden a webáruházában történt megrendelés átadásra kerül a SalesAutopilot-nak a megrendelt termék létrejön a SalesAutopilot-ban, ha még korábban az adott cikkszámmal nem szerepelt benne. Ha termékkategóriát is átadott a webáruháza, akkor a termék besorolásra kerül a kategóriába.
Kategória megfeleltetést használjon, ha webáruháza több száz vagy ezer terméket értékesít. Ebben az esetben az átadott megrendelésben szereplő termékek kategóriái jönnek létre termékként a SalesAutopilot-ban (ha még nem jött létre korábban), az átadott termék fő kategória pedig kategóriaként jön létre.
Kérés:
https://api.salesautopilot.com/processWebshopOrder/<nl_id>/ns_id/<ns_id>
Paraméterek:
Megrendeléslista azonosítója, amelybe az átadott megrendelések bekerülnek.
Megrendeléslistához tartozó űrlap azonosítója.
A kérés törzse tartalmazza a megrendelés adatait. Minden egyes termék a products
altömbben eleme legyen.
Kérés törzse:
{"email" : "teszt@weboldal.hu",
"mssys_lastname" : "Teszt",
"mssys_firstname" : "Elek",
"mssys_mobile" : "+36301111111",
"mssys_company" : "XYZ Kft.",
"shipping_method" : "Futár",
"payment_method" : "COD",
"currency" : "HUF",
"netshippingcost" : 1000,
"grossshippingcost" : 1270,
"order_id" : 12321,
"products" : [{
"prod_id" : 5223,
"prod_name" : "Vitamin C",
"category_id" : "VIT01",
"category_name" : "Vitaminok",
"prod_price" : 5000,
"tax" : 27,
"qty" : 5
}]}
Törzsben átadandó paraméterek:
Megrendelő email címe. Nem kötelező adat.
Megrendelő vezetékneve. Nem kötelező adat.
Megrendelő keresztneve. Nem kötelező adat.
Megrendelő cégneve. Nem kötelező adat.
Megrendelő mobiltelefonszáma. Nem kötelező adat.
Megrendelő telefonszáma. Nem kötelező adat.
Szállítási mód elnevezése.
Fizetési mód neve. A webáruház által használt rövid elnevezés is lehet.
Megrendelés pénzneme. A pénznem hárombetűs kódját kell használnia, pl. HUF, EUR.
Szállítási költség nettó összege.
Szállítási költség bruttó összege.
Rendelés azonosítója a webáruházban.
Postázási cégnév
Postázási cím ország
Postázási cím állam
Postázási cím város
Postázási cím utca, házszám
Postázási cím irányítószám
Számlázási cégnév
Számlázási cím ország
Számlázási cím állam
Számlázási cím város
Számlázási cím utca, házszám
Számlázási cím irányítószám
A megrendelő által felhasznált kuponkód (pl. MCV2014)
Kupon kedvezmény nettó értéke.
Kupon kedvezmény bruttó értéke.
Rendelt termékek. A products
altömbben kell átadni. Az egyes elemk paraméterei a következők lehetnek:
Termék azonosítója vagy cikkszáma a webáruházban.
Termék neve.
Termék kategória azonosítója a webáruházban.
Termék kategória neve.
Ha a termék több kategóriába is tartozik, akkor a categories tömb elemeinként kell átadni a category_id és category_name értékeket. Például: ,categories: [{"category_id":1232,"category_name":"Egyik kategória"},{"category_id":1234,"category_name":"Másik kategória"}]
Termék nettó egységára.
Termékhez tartozó áfa kulcs százalékban.
Rendelt mennyiség.
Válasz
Válasz sikeres hívás esetén:
Visszaadja a megrendelés SalesAutopilot-os azonosítóját.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
1345
Ha a megrendelés rögzítése sikertelen a válasz üres string illetve a megfelelő HTTP hibakód lesz.
Megjegyzések
0 megjegyzés
Cikk zárolt megjegyzésekkel szemben.