productUnpublish
mutation
deprecated

Choose a version:

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?

Code examples for MUTATION: productUnpublish

Query Reference for MUTATION: productUnpublish

"mutation productUnpublish($input: ProductUnpublishInput!) {\n  productUnpublish(input: $input) {\n    product {\n      # Product fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: productUnpublish

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

Schema Reference for MUTATION: productUnpublish

"input ProductUnpublishInput {\n  id: ID!\n  productPublications: [ProductPublicationInput!]!\n}\n\ninput ProductPublicationInput {\n  channelHandle: String\n  channelId: ID\n  publicationId: ID\n  publishDate: DateTime\n}\n"

Display Examples for MUTATION: productUnpublish

[]

productUnpublishmutationdeprecated

Arguments

ProductUnpublishPayload returns

productUnpublish
mutation
deprecated