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

publishablePublish mutation

Version unstable

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Publishes a resource to a channel. If the resource is a product, then its status must be active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

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 create or update publications for.

input ( [PublicationInput!]! ) required

Specifies the input fields required to publish 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. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing.

Return fields

publishable (Publishable)

Resource that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.