productDuplicate mutation

Duplicates a product.

Required access

write_products access scope.

On this page

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.

mutation productDuplicate($productId: ID!, $newTitle: String!) { productDuplicate(productId: $productId, newTitle: $newTitle) { 
  1. <font style="color:#1F61A0;">imageJob</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">newProduct</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">shop</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">id</font>
  17. <font style="color:#555555;">}</font>
  19. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  21.   <font style="color:#1F61A0;">field</font>
  23.   <font style="color:#1F61A0;">message</font>
  25. <font style="color:#555555;">}</font>
} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “newTitle”: “placeholder” }

Arguments

Argument Description
includeImages
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Specifies whether or not to duplicate images.
Default value: false
newStatus
(
[ProductStatus](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productstatus)

)		 The new status of the product. If no value is provided the status will be inherited from the original product.
newTitle
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The new title of the product.
productId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the product to be duplicated.

Return fields

  • imageJob ([Job](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/job))
    The asynchronous job duplicating the product images.
  • newProduct ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    The duplicated product.
  • shop ([Shop!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shop))
    The user’s shop.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.