Query market list

Requires read_markets access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/markets.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Query markets created for the store.

Query Parameters

limit integer
[]
The maximum query quantity limit for markets.

Default value：50

Value range：0-100
[]
Example: 2
page_info string
[]
The unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://\{handle\}.myshopline.com/admin/openapi/\{version\}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next", the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9.

For more information on how to use pagination, refer to Paging Mechanism.

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page. For more information on how to use pagination, refer to Paging Mechanism.

Example: <https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"
traceId
[]
traceId

Response Body

marketsobject[]
[]
Market list.
currency_settingsobject
[]
The setting of the selling price currency.
base_currencyobject
[]
The setting information of the selling price currency.
auto_exchange_rate boolean
[]
The system automatically updates exchange rates or not.

true: The system automatically updates the exchange rates.

false: The merchant needs to manually update the exchange rates.

[]
Example: true
currency_code string
[]
Currency displayed for product prices. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
[]
Example: USD
currency_name string
[]
The currency name of the selling price.
[]
Example: USD
exchange_rate string
[]
The exchange rate of USD to the target currency. It only has a value when auto_exchange_rate is false.
[]
Example: 1.01234567891
rate_updated_at string
[]
The date and time when the system automatically updated the exchange rate. The value of this field follows the ISO 8601 standard time format. For example, 2019-09-07T15:50:00Z.
[]
Example: 2019-09-07T15:50:00Z
local_currencies boolean
[]
Use the local currency or not.

true: use the local currency

false: not use the local currency

[]
Example: true
enabled boolean
[]
Indicate whether the market is avaliable.

true: available

false: unavailable

[]
Example: true
market_id string
[]
The unique identifier for the market.
[]
Example: 2805657769119556579334
market_name string
[]
Name of the market.
[]
Example: US-MARKET
price_listobject
[]
Market product price information.
parentobject
[]
The price adjustment details.
adjustmentobject
[]
The configuration for adjusting the market's product prices relative to the default price.
type string
[]
The type for adjusting the market's product prices relative to the default price.

PERCENTAGE_INCREASE: increase

PERCENTAGE_DECREASE: decrease

[]
Example: PERCENTAGE_DECREASE
value float
[]
The market's relative price adjustment percentage.

Value range：0-100
[]
Example: 10
primary boolean
[]
Indicate whether the market is primary market.

true: The market is primary market.

false: The market is not primary market.

[]
Example: true
regionsobject[]
[]
A list of country or region information of the market.
code string
[]
A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region. For example, US.
[]
Example: US
currencyobject
[]
Order currency details.
currency_code string
[]
The order currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
[]
Example: USD
web_presenceobject
[]
Market domain name configuration.
alternate_locales array
[]
A list of alternate locales, representing additional languages or regions supported by a market.
[]
Example: ["us"]
default_locale string
[]
Default locale, referring to the primary languages or regions of a market, which is typically the default content displayed when users access the market.
[]
Example: us
root_urlsobject[]
[]
A list of regional root domain names.
locale string
[]
The locale that the storefront loads in.
[]
Example: us
url string
[]
The domain name corresponding to the store.
[]
Example: https://myshopline.com
subfolder_suffix string
[]
Subfolder-specific suffix, used in the URL to distinguish content for different languages or regions.
[]
Example: suffix

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

limit — query

page_info — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/markets.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

Query the market list and specify the number of results returned.

Response

{
  "markets": [
    {
      "currency_settings": {
        "base_currency": {
          "auto_exchange_rate": true,
          "currency_code": "USD",
          "currency_name": "dollar",
          "exchange_rate": null,
          "rate_updated_at": "2023-01-11T08:47:53-10:00"
        },
        "local_currencies": false
      },
      "enabled": true,
      "market_id": "2805653744179656264912",
      "market_name": "US",
      "price_list": {
        "parent": {
          "adjustment": {
            "type": "PERCENTAGE_DECREASE",
            "value": 0
          }
        }
      },
      "primary": true,
      "regions": [
        {
          "code": "US",
          "currency": {
            "currency_code": "USD"
          }
        }
      ],
      "web_presence": {
        "alternate_locales": [
          "ar",
          "es",
          "fr",
          "ja",
          "ko",
          "pt",
          "pt-pt",
          "zh-hans-cn",
          "zh-hant-tw"
        ],
        "default_locale": "en",
        "root_urls": [
          {
            "locale": "en",
            "url": "https://bing5.myshoplinestg.com"
          },
          {
            "locale": "ar",
            "url": "https://bing5.myshoplinestg.com/ar"
          },
          {
            "locale": "es",
            "url": "https://bing5.myshoplinestg.com/es"
          },
          {
            "locale": "fr",
            "url": "https://bing5.myshoplinestg.com/fr"
          },
          {
            "locale": "ja",
            "url": "https://bing5.myshoplinestg.com/ja"
          },
          {
            "locale": "ko",
            "url": "https://bing5.myshoplinestg.com/ko"
          },
          {
            "locale": "pt",
            "url": "https://bing5.myshoplinestg.com/pt"
          },
          {
            "locale": "pt-pt",
            "url": "https://bing5.myshoplinestg.com/pt-pt"
          },
          {
            "locale": "zh-hans-cn",
            "url": "https://bing5.myshoplinestg.com/zh-hans-cn"
          },
          {
            "locale": "zh-hant-tw",
            "url": "https://bing5.myshoplinestg.com/zh-hant-tw"
          }
        ],
        "subfolder_suffix": null
      }
    },
    {
      "currency_settings": {
        "base_currency": {
          "auto_exchange_rate": true,
          "currency_code": "EUR",
          "currency_name": "EUR",
          "exchange_rate": null,
          "rate_updated_at": "2024-06-06T06:40:58-09:00"
        },
        "local_currencies": false
      },
      "enabled": true,
      "market_id": "2805666406954174003208",
      "market_name": "France",
      "price_list": {
        "parent": {
          "adjustment": {
            "type": "PERCENTAGE_INCREASE",
            "value": 10
          }
        }
      },
      "primary": false,
      "regions": [
        {
          "code": "GB",
          "currency": {
            "currency_code": "EUR"
          }
        },
        {
          "code": "YT",
          "currency": {
            "currency_code": "EUR"
          }
        },
        {
          "code": "FR",
          "currency": {
            "currency_code": "EUR"
          }
        }
      ],
      "web_presence": {
        "alternate_locales": [
          "ko",
          "pt",
          "pt-pt"
        ],
        "default_locale": "en",
        "root_urls": [
          {
            "locale": "en",
            "url": "https://bing5.myshoplinestg.com/en-fr"
          },
          {
            "locale": "ko",
            "url": "https://bing5.myshoplinestg.com/ko-fr"
          },
          {
            "locale": "pt",
            "url": "https://bing5.myshoplinestg.com/pt-fr"
          },
          {
            "locale": "pt-pt",
            "url": "https://bing5.myshoplinestg.com/pt-pt-fr"
          }
        ],
        "subfolder_suffix": "fr"
      }
    }
  ]
}

Was this article helpful to you?

SHOPLINE

Legal