Returns a market resource by ID
GET https://{handle}.myshopline.com/admin/openapi/v20230901/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 requiredMarket unique IDExample:
2805657769119556579335
Request Headers
- Content-Type requiredThe value of this field is fixed to
application/json; charset=utf-8
- Authorization string requiredThe 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
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
marketobject
Market informationcurrency_settingsobject
Market currency setting informationbase_currencyobject
Currency setting informationauto_exchange_rate booleanTrue : automatic exchange rate ; false : manual exchange rate ;Example:true
currency_code stringCurrency codeExample:USD
currency_name stringCurrency nameExample:USD
exchange_rate stringThe exchange rate is worth it when auto_exchange_rate= false ; manually fill in the exchange rate value ;Example:1.01234567891
rate_updated_at stringThe 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
local_currencies booleanEnable local currency or notExample:true
enabled booleanMarket status available ; true : enable ; false : disable ;Example:true
market_id stringMarket unique logoExample:2805657769119556579334
market_name stringName of the marketExample:US-MARKET
price_listobject
The market’s price listparentobject
Relative adjustments to other pricesadjustmentobject
price adjustmenttype stringThe type of price adjustmentvalue floatThe percentage of price adjustmentprimary booleanKey markets or notExample:true
regionsobject[]
Region informationcode stringThe ISO code identifying the regioncurrencyobject
Currency informationcurrency_code stringThe currency's ISO codeweb_presenceobject
The market’s web presencealternate_locales arrayThe ISO codes for the alternate localesExample: ``default_locale stringThe ISO code for the default localeroot_urlsobject[]
The list of root URLslocale stringThe locale that the storefront loads inurl stringUrlsubfolder_suffix stringThe market-specific suffix of the subfolders
API Explorer
Debugger
Was this article helpful to you?
Error loading component.