For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • QUERYsite
          • QUERYchannel
          • QUERYcustomer
          • QUERYnode
          • QUERYlocations
          • QUERYshopperPreferences
          • QUERYstore
          • QUERYcountries
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontQueries

channel

Example Query
1query ExampleQuery {
2  channel {
3    entityId
4    metafields {
5      pageInfo
6      edges
7    }
8  }
9}
Example response
1{
2  "data": {
3    "channel": {
4      "entityId": "Long",
5      "metafields": {
6        "pageInfo": {
7          "hasNextPage": null,
8          "hasPreviousPage": null,
9          "startCursor": null,
10          "endCursor": null
11        },
12        "edges": [
13          {
14            "node": null,
15            "cursor": null
16          }
17        ]
18      }
19    }
20  }
21}
The current channel.
Was this page helpful?
Previous

site

Next

customer

Built with

Returns

a Channel
entityIdLong
The ID of the channel.
metafieldsMetafieldConnection
Metafield data related to a channel.