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 templates in Elevate.
GET https://{cluster-id}.elevate-api.cloud/api/admin/v3/export/templates
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/v3/export/templates"
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
{
"lightTemplate" : {
"products" : {
"first" : {
"fields" : [ "brand", "title", "link", "sellingPrice", "listPrice", "inStock", "custom.material" ],
"variants" : {
"all" : {
"fields" : [ "label", "inStock", "sellingPrice", "listPrice", "custom.campaign" ]
}
}
},
"rest" : {
"fields" : [ "link", "swatch" ],
"maxVariants" : 0
}
}
}
}
Response body schema
[a-zA-Z0-9]{1,25} and with the value: TemplateSettings
Max: 5 keys| Name | Type | Description |
|---|---|---|
| fields* | string[] | The product level attributes to include. Custom attributes can be included by prefixing them with custom., or the special custom.* can be used to include all custom attributes. |
| maxVariants | integer | The max number of variants to include. If not specified, all variants will be included. Min: 0.Examples: 0 |
| variants | VariantTemplateMapping | The definition of the product’s variants for either all or the first and rest of the variants. Required unless maxVariants is not set to 0. |
| Name | Type | Description |
|---|---|---|
| all | ProductTemplate | All products/variants. Only if first and rest are not used. |
| first | ProductTemplate | The first product/variant in the list. |
| rest | ProductTemplate | The remaining products/variants in the list. Required if first is used. |
| Name | Type | Description |
|---|---|---|
| products* | ProductTemplateMapping | The definition of the group’s products for either all or the first and rest of the products. |
| Name | Type | Description |
|---|---|---|
| fields* | string[] | The variant level attributes to include. Custom attributes can be included by prefixing them with custom., or the special custom.* can be used to include all custom attributes. |
| Name | Type | Description |
|---|---|---|
| all | VariantTemplate | All products/variants. Only if first and rest are not used. |
| first | VariantTemplate | The first product/variant in the list. |
| rest | VariantTemplate | The remaining products/variants in the list. Required if first is used. |