Skip to content


The product data in eSales Lifestyle can be exported using the standard HTTP GET protocol, with personal cluster credentials provided by Apptus.


The export can be compressed using gzip. This is done automatically if the client that triggers the export support compression using the header Accept-Encoding: gzip, or if the request contained the header Accept-Encoding: gzip.

Request example

A data export request example, with fictive credentials, is demonstrated using cURL below.

curl -i \
-X GET \
-H "Api-Key: pkA123456789AB1BDA3E968F69A97B5508BF5B123456778912FFC99" \
-H "Accept-Encoding:gzip" \

Request specification

Request specification Description
Method GET
Header Api-Key: apiKey, the unique apiKey provided by Apptus.
url https://{cluster-id}, with the unique cluster id, webApiId, provided by Apptus.


If the export is successful a 200 OK response will be returned and the data will be returned as an application/xml-object. If the export is unsuccessful, an error will be returned.

Error handling

If an error is received, the export can be safely rerun once the connection is restored. The following types of errors can be returned:

Code Description
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.

Last update: December 1, 2020

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.