Inventory Transfer API
Áruszállításokkal kapcsolatos API funkciók

Áruszállítás alapadatainak lekérdezése

Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
page
Nem
A lekérdezendő oldal sorszáma.
(Alapértelmezett: 0.)
limit
Nem
Az egy oldalon szereplő találatok száma.
(Alapértelmezett: 100, maximum: 1000.)
wspyId
Nem
Az áruszállítás egyedi, Webshippy azonosítója.
lastMod
Nem
Az utolsó módosítás dátuma.
A megadott dátum után létrehozott vagy módosított termékeket listázza ki, akár egyszerre többet is.
status
Nem
A lekérdezendő beszállítások státusza (lehetséges értékek: new, draft).
nickname
Nem
Az API-n keresztül fantázianévvel létrehozott áruszállítás a neve alapján kereshető a listafelületen. Áruszállítás frissítésekor a fantázianév is frissíthető.
XML esetén:
Url: https://app.webshippy.com/wspyapi/getTransfer/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>1000</limit>
6
<filters>
7
<wspyId></wspyId>
8
<lastMod>2019-01-01 00:00:00</lastMod>
9
</filters>
10
</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>7258</wspyId>
8
<warehouseId/>
9
<nickname>balloon</nickname>
10
<status>shipped</status>
11
<direction>in</direction>
12
<expectedArrival>2019-07-24</expectedArrival>
13
<note>t-takács</note>
14
<created>2019-07-23 10:54:33</created>
15
<updated>2019-07-24 07:24:10</updated>
16
<new>2019-07-23 11:51:25</new>
17
<arrived>2019-07-24 07:28:57</arrived>
18
<transfered>2019-07-24 07:30:45</transfered>
19
</elem>
20
</result>
21
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/getTransfer/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"page": "0",
4
"limit": "1000",
5
"filters": {
6
"wspyId": "",
7
"lastMod": "2019-01-01 00:00:00"
8
}
9
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [],
4
"result": [
5
{
6
"wspyId": "7258",
7
"warehouseId": null,
8
"nickname": "balloon",
9
"status": "shipped",
10
"direction": "in",
11
"expectedArrival": "2019-07-24",
12
"note": "t-takács",
13
"created": "2019-07-23 10:54:33",
14
"updated": "2019-07-24 07:24:10",
15
"new": "2019-07-23 11:51:25",
16
"arrived": "2019-07-24 07:28:57",
17
"transfered": "2019-07-24 07:30:45"
18
}
19
]
20
}
Copied!

Egy áruszállítás tételeinek lekérdezése

A wspyId ismeretében áruszállításonként lehet lekérdezni a szállításban szereplő tételeket és azok bekészített, valamint ténylegesen leszámolt mennyiségét.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
wspyId
Igen
Az áruszállítás egyedi, Webshippy azonosítója.
nickname
Nem
Az API-n keresztül fantázianévvel létrehozott áruszállítás a neve alapján kereshető a listafelületen. Áruszállítás frissítésekor a fantázianév is frissíthető.
XML esetén:
Url: https://app.webshippy.com/wspyapi/getTransferDetails/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>6526</wspyId>
6
</filters>
7
</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
<wspyProductId>267812</wspyProductId>
8
<productName>Teszt termék 2</productName>
9
<variantName/>
10
<nickname>balloon</nickname>
11
<produtSku>TESZT-2</produtSku>
12
<productBarcode>TESZT-2</productBarcode>
13
<quantity>10</quantity>
14
<checkedQuantity>15</checkedQuantity>
15
</elem>
16
</result>
17
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/getTransferDetails/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"filters": {
4
"wspyId": "6526"
5
}
6
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [],
4
"result": [
5
{
6
"wspyProductId": "267812",
7
"productName": "Teszt termék 2",
8
"variantName": "",
9
"nickname": "balloon",
10
"produtSku": "TESZT-2",
11
"productBarcode": "TESZT-2",
12
"quantity": "10",
13
"checkedQuantity": "15"
14
}
15
]
16
}
Copied!

Áruszállítás létrehozása

Ezzel a funkcióval áruszállítások hozhatóak létre.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
nickname
Nem
Az API-n keresztül fantázianévvel létrehozott áruszállítás a neve alapján kereshető a listafelületen. Áruszállítás frissítésekor a fantázianév is frissíthető.
finalize
Nem
Az árubeszállítás rögzítése (véglegesítése), lehetséges értékek:
  • normal- a normál kapacitás terhére kívánja előjegyezni az árubeszállítását,
  • priority- a feláras (priós) kapacitás terhére kívánja előjegyezni az árubeszállítását,
  • BLANK- (üres) piszkozatban mentjük.
direction
Igen
A létrehozandó áruszállítás iránya (in/out).
note
Igen
Megjegyzés az áruszállításhoz.
date
Nem
Az áruszállítás várható dátuma.
Amennyiben nincs megadva, piszkozatként jön létre az áruszállítás.
quantity
Igen
A szállított termék mennyisége (pozitív egész).
sku
Igen
A szállított termék SKU-ja (cikkszáma).
Amennyiben nincs rögzítve az áruszállítás várható dátuma (date), akkor a piszkozat státuszú áruszállítás már csak az Webshippy app felületén véglegesíthető.
XML esetén:
Url: https://app.webshippy.com/wspyapi/CreateTransfer/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<transfer>
5
<direction>in</direction>
6
<note>délután érkezik</note>
7
<date>2018-01-01</date>
8
<nickname>balloon</nickname>
9
<finalize></finalize>
10
<products>
11
<elem>
12
<quantity>3</quantity>
13
<sku>4345</sku>
14
</elem>
15
<elem>
16
<quantity>1</quantity>
17
<sku>67657</sku>
18
</elem>
19
<elem>
20
<quantity>1</quantity>
21
<sku>56464</sku>
22
</elem>
23
</products>
24
</transfer>
25
</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 transfer creation was successful</elem>
6
</message>
7
<transfer_id>74210</transfer_id>
8
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/CreateTransfer/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"transfer": {
4
"direction": "in",
5
"transfer_id": 59,
6
"note": "délután viszik el",
7
"date": "2018-08-20",
8
"nickname": "balloon",
9
"products": [
10
{
11
"quantity": 3,
12
"sku": 343545
13
},
14
{
15
"quantity": 2,
16
"sku": 654564
17
},
18
{
19
"quantity": 1,
20
"sku": 32432432
21
}
22
]
23
}
24
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [
4
"The transfer creation was successful"
5
],
6
"transfer_id": 176
7
}
Copied!