Choose a version:

markets

query

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

Returns a paginated list of Market objects configured for the shop. Markets match buyers based on defined conditions to deliver customized shopping experiences.

Filter markets by MarketType and MarketStatus, search by name, and control sort order. Retrieve market configurations including MarketCurrencySettings, MarketWebPresence objects, and MarketConditions.

Learn more about Shopify Markets.

Anchor to Arguments

MarketConnection arguments

•MarketConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to enabledenabled

•Boolean

Default:null

Filters markets by enabled status.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to market_condition_types •string: A comma-separated list of condition types.
Anchor to market_type •string
Anchor to name •string
Anchor to status •string
Anchor to wildcard_company_location_with_country_code •string

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MarketsSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to typetype

•MarketType

Default:null

Filters markets by type.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[MarketEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[Market!]! non-null: A list of nodes that are contained in MarketEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Get market web presences and their root URLs

Description

The following query loads the web presences configured for a shop’s markets and the language-specific root URLs available on each.

Query

query Markets {
  markets(first: 4) {
    nodes {
      name
      webPresence {
        rootUrls {
          locale
          url
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query Markets { markets(first: 4) { nodes { name webPresence { rootUrls { locale url } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }`,
});

Response

{
  "markets": {
    "nodes": [
      {
        "name": "Canada",
        "webPresence": {
          "rootUrls": [
            {
              "locale": "en",
              "url": "https://defaultglobal.com/en-ca"
            },
            {
              "locale": "fr",
              "url": "https://defaultglobal.com/fr-ca"
            }
          ]
        }
      },
      {
        "name": "European Union",
        "webPresence": {
          "rootUrls": [
            {
              "locale": "en",
              "url": "https://defaultglobal.com/en-eu"
            },
            {
              "locale": "es",
              "url": "https://defaultglobal.com/es-eu"
            },
            {
              "locale": "fr",
              "url": "https://defaultglobal.com/fr-eu"
            }
          ]
        }
      },
      {
        "name": "United Kingdom",
        "webPresence": {
          "rootUrls": [
            {
              "locale": "en",
              "url": "https://uk.defaultglobal.com"
            }
          ]
        }
      },
      {
        "name": "United States",
        "webPresence": {
          "rootUrls": [
            {
              "locale": "en",
              "url": "https://defaultglobal.com"
            },
            {
              "locale": "es",
              "url": "https://defaultglobal.com/es"
            }
          ]
        }
      }
    ]
  }
}

Get the first four markets

Description

The following query retrieves the first four markets, their names, and what regions are included in them.

Query

query Markets {
  markets(first: 4) {
    nodes {
      id
      name
      regions(first: 2) {
        pageInfo {
          hasNextPage
        }
        nodes {
          name
          ... on MarketRegionCountry {
            code
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query Markets { markets(first: 4) { nodes { id name regions(first: 2) { pageInfo { hasNextPage } nodes { name ... on MarketRegionCountry { code } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query Markets {
    markets(first: 4) {
      nodes {
        id
        name
        regions(first: 2) {
          pageInfo {
            hasNextPage
          }
          nodes {
            name
            ... on MarketRegionCountry {
              code
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query Markets {
    markets(first: 4) {
      nodes {
        id
        name
        regions(first: 2) {
          pageInfo {
            hasNextPage
          }
          nodes {
            name
            ... on MarketRegionCountry {
              code
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query Markets {
    markets(first: 4) {
      nodes {
        id
        name
        regions(first: 2) {
          pageInfo {
            hasNextPage
          }
          nodes {
            name
            ... on MarketRegionCountry {
              code
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "markets": {
    "nodes": [
      {
        "id": "gid://shopify/Market/249692835",
        "name": "Canada",
        "regions": {
          "pageInfo": {
            "hasNextPage": false
          },
          "nodes": [
            {
              "name": "Canada",
              "code": "CA"
            }
          ]
        }
      },
      {
        "id": "gid://shopify/Market/58345162",
        "name": "European Union",
        "regions": {
          "pageInfo": {
            "hasNextPage": true
          },
          "nodes": [
            {
              "name": "Germany",
              "code": "DE"
            },
            {
              "name": "Belgium",
              "code": "BE"
            }
          ]
        }
      },
      {
        "id": "gid://shopify/Market/867658238",
        "name": "United Kingdom",
        "regions": {
          "pageInfo": {
            "hasNextPage": false
          },
          "nodes": [
            {
              "name": "United Kingdom",
              "code": "GB"
            }
          ]
        }
      },
      {
        "id": "gid://shopify/Market/371343838",
        "name": "United States",
        "regions": {
          "pageInfo": {
            "hasNextPage": false
          },
          "nodes": [
            {
              "name": "United States",
              "code": "US"
            }
          ]
        }
      }
    ]
  }
}

query markets by type and retrieve the responders

Description

Filtering the markets by type allow to retrieve only markets of the specified type

Query

query Markets {
  markets(first: 10, type: REGION) {
    edges {
      node {
        id
        handle
        status
        conditions {
          regionsCondition {
            regions(first: 10) {
              edges {
                node {
                  id
                  name
                }
              }
            }
          }
        }
        catalogs(first: 10) {
          edges {
            node {
              id
            }
          }
        }
        webPresences(first: 10) {
          edges {
            node {
              domain {
                id
              }
              subfolderSuffix
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query Markets { markets(first: 10, type: REGION) { edges { node { id handle status conditions { regionsCondition { regions(first: 10) { edges { node { id name } } } } } catalogs(first: 10) { edges { node { id } } } webPresences(first: 10) { edges { node { domain { id } subfolderSuffix } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "markets": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/Market/648318726",
          "handle": "ar",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/235308185",
                      "name": "Argentina"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/648318726"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/1054177655",
          "handle": "apac",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/549281533",
                      "name": "Philippines"
                    }
                  },
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/528768080",
                      "name": "Vietnam"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/1054177655"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/984242607",
          "handle": "au",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/274862388",
                      "name": "Australia"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/984242607"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/128989799",
          "handle": "ca",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/948873163",
                      "name": "Canada"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/128989799"
                }
              }
            ]
          },
          "webPresences": {
            "edges": [
              {
                "node": {
                  "domain": {
                    "id": "gid://shopify/Domain/948873163"
                  },
                  "subfolderSuffix": null
                }
              }
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/73827535",
          "handle": "us",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/397370199",
                      "name": "United States"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/73827535"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/680406738",
          "handle": "jp",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/66862194",
                      "name": "Japan"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/680406738"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/642625972",
          "handle": "ki",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/1049404916",
                      "name": "Kiribati"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/642625972"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/755557108",
          "handle": "market-without-catalog",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/606547003",
                      "name": "Belgium"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": []
          },
          "webPresences": {
            "edges": []
          }
        }
      }
    ]
  }
}

query markets by type and retrieve the responders

Description

Filtering the markets by type allow to retrieve only markets of the specified type

Query

query Markets {
  markets(first: 10, type: REGION) {
    edges {
      node {
        id
        handle
        status
        conditions {
          regionsCondition {
            regions(first: 10) {
              edges {
                node {
                  id
                  name
                }
              }
            }
          }
        }
        catalogs(first: 10) {
          edges {
            node {
              id
            }
          }
        }
        webPresences(first: 10) {
          edges {
            node {
              domain {
                id
              }
              subfolderSuffix
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query Markets { markets(first: 10, type: REGION) { edges { node { id handle status conditions { regionsCondition { regions(first: 10) { edges { node { id name } } } } } catalogs(first: 10) { edges { node { id } } } webPresences(first: 10) { edges { node { domain { id } subfolderSuffix } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query Markets {
    markets(first: 10, type: REGION) {
      edges {
        node {
          id
          handle
          status
          conditions {
            regionsCondition {
              regions(first: 10) {
                edges {
                  node {
                    id
                    name
                  }
                }
              }
            }
          }
          catalogs(first: 10) {
            edges {
              node {
                id
              }
            }
          }
          webPresences(first: 10) {
            edges {
              node {
                domain {
                  id
                }
                subfolderSuffix
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "markets": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/Market/648318726",
          "handle": "ar",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/235308185",
                      "name": "Argentina"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/648318726"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/1054177655",
          "handle": "apac",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/549281533",
                      "name": "Philippines"
                    }
                  },
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/528768080",
                      "name": "Vietnam"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/1054177655"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/984242607",
          "handle": "au",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/274862388",
                      "name": "Australia"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/984242607"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/128989799",
          "handle": "ca",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/948873163",
                      "name": "Canada"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/128989799"
                }
              }
            ]
          },
          "webPresences": {
            "edges": [
              {
                "node": {
                  "domain": {
                    "id": "gid://shopify/Domain/948873163"
                  },
                  "subfolderSuffix": null
                }
              }
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/73827535",
          "handle": "us",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/397370199",
                      "name": "United States"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/73827535"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/680406738",
          "handle": "jp",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/66862194",
                      "name": "Japan"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/680406738"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/642625972",
          "handle": "ki",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/1049404916",
                      "name": "Kiribati"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": [
              {
                "node": {
                  "id": "gid://shopify/MarketCatalog/642625972"
                }
              }
            ]
          },
          "webPresences": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Market/755557108",
          "handle": "market-without-catalog",
          "status": "ACTIVE",
          "conditions": {
            "regionsCondition": {
              "regions": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/MarketRegionCountry/606547003",
                      "name": "Belgium"
                    }
                  }
                ]
              }
            }
          },
          "catalogs": {
            "edges": []
          },
          "webPresences": {
            "edges": []
          }
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query Markets {

markets(first: 4) {

nodes {

name

webPresence {

rootUrls {

locale

url

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query Markets {
  markets(first: 4) {
    nodes {
      name
      webPresence {
        rootUrls {
          locale
          url
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query Markets { markets(first: 4) { nodes { name webPresence { rootUrls { locale url } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query Markets {
    markets(first: 4) {
      nodes {
        name
        webPresence {
          rootUrls {
            locale
            url
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"markets": {

"nodes": [

{

"name": "Canada",

"webPresence": {

"rootUrls": [

{

"locale": "en",

"url": "https://defaultglobal.com/en-ca"

{

"locale": "fr",

"url": "https://defaultglobal.com/fr-ca"

}

]

}

{

"name": "European Union",

"webPresence": {

"rootUrls": [

{

"locale": "en",

"url": "https://defaultglobal.com/en-eu"

{

"locale": "es",

"url": "https://defaultglobal.com/es-eu"

{

"locale": "fr",

"url": "https://defaultglobal.com/fr-eu"

}

]

}

{

"name": "United Kingdom",

"webPresence": {

"rootUrls": [

{

"locale": "en",

"url": "https://uk.defaultglobal.com"

}

]

}

{

"name": "United States",

"webPresence": {

"rootUrls": [

{

"locale": "en",

"url": "https://defaultglobal.com"

{

"locale": "es",

"url": "https://defaultglobal.com/es"

}

]

}

]

}