Anchor to section titled 'undefined'

productUnpublish
mutation
deprecated

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

Unpublishes a product. Use publishableUnpublish instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
ProductUnpublishInput!
required

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

Was this section helpful?
Anchor to section titled 'ProductUnpublishPayload returns'

ProductUnpublishPayload returns

Anchor to ProductUnpublishPayload.product
product
Product

The product that has been unpublished.

Anchor to ProductUnpublishPayload.shop
shop
Shop!
non-null

The user's shop.

Anchor to ProductUnpublishPayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation productUnpublish($input: ProductUnpublishInput!) {
  productUnpublish(input: $input) {
    product {
      # Product fields
    }
    shop {
      # Shop fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "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
}