Returns a market resource by ID

Requires read_markets access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/markets/:id.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 .

Path Parameters

id string required

Market unique ID

Example: 2805657769119556579335

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

marketobject

Market information
market_name string

Name of the market
Example: US-MARKET
price_listobject

The market’s price list
parentobject

Relative adjustments to other prices
adjustmentobject

price adjustment
type string

The type of price adjustment
value float

The percentage of price adjustment
primary boolean

Key markets or not
Example: true
regionsobject[]

Region information
currencyobject

Currency information
currency_code string

The currency's ISO code
code string

The ISO code identifying the region
web_presenceobject

The market’s web presence
default_locale string

The ISO code for the default locale
root_urlsobject[]

The list of root URLs
locale string

The locale that the storefront loads in
url string

Url
subfolder_suffix string

The market-specific suffix of the subfolders
alternate_locales array

The ISO codes for the alternate locales
Example: [""]
currency_settingsobject

Market currency setting information
base_currencyobject

Currency setting information
currency_code string

Currency code
Example: USD
currency_name string

Currency name
Example: USD
exchange_rate string

The exchange rate is worth it when auto_exchange_rate= false ; manually fill in the exchange rate value ;
Example: 1.01234567891
rate_updated_at string

The date and time string that indicates ISO 8601 encoding . for example , the utc ( co-world time ) time zone indicates " 2019-09-07T15 : 50 : 00 z .2019 @ 3 : 00 pm . "Automatic exchange rate is the time for system update ;
Example: 2019-09-07T15:50:00Z
auto_exchange_rate boolean

True : automatic exchange rate ; false : manual exchange rate ;
Example: true
local_currencies boolean

Enable local currency or not
Example: true
enabled boolean

Market status available ; true : enable ; false : disable ;
Example: true
market_id string

Market unique logo
Example: 2805657769119556579334

API Explorer

Debugger

Base URL

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

ParamOptions

id — path required

Authorization — header required

Language

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

Was this article helpful to you?

SHOPLINE

Legal