Choose a version:

productUnpublish

mutation

Requires write_publications access scope. Also: The user must have a permission to unpublish a product.

Deprecated. Use `publishableUnpublish` instead.

Unpublishes a product.

Arguments

Anchor to inputinput • ProductUnpublishInput!required: Specifies the product to unpublish and the channel to unpublish it from.

Was this section helpful?

Anchor to ProductUnpublishPayload returnsProductUnpublishPayload returns

Anchor to productproduct • Product: The product that has been unpublished.
Anchor to shopshop • Shop!non-null: The user's shop.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation productUnpublish($input: ProductUnpublishInput!) {

productUnpublish(input: $input) {

product {

# Product fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"input": {

"id": "gid://shopify/<objectName>/10079785100",

"productPublications": [

{

"channelHandle": "<your-channelHandle>",

"channelId": "gid://shopify/<objectName>/10079785100",

"publicationId": "gid://shopify/<objectName>/10079785100",

"publishDate": "2019-09-07T15:50:00Z"

}

]

}

{
  "input": {
    "id": "gid://shopify/<objectName>/10079785100",
    "productPublications": [
      {
        "channelHandle": "<your-channelHandle>",
        "channelId": "gid://shopify/<objectName>/10079785100",
        "publicationId": "gid://shopify/<objectName>/10079785100",
        "publishDate": "2019-09-07T15:50:00Z"
      }
    ]
  }
}

input ProductUnpublishInput {
  id: ID!
  productPublications: [ProductPublicationInput!]!
}

input ProductPublicationInput {
  channelHandle: String
  channelId: ID
  publicationId: ID
  publishDate: DateTime
}