Publishable

Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection.

Show definition

# Represents a resource that can be published to a channel.

A publishable resource can be either a Product or Collection.

interface Publishable { # The number of channels a resource is published on without feedback errors. availablePublicationCount: Int!

# The number of channels a resource is published on. publicationCount( # Include only the resource's publications that are published. If false it # will return all resource's publications including future publications. onlyPublished: Boolean = true ): Int!

# The list of resources that are published to a channel. publicationsV2( # Return only the resources that are published. If false it will return all resource's publications. onlyPublished: Boolean = true

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

# Check to see if resource is published to a given channel. publishedOnChannel( # The ID of the channel to check. channelId: ID! ): Boolean!

# Check to see if resource is published to the calling app's channel. publishedOnCurrentChannel: Boolean!

# The list of resources that are published to a channel. resourcePublications( # Return only the resources that are published. If false it will return all resource publications. onlyPublished: Boolean = true

# 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 ): ResourcePublicationConnection!

# The list of channels that the resource is not published to. unpublishedChannels( # 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 ): ChannelConnection! }

Possible types

Fields

availablePublicationCount   (Int!)

The number of channels a resource is published on without feedback errors.

Required access

read_publications access scope

publicationCount   (Int!)

The number of channels a resource is published on.

Required access

read_publications access scope

Argument Type Default Description
onlyPublished

Boolean

true

Include only the resource's publications that are published. If false it will return all resource's publications including future publications.

publishedOnChannel   (Boolean!)

Check to see if resource is published to a given channel.

Required access

read_publications access scope

Argument Type Default Description
channelId

required

ID!

The ID of the channel to check.

publishedOnCurrentChannel   (Boolean!)

Check to see if resource is published to the calling app's channel.

Required access

read_product_listings access scope

resourcePublications   (ResourcePublicationConnection!)

The list of resources that are published to a channel.

Required access

read_publications access scope

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.

onlyPublished

Boolean

true

Return only the resources that are published. If false it will return all resource publications.

reverse

Boolean

false

Reverse the order of the underlying list.

unpublishedChannels   (ChannelConnection!)

The list of channels that the resource is not published to.

Required access

read_publications access scope

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.

Deprecated fields

Show/Hide

publicationsV2   (PublicationConnection!)

deprecated

The list of resources that are published to a channel.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope

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.

onlyPublished

Boolean

true

Return only the resources that are published. If false it will return all resource's publications.

reverse

Boolean

false

Reverse the order of the underlying list.

Sign up for a Partner account to get started.

Sign up