publishableUnpublish mutation

Version 2020-10 (Release candidate)

Unpublishes a resource to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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 (Latest)

Unpublishes a resource to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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 to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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

Unpublishes a resource to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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

Unpublishes a resource to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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 to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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 to a channel.

Required access

write_publications 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

id ( ID! ) required

The resource to delete or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to unpublish a resource.

PublicationInput fields

channelId (ID)

ID of the channel. This argument is deprecated: Use publicationId instead.

publicationId (ID)

ID of the publication.

publishDate (DateTime)

The date and time that the resource was published. For channels that support future publishing, setting this to a date in the future will schedule the resource to be published.

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.