2.2.6.Products
Qwindo should be able to request a list of products by using an offset and limit, or only a specific product based on product ID. The request will be done doing a GET request to the configured feed URL.
For example, a request using an offset and limit can look like:
https://www.store.com/index.php?identifier=products&offset=0&limit=25
This will return the first 25 products from the store.
Or for example, a request based on product ID can look like:
https://www.store.com/index.php?identifier=products&product_id=x
The GET value “identifier” is used to specify the type of request, in this case “products” to request all products within the store, based on category_id or only one product based on the product_id
Product Request Specification
Field
|
Description
|
Type
|
Required
|
Length
|
---|---|---|---|---|
product_id | Unique product ID used within the store | int | yes | |
product_name | Product name used within the store | string | yes | 128 |
brand | Brand of the product | string | no | 128 |
sku_number | Stock Keeping Unit | string | no | 128 |
primary_category | Object with language iso and string.
Definition: { "en_US": "Dresses & Skirts" } |
string | yes | 128 |
category_ids | Array of category ID’s. “category_ids”:[ “18” ] |
array | yes | 128 |
secondary_category | The secondary categoryname | string | no | 128 |
product_url | The url to the product within the store | string | yes | 2000 |
short_product_description | Object with language iso and string.
Definition: { "en_US": "Short description" } |
string | yes | 256 |
long_product_description | Object with language iso and string.
Definition: { "en_US": "Long description" } |
string | yes | |
sale_price | A special Sale price | double | yes | |
retail_price | The retail price | double | yes | |
from_price | When the main product does not have a price set as its part of a configurable product, this field will have the lowest value for the product | double | no | |
cashback | Cashback percentage for this product. (When no cashback is configured, default Qwindo cashback will be used) | int | no | |
tax | Object of a tax rule for the product. Definition:
{ "id":"id", "name":"string", "rules":{ "NL":"21.0000", "ES":"8.0000" } } |
object | yes | |
gtin | Global Trade Item Number | string | no | 32 |
mpn | Manufacturer Part Number | string | no | 1000 |
unique_identifier | Set to ‘FALSE’ to indicate that you have no identifier for the product (when no GTIN or MPN is available) | boolean | yes | |
stock | Stock available for the product | int | yes | |
metadata |
{ "metadata":{ "title":{ "en_US":null }, "keyword":{ "en_US":null }, "description":{ "en_US":null } } } |
object | no | |
created | The creation date of the product, format Y-m-d H:i:s | int | yes | |
updated | The date of when the product was last updated, format Y-m-d H:i:s | int | yes | |
downloadable | True of False when the product is downloadable | boolean | yes | |
package_dimensions | Size of the package in lxbxh | string | no | 128 |
dimension_unit | Unit of the dimension. Example: cm | string | no | |
weight | Weight of the product in g, kg, lb | double | no | |
weight_unit | Unit of the weight. Example: g, kg, lb | string | no | |
product_image_urls | An array of objects, containing the URL of the image and selector for the main image:
[ { "url": (string) required (maxlength: 2000), "main": (bool) required } ] |
arrayofobjects | yes | |
attributes | Object with product attributes:
{ "occasion":{ "en_US :{ "label": (string) required (maxlength: 128), "value": (string) required (maxlength: 256) } } } |
object | no | |
options | Object of product options:
{ "GlobalOptions":{ "(string) required (maxlength: 2000)":{ "(string) required (maxlength: 128)":{ "Label": (string) required (maxlength: 128), "Pricing": (double(15,2) or null) required } } } |
object | no | |
varients | Array of minimal product objects | Array | no |
The response is an array of product objects.
[ { "product_id": "425", "product_name": "Lafayette Convertible Dress", "sku_number": "wsd013c", "created": "2013-03-04 23:25:12", "updated": "2017-02-20 00:49:54", "downloadable": false, "gtin": null, "unique_identifier": false, "mpn": null, "brand": null, "weight": null, "weight_unit": "kg", "primary_category": { "en_US": "Dresses & Skirts" }, "product_url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/lafayette-convertible-dress.html", "product_image_urls": [ { "url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/catalog\/product\/w\/s\/wsd013t.jpg", "main": true }, { "url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/catalog\/product\/w\/s\/wsd013t.jpg", "main": false }, { "url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/catalog\/product\/w\/s\/wsd013a_2.jpg", "main": false }, { "url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/catalog\/product\/w\/s\/wsd013b_2.jpg", "main": false } ], "short_product_description": { "en_US": "This all day dress has a flattering silhouette and a convertible neckline to suit your mood. Wear tied and tucked in a sailor knot, or reverse it for a high tied feminine bow." }, "long_product_description": { "en_US": "Two sash, convertible neckline with front ruffle detail. Unhemmed, visisble seams. Hidden side zipper. Unlined. Wool\/elastane. Hand wash." }, "sale_price": "340.00", "retail_price": "340.00", "from_price": "340.00", "cashback": "10", "tax": { "name": "Taxable Goods", "id": "2", "rules": { "NL": "21.0000", "ES": "8.0000" } }, "stock": 0, "metadata": { "title": { "en_US": null }, "keyword": { "en_US": null }, "description": { "en_US": null } }, "attributes": { "occasion": { "en_US": { "label": "Occasion en", "value": "Career" } }, "apparel_type": { "en_US": { "label": "Type", "value": "Dresses" } }, "gender": { "en_US": { "label": "Gender", "value": "Female" } } }, "variants": [ { "product_id": "310", "sku_number": "wsd013", "gtin": null, "unique_identifier": false, "product_image_urls": [ { "url": "http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/catalog\/product\/w\/s\/wsd013t_1.jpg", "main": true } ], "stock": 3483, "sale_price": "340.00", "retail_price": "340.00", "weight":"1.0000", "weight_unit":"kg", "attributes": { "color": { "en_US": { "label": "Color", "value": "Blue" } }, "size": { "en_US": { "label": "Size", "value": "2" } }, "length": { "en_US": { "label": "Length", "value": "No" } } } } ], "options":{ "global_options":{ "en_US":{ "Color":{ "id":"92", "type":"related", "values":[ { "id":"72", "label":"10", "pricing":null, "price_type":"fixed" } ] }, "test":{ "id":"7", "type":"custom", "values":[ { "id":"3", "label":"test 1", "pricing":"1.0000", "price_type":"percent" }, { "id":"4", "label":"test 2", "pricing":"2.0000", "price_type":"fixed" }, { "id":"5", "label":"test 3", "pricing":"3.0000", "price_type":"fixed" } ] } } } } } ]