Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
An export of all product sets in Elevate
GET https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/product-sets
Request header parameters
| Name | Description | Example |
|---|---|---|
Api-Key* | API key supplied during onboarding. | 123456789.. |
Accept-Encoding* | Allows responses to be compressed using Gzip. | gzip |
Example request
curl -i \
-X GET \
-H 'Api-Key: 123456789..' \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/product-sets"
Response codes
| Status | Description |
|---|---|
200 | Query accepted. The data will be returned as an application/json-object. |
403 | Incorrect cluster credentials. |
404 | Cluster not found. |
406 | No acceptable encoding found in Accept-Encoding header. |
500 | Server error such as cluster unavailable, busy or internal error. If 5xx errors persist, contact support and attach any information found in the response body. |
503 | The server in the cluster that received the request is currently unavailable or busy. It is recommended to retry the request. The time between request attempts should be increasing. |
Example response
{
"WINTER" : {
"name" : "Winter sale",
"rule" : "rule incl custom.season { \"winter\" }"
},
"STRIPED" : {
"name" : "All striped items",
"rule" : "rule incl pattern { \"striped\" }"
}
}
Response body schema
[\p{L}\p{N}_\-()<>.:,&+%\[\]|?#�']{1,200} and with the value: ProductSet
Max: 1000 keys| Name | Type | Description |
|---|---|---|
| name* | string | The name of the product set, displayed in the Elevate application. Min length: 1. Max length: 80. |
| rules | string | A product rule expression restricting the products that the product set may contain. |