Skip to content

Get market settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/markets

Costs 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_draftsboolean

    Also return the store's draft markets, in draft_markets.

    Default false

Returns

  • market_setup_typestring
    Example: string
  • market_locations_enabledboolean
    Example: true
  • market_urls_enabledboolean
    Example: true
  • preorder_location_filterobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: true
    • shopify_location_idsarray of strings
  • linksarray of objects
    Show 2 child attributesHide child attributes
    • shopify_market_idstring
      Example: string
    • shopify_location_idstring
      Example: string
  • marketsarray of objects
    Show 5 child attributesHide child attributes
    • shopify_market_idstring
      Example: string
    • namestring
      Example: string
    • statusstring
      Example: string
    • countriesarray of strings
    • country_namesarray of strings
  • draft_marketsarray of objects
    Show 5 child attributesHide child attributes
    • shopify_market_idstring
      Example: string
    • namestring
      Example: string
    • statusstring
      Example: string
    • countriesarray of anys
    • country_namesarray of anys

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The 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.

GET/account/markets
curl "https://app.stoqapp.com/api/v2/external/account/markets" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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
      ]
    }
  ]
}