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.

Anchor to Arguments

Arguments

Anchor to inputinput

•ProductUnpublishInput!

required

Specifies the product to unpublish and the channel to unpublish it from.

Show input fields

Was this section helpful?

Anchor to ProductUnpublishPayload returnsProductUnpublishPayload returns

Anchor to productproduct •Product: The product that has been unpublished.

Show fields
Anchor to shopshop •Shop! non-null: The user's shop.

Show fields
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

productUnpublish reference

Mutation Reference

mutation productUnpublish($input: ProductUnpublishInput!) {

productUnpublish(input: $input) {

product {

# Product fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"input": {

"id": "gid://shopify/Product/10079785100",

"productPublications": [

{

"publicationId": "gid://shopify/Publication/10079785100",

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

}

]

}

Variables

{
  "input": {
    "id": "gid://shopify/Product/10079785100",
    "productPublications": [
      {
        "publicationId": "gid://shopify/Publication/10079785100",
        "publishDate": "2019-09-07T15:50:00Z"
      }
    ]
  }
}

Schema

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

input ProductPublicationInput {
  publicationId: ID
  publishDate: DateTime
}