Domain - admin-graphql - OBJECT

Version: 2024-10

Description:

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

Access Scopes

Fields

• host: String! - The host name of the domain. For example, `example.com`.
• id: ID! - A globally-unique ID.
• localization: DomainLocalization - The localization of the domain, if the domain doesn't redirect.
• marketWebPresence: MarketWebPresence - The web presence of the domain.
• sslEnabled: Boolean! - Whether SSL is enabled.
• url: URL! - The URL of the domain (for example, `https://example.com`).

Connections

Related queries

• domain Lookup a Domain by ID.

Related mutations

Related Unions

Examples

• Retrieve a domain by ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { domain(id: \\\"gid://shopify/Domain/948873163\\\") { host url } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    domain(id: \"gid://shopify/Domain/948873163\") {\n      host\n      url\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    domain(id: \"gid://shopify/Domain/948873163\") {\n      host\n      url\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    domain(id: \"gid://shopify/Domain/948873163\") {\n      host\n      url\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  domain(id: \"gid://shopify/Domain/948873163\") {\n    host\n    url\n  }\n}"
        

  input: null

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

  Retrieve information about a shop's domains

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { domains { id host url } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      domains {\n        id\n        host\n        url\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shop {\n      domains {\n        id\n        host\n        url\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      domains {\n        id\n        host\n        url\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    domains {\n      id\n      host\n      url\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "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"
          }
        ]
      }
    }
  }