publishableUnpublish mutation

Unpublishes a resource from a channel. If the resource is a product, then its status must be active.

Required access

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

On this page

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.

mutation publishableUnpublish($id: ID!, $input: [PublicationInput!]!) { publishableUnpublish(id: $id, input: $input) { 
  1. <font style="color:#1F61A0;">publishable</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">availablePublicationCount</font>
  5.   <font style="color:#1F61A0;">publicationCount</font>
  7.   <font style="color:#1F61A0;">publishedOnCurrentPublication</font>
  9. <font style="color:#555555;">}</font>
  11. <font style="color:#1F61A0;">shop</font> <font style="color:#555555;">{</font>
  13.   <font style="color:#1F61A0;">id</font>
  15. <font style="color:#555555;">}</font>
  17. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  19.   <font style="color:#1F61A0;">field</font>
  21.   <font style="color:#1F61A0;">message</font>
  23. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “input”: [ 
  1. <font style="color:#555555;">{}</font>
] }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The resource to delete or update publications for.
input
(
[[PublicationInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/publicationinput)

) REQUIRED		 Specifies the input fields required to unpublish a resource.

PublicationInput fields

  • channelId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    ID of the channel. This argument is deprecated: Use publicationId instead.
  • publicationId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    ID of the publication.
  • publishDate ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    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](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/publishable))
    Resource that has been unpublished.
  • shop ([Shop!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shop))
    The user’s shop.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.