GET https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/configuration
Request
Request header parameters
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
Example request
bash
curl -i \
-X GET \
-H 'Api-Key: 123456789..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/configuration"
Response
Response codes
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
Example response
{
"edit" : {
"markets" : { }
},
"remove" : {
"markets" : [ null ]
},
"replace" : {
"markets" : { }
}
}
Response body schema
Response body schema
Configuration
A config import must include exactly one of ‘remove’, ‘replace’, or ‘edit’| Name | Type | Description |
|---|---|---|
| edit | ConfigEdit | The edit operation adds or changes the included markets |
| remove | ConfigRemove | The remove operation removes specific markets |
| replace | ConfigReplace | The replace operation fully replaces the configuration, removing all markets not included in the requests |
Schemas
AppSettings
| Name | Type | Description |
|---|---|---|
| currency | string | A currency symbol or string for the market, used in the Elevate app interface. Will default to * if not provided. Min length: 1. Max length: 2147483647.Examples: "GBP" |
| name | string | A human readable name for the market, used in the Elevate app interface. Will default to the market id if not provided. Min length: 1. Max length: 2147483647.Examples: "UK" |
| navigationUrl | string | If specified, previewing navigation changes in the Elevate app will take you to this url. Usually the root or a top-level node in the navigation tree.If not set, users will be asked to provide a link each time they use the preview feature. Examples: "example.com/categories/ladies" |
| pageBaseUrl | string | If specified, previewing page changes in the Elevate app will take you to a url consisting of the pageBaseUrl + the page’s id or path.If not set, users will be asked to provide a link each time they use the preview feature. Examples: "example.com/categories" |
| searchPageUrl | string | If specified, previewing overrides for search & autocomplete in the Elevate app will take you to this url. Usually a page with access to the search box.If not set, users will be asked to provide a link each time they use the preview feature. Examples: "example.com/search" |
MarketDefinition
A complete or partial market definition| Name | Type | Description |
|---|---|---|
| appSettings | AppSettings | How the market should be presented in the Elevate app interface. It is highly recommended to provide a display name and currency for the market. |
| locales | string[] | A list of which locales this market should support. New markets must include at least one locale! |
ConfigEdit
| Name | Type | Description |
|---|---|---|
| markets* | <string, MarketDefinition> | A mapping from market key to a market configuration |
ConfigRemove
| Name | Type | Description |
|---|---|---|
| markets* | string[] | Which markets to delete. Deleting a market will delete everything on that market, including products and settings (promotions, pages, etc.)! |
ConfigReplace
| Name | Type | Description |
|---|---|---|
| markets* | <string, MarketDefinition> | A mapping from market key to a market configuration. |