publishableUnpublish mutation

Version unstable

Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores. Also: You must have read access to product_listings and Storefront API permissions to read products, variants, and collections.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

  • channelId (ID)

    ID of the channel. This argument is deprecated: Use publicationId instead.

  • publicationId (ID)

    ID of the publication.

  • publishDate (DateTime)

    The date and time that the resource was published. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores. Also: You must have read access to product_listings and Storefront API permissions to read products, variants, and collections.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.