Choose a version:

productDuplicate

mutation

Requires write_products access scope. Also: The user must have a permission to duplicate a product.

Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, include the synchronous: false argument in this mutation to perform the duplication asynchronously.

Metafield values are not duplicated if the unique values capability is enabled.

Anchor to Arguments

Arguments

Anchor to includeImagesincludeImages

•Boolean

Default:false

Specifies whether or not to duplicate images.

Anchor to includeTranslationsincludeTranslations

•Boolean

Default:false

Specifies whether or not to duplicate translations.

Anchor to newStatusnewStatus

•ProductStatus

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

Anchor to newTitlenewTitle

•String!

required

The new title of the product.

Anchor to productIdproductId

•ID!

required

The ID of the product to be duplicated.

Anchor to synchronoussynchronous

•Boolean

Default:true

Specifies whether or not to run the mutation synchronously.

Was this section helpful?

Anchor to ProductDuplicatePayload returnsProductDuplicatePayload returns

Anchor to imageJobimageJob •Job: The asynchronous job that duplicates the product images.
Anchor to newProductnewProduct •Product: The duplicated product.
Anchor to productDuplicateOperationproductDuplicateOperation •ProductDuplicateOperation: The product duplicate operation, returned when run in asynchronous mode.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

productDuplicate reference

Mutation Reference

mutation productDuplicate($includeImages: Boolean, $includeTranslations: Boolean, $newStatus: ProductStatus, $newTitle: String!, $productId: ID!, $synchronous: Boolean) {

productDuplicate(includeImages: $includeImages, includeTranslations: $includeTranslations, newStatus: $newStatus, newTitle: $newTitle, productId: $productId, synchronous: $synchronous) {

imageJob {

# Job fields

}

newProduct {

# Product fields

}

productDuplicateOperation {

# ProductDuplicateOperation fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"includeImages": true,

"includeTranslations": true,

"newStatus": "ACTIVE",

"newTitle": "<your-newTitle>",

"productId": "gid://shopify/Product/10079785100",

"synchronous": true

}

Variables

{
  "includeImages": true,
  "includeTranslations": true,
  "newStatus": "ACTIVE",
  "newTitle": "<your-newTitle>",
  "productId": "gid://shopify/Product/10079785100",
  "synchronous": true
}