Choose a version:

domain

query

Returns a Domain resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the Domain to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DomainDomain

•Domain

A unique string that represents the address of a Shopify store on the Internet.

Anchor to hosthost •String! non-null: The host name of the domain. For example, example.com.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to localizationlocalization •DomainLocalization: The localization of the domain, if the domain doesn't redirect.
Anchor to marketWebPresencemarketWebPresence •MarketWebPresence: The web presence of the domain.
Anchor to sslEnabledsslEnabled •Boolean! non-null: Whether SSL is enabled.
Anchor to urlurl •URL! non-null: The URL of the domain (for example, https://example.com).

Was this section helpful?

Examples

Retrieve a domain by ID

Description

Retrieve information about a domain by its ID.

Query

query {
  domain(id: "gid://shopify/Domain/948873163") {
    host
    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 { domain(id: \"gid://shopify/Domain/948873163\") { host 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 {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      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 {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      url
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      url
    }
  }`,
});

Response

{
  "domain": {
    "host": "www.snowdevil.ca",
    "url": "https://www.snowdevil.ca"
  }
}

Retrieve information about a shop's domains

Description

The following query retrieves information for the domain names associated with the shop.

Query

query {
  shop {
    domains {
      id
      host
      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 { shop { domains { id host 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 {
    shop {
      domains {
        id
        host
        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 {
    shop {
      domains {
        id
        host
        url
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    shop {
      domains {
        id
        host
        url
      }
    }
  }`,
});

Response

{
  "shop": {
    "domains": [
      {
        "id": "gid://shopify/Domain/26371970",
        "host": "snowdevil.myshopify.com",
        "url": "https://snowdevil.myshopify.com"
      },
      {
        "id": "gid://shopify/Domain/948873163",
        "host": "www.snowdevil.ca",
        "url": "https://www.snowdevil.ca"
      }
    ]
  }
}

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 {

domain(id: "gid://shopify/Domain/948873163") {

host

url

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  domain(id: "gid://shopify/Domain/948873163") {
    host
    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 { domain(id: \"gid://shopify/Domain/948873163\") { host 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 {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      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 {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      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 {
    domain(id: "gid://shopify/Domain/948873163") {
      host
      url
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"domain": {

"host": "www.snowdevil.ca",

"url": "https://www.snowdevil.ca"

}