Order API
Rendelésekkel kapcsolatos API funkciók

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:
  • paid,
  • pending,
  • stb.
paymentGateway
A fizetés módja, lehetséges értékek:
  • cod,
  • card,
  • stb.
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:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<page>0</page>
5
<limit>10</limit>
6
<filters>
7
<wspyId></wspyId>
8
<referenceId></referenceId>
9
<referenceName></referenceName>
10
<paymentStatus></paymentStatus>
11
<paymentGateway></paymentGateway>
12
<lastMod>2018-01-01 00:00:00</lastMod>
13
</filters>
14
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>
3
<status>success</status>
4
<message/>
5
<result>
6
<elem>
7
<wspyId>176</wspyId>
8
<status>fulfilled</status>
9
<referenceId>87962-110037</referenceId>
10
<referenceName>87962-110037</referenceName>
11
<createdAt>2018-02-14 13:04:33</createdAt>
12
<fulfilledAt>2018-02-20 16:27:17</fulfilledAt>
13
<paymentGateway>cod</paymentGateway>
14
<paymentStatus>pending</paymentStatus>
15
<paymentTotalPrice>8940.00</paymentTotalPrice>
16
<paymentTotalDiscounts>1000.00</paymentTotalDiscounts>
17
<paymentCurrency>HUF</paymentCurrency>
18
<shippingMode>GLS</shippingMode>
19
<packpoint>GLS</packpoint>
20
<packpointid>123</packpointid>
21
<shippingPrice>1290.00</shippingPrice>
22
<shippingVat>0.27</shippingVat>
23
<paidAt/>
24
<codAmount>1500.00</codAmount>
25
<codCurrency>HUF</codCurrency>
26
<codStatus/>
27
<codReceivedAt/>
28
<trackingCode>WSHPY176</trackingCode>
29
<invoiceStatus/>
30
<invoiceCreatedAt>2018-02-16 00:00:00</invoiceCreatedAt>
31
<invoiceNo>inv#00001</invoiceNo>
32
<refusedInvoiceNo/>
33
<invoiceUrl/>
34
<refusedDate/>
35
<updatedAt>2018-02-26 12:18:17</updatedAt>
36
<products>
37
<elem>
38
<sku>szuperhos-polo-piros-xl</sku>
39
<productName>Szuperhős Póló</productName>
40
<variantName>Piros, XL</variantName>
41
<priceGross>1890.00</priceGross>
42
<vat>0.27</vat>
43
<quantity>3</quantity>
44
</elem>
45
<elem>
46
<sku>cicanaci-one-size</sku>
47
<productName>CicaNaci - One Size</productName>
48
<variantName/>
49
<priceGross>990.00</priceGross>
50
<vat>0.27</vat>
51
<quantity>1</quantity>
52
</elem>
53
<elem>
54
<sku>akcios-sapka</sku>
55
<productName>Akciós sapka</productName>
56
<variantName>Fekete</variantName>
57
<priceGross>1990.00</priceGross>
58
<vat>0.27</vat>
59
<quantity>1</quantity>
60
</elem>
61
</products>
62
</elem>
63
<elem>
64
[ ... ]
65
</elem>
66
[ ... ]
67
</result>
68
</response>
Copied!
Hibás kérés esetén (példa):
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>
3
<status>error</status>
4
<message>
5
<elem>[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)</elem>
6
</message>
7
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/GetOrder/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"page": "0",
4
"limit": "10",
5
"filters": {
6
"wspyId": "",
7
"referenceId": "",
8
"referenceName": "",
9
"paymentStatus": "",
10
"paymentGateway": "",
11
"lastMod": "2018-01-01 00:00:00"
12
}
13
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [],
4
"result": [
5
{
6
"wspyId": 176,
7
"status": "fulfilled",
8
"referenceId": "87962-110037",
9
"referenceName": "87962-110037",
10
"createdAt": "2018-02-14 13:04:33",
11
"fulfilledAt": "2018-02-20 16:27:17",
12
"paymentGateway": "cod",
13
"paymentStatus": "pending",
14
"paymentTotalPrice": 8940,
15
"paymentTotalDiscounts": 1000,
16
"paymentCurrency": "HUF",
17
"shippingMode": "GLS",
18
"packpoint": "GLS",
19
"packpointid": "123",
20
"shippingPrice": 1290,
21
"shippingVat": 0.27,
22
"paidAt": "",
23
"codAmount": 1500,
24
"codCurrency": "HUF",
25
"codStatus": "",
26
"codReceivedAt": "",
27
"trackingCode": "WSHPY176",
28
"invoiceStatus": "",
29
"invoiceCreatedAt": "2018-02-16 00:00:00",
30
"invoiceNo": "inv#00001",
31
"refusedInvoiceNo": "",
32
"invoiceUrl": "",
33
"refusedDate": "",
34
"updatedAt": "2018-02-26 12:18:17",
35
"products": [
36
{
37
"sku": "szuperhos-polo-piros-xl",
38
"productName": "Szuperhős Póló",
39
"variantName": "Piros, XL",
40
"priceGross": 1890,
41
"vat": 0.27,
42
"quantity": 3
43
},
44
{
45
"sku": "cicanaci-one-size",
46
"productName": "CicaNaci - One Size",
47
"variantName": "",
48
"priceGross": 990,
49
"vat": 0.27,
50
"quantity": 1
51
},
52
{
53
"sku": "akcios-sapka",
54
"productName": "Akciós sapka",
55
"variantName": "Fekete",
56
"priceGross": 1990,
57
"vat": 0.27,
58
"quantity": 1
59
}
60
]
61
}
62
]
63
}
Copied!
Hibás kérés esetén (példa):
1
{
2
"status": "error",
3
"message": [
4
"[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)"
5
]
6
}
Copied!
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:
  • paid,
  • pending,
  • stb.
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.
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.

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,
  • FOXPOST-HU,
  • PRIO.
shipping.packPoint
Nem
A csomagpont fajtája, lehetséges értékek:
  • GLS,
  • FOXPOST-HU,
  • CSOMAGKULDO.
XML esetén:
Url: https://app.webshippy.com/wspyapi/CreateOrder/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<order>
5
<referenceId>87962-110037</referenceId>
6
<referenceName>87962-110037</referenceName>
7
<createdAt>2018-02-14 13:04:33</createdAt>
8
<shipping>
9
<name>Kováts Béla</name>
10
<company>Virág Bt.</company>
11
<email>[email protected]</email>
12
<phone>+36301234567</phone>
13
<countryCode>HU</countryCode>
14
<stateOrProvinceCode></stateOrProvinceCode>
15
<zip>1234</zip>
16
<city>Budapest</city>
17
<address1>Virág utca 25.</address1>
18
<address2></address2>
19
<note>
20
<![CDATA[Szállításkor kérem a futárt, hogy ne csengessen!!!]]>
21
</note>
22
<mode>GLS</mode>
23
</shipping>
24
<billing>
25
<name>Kováts Béla</name>
26
<company>Virág Bt.</company>
27
<phone>+36301234567</phone>
28
<countryCode>HU</countryCode>
29
<zip>1234</zip>
30
<city>Budapest</city>
31
<address1>Virág utca 25.</address1>
32
<address2></address2>
33
</billing>
34
<payment>
35
<paymentMode>COD</paymentMode>
36
<codAmount>1500.00</codAmount>
37
<paymentStatus>pending</paymentStatus>
38
<paidDate></paidDate>
39
<shippingPrice>1290.00</shippingPrice>
40
<shippingVat>0.27</shippingVat>
41
<currency>HUF</currency>
42
<discount>1000.00</discount>
43
</payment>
44
<products>
45
<elem>
46
<sku>szuperhos-polo-piros-xl</sku>
47
<productName>Szuperhős Póló</productName>
48
<variantName>Piros, XL</variantName>
49
<priceGross>1890.00</priceGross>
50
<vat>0.27</vat>
51
<quantity>3</quantity>
52
</elem>
53
<elem>
54
<sku>cicanaci-one-size</sku>
55
<productName>CicaNaci - One Size</productName>
56
<priceGross>990.00</priceGross>
57
<vat>0.27</vat>
58
<quantity>1</quantity>
59
</elem>
60
<elem>
61
<sku>akcios-sapka</sku>
62
<productName>Akciós sapka</productName>
63
<variantName>Fekete</variantName>
64
<priceGross>1990.00</priceGross>
65
<vat>0.27</vat>
66
<quantity>1</quantity>
67
</elem>
68
</products>
69
</order>
70
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>
3
<status>success</status>
4
<message>
5
<elem>The order creation was successful</elem>
6
</message>
7
<wspyId>176</wspyId>
8
</response>
Copied!
JSON esetén
Url: https://app.webshippy.com/wspyapi/CreateOrder/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"order": {
4
"referenceId": "87962-110037",
5
"referenceName": "87962-110037",
6
"createdAt": "2018-02-14 13:04:33",
7
"shipping": {
8
"name": "Kov\u00e1ts B\u00e9la",
9
"company": "Vir\u00e1g Bt.",
10
"email": "[email protected]",
11
"phone": "+36301234567",
12
"countryCode": "HU",
13
"stateOrProvinceCode": "",
14
"zip": "1234",
15
"city": "Budapest",
16
"address1": "Vir\u00e1g utca 25.",
17
"address2": "",
18
"note": "",
19
"mode": "GLS"
20
},
21
"billing": {
22
"name": "Kov\u00e1ts B\u00e9la",
23
"company": "Vir\u00e1g Bt.",
24
"phone": "+36301234567",
25
"countryCode": "HU",
26
"zip": "1234",
27
"city": "Budapest",
28
"address1": "Vir\u00e1g utca 25.",
29
"address2": ""
30
},
31
"payment": {
32
"paymentMode": "COD",
33
"codAmount": "1500.00",
34
"paymentStatus": "pending",
35
"paidDate": "",
36
"shippingPrice": "1290.00",
37
"shippingVat": "0.27",
38
"currency": "HUF",
39
"discount": "1000.00"
40
},
41
"products": [
42
{
43
"sku": "szuperhos-polo-piros-xl",
44
"productName": "Szuperh\u0151s P\u00f3l\u00f3",
45
"variantName": "Piros, XL",
46
"priceGross": "1890.00",
47
"vat": "0.27",
48
"quantity": "3"
49
},
50
{
51
"sku": "cicanaci-one-size",
52
"productName": "CicaNaci - One Size",
53
"priceGross": "990.00",
54
"vat": "0.27",
55
"quantity": "1"
56
},
57
{
58
"sku": "akcios-sapka",
59
"productName": "Akci\u00f3s sapka",
60
"variantName": "Fekete",
61
"priceGross": "1990.00",
62
"vat": "0.27",
63
"quantity": "1"
64
}
65
]
66
}
67
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [
4
"The order creation was successful"
5
],
6
"wspyId": 176
7
}
Copied!
További válaszlehetőségek:
  • The order creation was successful
  • The order modification was successful

Rendelés törlése

XMLesetén:
Url: https://app.webshippy.com/wspyapi/deleteOrder/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<filters>
5
<wspyId>917872738</wspyId>
6
</filters>
7
</request>
Copied!
Válasz:
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>
3
<status>error</status>
4
<message>
5
<elem>Error: Order is already modified!</elem>
6
</message>
7
<wspyId>12345678</wspyId>
8
<referenceId/>
9
<referenceName>WSP#12345678</referenceName>
10
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/deleteOrder/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"filters": {
4
"wspyId": "917872738"
5
}
6
}
Copied!
Válasz (példa):
1
{
2
"status": "error",
3
"message": [
4
{
5
"Error": "Order is already modified!"
6
}
7
]
8
}
Copied!
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.
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.