Channel object

Version 2020-01 (Release candidate)

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.

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: false

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: false

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: false

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: false

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.

Types that return Channel

Implements

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: false

Version 2019-10 (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.

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: false

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: false

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: false

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: false

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.

Types that return Channel

Implements

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: false

Version 2019-07

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.

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: false

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: false

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: false

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: false

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.

Types that return Channel

Implements

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: false

Version 2019-04

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.

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: false

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: false

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: false

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: false

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.

Types that return Channel

Implements

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: false

Sign up for a Partner account to get started.

Sign up