Get market settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/marketsCosts 1 rate-limit point · Rate limits
The store's Shopify Markets (international selling) and how STOQ routes stock by market: active markets with their countries, the market setup, the market-to-location links, market URLs in alerts, and the single-market preorder location filter. Distinct from an offer's market availability or restock-alert locations. Only active markets are returned by default.
links count only while market_setup_type is "multiple_markets" and market_locations_enabled is true; they are kept when either is off.
Also searched asmarketsshopify marketsinternational sellingwhich marketssell internationally
Query parameters
include_draftsbooleanAlso return the store's draft markets, in draft_markets.
Defaultfalse
Returns
market_setup_typestringExample:stringmarket_locations_enabledbooleanExample:truemarket_urls_enabledbooleanExample:truepreorder_location_filterobjectShow 2 child attributesHide child attributes
enabledbooleanExample:trueshopify_location_idsarray of strings
linksarray of objectsShow 2 child attributesHide child attributes
shopify_market_idstringExample:stringshopify_location_idstringExample:string
marketsarray of objectsShow 5 child attributesHide child attributes
shopify_market_idstringExample:stringnamestringExample:stringstatusstringExample:stringcountriesarray of stringscountry_namesarray of strings
draft_marketsarray of objectsShow 5 child attributesHide child attributes
shopify_market_idstringExample:stringnamestringExample:stringstatusstringExample:stringcountriesarray of anyscountry_namesarray of anys
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe action refused the request for a reason that is not a single bad field.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/account/markets" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/markets", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/account/markets",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/markets")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl "https://app.stoqapp.com/api/v2/external/account/markets?include_drafts=false" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/markets?include_drafts=false", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/account/markets?include_drafts=false",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/markets?include_drafts=false")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"market_setup_type": "string",
"market_locations_enabled": true,
"market_urls_enabled": true,
"preorder_location_filter": {
"enabled": true,
"shopify_location_ids": [
"string"
]
},
"links": [
{
"shopify_market_id": "string",
"shopify_location_id": "string"
}
],
"markets": [
{
"shopify_market_id": "string",
"name": "string",
"status": "string",
"countries": [
"string"
],
"country_names": [
"string"
]
}
],
"draft_markets": [
{
"shopify_market_id": "string",
"name": "string",
"status": "string",
"countries": [
null
],
"country_names": [
null
]
}
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}