Channel
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.
Anchor to FieldsFields
- •App!non-null
The underlying app used by the channel.
- Anchor to collectionPublicationsV3collection•Resource
Publications V3 Publication Connection! non-null The list of collection publications. Each record represents information about the publication of a collection.
- Anchor to collectionscollections•Collection
Connection! non-null The list of collections published to the channel.
- Anchor to hasCollectionhas•Boolean!
Collection non-null Whether the collection is available to the channel.
- •ID!required
The collection ID to check.
Arguments
- •ID!
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The name of the channel.
- Anchor to productPublicationsV3product•Resource
Publications V3 Publication Connection! non-null The list of product publication records for products published to this channel.
- Anchor to productsproducts•Product
Connection! non-null The list of products published to the channel.
- Anchor to productsCountproducts•Count
Count Retrieves the total count of products that are currently published to a specific sales channel. This provides a quick way to understand channel inventory without fetching the full product list.
For example, when building channel management dashboards, you can display how many products are available in each channel like "150 products in Online Store" or "75 products in Facebook Shop."
Use
to:
- Display inventory summaries in channel management interfaces
- Monitor product distribution across sales channels
- Validate channel setup and product availability
The count reflects only published products and updates as merchants add or remove products from channels.
Learn more about sales channels. Limited to a maximum of 10000 by default.
- Anchor to supportsFuturePublishingsupports•Boolean!
Future Publishing non-null Whether the channel supports future publishing.
Deprecated fields
- Anchor to handlehandle•String!non-nullDeprecated
- •[Navigation
Item!]! non-nullDeprecated - Anchor to overviewPathoverview•URL
Path Deprecated - Anchor to productPublicationsproduct•Product
Publications Publication Connection! non-nullDeprecated
Anchor to QueriesQueries
Deprecated queries
- •queryDeprecated
- •queryDeprecated