publishableUnpublishToCurrentChannel mutation

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

Required access

write_product_listings access scope.

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 publishableUnpublishToCurrentChannel($id: ID!) { publishableUnpublishToCurrentChannel(id: $id) { 
  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=” }

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.

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.