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

productDuplicate mutation

Version unstable

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newStatus ( ProductStatus )

The new status of the product. If no value is provided the status will be inherited from the original product.

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newStatus ( ProductStatus )

The new status of the product. If no value is provided the status will be inherited from the original product.

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newStatus ( ProductStatus )

The new status of the product. If no value is provided the status will be inherited from the original product.

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Duplicates a product.

Required access

write_products 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

includeImages ( Boolean )

Specifies whether or not to duplicate images.Default value: false

newTitle ( String! ) required

The new title of the product.

productId ( ID! ) required

The ID of the product to be duplicated.

Return fields

imageJob (Job)

The asynchronous job duplicating the product images.

newProduct (Product)

The duplicated product.

shop (Shop!)

The user's shop.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.