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 publication a resource is published to without feedback errors. availablePublicationCount: Int!

# The number of publications 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!

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

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

# Check to see if resource is published to a given publication. publishedOnPublication( # The ID of the publication to check. publicationId: ID! ): Boolean!

# The list of resources that are published to a publication. resourcePublications( # 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

# Return only the resources that are published. If false it will return all resource publications. onlyPublished: Boolean = true

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

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

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

Possible types

Fields

availablePublicationCount   (Int!)

The number of publication a resource is published to without feedback errors.

Required access

read_publications access scope

publicationCount   (Int!)

The number of publications 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.

publishedOnCurrentPublication   (Boolean!)

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

Required access

read_product_listings access scope

publishedOnPublication   (Boolean!)

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

Required access

read_publications access scope

Argument Type Default Description
publicationId

required

ID!

The ID of the publication to check.

resourcePublications   (ResourcePublicationConnection!)

The list of resources that are published to a publication.

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.

unpublishedPublications   (PublicationConnection!)

The list of publications 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

publishedOnChannel   (Boolean!)

deprecated

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

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope

Argument Type Default Description
channelId

required

ID!

The ID of the channel to check.

publishedOnCurrentChannel   (Boolean!)

deprecated

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

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope

unpublishedChannels   (ChannelConnection!)

deprecated

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

Deprecation warning

Use unpublishedPublications 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.

reverse

Boolean

false

Reverse the order of the underlying list.

Sign up for a Partner account to get started.

Sign up