Skip to content




An export of all currently configured markets.


Header parameters

Name Description Example
Api-key that was supplied during on-boarding pkA123456789AB1BE..
Allows responses to be compressed using Gzip. gzip
curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \


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.

Response body

  "edit" : {
    "markets" : { }
  "remove" : {
    "markets" : [ null ]
  "replace" : {
    "markets" : { }


A config import must include exactly one of 'remove', 'replace', or 'edit'

Name Type Description Example
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


Inner schemas


Name Type Description Example
markets <string, MarketDefinition> A mapping from market key to a market configuration


Name Type Description Example
markets string[] Which markets to delete. Deleting a market will delete everything on that market, including products and settings (promotions, pages, etc.)!


Name Type Description Example
markets <string, MarketDefinition> A mapping from market key to a market configuration


A complete or partial market definition

Name Type Description Example
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!

This online publication is intellectual property of Voyado Lund AB. 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 Voyado Lund AB 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. Voyado Lund AB 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.