API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04 Unsupported
API version: 2020-01 Unsupported

Publishable interface

Version unstable

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2021-07 (Release candidate)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2021-04 (Latest)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2021-01

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2020-10

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2020-07

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2020-04 (Unsupported)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2020-01 (Unsupported)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2019-10 (Unsupported)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2019-07 (Unsupported)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Version 2019-04 (Unsupported)

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

Fields

  • availablePublicationCount (Int!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedOnCurrentPublication (Boolean!)

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

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

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

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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

Types that implement Publishable

Deprecated fields

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the 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. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument 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 )

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