# Product API
### **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:
```
api-key-comes-here
0
10
2018-01-01 00:00:00
```
Válasz (példa):
```
success
74210
1231
szuperhos-polo-piros-xl
126510305031
Szuperhős Póló
Piros, XL
no
yes
12345
5
1200.00
0.27
HUF
yes
4
2
none
no
Divat és ruházat
Gyermek divat
Overál
5
1000.00
0.27
1200.00
no
Szuperhős Póló leírás
product
clothes
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
191
189
2
2018-03-12 11:59:35
74211
1232
cicanaci-one-size
126510305032
CicaNaci - One Size
no
yes
12345
5
1200.00
0.27
HUF
yes
4
2
none
no
Divat és ruházat
Gyermek divat
5
1000.00
0.27
1200.00
no
CicaNaci - One Size
product
clothes
197
196
1
2018-03-12 11:59:32
[ ... ]
[ ... ]
```
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/GetProduct/json`
Kérés:
```
{
"apiKey": "api-key-comes-here",
"page": "0",
"limit": "10",
"filters": {
"wspyId": "",
"referenceId": "",
"productName": "",
"sku": "",
"barcode": "",
"lastMod": "2018-01-01 00:00:00",
"getAllProduct": true
}
}
```
Válasz (példa):
```
{
"status": "success",
"message": [],
"result": [
{
"wspyId": "74210",
"referenceId": "1231",
"sku": "szuperhos-polo-piros-xl",
"barcode": "126510305031",
"productName": "Szuperhős Póló",
"variantName": "Piros, XL",
"hasSerial": "no",
"dutiable": "yes",
"taricCode": "12345",
"lowStock": "5",
"price": "1200.00",
"vat": "0.27",
"currency": "HUF",
"isAdr": "yes",
"adrCode": "4",
"adrQuantity": "2",
"coolingDemand": "none",
"isFragile": "no",
"category": "Divat és ruházat",
"subCategory": "Gyermek divat",
"keepQuantity": "5",
"dropshippyWholesalePrice": "1000.00",
"dropshippyWholesaleVat": "0.27",
"dropshippyRecommendedPrice": "1200.00",
"dropshippyPromotion": "no",
"productDescription": "Szuperhős Póló leírás",
"type": "product",
"productType": "clothes",
"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",
"quantity": "191",
"available_quantity": "189",
"reserved_by_orders": "2",
"updatedAt": "2018-03-12 11:59:35"
},
{
"wspyId": "74211",
"referenceId": "1232",
"sku": "cicanaci-one-size",
"barcode": "126510305032",
"productName": "CicaNaci - One Size",
"variantName": "",
"hasSerial": "no",
"dutiable": "yes",
"taricCode": "12345",
"lowStock": "5",
"price": "1200.00",
"vat": "0.27",
"currency": "HUF",
"isAdr": "yes",
"adrCode": "4",
"adrQuantity": "2",
"coolingDemand": "none",
"isFragile": "no",
"category": "Divat és ruházat",
"subCategory": "Gyermek divat",
"subSubCategory": "Overál",
"keepQuantity": "5",
"dropshippyWholesalePrice": "1000.00",
"dropshippyWholesaleVat": "0.27",
"dropshippyRecommendedPrice": "1200.00",
"dropshippyPromotion": "no",
"productDescription": "CicaNaci - One Size",
"type": "product",
"productType": "clothes",
"imageUrls": "",
"quantity": "197",
"available_quantity": "196",
"reserved_by_orders": "1",
"updatedAt": "2018-03-12 11:59:32"
}
]
}
```
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 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:
|
| `dutiable` | Vámkezelendő-e a termék? Lehetséges értékek:
|
| `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:
|
| `adrCode` | ADR kód. |
| `adrQuantity` | ADR mennyiség. |
| `coolingDemand` | A termék hűtést igényel, lehetséges értékek:
refrigerator,freezer,none.
|
| `isFragile` | Törékeny-e a termék? Lehetséges értékek:
|
| `categoryUniqueId` | Kategória azonosító. |
| `category` | Termékcsoport. |
| `subCategory` | Főkategória. |
| `sub_subCategory` | Alkategória. |
| `keepQuantity` | Foglalt saját készlet. |
| `dropshippyWholesalePrice` | Marketplace nagykereskedelmi ár.
(Nettó, forintban, csak nagykereskedő látja.)
|
| `dropshippyWholesaleVat` | Marketplace nagykereskedelmi ÁFA.
(pl: 0.27)
|
| `dropshippyRecommendedPrice` | Marketplace ajánlott fogyasztói ár.
(Nettó, forintban, csak nagykereskedő látja.)
|
| `dropshippyCatalogPrice` | Marketplace katalógus ár.
(A kiskereskedő részére.)
|
| `dropshippyCatalogVat` | Marketplace katalógus ár ÁFA.
(A kiskereskedő részére.)
|
| `productDescription` | Termékleírás. |
| `type` | A termék típusa, lehetséges értékek:
|
| `imageUrls` | A termék kép linkek.
(; \[pontosvessző] szeparátorral elválasztva, maximum 6 darab link.)
|
| `quantity` | A termék raktárkészlet állapota.
(A szabad készletet és a rendelésekhez lefoglalt mennyiségeket is tartalmazza.)
|
| `available_quantity` | A termék szabad készletét tartalmazza.
(A rendelésekhez már lefoglalt mennyiségeket nem tartalmazza.)
|
| `external_quantity` | A termék külső készletről beszerezhető mennyisége.
(1-3 napos beszállítással teljesíthető.)
|
| `reserved_by_orders` | A termék készletből rendelésekhez lefoglalt mennyiség. |
| `updatedAt` | A termék utolsó módosításának ideje. |
### **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ó.
{% hint style="info" %}
Dropshippy felhasználás esetén keresd fel a kapcsolódó [help](https://help.webshippy.com/hu/articles/3768583-sajat-termekek-belistazasa-a-dropshippy-katalogusba) anyagjainkat is.
{% endhint %}
| 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:
|
| `productDescription` | Nem | A termékleírás. |
| `hasSerial` | Nem | Rendelkezik-e a termék egyedi sorszámmal? Lehetséges értékek:
|
| `dutiable` | Nem | Vámkezelendő-e a termék? Lehetséges értékek:
|
| `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:
|
| `adrCode` | Nem | ADR kód. |
| `adrQuantity` | Nem | ADR mennyiség. |
| `coolingDemand` | Nem | A termék hűtést igényel, lehetséges értékek:
refrigerator,freezer,none.
|
| `isFragile` | Nem | Törékeny-e a termék? Lehetséges értékek:
|
| `category` | Nem | Kategória azonosító.
(azonosítók letöltése)
|
| `keepQuantity` | Nem | Foglalt saját készlet. |
| `dropshippyWholesalePrice` | Nem | Marketplace nagykereskedelmi ár.
(Nettó, forintban.)
|
| `dropshippyWholesaleVat` | Nem | Marketplace nagykereskedelmi ÁFA.
(pl. 0.27)
|
| `dropshippyRecommendedPrice` | Nem | Marketplace ajánlott nettó fogyasztói ár.
(Forintban.)
|
| `imageUrls` | Nem | A termék kép linkek.
(; \[pontosvessző] szeparátorral elválasztva, maximum 6 darab link.)
|
**XML** esetén:
Url: `https://app.webshippy.com/wspyapi/CreateProduct/xml`
Kérés:
```
api-key-comes-here
1231
szuperhos-polo-piros-xl
126510305031
Szuperhős Póló
Piros, XL
product
no
yes
Szuperhős Póló leírás
12345
5
1200
0.27
HUF
yes
4
2
none
no
clothes
3-406
5
1000
0.27
1200
no
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
```
Válasz (példa):
```
success
The product creation was successful
74210
```
**JSON** esetén:
Url: `https://app.webshippy.com/wspyapi/CreateProduct/json`
Kérés:
```
{
"apiKey": "api-key-comes-here",
"product": {
"referenceId": "1231",
"sku": "szuperhos-polo-piros-xl",
"barcode": "126510305031",
"productName": "Szuperhős Póló",
"variantName": "Piros, XL",
"type": "product",
"hasSerial": "no",
"dutiable": "yes",
"productDescription": "Szuperhős Póló leírás",
"taricCode": "12345",
"lowStock": "5",
"price": "1200",
"vat": "0.27",
"currency": "HUF",
"isAdr": "yes",
"adrCode": "4",
"adrQuantity": "2",
"coolingDemand": "none",
"isFragile": "no",
"productType": "clothes",
"category": "3-406",
"keepQuantity": "5",
"dropshippyWholesalePrice": "1000",
"dropshippyWholesaleVat": "0.27",
"dropshippyRecommendedPrice": "1200",
"dropshippyPromotion": "no",
"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"
}
}
```
Válasz (példa):
```
{
"status": "success",
"message": [
"The product creation was successful"
],
"wspyId": 74210
}
```
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:
```
api-key-comes-here
123334
Akciós csomag
5000
26
HUF
prod001
3
```
Válasz (példa):
```
error
Request format is invalid
```
**JSON** esetén:
Url: `https://app.webshippy.com/wspyapi/createBundle/json`
Kérés:
```
{
"apiKey": "xxx-own-apikey-xxx",
"bundleSku": "bundlesku-001",
"bundleName": "bundlename-001",
"bundlePriceNet": "1000",
"bundleCurrency": "HUF",
"products": [{
"productSku": "09002",
"quantity": "1"
},
{
"productSku": "09004",
"quantity": "1"
}
]
}
```
Válasz (példa):
```
{
"status": "error",
"message": [
"Request format is invalid"
]
}
```
### **Termék törlése**
Hamarosan…