# productDuplicate - admin-graphql - MUTATION Version: 2024-07 ## Description Duplicates a product. If you need to duplicate a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you might encounter timeout errors. To avoid these timeout errors, you can instead duplicate the product asynchronously. In API version 2024-10 and higher, include `synchronous: false` argument in this mutation to perform the duplication asynchronously. In API version 2024-07 and lower, use the asynchronous [`ProductDuplicateAsyncV2`](https://shopify.dev/api/admin-graphql/2024-07/mutations/productDuplicateAsyncV2). Metafield values are not duplicated if the unique values capability is enabled. ### Access Scopes `write_products` access scope. Also: The user must have a permission to duplicate a product. ## Arguments * [includeImages](/docs/api/admin-graphql/2024-07/scalars/Boolean): Boolean - Specifies whether or not to duplicate images. * [includeTranslations](/docs/api/admin-graphql/2024-07/scalars/Boolean): Boolean - Specifies whether or not to duplicate translations. * [newStatus](/docs/api/admin-graphql/2024-07/enums/ProductStatus): ProductStatus - The new status of the product. If no value is provided the status will be inherited from the original product. * [newTitle](/docs/api/admin-graphql/2024-07/scalars/String): String! - The new title of the product. * [productId](/docs/api/admin-graphql/2024-07/scalars/ID): ID! - The ID of the product to be duplicated. ## Returns * [imageJob](/docs/api/admin-graphql/2024-07/objects/Job): Job The asynchronous job that duplicates the product images. * [newProduct](/docs/api/admin-graphql/2024-07/objects/Product): Product The duplicated product. * [shop](/docs/api/admin-graphql/2024-07/objects/Shop): Shop! The user's shop. * [userErrors](/docs/api/admin-graphql/2024-07/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Duplicate a product Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus) { productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus) { newProduct { id title vendor productType variants(first: 1) { nodes { id title } } } imageJob { id done } userErrors { field message } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus) {\n newProduct {\n id\n title\n vendor\n productType\n variants(first: 1) {\n nodes {\n id\n title\n }\n }\n }\n imageJob {\n id\n done\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\"\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus) {\n newProduct {\n id\n title\n vendor\n productType\n variants(first: 1) {\n nodes {\n id\n title\n }\n }\n }\n imageJob {\n id\n done\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\"\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus) {\n newProduct {\n id\n title\n vendor\n productType\n variants(first: 1) {\n nodes {\n id\n title\n }\n }\n }\n imageJob {\n id\n done\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus) {\n newProduct {\n id\n title\n vendor\n productType\n variants(first: 1) {\n nodes {\n id\n title\n }\n }\n }\n imageJob {\n id\n done\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "productId": "gid://shopify/Product/20995642", "newTitle": "Copy of Product", "includeImages": true, "newStatus": "ACTIVE" } #### Graphql Response { "data": { "productDuplicate": { "newProduct": { "id": "gid://shopify/Product/1072481071", "title": "Copy of Product", "vendor": "Arbor", "productType": "Snowboards", "variants": { "nodes": [ { "id": "gid://shopify/ProductVariant/1070325098", "title": "151cm" } ] } }, "imageJob": null, "userErrors": [] } } } ### Duplicate a product asynchronously and return productDuplicateOperation Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus, $synchronous: Boolean) { productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus, synchronous: $synchronous) { productDuplicateOperation { id status newProduct { id title } userErrors { field message } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\",\n \"synchronous\": false\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus, $synchronous: Boolean) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus, synchronous: $synchronous) {\n productDuplicateOperation {\n id\n status\n newProduct {\n id\n title\n }\n userErrors {\n field\n message\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\",\n \"synchronous\": false\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus, $synchronous: Boolean) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus, synchronous: $synchronous) {\n productDuplicateOperation {\n id\n status\n newProduct {\n id\n title\n }\n userErrors {\n field\n message\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\",\n \"synchronous\": false\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus, $synchronous: Boolean) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus, synchronous: $synchronous) {\n productDuplicateOperation {\n id\n status\n newProduct {\n id\n title\n }\n userErrors {\n field\n message\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"newTitle\": \"Copy of Product\",\n \"includeImages\": true,\n \"newStatus\": \"ACTIVE\",\n \"synchronous\": false\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation DuplicateProduct($productId: ID!, $newTitle: String!, $includeImages: Boolean, $newStatus: ProductStatus, $synchronous: Boolean) {\n productDuplicate(productId: $productId, newTitle: $newTitle, includeImages: $includeImages, newStatus: $newStatus, synchronous: $synchronous) {\n productDuplicateOperation {\n id\n status\n newProduct {\n id\n title\n }\n userErrors {\n field\n message\n }\n }\n }\n}" #### Graphql Input { "productId": "gid://shopify/Product/20995642", "newTitle": "Copy of Product", "includeImages": true, "newStatus": "ACTIVE", "synchronous": false } #### Graphql Response { "data": { "productDuplicate": { "productDuplicateOperation": { "id": "gid://shopify/ProductDuplicateOperation/1010603707", "status": "CREATED", "newProduct": null, "userErrors": [] } } } }