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

publishableUnpublishToCurrentChannel mutation

Version unstable

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource 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)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Required access

write_product_listings access scope.

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
id ( ID! ) required

The resource to delete or update publications for.

Return fields

  • publishable (Publishable)

    Resource that has been unpublished.

  • shop (Shop!)

    The user's shop.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.