Page - admin-graphql - OBJECT

Version: 2025-01

Description:

A page on the Online Store.

Access Scopes

`read_content` access scope or `read_online_store_pages` access scope.

Fields

• body: HTML! - The text content of the page, complete with HTML markup.
• bodySummary: String! - The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.
• createdAt: DateTime! - The date and time (ISO 8601 format) of the page creation.
• defaultCursor: String! - A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
• handle: String! - A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.
• id: ID! - A globally-unique ID.
• isPublished: Boolean! - Whether or not the page is visible.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• publishedAt: DateTime - The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.
• templateSuffix: String - The suffix of the template that's used to render the page.
• title: String! - Title of the page.
• translations: Translation! - The published translations associated with the resource.
• updatedAt: DateTime! - The date and time (ISO 8601 format) of the latest page update.

Connections

• events: EventConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!

Related queries

• page Returns a Page resource by ID.
• pages List of the shop's pages.

Related mutations

• pageCreate Creates a page.
• pageUpdate Updates a page.

Related Unions

• MetafieldReference The resource referenced by the metafield value.
• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples

• Retrieves a single page by its ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query PageShow($id: ID!) { page(id: $id) { id title handle } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Page/602767277\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query PageShow($id: ID!) {\n      page(id: $id) {\n        id\n        title\n        handle\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Page/602767277\"\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 PageShow($id: ID!) {\n    page(id: $id) {\n      id\n      title\n      handle\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Page/602767277\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query PageShow($id: ID!) {\n    page(id: $id) {\n      id\n      title\n      handle\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Page/602767277\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query PageShow($id: ID!) {\n    page(id: $id) {\n      id\n      title\n      handle\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Page/602767277\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query PageShow($id: ID!) {\n  page(id: $id) {\n    id\n    title\n    handle\n  }\n}"
        

  input: {
    "id": "gid://shopify/Page/602767277"
  }

  response: {
    "data": {
      "page": {
        "id": "gid://shopify/Page/602767277",
        "title": "Sample Page",
        "handle": "samplepage"
      }
    }
  }