Skip to main content
Anchor to pageByHandle

pageByHandle

query
Deprecated. Use page instead.

Retrieves a Page by its handle.

Anchor to Arguments

Arguments

Anchor to handlehandle
•String!
required

The handle of the page.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PagePage
•Page

A custom content page on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.

Each page has a unique handle for URL routing and includes SEO information for search engine optimization. Pages support Metafield attachments for storing additional custom data.

Anchor to bodybody
•HTML!
non-null

The description of the page, complete with HTML formatting.

Anchor to bodySummarybodySummary
•String!
non-null

Summary of the page body.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The timestamp of the page creation.

Anchor to handlehandle
•String!
non-null

A human-friendly unique string for the page automatically generated from its title.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The identifier for the metafield.

Anchor to metafieldsmetafields
•[Metafield]!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to identifiersidentifiers
•[HasMetafieldsIdentifier!]!
required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to onlineStoreUrlonlineStoreUrl
•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

Anchor to seoseo
•SEO

The page's SEO information.

Anchor to titletitle
•String!
non-null

The title of the page.

Anchor to trackingParameterstrackingParameters
•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The timestamp of the latest page update.

Was this section helpful?