# Order API
### **Rendelések lekérdezése**
| Szűrési feltétel | Leírás |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | A lekérdezendő oldal sorszáma.
(Alapértelmezett: 0.)
|
| `limit` | Az egy oldalon szereplő találatok száma.
(Alapértelmezett: 100, maximum: 1000.)
|
| `wspyId` | Belső 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.
|
| `paymentStatus` | A fizetési státusz, lehetséges értékek:
|
| `paymentGateway` | A fizetés módja, lehetséges értékek:
|
| `lastMod` | Az utolsó módosítás dátuma.
A megadott dátum után létrehozott vagy módosított rendeléseket listázza ki, akár egyszerre többet is.
|
A táblázatban megadott szűrési feltételek `ÉS` kapcsolatban állnak egymással, csak azokat a szűrőket kell megadni, amelyekre szűrni szeretnénk.
**XML** esetén:
Url: `https://app.webshippy.com/wspyapi/GetOrder/xml`
Kérés:
```
api-key-comes-here
0
10
2018-01-01 00:00:00
```
Válasz (példa):
```
success
176
fulfilled
87962-110037
87962-110037
2018-02-14 13:04:33
2018-02-20 16:27:17
cod
pending
8940.00
1000.00
HUF
GLS-HU
GLS
123
1290.00
0.27
1500.00
HUF
WSHPY176
2018-02-16 00:00:00
inv#00001
2018-02-26 12:18:17
szuperhos-polo-piros-xl
Szuperhős Póló
Piros, XL
1890.00
0.27
3
cicanaci-one-size
CicaNaci - One Size
990.00
0.27
1
akcios-sapka
Akciós sapka
Fekete
1990.00
0.27
1
[ ... ]
[ ... ]
```
Hibás kérés esetén (példa):
```
error
[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)
```
**JSON** esetén:
Url: `https://app.webshippy.com/wspyapi/GetOrder/json`
Kérés:
```
{
"apiKey": "api-key-comes-here",
"page": "0",
"limit": "10",
"filters": {
"wspyId": "",
"referenceId": "",
"referenceName": "",
"paymentStatus": "",
"paymentGateway": "",
"lastMod": "2018-01-01 00:00:00"
}
}
```
Válasz (példa):
```
{
"status": "success",
"message": [],
"result": [
{
"wspyId": 176,
"status": "fulfilled",
"referenceId": "87962-110037",
"referenceName": "87962-110037",
"createdAt": "2018-02-14 13:04:33",
"fulfilledAt": "2018-02-20 16:27:17",
"paymentGateway": "cod",
"paymentStatus": "pending",
"paymentTotalPrice": 8940,
"paymentTotalDiscounts": 1000,
"paymentCurrency": "HUF",
"shippingMode": "GLS-HU",
"packPoint": "GLS",
"packPointId": "123",
"shippingPrice": 1290,
"shippingVat": 0.27,
"paidAt": "",
"codAmount": 1500,
"codCurrency": "HUF",
"codStatus": "",
"codReceivedAt": "",
"trackingCode": "WSHPY176",
"invoiceStatus": "",
"invoiceCreatedAt": "2018-02-16 00:00:00",
"invoiceNo": "inv#00001",
"refusedInvoiceNo": "",
"invoiceUrl": "",
"refusedDate": "",
"updatedAt": "2018-02-26 12:18:17",
"products": [
{
"sku": "szuperhos-polo-piros-xl",
"productName": "Szuperhős Póló",
"variantName": "Piros, XL",
"priceGross": 1890,
"vat": 0.27,
"quantity": 3
},
{
"sku": "cicanaci-one-size",
"productName": "CicaNaci - One Size",
"variantName": "",
"priceGross": 990,
"vat": 0.27,
"quantity": 1
},
{
"sku": "akcios-sapka",
"productName": "Akciós sapka",
"variantName": "Fekete",
"priceGross": 1990,
"vat": 0.27,
"quantity": 1
}
]
}
]
}
```
Hibás kérés esetén (példa):
```
{
"status": "error",
"message": [
"[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)"
]
}
```
| Mező | Leírás |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `status` | A művelet eredménye, lehetséges értékek:
success: sikeres,error: hiba.
|
| `message` | Hibás kérés esetén ebbe a mezőbe kerülnek a hibaüzenetek. |
| `result` | Sikeres kérés esetén ebbe a mezőbe kerül a lekérdezés eredménye, minden esetben tömbként kerül a válaszba. |
| `wspyId` | Belső azonosító.
A rendelés létrehozásakor az API visszaadja válaszban.
|
| `status` | A rendelés státusza, lehetséges értékek:
new: új,draft: piszkozat,ready: kész,packing: csomagolás alatt,fulfilled: teljesített,refused: visszautasított.
|
| `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.
|
| `createdAt` | A rendelés létrehozásának (eredeti) ideje. |
| `fulfilledAt` | A rendelés csomagolt állapotba kerülésének ideje. |
| `paymentStatus` | A fizetési státusz, lehetséges értékek:
|
| `paidAt` | Amennyiben `paid` (fizetve), a kifizetés ideje. |
| `codAmount` | Az utánvét összege. |
| `codCurrency` | Az utánvét pénzneme. |
| `codStatus` | Az utánvét státusza. |
| `codReceivedAt` | Az utánvét beérkezésének ideje. |
| `trackingCode` | A futárszolgálat nyomon követő kódja. Több csomagos megrendelés esetén a főcsomag kódja. |
| `invoiceUrl` | Számla link a letöltéshez.
|
| `invoiceStatus` | A számlázási állapot, lehetséges értékek:
uninvoiced: nincs számlázva,invoiced: számlázva,storno: sztornózva.
|
| `invoiceCreatedAt` | A számla létrehozásának ideje. |
| `invoiceNo` | A számla azonosítója. |
| `refusedInvoiceNo` | A sztornó számla azonosítója. |
| `refusedDate` | 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 |
|---|
| 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: |
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: 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ó. (pl.: HUF) |
payment.discount | Nem | Kedvezmény a megrendelés végösszegéből. |
products | Nem | A rendelés termékei. |
products.sku | Igen | A termék SKU-ja (cikkszáma). |
products.productName | Igen | A termék neve. |
products.variantName | Nem | A termékvariáns neve. |
products.priceGross | Igen | A termék bruttó egységára. |
products.vat | Igen | A termék ÁFA kulcsa. |
products.quantity | Igen | A termékből rendelt mennyiség. |
invoiceUrl | Nem | Számla link a letöltéshez. https://example.com/invoice.pdf Csak akkor van jelentősége, ha van Manuális PDF számlafeltöltő beállítva az API kapcsolathoz, mert ebben az esetben használja fel a rendszer. |
attachmentUrl | Nem | Csatolmány link a letöltéshez. https://example.com/attachment.pdf Egy rendeléshez 1 pdf melléklet csatolható és minden esetben nyomtatásra kerül. (pl. A használati útmutató a termékhez.) |
pdfSource | Nem | Pdf formátumú számla fájl base64 kódolással. Csak akkor van jelentősége, ha van Manuális PDF számlafeltöltő beállítva az API kapcsolathoz, mert ebben az esetben használja fel a rendszer. |
**XML** esetén:
Url: `https://app.webshippy.com/wspyapi/CreateOrder/xml`
Kérés:
```
api-key-comes-here
87962-110037
87962-110037
2018-02-14 13:04:33
Kováts Béla
Virág Bt.
bela@viragbt.hu
+36301234567
HU
1234
Budapest
Virág utca 25.
GLS-HU
Kováts Béla
Virág Bt.
+36301234567
HU
1234
Budapest
Virág utca 25.
COD
1500.00
pending
1290.00
0.27
HUF
1000.00
szuperhos-polo-piros-xl
Szuperhős Póló
Piros, XL
1890.00
0.27
3
cicanaci-one-size
CicaNaci - One Size
990.00
0.27
1
akcios-sapka
Akciós sapka
Fekete
1990.00
0.27
1
```
Válasz (példa):
```
success
The order creation was successful
176
```
**JSON** esetén
Url: `https://app.webshippy.com/wspyapi/CreateOrder/json`
Kérés:
```
{
"apiKey": "api-key-comes-here",
"order": {
"referenceId": "87962-110037",
"referenceName": "87962-110037",
"createdAt": "2018-02-14 13:04:33",
"shipping": {
"name": "Kov\u00e1ts B\u00e9la",
"company": "Vir\u00e1g Bt.",
"email": "bela@viragbt.hu",
"phone": "+36301234567",
"countryCode": "HU",
"stateOrProvinceCode": "",
"zip": "1234",
"city": "Budapest",
"address1": "Vir\u00e1g utca 25.",
"address2": "",
"note": "",
"mode": "GLS-HU"
},
"billing": {
"name": "Kov\u00e1ts B\u00e9la",
"company": "Vir\u00e1g Bt.",
"phone": "+36301234567",
"countryCode": "HU",
"zip": "1234",
"city": "Budapest",
"address1": "Vir\u00e1g utca 25.",
"address2": ""
},
"payment": {
"paymentMode": "COD",
"codAmount": "1500.00",
"paymentStatus": "pending",
"paidDate": "",
"shippingPrice": "1290.00",
"shippingVat": "0.27",
"currency": "HUF",
"discount": "1000.00"
},
"products": [
{
"sku": "szuperhos-polo-piros-xl",
"productName": "Szuperh\u0151s P\u00f3l\u00f3",
"variantName": "Piros, XL",
"priceGross": "1890.00",
"vat": "0.27",
"quantity": "3"
},
{
"sku": "cicanaci-one-size",
"productName": "CicaNaci - One Size",
"priceGross": "990.00",
"vat": "0.27",
"quantity": "1"
},
{
"sku": "akcios-sapka",
"productName": "Akci\u00f3s sapka",
"variantName": "Fekete",
"priceGross": "1990.00",
"vat": "0.27",
"quantity": "1"
}
]
}
}
```
Válasz (példa):
```
{
"status": "success",
"message": [
"The order creation was successful"
],
"wspyId": 176
}
```
További válaszlehetőségek:
* `The order creation was successful`
* `The order modification was successful`
### **Rendelés törlése**
**XML**esetén:
Url: `https://app.webshippy.com/wspyapi/deleteOrder/xml`
Kérés:
```
api-key-comes-here
917872738
```
Válasz:
```
error
Error: Order is already modified!
12345678
WSP#12345678
```
**JSON** esetén:
Url: `https://app.webshippy.com/wspyapi/deleteOrder/json`
Kérés:
```
{
"apiKey": "api-key-comes-here",
"filters": {
"wspyId": "917872738"
}
}
```
Válasz (példa):
```
{
"status": "error",
"message": [
{
"Error": "Order is already modified!"
}
]
}
```
| Szűrési feltétel | Leírás |
| ---------------- | ------------------------------------------------------------------------------------ |
| `wspyId` | Belső 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.
|
{% hint style="info" %}
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.
{% endhint %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://apidoc.webshippy.com/webaruhaz-integraciok/order-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.