Export¶
An export of the product data in eSales 4 can be done using the standard HTTP GET method, with personal cluster credentials provided by Apptus.
Request¶
Request method¶
GET
Request URL¶
https://{cluster-id}.api.esales.apptus.cloud/api/v1/export/data
Request parameters¶
N/A
Request headers¶
The Api-Key request header is required.
Api-Key-apiKey, the unique apiKey provided by Apptus.Accept-Encoding-gzip, allows the export to be compressed using Gzip (recommended).
Request body¶
N/A
Request example¶
A data export request example, with fictive credentials, is demonstrated using cURL below.
#!/bin/bash
curl -i \
-X GET \
-H "Api-Key: pkA123456789AB1BDA3E968F69A97B5508BF5B123456778912FFC99" \
-H "Accept-Encoding:gzip" \
"https://w1A2B3C45.api.esales.apptus.cloud/api/v1/export/data"
Response¶
Response headers¶
N/A
Response content-type¶
application/xml
Response codes¶
| Response | Description |
|---|---|
| 200 | Query accepted. The data will be return as an application/xml-object. |
| 403 | Incorrect cluster credentials. |
| 404 | Cluster not found. |
| 5xx | Server error such as cluster unavailable or busy. If 5xx errors persist, contact Apptus Support and attach any information found in the response body. |
If a retailer experiences persistent network errors they should first contact their network administrator. If the problem seems to be on Apptus end, please contact Apptus Support.
Response objects¶
XML
<?xml version="1.0" encoding="UTF-8" ?>
<data_import type="full">
<modify market="UK" locale="en-GB">
<product_groups>
<add_or_replace>
<product_group key="1001">
<brand>Gazelle</brand>
<department>Men</department>
<products>
<product key="1001-100">
<title>Linen T-shirt</title>
<url>/products/1001-100</url>
<release_date>2019-10-27T00:00:00Z</release_date>
<description>Loose-fit striped T-shirt with a slightly lower neckline.</description>
<images>
<image>
<type_default>model</type_default>
<tags>Hero</tags>
<urls>
<url width="200">//cdn.esalesdrivensite.com/images/1001-100_model.jpg?preset=200x200</url>
<url width="600">//cdn.esalesdrivensite.com/images/1001-100_model.jpg?preset=600x600</url>
</urls>
</image>
<image>
<type_override>cutout</type_override>
<urls>
<url width="40">//cdn.esalesdrivensite.com/images/1001-100_cutout_thumbnail.jpg</url>
<url width="600">//cdn.esalesdrivensite.com/images/1001-100_cutout.jpg</url>
</urls>
</image>
</images>
<custom_attributes>
<season name="Summer">m_678</season>
<style name="Casual">m_c_349</style>
<category name="T-shirts">349</category>
</custom_attributes>
<pattern>striped</pattern>
<rating>4.3</rating>
<color_default>#0000ff|#ffffff</color_default>
<variants>
<variant key="1001-100-1">
<stock_number>12</stock_number>
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
<cost>8.00</cost>
<url>/products/1001-100?size=S</url>
<sizes>
<size custom_format="SML">S</size>
<size custom_format="EU">36</size>
</sizes>
<custom_prices>
<price id="EUR">
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
</price>
<price id="SEK">
<selling_price>99.90</selling_price>
<list_price>129.90</list_price>
</price>
<price id="VIP_SEK">
<selling_price>69.90</selling_price>
<list_price>129.90</list_price>
</price>
</custom_prices>
</variant>
<variant key="1001-100-2">
<stock_number>0</stock_number>
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
<cost>8.00</cost>
<url>/products/1001-100?size=M</url>
<sizes>
<size custom_format="SML">M</size>
<size custom_format="EU">38</size>
</sizes>
<custom_prices>
<price id="EUR">
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
</price>
<price id="SEK">
<selling_price>99.90</selling_price>
<list_price>129.90</list_price>
</price>
<price id="VIP_SEK">
<selling_price>69.90</selling_price>
<list_price>129.90</list_price>
</price>
</custom_prices>
</variant>
<variant key="1001-100-3">
<stock_number>5</stock_number>
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
<cost>8.00</cost>
<url>/products/1001-100?size=L</url>
<sizes>
<size custom_format="SML">L</size>
<size custom_format="EU">40</size>
</sizes>
<custom_prices>
<price id="EUR">
<selling_price>9.99</selling_price>
<list_price>12.99</list_price>
</price>
<price id="SEK">
<selling_price>99.90</selling_price>
<list_price>129.90</list_price>
</price>
<price id="VIP_SEK">
<selling_price>69.90</selling_price>
<list_price>129.90</list_price>
</price>
</custom_prices>
</variant>
</variants>
</product>
</products>
</product_group>
</add_or_replace>
</product_groups>
<content_items>
<add_or_replace>
<content key="871">
<type>link</type>
<title>Shipping</title>
<link>/uk/customer-service/shipping</link>
</content>
<content key="872">
<type>link</type>
<title>Contact</title>
<link>/uk/contact</link>
</content>
<content key="901">
<type>faq</type>
<title>How do I return clothes?</title>
<link>/uk/faq/returns</link>
<release_date>2020-12-01T00:00:00Z</release_date>
<image>
<urls>
<url width="400">http://returns-pic-11204.com</url>
</urls>
</image>
<custom_attributes>
<keywords>replace|swap|take back</keywords>
</custom_attributes>
</content>
</add_or_replace>
</content_items>
</modify>
</data_import>
Last update: December 22, 2021