A Vevő rendelés fogadás elnevezésű API elem segítségével a sERPában már meglévő ügyfelek rendeléseit tudjuk felvenni.
HTTP metódus / Végpont
post / customerorder
Használt művelet
Vevő rendelés fogadás - API |
Bemenőparaméter változat = Alapértelmezett |
Használt művelet
Vevő rendelés fogadás |
|
Bejövő adatok
Művelet paraméter |
Azonosító (JSON path) |
Leírás |
Külső azonosító |
$.CustomerOrder.External_ID |
Ügyfél saját egyedi azonosítója |
Sorozat |
$.CustomerOrder.Series |
Rendelés sorozat, nem kötelező (string 4) |
Hivatkozási szám |
$.CustomerOrder.OrderCode |
A rendelés webáruház szerinti saját azonosítója (vevő rendelésen: Hivatkozási szám); kötelező (string 25) |
Dátum |
$.CustomerOrder.Date |
Rendelés dátuma; kötelező (string (date format)) |
Raktár |
$.CustomerOrder.Store_ID |
Raktár ID, nem kötelező; ha nincs megadva, akkor a paraméterben megadott kiszolgáló raktárral vesszük fel a megrendelést. (number int) |
Raktár kód |
$.CustomerOrder.StoreCode |
Raktár kód, nem kötelező; ha nincs megadva, akkor a paraméterben megadott kiszolgáló raktárral vesszük fel a megrendelést.(string 15) |
Deviza |
$.CustomerOrder.Currency_ID |
A rendelés deviza ID, nem kötelező, ha nincs megadva, akkor HUF (number int) |
Deviza kód |
$.CustomerOrder.Currency |
A rendelés deviza, nem kötelező, ha nincs megadva, akkor HUF (string 3) |
Ügyfél |
$.CustomerOrder.Partner_ID |
Ügyfél ID, Belföldi/Külföldi vevő (number int) |
Ügyfél kód |
$.CustomerOrder.PartnerCode |
Ügyfél kód VAGY ügyfél idegen azonosító a bemenő paraméter szerint, kötelező, Belföldi / Külföldi vevő (string 15 / 50) |
Ügyfél telephely |
$.CustomerOrder.PartnerPremise_ID |
Ügyfél telephely ID; nem kötelező (number) |
Ügyfél telephely kód |
$.CustomerOrder.PartnerPremiseCode |
Ügyfél telephely kód; nem kötelező (string) |
Ügyfél ügyintéző |
$.CustomerOrder.CustomerAdministrator_ID |
Ügyfél ügyintéző ID; nem kötelező |
Ügyfél ügyintéző név |
$.CustomerOrder.CustomerAdministratorName |
Ügyfél ügyintéző név; nem kötelező |
Fuvar |
$.CustomerOrder.Delivery_ID |
Fuvar ID, nem kötelező, ha nincs megadva, akkor a rendelés-nyilvántartás paraméter sorozat adatából ajánlódik (number smallint) |
Fuvar név |
$.CustomerOrder.DeliveryName |
Fuvar név, nem kötelező, ha nincs megadva, akkor a rendelés-nyilvántartás paraméter sorozat adatából ajánlódik (string 100) |
Csomagpont |
$.CustomerOrder.DeliveryPoint_ID |
Csomagpont ID, nem kötelező (number int) |
Csomagpont azonosító |
$.CustomerOrder.DeliveryPoint |
Csomagpont azonosító, nem kötelező (string 50) |
Fuvardíj nettó összeg |
$.CustomerOrder.DeliveryCostNet |
Fuvar díj nettó összege, nem kötelező (number float) |
Fizetési mód |
$.CustomerOrder.PaymentMethod_ID |
Fizetési mód ID; ha nincs megadva, a sERPa ajánlást használjuk (ügyfél, rendelés sorozat stb. vevő fizetési feltétel szerint) (number smallint) |
Fizetési mód név |
$.CustomerOrder.PaymentMethodName |
Fizetési mód név, ha nincs megadva, a sERPa ajánlást használjuk (ügyfél, rendelés sorozat stb. vevő fizetési feltétel szerint) (string 25) |
További adat 2 szöveg |
$.CustomerOrder.AdditionalText2 |
A tartalma a "További adat 2"-ben megadott További adat szöveg mezőbe kerül, nem kötelező; pl. kifizetés státusz (string 100) |
Megjegyzés |
$.CustomerOrder.Comment |
Rendelés megjegyzés (string 2000) |
Tételek |
$.CustomerOrder.Items |
Tételek táblázat |
Tétel azonosító |
$.CustomerOrder.Items.ItemCode |
Tétel azonosító, a webáruház által adott, a tételt egyedien azonosító kód, nem kötelező, a paraméterben megadott rendelés tétel tulajdonságban tároljuk (string 100) |
Tétel sorrend |
$.CustomerOrder.Items.Order |
Rendelés tétel sorrend (number int) |
Termék |
$.CustomerOrder.Items.Product_ID |
Termék ID (number int) |
Termék kód |
$.CustomerOrder.Items.ProductCode |
Termék kód, vagy termék idegen azonosító kód a bemenő paraméter beállítás szerint (string 30) |
Mennyiség |
$.CustomerOrder.Items.Quantity |
Mennyiség, kötelező (de 0-t elfogadunk) (number float) |
Kért szállítási határidő |
$.CustomerOrder.Items.ShipDate |
Kért szállítási határidő, ha nincs megadva, akkor a rendelés dátuma kerül ebbe a mezőbe is (string (date format)) |
Nettó egységár |
$.CustomerOrder.Items.NetUnitPrice |
Nettó egységár, kötelező (ha azonosítása sikertelen, az alapértelmezett ártábla szerinti árat ajánlja a program. Ha ez NULL az hibához vezet,ha 0 akkor akkor az ártáblás ár nem fogja felülírni a 0-át) (number float) |
Engedmény százalék |
$.CustomerOrder.Items.DiscountPercent |
Engedmény százalék, nem kötelező (number float) |
Engedmény összeg |
$.CustomerOrder.Items.DiscountAmount |
Engedmény összeg, nem kötelező (number float) |
Paraméterek
Paraméter |
Paraméter érték |
Leírás |
Ügyfél azonosítás |
Kód |
Azonosítás Kód, Idegen azonosító alapján |
Termék azonosítás |
Kód |
Kód, Idegen azonosító (ügyfélre szűkítve) |
Ügyfél idegen azonosító típus |
|
Ezzel az idegen azonosító típussal történik az ügyfél azonosítás (struktura.idegenazonositotipus) |
Termék idegen azonosító típus |
|
Ezzel az idegen azonosító típussal történik a termék azonosítás (struktura.idegenazonositotipus). |
Alapértelmezett vevő rendelés sorozat |
|
Ha a rendelésben nincs megadva, akkor ezzel a sorozattal vesszük fel a rendelést |
Alapértelmezett ártábla |
|
Megadása nem kötelező és csak használható ártábla választható ki. |
Tétel azonosító tulajdonság |
Figyelmeztetés |
A webáruház által küldött rendeléstétel egyedi azonosítójának tárolására szolgáló Tulajdonság kiválasztása. Csak szöveg adattípusú tulajdonság választható. |
Forrás |
|
Ezzel a forrással kerül felvételre a rendelés (aruforgalom.forras) |
Kiszolgáló raktár |
|
Ezzel a kiszolgáló raktárral kerül felvételre a rendelés, amennyiben a rendelésben nincs megadva |
Saját ügyintéző |
|
Kód/ID (struktura.szemely) |
További adat típus 1 - rendelés státusz |
|
További adat típus közül választható szöveges típus, ez bekerül a vevőrendelés fejléc további adat grid címke oszlopba (aruforgalom.tovadattipus) pl. a rendelés státusz |
További adat típus 1 szövege |
|
További adat szövegek közül választható; vagy beírható; ez bekerül a vevőrendelés fejléc további adat grid szöveg oszlopába (aruforgalom.tovadattipus) pl. ez lesz a rendelés státusz fix szövege a rendelés rögzítésekor |
További adat típus 2 - kifizetés státusz |
|
További adat típus közül választható szöveges típus, ez a további adat típus kerül be a rendelés további adat grid oszlopába; pl. a BankStatus szövege (aruforgalom.tovadattipus) |
Felhasználó |
|
Ezzel a felhasználóval lesznek felvéve a rendelések; alapértelmezetten nulla. (rendszer.bejelentkezettfelhasznalo) |
Kimenő adatok
Azonosító |
Leírás |
Order_ID |
Rendelés ID |
External_ID |
Külső azonosító |
OrderNumber |
Rendelés sERPa bizonylatszám |
OrderCode |
Rendelés webáruház szerinti saját azonosítója (Hivatkozási számban tárolt) |
ErrorCode |
Hibakód - helyes művelet esetén 0 |
ErrorMessage |
Hiba szöveges üzenete |
Alapvetések
•A többi webshop kapcsolattal ellentétben itt a vevő rendelés fogadásakor feltételezzük, hogy a sERPában már létező és kurrens adatokkal felruházott ügyfélre érkezik be a rendelés.
•Ezért a vevő rendelés fogadásakor nem lehetséges új ügyfél rögzítése. A webshopnak szükség szerint ellenőriznie kell a rendelés beküldése előtt, hogy létezik a rendelés ügyfele a sERPában és használható vevő rendelésen (belföldi vagy külföldi vevő típusú). B2C működés esetén ezt az ellenőrzést mindenképp ajánljuk a webshop fejlesztőknek.
További feltételek a bizonylat rögzítéshez
•A vevő rendelés fogadás paraméterben megadott további adatokon kívül felvételre kerül a vevő rendelésre a rendelés-nyilvántartás paraméterben a sorozathoz megadott összes további adat is.
•Ha a bejövő adathalmazban a kért szállítási határidő üres, akkor a vevő rendelésen a kért szállítási határidőt fixen a rendelés dátumával (Date) töltjük ki.
•A vevő rendelésen az ár típust a rendelés-nyilvántartás paraméterben az adott sorozathoz megadott mező szerint töltjük ki (irányár vagy rögzített ár).
•A felvett rendelésbe a saját ügyintéző a vevő rendelés fogadás paraméter alapján kerül kitöltésre.
•A rögzített rendelésen az Összevonható vevőszámla mező értéke fixen 0.
•Lehetőség van a vevő rendelés létrehozása során reláció megadására (Belföldi, Export, Import), amely relációt az alábbiak alapján határozza meg a program:
1. Az API hívás során beállított reláció,
2. Az Interfész funkcióban beállított alapértelmezés,
3. A program által, a vevő rendelés sorozat és a beállított ügyfél alapján kalkulált reláció.
Hibakezelés
•"A rendelés sorozat beállításai alapján a %1 reláció nem adható meg!" hibaüzenet akkor, ha a létrehozandó rendelés sorozatán az adott reláció nem adható meg.
•"Nem használható rendelés sorozatra nem vehető fel rendelés!" hibaüzenet akkor, ha a beállított sorozat nem használható, vagy nem vevő rendelés sorozat.
Példa
ID azonosítással, idegen azonosítóval azonosítás terméknél és ügyfélnél, raktárkód paraméterből, rendelés sorozat rendelésből, fizetési mód megvan a rendelésben; kért szállítási határidő nincs megadva;
PUT
URL
sERPaAPI/customerorder
Body
[{
"CustomerOrder": {
"External_ID": "Rendelés00001",
"OrderCode": "xxx5x45",
"Date": "2023-06-26",
"Series": "VTD",
"Source_ID": 126,
"Currency": "HUF",
"PartnerCode": "0",
"PartnerPremiseCode" : "BP",
"CustomerAdministratorName": "jakab lászló",
"DeliveryName": "Házhozszállítás futárszolgálattal",
"PaymentMethodName": "Kp",
"AdditionalText2": "fizetve",
"Comment": "Tessék hangosan csengetni",
"Items": [{
"OrderItemCode": "55551501",
"Order": 1,
"ProductCode": "T001",
"Quantity": 1.000000,
"NetUnitPrice": 10000.000000,
"DiscountPercent": 0.100000
},
{
"OrderItemCode": "55551502",
"Order": 2,
"Product_ID": 539,
"Quantity": 1.000000,
"NetUnitPrice": 55000.000000,
"DiscountAmount": 100,
"DiscountPercent": 0.15000,
"ShipDate": "20230627"
}
]
}
}]
Eredmény
[
{
"Order_ID": 152,
"External_ID": "Rendelés00001",
"OrderNumber": "2023-VTD/000005",
"OrderCode": "xxx5x45",
"ErrorCode": 0
}
]
