Channel

A channel is a medium for Shopify merchants to sell their products. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.

Show definition
# A channel is a medium for Shopify merchants to sell their products. A channel can be a platform or marketplace such
# as Facebook or Pinterest, an online store, or POS.
type Channel implements Node {
  # Globally unique identifier.
  id: ID!

  # Underlying app used by the channel.
  app: App!

  # The list of collections published to the channel.
  collectionPublicationsV2(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): PublicationConnection!

  # The list of collections published to the channel.
  collections(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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!

  # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): ProductPublicationConnection!

  # The list of products published to the channel.
  productPublicationsV2(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): PublicationConnection!

  # The list of products published to the channel.
  products(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): ProductConnection!

  # Whether or not this channel supports future publishing.
  supportsFuturePublishing: Boolean!
}

Implements

Connections

collectionPublicationsV2   (PublicationConnection!)

The list of collections published to the channel.

Argument Type Default Description
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 false

Reverse the order of the underlying list.

collections   (CollectionConnection!)

The list of collections published to the channel.

Argument Type Default Description
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 false

Reverse the order of the underlying list.

productPublicationsV2   (PublicationConnection!)

The list of products published to the channel.

Argument Type Default Description
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 false

Reverse the order of the underlying list.

products   (ProductConnection!)

The list of products published to the channel.

Argument Type Default Description
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 false

Reverse the order of the underlying list.

Fields

app   (App!)

Underlying app used by the channel.

hasCollection   (Boolean!)

Whether the collection is available to the channel.

Argument Type Default Description
id required ID!

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

Menu items for the channel, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use App.navigation_items instead

overviewPath   (URL) deprecated

Home page for the channel.

Deprecation warning

Use App.launch_url instead

productPublications   (ProductPublicationConnection!) deprecated

Deprecation warning

Use productPublicationsV2 instead

Argument Type Default Description
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 false

Reverse the order of the underlying list.