查询市场列表

需要 read_markets 权限点。

更多权限点使用信息,请参考:

[]

访问权限

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

[]

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

[]

查询市场的列表数据。

查询参数

limit integer
[]
查询数量限制。

默认值：50

取值范围：0-100
[]
Example: 2
page_info string
[]
分页查询的唯一标识，用于定位特定页面。

该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://\{handle\}.myshopline.com/admin/openapi/\{version\}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息，请参考分页机制。

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

link
[]
提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。

当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考分页机制。

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

响应体

marketsobject[]
[]
市场列表。
currency_settingsobject
[]
商家店铺售卖商品时所标注的售价币种的设置。
base_currencyobject
[]
商家店铺售卖商品时所标注的售价币种设置的具体信息。
auto_exchange_rate boolean
[]
表示系统是否自动更新汇率。

true：系统自动更新汇率

false：商家手动更新汇率

[]
Example: true
currency_code string
[]
商家店铺售卖商品时所标注的售价币种。该字段值为三位币种码，遵循 ISO 4217 标准，例如：USD。
[]
Example: USD
currency_name string
[]
商家店铺售卖商品时所标注的售价币种名称。
[]
Example: USD
exchange_rate string
[]
美元兑换目标币种的汇率。当 auto_exchange_rate 为 false 时，才有值。
[]
Example: 1.01234567891
rate_updated_at string
[]
表示系统更新自动汇率的时间，时间格式遵循 ISO 8601 国际标准，例如：2019-09-07T15:50:00Z。
[]
Example: 2019-09-07T15:50:00Z
local_currencies boolean
[]
是否启用本地币种。

true：启用本地币种

false：不启用本地币种

[]
Example: true
enabled boolean
[]
市场是否可用状态。

true：启用状态

fasle：禁用状态

[]
Example: true
market_id string
[]
市场的唯一标识 ID。
[]
Example: 2805657769119556579334
market_name string
[]
市场的名称。
[]
Example: US-MARKET
price_listobject
[]
市场的商品价格信息。
parentobject
[]
市场的商品价格调整详情。
adjustmentobject
[]
市场的商品价格相对于默认价格的调整配置。
type string
[]
市场的商品价格相对于默认价格的调整类型。

PERCENTAGE_INCREASE：升高

PERCENTAGE_DECREASE：降低

[]
Example: PERCENTAGE_DECREASE
value float
[]
市场的相对价格的调整百分比。

取值范围：0-100
[]
Example: 10
primary boolean
[]
是否为主要市场。

true：是主要市场

false：不是主要市场

[]
Example: true
regionsobject[]
[]
市场的国家信息。
code string
[]
对应市场的国家地区码。遵循 ISO 3166-1 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。例如：US。
[]
Example: US
currencyobject
[]
订单币种信息。
currency_code string
[]
订单币种。该字段值为三位币种码，遵循 ISO 4217 标准，例如：USD。
[]
Example: USD
web_presenceobject
[]
市场的域名配置。
alternate_locales array
[]
备用区域，指一个市场支持的额外语言或地区版本。
[]
Example: ["us"]
default_locale string
[]
默认区域，指一个市场的主要语言或地区版本，通常是用户访问该市场时显示的默认内容。
[]
Example: us
root_urlsobject[]
[]
区域根域名列表。
locale string
[]
区域。
[]
Example: us
url string
[]
对应店铺的域名。
[]
Example: https://myshopline.com
subfolder_suffix string
[]
子文件夹特定后缀，用于在 URL 中区分不同语言或地区的内容。
[]
Example: suffix

API Explorer

调试台

示例代码

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

查询市场列表，指定返回结果个数。

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"
      }
    }
  ]
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议