Skip to main content
Anchor to ChannelConnection

ChannelConnection

connection

An auto-generated type for paginating through multiple Channels.

Anchor to Fields with this connectionFields with this connection

Anchor to App.channelsApp.channels
•OBJECT

A Shopify application that extends store functionality. Apps integrate with Shopify through APIs to add features, automate workflows, or connect external services.

Provides metadata about the app including its developer information and listing details in the Shopify App Store. Use the installation field to determine if the app is currently installed on the shop and access installation-specific details like granted AccessScope objects. Check failedRequirements before installation to identify any prerequisites that must be met.

Anchor to AppCatalog.channelsAppCatalog.channels
•OBJECT

A catalog that defines the publication associated with an app.

Anchor to Publication.channelsPublication.channels
•OBJECT

A group of products and collections that are published to an app.

Each publication manages which products and collections display on its associated Channel. Merchants can automatically publish products when they're created if autoPublish is enabled, or manually control publication through publication records.

Publications support scheduled publishing through future publish dates for online store channels, allowing merchants to coordinate product launches and promotional campaigns. The catalog field links to pricing and availability rules specific to that publication's context.

Deprecated fields with this connection

Anchor to Collection.unpublishedChannelsCollection.unpublishedChannels
•OBJECT
Deprecated
Anchor to Product.unpublishedChannelsProduct.unpublishedChannels
•OBJECT
Deprecated
Anchor to Publishable.unpublishedChannelsPublishable.unpublishedChannels
•INTERFACE
Deprecated
Anchor to Shop.channelsShop.channels
•OBJECT
Deprecated
Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to channelschannels
•query

The list of Channel objects on the shop. When the calling application supports multi-channel, only channels established by the calling application are returned. Each channel represents an authenticated connection to an external selling platform such as a marketplace, social media platform, online store, or point-of-sale system.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[ChannelEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[Channel!]!
non-null

A list of nodes that are contained in ChannelEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?