---
title: "Get market settings"
description: "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 p"
url: https://docs.stoqapp.com/v2-reference/account-markets/get-market-settings/
api: "API v2 reference"
method: GET
path: "/account/markets"
---

# Get market settings

`GET https://app.stoqapp.com/api/v2/external/account/markets`

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.

**Note:** links count only while market_setup_type is &quot;multiple_markets&quot; and market_locations_enabled is true; they are kept when either is off.

## Query parameters

- `include_drafts` (boolean): Also return the store's draft markets, in draft_markets.

## Returns

- `market_setup_type` (string): e.g. `string`
- `market_locations_enabled` (boolean): e.g. `true`
- `market_urls_enabled` (boolean): e.g. `true`
- `preorder_location_filter` (object)
  - `enabled` (boolean): e.g. `true`
  - `shopify_location_ids` (array of strings)
- `links` (array of objects)
  - `shopify_market_id` (string): e.g. `string`
  - `shopify_location_id` (string): e.g. `string`
- `markets` (array of objects)
  - `shopify_market_id` (string): e.g. `string`
  - `name` (string): e.g. `string`
  - `status` (string): e.g. `string`
  - `countries` (array of strings)
  - `country_names` (array of strings)
- `draft_markets` (array of objects)
  - `shopify_market_id` (string): e.g. `string`
  - `name` (string): e.g. `string`
  - `status` (string): e.g. `string`
  - `countries` (array of anys)
  - `country_names` (array of anys)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Get market settings

```sh
curl "https://app.stoqapp.com/api/v2/external/account/markets" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get market settings filtered by include_drafts

```sh
curl "https://app.stoqapp.com/api/v2/external/account/markets?include_drafts=false" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "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
      ]
    }
  ]
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

