Channel

Version 2019-04 (latest)

A channel is a group of products and collections that is published to an app. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.

Show definition

"""
A channel is a group of products and collections that is published to an app. A
channel can be a platform or marketplace such
as Facebook or Pinterest, an online store, or POS.
"""
type Channel implements Node {
  """
  Underlying app used by the channel.
  """
  app: App!
  """
  The collection publications for the list of collections published to the channel.
  """
  collectionPublicationsV3(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): ResourcePublicationConnection!
  """
  The list of collections published to the channel.
  """
  collections(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): CollectionConnection!
  """
  Unique identifier for the channel.
  """
  handle: String!
  """
  Whether the collection is available to the channel.
  """
  hasCollection(
    """
    Collection ID to check.
    """
    id: ID!
  ): Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Name of the channel.
  """
  name: String!
  """
  Menu items for the channel, which also appear as submenu items in left navigation sidebar in the Shopify admin.
  """
  navigationItems: [NavigationItem!]!
  """
  Home page for the channel.
  """
  overviewPath: URL
  productPublications(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): ProductPublicationConnection!
  """
  The product publications for the list of products published to the channel.
  """
  productPublicationsV3(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): ResourcePublicationConnection!
  """
  The list of products published to the channel.
  """
  products(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): ProductConnection!
  """
  Whether or not this channel supports future publishing.
  """
  supportsFuturePublishing: Boolean!
}

Implements

Connections

collectionPublicationsV3 (ResourcePublicationConnection!)

The collection publications for the list of collections published to the channel.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

collections (CollectionConnection!)

The list of collections published to the channel.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

productPublicationsV3 (ResourcePublicationConnection!)

The product publications for the list of products published to the channel.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

products (ProductConnection!)

The list of products published to the channel.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

app (App!)

Underlying app used by the channel.

hasCollection (Boolean!)

Whether the collection is available to the channel.

id ( ID! ) required

Collection ID to check.

id (ID!)

Globally unique identifier.

name (String!)

Name of the channel.

supportsFuturePublishing (Boolean!)

Whether or not this channel supports future publishing.

Deprecated fields

Show/Hide
handle (String!) deprecated

Unique identifier for the channel.

Deprecation warning

Use id instead

overviewPath (URL) deprecated

Home page for the channel.

Deprecation warning

Use App.launch_url instead

productPublications (ProductPublicationConnection!) deprecated

Deprecation warning

Use productPublicationsV3 instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Sign up for a Partner account to get started.

Sign up