Ugrás a fő tartalomra

Ecommerce metódusok

A bejegyzés tartalma:

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.

POST https://api.salesautopilot.com/saveOrder/<nl_id>/form/<ns_id>

Paraméterek

Leírás

<nl_id>

Megrendelő lista azonosítója.

<ns_id>

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ű.

Fontos: A hívás törzsében megadott szállítási és fizetési módnak (shipping_method) a megfelelő működéshez szerepelnie kell a hívásban megadott megrendelő űrlapon. Ha olyan fizetési mód szerepel a hívásban, amely nem szerepel az űrlapon, abban az esetben "400 - Bad Request" hibaüzenet fog megjelenni.

Hívás törzse:

{"email" : "[email protected]",
 "mssys_firstname" : "János",
 "mssys_lastname" : "Kovács",
 "mssys_company" : "XYZ Kft.",
 "mssys_bill_city": "Teszt város",
 "mssys_bill_address" : "Teszt u.",
 "mssys_bill_zip" : "1234",
 "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" : "[email protected]",
 "mssys_firstname" : "János",
 "mssys_lastname" : "Kovács",
 "mssys_company" : "XYZ Kft.",
 "mssys_bill_city": "Teszt város",
 "mssys_bill_address" : "Teszt u.",
 "mssys_bill_zip" : "1234",
 "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ű:

{"email" : "[email protected]",
 "mssys_firstname" : "János",
 "mssys_lastname" : "Kovács",
 "mssys_company" : "XYZ Kft.",
 "mssys_bill_city": "Teszt város",
 "mssys_bill_address" : "Teszt u.",
 "mssys_bill_zip" : "1234",
 "shipping_method" : "2",
 "prod_id" : "23"}

A törzsben kötelező, hogy szerepeljen a megrendelt termék azonosítója (prod_id)

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

Sikeres hívás esetén a 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.

POSThttps://api.salesautopilot.com/createproduct

A kérés törzse tartalmazza az új termék adatait.

Hívás törzse:

{"prod_name" : "Online Marketing eBook",
 "prod_price" : "19000",
 "prod_vat_percent" : "27",
 "prod_currency" : "HUF",
 "prod_sku" : "OME012",
 "prodcat_ids" : [12],
 "afa_fokonyvi_szam": "4671",
 "arbevetel_fokonyvi_szam": "4530",
 "gazdasagi_esemeny": "ESEMENY_NEV",
 "gazdasagi_esemeny_afa": "20",
 "kulonbozeti_afa": "20",
 "to_be_shipped" : 0
}

Paraméterek

Leírás

prod_name

Az új termék neve.

prod_price

Termék ára a megadott pénznemben.

prod_vat_percent

Termék áfa tartalma százalékban.

prod_currency

A termék árának pénzneme. A következő pénznemek támogatottak: EUR, USD, HUF

prod_sku

Termék azonosító kódja.

prodcat_ids

Termék kategória altömbje.

afa_fokonyvi_szam

ÁFA főkönyvi szám

arbevetel_fokonyvi_szam

Árbevétel főkönyvi szám

gazdasagi_esemeny

Gazdasági esemény azonosító

gazdasagi_esemeny_afa

Gazdasági esemény áfa

kulonbozeti_afa

Különbözeti áfa alap

to_be_shipped

Ténylegesen szállítandó (1 - Ténylegesen szállítandó, 0 - Nem kell ténylegesen szállítani)

Válasz

A hozzáadott termék 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
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.

POST https://api.salesautopilot.com/modifyproduct/<prod_id>

vagy:

POST https://api.salesautopilot.com/modifyproduct/sku/<sku>

Paraméterek

Leírás

prod_id

A módosítandó termék azonosítója.

sku

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. A termék neve mellett látható a termék azonosítója.

A termék törzse tartalmazza a módosítandó termék új adatait.

Hívá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

Leírás

prod_name

Az új termék neve.

prod_price

Termék ára a megadott pénznemben.

prod_vat_percent

Termék áfa tartalma százalékban.

prod_currency

A termék árának pénzneme. A következő pénznemek támogatottak: EUR, USD, HUF

prod_sku

Termék azonosító kódja.

prodcat_ids

Termék kategória altömbje.

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.

GET https://api.salesautopilot.com/getproduct/<prod_id>

Paraméterek

Leírás

prod_id

A módosítandó 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. A termék neve mellett látható 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": 2621043,
"prod_name": "Teszt Termék",
"prod_name_utf8": "Teszt Termék",
"prod_price": "1000",
"prod_vat_percent": 0,
"prod_vat_name": "AAM",
"prod_currency": "HUF",
"prod_sku": "TESZTSKU",
"prod_sku_utf8": "TESZTSKU",
"prod_params":{
"to_be_shipped": 0,
"afa_fokonyvi_szam": "",
"arbevetel_fokonyvi_szam": "",
"gazdasagi_esemeny": "",
"gazdasagi_esemeny_afa": "",
"kulonbozeti_afa": ""
},
"prod_cat": 109314,
"prodcat_name": "Vitaminok",
"prodcats":[
{
"prodcat_id": 109314,
"prodcat_name": "Vitaminok",
"prodcat_order": 16
}
]
}

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

GET 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.
A termék abban az esetben is törlésre kerül, ha szerepel megrendelő űrlapon, emiatt gondoskodj arról, hogy a megrendelő űrlapról lekerüljön a törölt termék.

DELETE https://api.salesautopilot.com/deleteproduct/<prod_id>

Paraméterek

Leírás

prod_id

A módosítandó termék azonosítója.

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.

POST https://api.salesautopilot.com/orderaddproduct/<nl_id>/<nud_id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<nud_id>

Megrendelés azonosítója (id)

Hívá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.

POST https://api.salesautopilot.com/orderdelproduct/<nl_id>/<nud_id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<nud_id>

Megrendelés azonosítója (id)

Hívá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.

POST https://api.salesautopilot.com/ordermodproduct/<nl_id>/<nud_id>

vagy:

POSThttps://api.salesautopilot.com/ordermodproduct/<nl_id>/orderid/<webshop_order_id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<nud_id>

Megrendelés azonosítója (id)

webshop_order_id

Megrendelés azonosítója a webshopban (ha külső rendszerből érkezett a megrendelés)

Hívá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,
	"prod_name" : "Módosított név",
	"qty" : 5
 }]
}

vagy:

{"products": [{
	"prod_sku" : "KT8345",
	"prod_price" : 5000,
	"prod_name" : "Módosított név",
	"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.

GET https://api.salesautopilot.com/orderlistallproducts/<nl_id>/<id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<id>

Megrendelés azonosítója (id)

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:

GEThttps://api.salesautopilot.com/orderlistproducts/<nl_id>/<oi_id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<oi_id>

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.

GET https://api.salesautopilot.com/listprodcategories/<prodcat_id>

Paraméterek

Leírás

<prodcat_id>

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ória 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.

POST https://api.salesautopilot.com/createprodcategory

Hívás törzse:

{"prodcat_name" : "Bed & Bath"}

Válasz

Válasz sikeres hívás esetén a termékkategória azonosítja:

HTTP/1.1 200 OK
12345

Termékkategória módosítása

Létrehoz egy termékkategóriát a megadott néven.

POST https://api.salesautopilot.com/modprodcategory/<prodcat_id>

Paraméterek

Leírás

<prodcat_id>

Módosítandó termékkategória azonosítója

Hívá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.

GET https://api.salesautopilot.com/delprodcategory/<prodcat_id>

Paraméterek

Leírás

<prodcat_id>

Módosítandó 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.

POST https://api.salesautopilot.com/couponcheck

Hívás törzse:

{"coupon_code" : "OK12561",
 "products": [{
 "prod_id" : "55",
 "quantity" : "2",
 "price" : "25000"}]}

Paraméterek

Leírás

coupon_code

Kupon kód.

products

Rendelt termékek altömbben átadva. Az altömb elemei a következők:

prod_id

Termék egyedi azonosítója.

quantity

Az adott termékből rendelt darabszám.

price

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{
"type": 1
"netto_discount": 2000,
"brutto_discount": 2540
"status" => 1
}

A status paraméter csak akkor szerepel a válaszban, ha egyedi kuponkód kerül lekérdezésre. Lehetséges értékei:

0 : egyedi kupon nincs még kiosztva

1 : egyedi kupon kiosztásra került egy megrendelőnek

2 : egyedi kupon felhasználásra került egy rendelésben

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.

POST https://api.salesautopilot.com/processWebshopOrder/<nl_id>/ns_id/<ns_id>

Paraméterek

Leírás

<nl_id>

Megrendelés lista azonosítója

<ns_id>

Megrendelő ű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.

A törzsben kötelező, hogy szerepeljen a megrendelt termék azonosítója (prod_id)

Hívás törzse:

	{"email" : "[email protected]",
	 "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

Leírás

email

Megrendelő email címe. Nem kötelező adat.

mssys_lastname

Megrendelő vezetékneve. Nem kötelező adat.

mssys_firstname

Megrendelő keresztneve. Nem kötelező adat.

mssys_company

Megrendelő cégneve. Nem kötelező adat.

mssys_mobile

Megrendelő mobiltelefonszáma. Nem kötelező adat.

mssys_phone

Megrendelő telefonszáma. Nem kötelező adat.

shipping_method

Szállítási mód elnevezése.

payment_method

Fizetési mód neve. A webáruház által használt rövid elnevezés is lehet.

currency

Megrendelés pénzneme. A pénznem hárombetűs kódját kell használnia, pl. HUF, EUR.

netshippingcost

Szállítási költség nettó összege.

grossshippingcost

Szállítási költség bruttó összege.

order_id

Rendelés azonosítója a webáruházban.

mssys_lastname

Megrendelő vezetékneve. Nem kötelező adat.

mssys_postal_company

Postázási cégnév

mssys_postal_country

Postázási cím ország

mssys_postal_state

Postázási cím állam

mssys_postal_city

Postázási cím város

mssys_postal_address

Postázási cím utca, házszám

mssys_postal_zip

Postázási cím irányítószám

mssys_bill_company

Számlázási cégnév

mssys_bill_country

Számlázási cím ország

mssys_bill_state

Számlázási cím állam

mssys_bill_city

Számlázási cím város

mssys_bill_address

Számlázási cím utca, házszám

mssys_bill_zip

Számlázási cím irányítószám

mssys_coupon

A megrendelő által felhasznált kuponkód (pl. MCV2014)

mssys_coupon_discount_amount_netto

Kupon kedvezmény nettó értéke.

mssys_coupon_discount_amount_brutto

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:

Paraméterek

Leírás

prod_id

Termék azonosítója vagy cikkszáma a webáruházban.

prod_name

Termék neve.

category_id

Termék kategória azonosítója a webáruházban.

category_name

Termék kategória neve.

categories

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"}]

prod_price

Termék nettó egységára.

tax

Termékhez tartozó áfa kulcs százalékban.

qty

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.

Megrendelő, megrendelés adatainak módosítása

Megrendelési lista esetében is az update végpont meghívásával lehet a megrendelő (Név, számlázási / postázási cím, stb.) vagy az adott megrendeléshez (Webshop megrendelés állapota, Szállítás állapota, stb.) tartozó adatokat módosítani.

Fontos! Megrendelési lista esetében az e-mail cím általában nem azonosítja egyértelműen a feliratkozókat, ezért a frissítést a Megrendelési listában lévő azonosító (id) alapján szükséges elvégezni, hogy kizárólag az érintett megrendelés kerüljön frissítésre.

Kapcsolódó bejegyzések

Választ kapott a kérdésére?