Product API
Termékekkel kapcsolatos API funkciók

Termékek 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 termék létrehozásakor az API visszaadja válaszban.
referenceId
Külső azonosító.
A termék létrehozásakor megadott azonosító.
productName
A termék neve.
A termék létrehozásakor megadott név (SQL wildcard-ok engedélyezettek).
sku
A termék SKU-ja (cikkszáma).
barcode
A termék vonalkódja.
lastMod
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.
getAllProduct
Minden termék lekérdezése, nem csak a store API kulcsra leszűrve (true, false).
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/GetProduct/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
<productName></productName>
10
<sku></sku>
11
<barcode></barcode>
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>74210</wspyId>
8
<referenceId>1231</referenceId>
9
<sku>szuperhos-polo-piros-xl</sku>
10
<barcode>126510305031</barcode>
11
<productName>Szuperhős Póló</productName>
12
<variantName>Piros, XL</variantName>
13
<hasSerial>no</hasSerial>
14
<dutiable>yes</dutiable>
15
<taricCode>12345</taricCode>
16
<lowStock>5</lowStock>
17
<price>1200.00</price>
18
<vat>0.27</vat>
19
<currency>HUF</currency>
20
<isAdr>yes</isAdr>
21
<adrCode>4</adrCode>
22
<adrQuantity>2</adrQuantity>
23
<coolingDemand>none</coolingDemand>
24
<isFragile>no</isFragile>
25
<category>Divat és ruházat</category>
26
<subCategory>Gyermek divat</subCategory>
27
<subSubCategory>Overál</subSubCategory>
28
<keepQuantity>5</keepQuantity>
29
<dropshippyWholesalePrice>1000.00</dropshippyWholesalePrice>
30
<dropshippyWholesaleVat>0.27</dropshippyWholesaleVat>
31
<dropshippyRecommendedPrice>1200.00</dropshippyRecommendedPrice>
32
<dropshippyPromotion>no</dropshippyPromotion>
33
<productDescription>Szuperhős Póló leírás</productDescription>
34
<type>product</type>
35
<productType>clothes</productType>
36
<imageUrls>https://micoedward.com/wp-content/uploads/2018/04/Love-your-product.png;https://www.noto.design/wp-content/uploads/18-06-14_Heritage_Render_Header-1-1100x619.jpg</imageUrls>
37
<quantity>191</quantity>
38
<available_quantity>189</available_quantity>
39
<reserved_by_orders>2</reserved_by_orders>
40
<updatedAt>2018-03-12 11:59:35</updatedAt>
41
</elem>
42
<elem>
43
<wspyId>74211</wspyId>
44
<referenceId>1232</referenceId>
45
<sku>cicanaci-one-size</sku>
46
<barcode>126510305032</barcode>
47
<productName>CicaNaci - One Size</productName>
48
<variantName/> <hasSerial>no</hasSerial>
49
<dutiable>yes</dutiable>
50
<taricCode>12345</taricCode>
51
<lowStock>5</lowStock>
52
<price>1200.00</price>
53
<vat>0.27</vat>
54
<currency>HUF</currency>
55
<isAdr>yes</isAdr>
56
<adrCode>4</adrCode>
57
<adrQuantity>2</adrQuantity>
58
<coolingDemand>none</coolingDemand>
59
<isFragile>no</isFragile>
60
<category>Divat és ruházat</category>
61
<subCategory>Gyermek divat</subCategory>
62
<keepQuantity>5</keepQuantity>
63
<dropshippyWholesalePrice>1000.00</dropshippyWholesalePrice>
64
<dropshippyWholesaleVat>0.27</dropshippyWholesaleVat>
65
<dropshippyRecommendedPrice>1200.00</dropshippyRecommendedPrice>
66
<dropshippyPromotion>no</dropshippyPromotion>
67
<productDescription>CicaNaci - One Size</productDescription>
68
<type>product</type>
69
<productType>clothes</productType>
70
<imageUrls/>
71
<quantity>197</quantity>
72
<available_quantity>196</available_quantity>
73
<reserved_by_orders>1</reserved_by_orders>
74
<updatedAt>2018-03-12 11:59:32</updatedAt>
75
</elem>
76
<elem>
77
[ ... ]
78
</elem>
79
[ ... ]
80
</result>
81
</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/GetProduct/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"page": "0",
4
"limit": "10",
5
"filters": {
6
"wspyId": "",
7
"referenceId": "",
8
"productName": "",
9
"sku": "",
10
"barcode": "",
11
"lastMod": "2018-01-01 00:00:00",
12
"getAllProduct": true
13
}
14
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [],
4
"result": [
5
{
6
"wspyId": "74210",
7
"referenceId": "1231",
8
"sku": "szuperhos-polo-piros-xl",
9
"barcode": "126510305031",
10
"productName": "Szuperhős Póló",
11
"variantName": "Piros, XL",
12
"hasSerial": "no",
13
"dutiable": "yes",
14
"taricCode": "12345",
15
"lowStock": "5",
16
"price": "1200.00",
17
"vat": "0.27",
18
"currency": "HUF",
19
"isAdr": "yes",
20
"adrCode": "4",
21
"adrQuantity": "2",
22
"coolingDemand": "none",
23
"isFragile": "no",
24
"category": "Divat és ruházat",
25
"subCategory": "Gyermek divat",
26
"keepQuantity": "5",
27
"dropshippyWholesalePrice": "1000.00",
28
"dropshippyWholesaleVat": "0.27",
29
"dropshippyRecommendedPrice": "1200.00",
30
"dropshippyPromotion": "no",
31
"productDescription": "Szuperhős Póló leírás",
32
"type": "product",
33
"productType": "clothes",
34
"imageUrls": "https://micoedward.com/wp-content/uploads/2018/04/Love-your-product.png;https://www.noto.design/wp-content/uploads/18-06-14_Heritage_Render_Header-1-1100x619.jpg",
35
"quantity": "191",
36
"available_quantity": "189",
37
"reserved_by_orders": "2",
38
"updatedAt": "2018-03-12 11:59:35"
39
},
40
{
41
"wspyId": "74211",
42
"referenceId": "1232",
43
"sku": "cicanaci-one-size",
44
"barcode": "126510305032",
45
"productName": "CicaNaci - One Size",
46
"variantName": "",
47
"hasSerial": "no",
48
"dutiable": "yes",
49
"taricCode": "12345",
50
"lowStock": "5",
51
"price": "1200.00",
52
"vat": "0.27",
53
"currency": "HUF",
54
"isAdr": "yes",
55
"adrCode": "4",
56
"adrQuantity": "2",
57
"coolingDemand": "none",
58
"isFragile": "no",
59
"category": "Divat és ruházat",
60
"subCategory": "Gyermek divat",
61
"subSubCategory": "Overál",
62
"keepQuantity": "5",
63
"dropshippyWholesalePrice": "1000.00",
64
"dropshippyWholesaleVat": "0.27",
65
"dropshippyRecommendedPrice": "1200.00",
66
"dropshippyPromotion": "no",
67
"productDescription": "CicaNaci - One Size",
68
"type": "product",
69
"productType": "clothes",
70
"imageUrls": "",
71
"quantity": "197",
72
"available_quantity": "196",
73
"reserved_by_orders": "1",
74
"updatedAt": "2018-03-12 11:59:32"
75
}
76
]
77
}
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 termék létrehozásakor az API visszaadja válaszban.
referenceId
Külső azonosító.
A termék létrehozásakor megadott azonosító.
sku
A termék SKU-ja (cikkszáma).
barcode
Termék vonalkódja(i).
Az első vonalkód a termék vonalkódja. A további vonalkódok, ; [pontosvessző] szeparátorral elválasztva, a termék alternatív vonalkódjai lesznek. Formátum: [a-zA-Z0-9-_] (pl.: HU-324;WSPY_3456;12345; AAA)
productName
A termék neve.
variantName
A termékvariáns neve.
hasSerial
Rendelkezik-e a termék egyedi sorszámmal? Lehetséges értékek:
  • yes,
  • no.
dutiable
Vámkezelendő-e a termék? Lehetséges értékek:
  • yes,
  • no.
taricCode
A termék vámtarifaszáma.
productType
Termékleírás a vámeljáráshoz.
lowStock
Megadható készletszint érték, ami alatt a termék szerepel a termékkészlet utánpótlást figyelmeztető értesítésben.
Segíti a készleten tárolt termékek mennyiségének optimalizálását.
price
A termék eladási ára (nettó).
vat
ÁFA.
(pl.: 0.27)
currency
Valuta. Amennyiben nincs megadva (kitöltve), akkor az országnak megfelelő alapértelmezett pénznem.
(pl.: HUF, EUR, CZK, RON)
isAdr
Veszélyes árunak (ADR) számít-e a termék? Lehetséges értékek:
  • yes,
  • no.
adrCode
ADR kód.

Termékek létrehozása, módosítása

Ezzel a funkcióval egyszerre lehet létrehozni és módosítani termékeket. Amennyiben a megadott sku-val még nem szerepel nálunk termék, akkor az API létrehozza, amennyiben már szerepel, akkor módosítja azt. Minden mező szabadon módosítható, kivéve a barcode, ami csak akkor, ha még nincs megadva ez az adat vagy nem volt még belőle árubeszállítás rögzítve. Sikeres létrehozás, vagy módosítás esetén az API visszaadja a rendelés belső azonosítóját.
Egy API hívással egy termék hozható létre vagy módosítható.
Dropshippy felhasználás esetén keresd fel a kapcsolódó help anyagjainkat is.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
product
Igen
Létrehozandó vagy módosítandó termék adatai.
referenceId
Nem
Külső azonosító.
Szabadszavas, ajánlott a termék azonosítójának használata.
sku
Igen
A termék SKU-ja (cikkszáma).
barcode
Igen
Termék vonalkódja(i).
Az első vonalkód a termék vonalkódja. A további vonalkódok, ; [pontosvessző] szeparátorral elválasztva, a termék alternatív vonalkódjai lesznek. Formátum: [a-zA-Z0-9-_] (pl.: HU-324;WSPY_3456;12345; AAA)
productName
Igen
A termék neve.
variantName
Nem
A termék variáns neve.
(pl.: szín, méret)
type
Nem
A termék típusa, lehetséges értékek:
  • product,
  • virtual.
productDescription
Nem
A termékleírás.
hasSerial
Nem
Rendelkezik-e a termék egyedi sorszámmal? Lehetséges értékek:
  • yes,
  • no.
dutiable
Nem
Vámkezelendő-e a termék? Lehetséges értékek:
  • yes,
  • no.
taricCode
Nem
A termék vámtarifaszáma.
productType
Nem
Termékleírás a vámeljáráshoz.
lowStock
Nem
Alacsony készletszint értéke.
price
Nem
A termék eladási ára (nettó).
vat
Nem
ÁFA (termék eladás).
currency
Nem
Valuta. Amennyiben nincs megadva (kitöltve), akkor az országnak megfelelő alapértelmezett pénznem.
(pl.: HUF, EUR, CZK, RON)
isAdr
Nem
Veszélyes árunak (ADR) számít-e a termék? Lehetséges értékek:
  • yes,
  • no.
adrCode
Nem
ADR kód.
adrQuantity
Nem
ADR mennyiség.
XML esetén:
Url: https://app.webshippy.com/wspyapi/CreateProduct/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<product>
5
<referenceId>1231</referenceId>
6
<sku>szuperhos-polo-piros-xl</sku>
7
<barcode>126510305031</barcode>
8
<productName>Szuperhős Póló</productName>
9
<variantName>Piros, XL</variantName>
10
<type>product</type>
11
<hasSerial>no</hasSerial>
12
<dutiable>yes</dutiable>
13
<productDescription>Szuperhős Póló leírás</productDescription>
14
<taricCode>12345</taricCode>
15
<lowStock>5</lowStock>
16
<price>1200</price>
17
<vat>0.27</vat>
18
<currency>HUF</currency>
19
<isAdr>yes</isAdr>
20
<adrCode>4</adrCode>
21
<adrQuantity>2</adrQuantity>
22
<coolingDemand>none</coolingDemand>
23
<isFragile>no</isFragile>
24
<productType>clothes</productType>
25
<category>3-406</category>
26
<keepQuantity>5</keepQuantity>
27
<dropshippyWholesalePrice>1000</dropshippyWholesalePrice>
28
<dropshippyWholesaleVat>0.27</dropshippyWholesaleVat>
29
<dropshippyRecommendedPrice>1200</dropshippyRecommendedPrice>
30
<dropshippyPromotion>no</dropshippyPromotion>
31
<imageUrls>https://micoedward.com/wp-content/uploads/2018/04/Love-your-product.png;https://www.noto.design/wp-content/uploads/18-06-14_Heritage_Render_Header-1-1100x619.jpg</imageUrls>
32
</product>
33
</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 product creation was successful</elem>
6
</message>
7
<wspyId>74210</wspyId>
8
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/CreateProduct/json
Kérés:
1
{
2
"apiKey": "api-key-comes-here",
3
"product": {
4
"referenceId": "1231",
5
"sku": "szuperhos-polo-piros-xl",
6
"barcode": "126510305031",
7
"productName": "Szuperhős Póló",
8
"variantName": "Piros, XL",
9
"type": "product",
10
"hasSerial": "no",
11
"dutiable": "yes",
12
"productDescription": "Szuperhős Póló leírás",
13
"taricCode": "12345",
14
"lowStock": "5",
15
"price": "1200",
16
"vat": "0.27",
17
"currency": "HUF",
18
"isAdr": "yes",
19
"adrCode": "4",
20
"adrQuantity": "2",
21
"coolingDemand": "none",
22
"isFragile": "no",
23
"productType": "clothes",
24
"category": "3-406",
25
"keepQuantity": "5",
26
"dropshippyWholesalePrice": "1000",
27
"dropshippyWholesaleVat": "0.27",
28
"dropshippyRecommendedPrice": "1200",
29
"dropshippyPromotion": "no",
30
"imageUrls": "https://micoedward.com/wp-content/uploads/2018/04/Love-your-product.png;https://www.noto.design/wp-content/uploads/18-06-14_Heritage_Render_Header-1-1100x619.jpg"
31
}
32
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"message": [
4
"The product creation was successful"
5
],
6
"wspyId": 74210
7
}
Copied!
További válaszlehetőségek:
  • The product creation was successful
  • The product modification was successful
  • No changes detected in product

Termékcsomag létrehozása

Ezzel a funkcióval lehet létrehozni termékcsomagokat. Ha a megadott bundleSku-val még nem szerepel nálunk sem termék, sem termékcsomag akkor az API létrehozza. Sikeres létrehozás, vagy módosítás esetén az API visszaadja a termékcsomag belső azonosítóját
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
bundleSku
Igen
A termékcsomag SKU-ja (cikkszáma).
bundleName
Igen
A termékcsomag neve.
bundlePriceNet
Nem
A termékcsomag nettó eladási ára.
bundleVat
Nem
A termékcsomag ÁFA.
(pl.: 27)
bundleCurrency
Nem
Az eladási ár pénzneme.
(pl.: HUF, EUR, CZK, RON)
products
Igen
A termékcsomag termékei.
productSku
Igen
A termék SKU-ja (cikkszáma).
quantity
Igen
A rendelt mennyiség.
XML esetén:
Url: https://app.webshippy.com/wspyapi/createBundle/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request>
3
<apiKey>api-key-comes-here</apiKey>
4
<bundleSKU>123334</bundleSKU>
5
<bundleName>Akciós csomag</bundleName>
6
<bundlePriceNet>5000</bundlePriceNet>
7
<bundleVat>26</bundleVat>
8
<bundleCurrency>HUF</bundleCurrency>
9
<products>
10
<productSku>prod001</productSku>
11
<quantity>3</quantity>
12
</products>
13
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>
3
<status>error</status>
4
<message>Request format is invalid</message>
5
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/createBundle/json
Kérés:
1
{
2
"apiKey": "xxx-own-apikey-xxx",
3
"bundleSku": "bundlesku-001",
4
"bundleName": "bundlename-001",
5
"bundlePriceNet": "1000",
6
"bundleCurrency": "HUF",
7
"products": [{
8
"productSku": "09002",
9
"quantity": "1"
10
},
11
{
12
"productSku": "09004",
13
"quantity": "1"
14
}
15
]
16
}
Copied!
Válasz (példa):
1
{
2
"status": "error",
3
"message": [
4
"Request format is invalid"
5
]
6
}
Copied!

Termék törlése

Hamarosan…