Product API
Product requests
Filtering terms listed above are linked with ÉS , you need to add only the terms that you'd like to filter.
In case of XML:
Url: https://app.webshippy.com/wspyapi/GetProduct/xml
Request:
<?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>Response (example):
<?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>
<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>In case of a failed request (example):
<?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>In case of JSON:
Url: https://app.webshippy.com/wspyapi/GetProduct/json
Request:
{
"apiKey": "api-key-comes-here",
"page": "0",
"limit": "10",
"filters": {
"wspyId": "",
"referenceId": "",
"productName": "",
"sku": "",
"barcode": "",
"lastMod": "2018-01-01 00:00:00",
"getAllProduct": true
}
}Response (example):
{
"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",
"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"
},
{
[ ... ]
}
]
}In case of a failed request (example):
{
"status": "error",
"message": [
"[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)"
]
}Generating and modifying a product
With this function you can create and modify a product. In case we do not have the product's sku the API creates one, in case we do have, the API modifies it. All fields are free to modify, except barcode field, which is only modifiable if we do not have the data. In case of a successful generation or modification, API returns the order's Internal ID.
For Dropshippy use, please go and refer to related help which fields you need to specify
In case of XML:
Url: https://app.webshippy.com/wspyapi/CreateProduct/xml
Request:
<?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>Divat és ruházat</category>
<subCategory>Gyermek divat</subCategory>
<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>Response (example):
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>success</status>
<message>
<elem>The product creation was successful</elem>
</message>
<wspyId>74210</wspyId>
</response>In case of JSON:
Url: https://app.webshippy.com/wspyapi/CreateProduct/json
Request:
{
"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": "Divat és ruházat",
"subCategory": "Gyermek divat",
"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"
}
}Response (example):
{
"status": "success",
"message": [
"The product creation was successful"
],
"wspyId": 74210
}Additional response possibilities:
The product creation was successfulThe product modification was successfulNo changes detected in product
Product deletion
Soon…
Last updated