Export¶
The product data in eSales Lifestyle can be exported using the standard HTTP GET protocol, with personal cluster credentials provided by Apptus.
Compression¶
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.
#!/bin/bash
curl -i \
-X GET \
-H "Api-Key: pkA123456789AB1BDA3E968F69A97B5508BF5B123456778912FFC99" \
-H "Accept-Encoding:gzip" \
"https://w1A2B3C45.api.esales.apptus.cloud/api/v1/export/lifestyle-data"
Request specification¶
| Request specification | Description |
|---|---|
Method | GET |
Header | Api-Key: apiKey, the unique apiKey provided by Apptus. |
url | https://{cluster-id}.api.esales.apptus.cloud/api/v1/export/lifestyle-data, with the unique cluster id, webApiId, provided by Apptus. |
Response¶
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.