Product API
Szűrési feltétel | Leírás |
| Az egy oldalon szereplő találatok száma (alapértelmezett: 100, maximum: 1000) |
| Lekérdezendő oldal sorszáma (alapértelmezett: 0) |
| Belső azonosító, termék létrehozásakor az API visszaadja válaszban |
| Külső azonosító, termék létrehozásakor megadott azonosító |
| Termék neve, termék létrehozásakor megadott név (SQL wildcard-ok engedélyezettek) |
| Termék SKU-ja, cikkszáma |
| Termék vonalkódja |
| 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 |
| 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:
<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey> <page>0</page> <limit>10</limit> <filters> <wspyId></wspyId> <referenceId></referenceId> <productName></productName> <sku></sku> <barcode></barcode> <lastMod>2018-01-01 00:00:00</lastMod> </filters></request>
Válasz (példa):
<?xml version="1.0" encoding="utf-8"?><response> <status>success</status> <message/> <result> <elem> <wspyId>74210</wspyId> <referenceId>1231</referenceId> <sku>szuperhos-polo-piros-xl</sku> <barcode>126510305031</barcode> <productName>Szuperhős Póló</productName> <variantName>Piros, XL</variantName> <hasSerial>no</hasSerial> <dutiable>yes</dutiable> <taricCode>12345</taricCode> <lowStock>5</lowStock> <price>1200.00</price> <vat>0.27</vat> <currency>HUF</currency> <isAdr>yes</isAdr> <adrCode>4</adrCode> <adrQuantity>2</adrQuantity> <coolingDemand>none</coolingDemand> <isFragile>no</isFragile> <category>Divat és ruházat</category> <subCategory>Gyermek divat</subCategory> <subSubCategory>Overál</subSubCategory> <keepQuantity>5</keepQuantity> <dropshippyWholesalePrice>1000.00</dropshippyWholesalePrice> <dropshippyWholesaleVat>0.27</dropshippyWholesaleVat> <dropshippyRecommendedPrice>1200.00</dropshippyRecommendedPrice> <dropshippyPromotion>no</dropshippyPromotion> <productDescription>Szuperhős Póló leírás</productDescription> <type>product</type> <productType>clothes</productType> <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> <quantity>191</quantity> <available_quantity>189</available_quantity> <reserved_by_orders>2</reserved_by_orders> <updatedAt>2018-03-12 11:59:35</updatedAt> </elem> <elem> <wspyId>74211</wspyId> <referenceId>1232</referenceId> <sku>cicanaci-one-size</sku> <barcode>126510305032</barcode> <productName>CicaNaci - One Size</productName> <variantName/> <hasSerial>no</hasSerial> <dutiable>yes</dutiable> <taricCode>12345</taricCode> <lowStock>5</lowStock> <price>1200.00</price> <vat>0.27</vat> <currency>HUF</currency> <isAdr>yes</isAdr> <adrCode>4</adrCode> <adrQuantity>2</adrQuantity> <coolingDemand>none</coolingDemand> <isFragile>no</isFragile> <category>Divat és ruházat</category> <subCategory>Gyermek divat</subCategory> <keepQuantity>5</keepQuantity> <dropshippyWholesalePrice>1000.00</dropshippyWholesalePrice> <dropshippyWholesaleVat>0.27</dropshippyWholesaleVat> <dropshippyRecommendedPrice>1200.00</dropshippyRecommendedPrice> <dropshippyPromotion>no</dropshippyPromotion> <productDescription>CicaNaci - One Size</productDescription> <type>product</type> <productType>clothes</productType> <imageUrls/> <quantity>197</quantity> <available_quantity>196</available_quantity> <reserved_by_orders>1</reserved_by_orders> <updatedAt>2018-03-12 11:59:32</updatedAt> </elem> <elem> [ ... ] </elem> [ ... ] </result></response>
Hibás kérés esetén (példa):
<?xml version="1.0" encoding="utf-8"?><response> <status>error</status> <message> <elem>[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)</elem> </message></response>
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 |
| Művelet eredménye. Lehetséges értékek: |
| Hibás kérés esetén ebbe a mezőbe kerülnek a hibaüzenetek |
| 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 |
| Belső azonosító, termék létrehozásakor az API visszaadja válaszban |
| Külső azonosító, termék létrehozásakor megadott azonosító |
| Termék SKU-ja, cikkszáma |
| Termék vonalkódja(i). Első vonalkód a termék vonalkódja, további vonalkódok ;-vel elválasztva a termék alternatív vonalkódjai lesznek. Formátum: [a-zA-Z0-9-_] (pl.: HU-324;WSPY_3456;12345; AAA) |
| Termék neve |
| Termék variáns neve |
| Rendelkezik-e a termék egyedi sorszámmal ("yes", "no") |
| Vámkezelendő? ("yes", "no") |
| A termék vámtarifaszáma |
| Termékleírás vámeljáráshoz |
| Megadhatod azt a készletszint értéket, ami alatt a termékkészlet utánpótlást figyelmeztető értesítésbe a termék szerepeljen. Ezzel segítheted a készleten tárolt termékek mennyiségének optimalizálását. |
| A termék eladási ára (nettó) |
| ÁFA (pl.: 0.27) |
| Valuta (pl.: HUF, RON, EUR) |
| A termék veszélyes árunak (ADR) számít? ("yes", "no") |
| ADR kód |
| ADR mennyiség |
| A termék hűtést igényel ("refrigerator", "freezer" "none") |
| A termék törékeny ("yes", "no") |
| Termékcsoport |
| Alkategória |
| Foglalt saját készlet |
| Dropshippy nagykereskedelmi ár (nettó, forintban, csak nagykereskedő látja) |
| Dropshippy nagykereskedelmi ÁFA (pl: 0.27) |
| Dropshippy ajánlott nettó fogyasztói ár (forintban, csak nagykereskedő látja) |
| Dropshippy katalógus ár (kiskereskedő részére) |
| Dropshippy katalógus ár ÁFA (kiskereskedő részére) |
| Termékleírás |
| Termék típusa ("product", "virtual") |
| Termék kép linkek (; [pontosvessző] szeparátorral elválasztva, maximum 6 darab link) |
| Termék raktárkészlet állapota (a szabad készletet és a rendelésekhez lefoglalt mennyiségeket is tartalmazza) |
| A termék szabad készletét tartalmazza (a rendelésekhez már lefoglalt mennyiségeket nem) |
| A termék külső készletről beszerezhető mennyisége (1-3 napos beszállítással teljesíthető) |
| A termék készletből a rendelésekhez lefoglalt mennyiséget tartalmazza |
| Termék utolsó módosításának ideje |
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 |
| Igen | API kulcs |
| Igen | Létrehozandó vagy módosítandó termék adatai |
| Nem | Külső azonosító, szabadszavas, ajánlott a termék azonosítójának használata |
| Igen | Termék SKU-ja, cikkszáma |
| Igen | Termék vonalkódja(i). Első vonalkód a termék vonalkódja, további vonalkódok ;-vel elválasztva a termék alternatív vonalkódjai lesznek. Formátum: [a-zA-Z0-9-_] (pl.: HU-324;WSPY_3456;12345; AAA) |
| Igen | Termék neve |
| Nem | Termék variáns neve (pl.: szín, méret) |
| Nem | Termék típusa ("product", "virtual") |
| Nem | Termékleírás |
| Nem | Rendelkezik-e a termék egyedi sorszámmal ("yes", "no") |
| Nem | Vámkezelendő? ("yes", "no") |
| Nem | A termék vámtarifaszáma |
| Nem | Termékleírás vámeljáráshoz |
| Nem | Alacsony készletszint értéke |
| Nem | A termék eladási ára (nettó) |
| Nem | ÁFA (termék eladás) |
| Nem | Valuta (termék eladás) |
| Nem | A termék veszélyes árunak (ADR) számít? ("yes", "no") |
| Nem | ADR kód |
| Nem | ADR mennyiség |
| Nem | A termék hűtést igényel ("refrigerator", "freezer" "none") |
| Nem | A termék törékeny ("yes", "no") |
| Nem | Kategória azonosító (azonosítók letöltése) |
| Nem | Foglalt saját készlet |
| Nem | Dropshippy nagykereskedelmi ár (nettó, forintban) |
| Nem | Dropshippy nagykereskedelmi ÁFA (pl. 0.27) |
| Nem | Dropshippy ajánlott nettó fogyasztói ár (forintban) |
| Nem | 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:
<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey> <product> <referenceId>1231</referenceId> <sku>szuperhos-polo-piros-xl</sku> <barcode>126510305031</barcode> <productName>Szuperhős Póló</productName> <variantName>Piros, XL</variantName> <type>product</type> <hasSerial>no</hasSerial> <dutiable>yes</dutiable> <productDescription>Szuperhős Póló leírás</productDescription> <taricCode>12345</taricCode> <lowStock>5</lowStock> <price>1200</price> <vat>0.27</vat> <currency>HUF</currency> <isAdr>yes</isAdr> <adrCode>4</adrCode> <adrQuantity>2</adrQuantity> <coolingDemand>none</coolingDemand> <isFragile>no</isFragile> <productType>clothes</productType> <category>3-406</category> <keepQuantity>5</keepQuantity> <dropshippyWholesalePrice>1000</dropshippyWholesalePrice> <dropshippyWholesaleVat>0.27</dropshippyWholesaleVat> <dropshippyRecommendedPrice>1200</dropshippyRecommendedPrice> <dropshippyPromotion>no</dropshippyPromotion> <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> </product></request>
Válasz (példa):
<?xml version="1.0" encoding="utf-8"?><response> <status>success</status> <message> <elem>The product creation was successful</elem> </message> <wspyId>74210</wspyId></response>
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 successfulThe product modification was successfulNo changes detected in product
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 |
| Igen | API kulcs |
| Igen | Termékcsomag cikkszáma |
| Igen | Termékcsomag neve |
| Nem | Termékcsomag nettó eladási ára |
| Nem | Termékcsomag ÁFA kulcsa %-ban (pl: 27) |
| Nem | Eladási ár pénznem (pl: HUF) |
| Igen | Termékcsomag termékei |
| Igen | Termék SKU-ja, cikkszáma |
| Igen | Rendelt mennyiség |
XML esetén:
Url: https://app.webshippy.com/wspyapi/createBundle/xml
Kérés:
<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey><bundleSKU>123334</bundleSKU><bundleName>Akciós csomag</bundleName><bundlePriceNet>5000</bundlePriceNet><bundleVat>26</bundleVat><bundleCurrency>HUF</bundleCurrency> <products> <productSku>prod001</productSku> <quantity>3</quantity> </products></request>
JSON esetén:
Url: https://app.webshippy.com/wspyapi/createBundle/json
Hamarosan…