These methods allow to get the information of all the products available in the catalogue. APIs are designed to support XML format. We provide also CSV and XLS format only to support existing customers, no support will be given to new customers using those formats.
Use
Method | Url | Format |
---|---|---|
GET | /restful/export/api/products.xml |
XML format |
GET | /restful/export/api/products.csv |
CSV format, Deprecated: provided only to existing customers |
GET | /restful/export/api/products.xls |
XLS format, Deprecated: provided only to existing customers |
Authentication
Remember to authenticate properly, using HTTP Basic Authentication with your API-Key as username and your password.
Query Params
Name | Description | Values | Mandatory |
---|---|---|---|
acceptedlocales | Locale code for languages. The comma separated list of values | it_IT, en_US, fr_FR... | Yes |
output-filetype | Format of the output data | xml | Yes |
since | the timestamp of the last update | ISO8601 date format | No |
tag_1 | product's brand | Any brand name | No |
tag_4 | product's category | “clothing”, “accessories”, “bags”, “cosmetics”, “underwear”, “shoes” | No |
tag_26 | product's gender | “kids”, “women”, “unisex”, “men” | No |
tag_11 | product's season | “fw” (fall/winter), “ss” (spring/summer), “all-year” | No |
Response Body (XML Format)
The main tag (page) shows the information about the number of results and the pagination:
- totalPages : page availability (Deprecated, always 1 to support backward compatibility)
- totalNumberOfElements : product availability
- pageSize : number of products per page (Deprecated, always the same as totalNumberOfElements to support backward compatibility)
- currentPage : sequence number of the current page. (Deprecated, always 1 to support backward compatibility)
This tag (items) contains a collection of items, which show product's informations.
Each tag has many child elements, corresponding to a product's property. The most important ones are:
- availability : product availability
- brand : product brand; also available as product tag
- code : product code (unique string code)
- country_selling_restrictions : a list of the country where product can't be sold
- currency : currency used to show prices
- descriptions : a list of the description with i18n; for each description the locale code is also available
- id : product id (unique numeric id)
- pictures : a list of the picture available for the product's models; for each picture its id, name and path are also available
- intra : intra code of the product
- models : the list of all the models
- name : product name
- tags : a list of the tag assigned to the product
- taxable : the product taxable
- streetPrice : product retail price tax included
- suggestedPrice : product suggested retail price tax included (Available since early january 2015 may not be available on all products)
- weight : product weight.
Each model element has six useful attributes:
- availability : model availability
- barcode : model barcode
- code : model code
- color : model color (may contain not accurate data for some product)
- id : model id (unique numeric id)
- model : model name
- size : model size.
A specific model can be identified by it's id or by product code/product id + size + color.
Response Body Example
Request example query: /restful/export/api/products.xml?tag_5=A%20mano&acceptedlocales=en_US
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<page totalPages="4" totalNumberOfElements="345" pageSize="100" lastUpdate="""2017-10- 31T14:05:12.322+01:00""" currentPage="1">
<query/>
<items>
<item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="product">
<availability>1</availability>
<bestTaxable>12.0</bestTaxable>
<brand>BRAND NAME</brand>
<code>GD65_CELESTE</code>
<country_selling_restrictions>
<country>IT</country>
[...]
</country_selling_restrictions>
<currency>EUR</currency>
<descriptions>
<description>
<description>
PRODUCT DESCRIPTION I18N
</description>
<localecode>en_US</localecode>
</description>
<description> ... </description>
...
</descriptions>
<id>31741</id>
<pictures>
<image>
<id>111695</id>
<url>/prod/stock_prod31741_image_1412490303.jpg</url>
</image>
<image> ... </image>
...
</pictures>
<intra>42022100</intra>
<models>
<model>
<availability>1</availability>
<barcode>00000000</barcode>
<code>GD065_CELESTE</code>
<color>#000000</color>
<id>100617</id>
<lastUpdate>2017-10-31T14:24:55.048+01:00</lastUpdate>
<model>MODEL NAME</model>
<size>SIZE</size>
<streetPrice>75.0</streetPrice>
<taxable>12.0</taxable>
</model>
<model>...</model>
...
</models>
<name>Borse</name>
<online>true</online>
<streetPrice>75.0</streetPrice>
<tags>
<tag>
<hidden>false</hidden>
<id>1</id>
<name>brand</name>
<priority>0</priority>
<translations>
<translation>
<description>Firme</description>
<localecode>it_IT</localecode>
</translation>
</translations>
<value>
<translations>
<translation>
<description>Borse</description>
<localecode>it_IT</localecode>
</translation>
</translation>
<value>Prada</value>
</value>
</tag>
<tag>...</tag>
...
</tags>
<taxable>12.0</taxable>
<weight>4.0</weight>
</item>
<item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="product">...</item>
...
</items>
</page>
Incremental updates(XML format)
Once you download the whole catalog, you can ask for updates only. The “since” query parameter is used to ask for quantity modifications after a given timestamp. The last update timestamp is retrieved from the “lastUpdate” attribute of the XML “page” tag.
Pay attention:
-
The service is available only for XML format (not CSV or XSL)
-
The update list is renewed every 3 minutes.
-
The modification window lasts 4 hours. If you ask for the update of the catalog called over 4 hours before, the service answer with 412 status code.
-
The + character is a reserved character therefor if you're writing your url manually encoding it is mandatory.