<?xml version="1.0" encoding="utf-8"?>
<response>
<status>error</status>
<message>
<elem>[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)</elem>
</message>
</response>
A csomag visszaérkezésének ideje, és a sztornó számla kelte.
updatedAt
A rendszerünkben történt utolsó módosítás dátuma.
products
A rendelés termékei, minden esetben tömb.
sku
A termék SKU-ja (cikkszáma).
productName
A termék neve.
variantName
A termékvariáns neve.
priceGross
A termék bruttó ára.
vat
Az ÁFA kulcs.
quantity
A rendelt mennyiség.
serial
A termékhez csomagoláskor rögzített egyedi azonosító.
(Opcionális.)
Rendelések létrehozása, módosítása
Ezzel a funkcióval egyszerre lehet létrehozni és módosítani rendeléseket. Amennyiben a megadott referenceId-val még nem szerepel nálunk rendelés, akkor az API létrehozza. Amennyiben már szerepel, és a létező rendelés státusza új vagy piszkozat, valamint még nem történt rajta manuális módosítás, akkor módosítja azt. Sikeres létrehozás, vagy módosítás esetén az API visszaadja a rendelés belső azonosítóját.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
order
Igen
A létrehozandó vagy módosítandó rendelés adatai.
referenceId
Igen
Külső azonosító.
Szabadszavas, ajánlott a megrendelés azonosítójának használata.
referenceName
Nem
A rendelés neve.
A rendelés létrehozásakor megadott név.
Szabadszavas, ajánlott a megrendelés azonosítójának használata, vagy egy abból képzett név.
(pl.:RENDELES#1221)
createdAt
Igen
A rendelés létrejöttének ideje.
shipping
Igen
A szállítási adatai.
shipping.name
Igen
A címzett neve.
shipping.company
Nem
Cég esetén, a cégnév.
shipping.email
Nem
E-mail cím.
shipping.phone
Nem
Telefonszám.
shipping.countryCode
Igen
Kétjegyű országkód.
(pl.: HU)
shipping.stateOrProvinceCode
Nem
Állam, tartomány.
(Főleg külföldi címzés esetén fontos.)
shipping.zip
Igen
Irányítószám.
shipping.city
Igen
Város.
shipping.address1
Igen
A cím első sora.
shipping.address2
Nem
A cím második sora.
shipping.note
Nem
A címhez tartozó megjegyzés, <![CDATA[]]>.
(Használata ajánlott.)
shipping.mode
Nem
A szállítási mód, lehetséges értékek:
GLS-HU,
DPD-HU,
FOXPOST-HU,
PRIO,
DHL,
SPRINTER,
GLS-SK,
MPL.
shipping.packPoint
Nem
A csomagpont fajtája, lehetséges értékek:
GLS,
FOXPOST-HU,
CSOMAGKULDO,
MPL,
SPRINTER,
EUSHIPMENTS-328-ROMANIA-SAMEDAY,
EUSHIPMENTS-643-POLAND-INPOST-LOCKERS,
EUSHIPMENTS-722-CROATIA-GLS-LOCKERS,
EUSHIPMENTS-15-BULGARIA-ECONT.
shipping.packPointId
Nem
A csomagpont azonosító Id-je.
billing
Nem*
A számlázás adatok.
(Kiszervezett számlázás esetén kötelező.)
billing.name
Igen
A számlázási név.
billing.company
Nem
Cég esetén, a cégnév.
billing.phone
Nem
Telefonszám.
billing.taxNumber
Nem
Adószám.
billing.countryCode
Igen
Kétjegyű országkód.
(pl.: HU)
billing.zip
Igen
Irányítószám.
billing.city
Igen
Város.
billing.address1
Igen
A cím első sora.
billing.address2
Nem
A cím második sora.
payment
Igen
A fizetéssel kapcsolatos információk.
payment.paymentMode
Igen
A fizetési mód, szabadszavas, intelligens felismerést használ, azonban az ajánlott értékek:
cod,
card,
paypal,
stb.
payment.codAmount
Nem
Az utánvét összege.
A végösszegtől eltérhet, ez az érték kerül a futárhoz utánvét összegeként.
payment.paymentStatus
Igen
A fizetés státusza, lehetséges értékek:
paid,
pending.
Egyéb esetben egyeztetés szükséges.
payment.paidDate
Nem*
A fizetés ideje.
paid (fizetve) státusz esetén kötelező.
payment.shippingPrice
Nem
A szállítási költség összege.
(Bruttó összeg, ami a vevői számlán szerepelni fog.)
payment.shippingVat
Nem
A szállítási költség ÁFA kulcsa.
payment.currency
Igen
A rendelés pénzneme, 3 karakteres (ISO) azonosító.
A rendelés létrehozásakor az API visszaadja válaszban.
referenceId
Külső azonosító.
A rendelés létrehozásakor megadott azonosító.
referenceName
A rendelés neve.
A rendelés létrehozásakor megadott név.
Egyszerre csak egy rendelés törölhető! Olyan rendelést, amit a Webshippy rendszer felületén a felhasználó manuálisan módosított, API hívással nem lehet törölni.
Csak "new" vagy "draft" státusszal rendelkező megrendelések törölhetőek.