productPublish mutation

Version 2020-07 (Release candidate)

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.

Version 2020-04 (Latest)

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.

Version 2020-01

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.

Version 2019-10

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.

Version 2019-07

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.

Version 2019-04

Deprecation warning

Use publishablePublish instead

Publishes a product.

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

input ( ProductPublishInput! ) required

Specifies the product to publish and the channels to publish it to.

ProductPublishInput fields

id (ID!) Required

The product to create or update publications for.

productPublications ([ProductPublicationInput!]!) Required

The publication that the product is published to.

Return fields

product (Product)

The product that has been published.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
productPublications ([ProductPublication!]) deprecated

The channels where the product is published.

Deprecation warning

Use Product.publications instead.