API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

productUnpublish mutation

Version unstable

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a product.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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.


Arguments

Argument Description
input ( ProductUnpublishInput! ) required

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

ProductUnpublishInput fields

  • id (ID!) Required

    The ID of the product to create or update publications for.

  • productPublications ([ProductPublicationInput!]!) Required

    The channels to unpublish the product from.

Return fields

  • product (Product)

    The product that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.