HTTP metódus / Végpont
post / customerorder
Használt művelet
Vevő rendelés fogadás API eredmény |
|
Bejövő adatok
Cimke |
Azonosító |
Mezőtípus |
Mező leírása |
|
CustomerOrder |
|
|
Hivatkozási szám |
OrderCode |
string 25 |
a rendelés webáruház szerinti saját azonosítója (vevő rendelésen: Hivatkozási szám); kötelező |
Dátum |
Date |
string (date format) |
rendelés dátuma; kötelező |
Sorozat |
Series |
string 4 |
rendelés sorozat, nem kötelező; ha üres, akkor paraméterben megadott alapértelmezett rendelés sorozatra vesszük fel a rendelést |
Raktár |
Store_ID |
number int |
raktár ID, nem kötelező; ha nincs megadva, akkor a paraméterben megadott kiszolgáló raktárral vesszük fel a megrendelést. |
Raktár kód |
StoreCode |
string 15 |
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. |
Deviza |
Currency_ID |
number int |
a rendelés deviza ID, nem kötelező, ha nincs megadva, akkor HUF |
Deviza kód |
Currency |
string 3 |
a rendelés deviza, nem kötelező, ha nincs megadva, akkor HUF |
Ügyfél |
Partner_ID |
number int |
ügyfél ID |
Ügyfél kód |
PartnerCode |
string 15 / 50 |
ügyfél kód VAGY ügyfél idegen azonosító a bemenő paraméter szerint, kötelező, ellenőrizni kell; hogy érvényes-e (érvényes = belföldi vevő/külföldi vevő) |
Ügyfél telephely |
PartnerPremise_ID |
number |
ügyfél telephely ID; nem kötelező, ha meg van adva, akkor ellenőrizni kell; hogy érvényes-e |
Ügyfél telephely kód |
PartnerPremiseCode |
string |
ügyfél telephely kód; nem kötelező, ha meg van adva, akkor ellenőrizni kell; hogy érvényes-e |
|
CustomerAdministrator_ID |
|
ügyfél ügyintéző ID; nem kötelező, ha meg van adva, akkor ellenőrizni kell; hogy érvényes-e |
|
CustomerAdministratorName |
|
ügyfél ügyintéző név; nem kötelező, ha meg van adva, akkor ellenőrizni kell; hogy érvényes-e |
|
Delivery_ID |
number smallint |
fuvar ID, nem kötelező, ha nincs megadva, akkor a rendelés-nyilvántartás paraméter sorozat adatából ajánlódik |
|
DeliveryName |
string 100 |
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 |
|
DeliveryPoint_ID |
number int |
csomagpont ID, nem kötelező |
|
DeliveryPoint |
string 50 |
csomagpont azonosító, nem kötelező |
|
DeliveryCostNet |
number float |
fuvar díj nettó összege, nem kötelező |
|
PaymentMethod_ID |
number smallint |
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) |
|
PaymentMethodName |
string 25 |
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) |
|
AdditionalText2 |
string 100 |
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 |
|
Comment |
string 2000 |
rendelés megjegyzés |
|
CustomerOrder.Items |
|
|
|
ItemCode |
string 100 |
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 |
|
Order |
number int |
rendelés tétel sorrend |
|
Product_ID |
number int |
termék ID |
|
ProductCode |
string 30 |
termék kód, vagy termék idegen azonosító kód a bemenő paraméter beállítás szerint |
|
|
|
|
|
Quantity |
number float |
mennyiség, kötelező (de 0-t elfogadunk) |
|
ShipDate |
string (date format) |
kért szállítási határidő, ha nincs megadva, akkor a rendelés dátuma kerül ebbe a mezőbe is |
|
NetUnitPrice |
number float |
nettó egységár, kötelező (de 0-t elfogadunk) |
|
DiscountPercent |
number float |
engedmény százalék, nem kötelező |
|
DiscountAmount |
number float |
engedmény összeg, nem kötelező |
Paraméterek
Paraméter |
Leírás |
Ügyfél azonosítás |
Kód, Idegen azonosító |
Termék azonosítás |
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 |
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
CustomerOrderResponse |
|
Címke |
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.
Használt eredményhalmaz
Vevő rendelés fogadás eredmény |
|
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
}
]
