Anchor to section titled 'undefined'product
product
mutation
2024-07
Requires write 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, 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 Product.
Anchor to section titled 'Arguments'
Arguments
Specifies whether or not to duplicate images.
Specifies whether or not to duplicate translations.
- Anchor to newStatusnewStatus
The new status of the product. If no value is provided the status will be inherited from the original product.
The new title of the product.
The ID of the product to be duplicated.
Was this section helpful?
Anchor to section titled 'ProductDuplicatePayload returns'
ProductDuplicatePayload returns
The asynchronous job that duplicates the product images.
The duplicated product.
The user's shop.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productDuplicate
Query Reference for MUTATION: productDuplicate
"mutation productDuplicate($newTitle: String!, $productId: ID!) {\n productDuplicate(newTitle: $newTitle, productId: $productId) {\n imageJob {\n # Job fields\n }\n newProduct {\n # Product fields\n }\n shop {\n # Shop fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productDuplicate
"{\n \"includeImages\": true,\n \"includeTranslations\": true,\n \"newStatus\": \"ACTIVE\",\n \"newTitle\": \"<your-newTitle>\",\n \"productId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: productDuplicate
""
Display Examples for MUTATION: productDuplicate
[
{
"example": {
"type_name": "productduplicate",
"title": "Duplicate a product",
"description": "Duplicating an image is done asynchronously. A job is created in the background, and the query will\nhave an empty lists of image, but will have image job id.\n\nWe can query for the state of duplication with the job id and once its done read the images\nthrough products(id: …) { images\n\nFor more information on product, refer to\n[Product](https://shopify.dev/api/admin-graphql/latest/objects/Product#connection-product-images).\n",
"query_string": "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}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"newTitle": "Copy of Product",
"includeImages": true,
"newStatus": "ACTIVE"
},
"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": []
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/slow/graph_api/admin/mutations/product_duplicate_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"newTitle\" => \"Copy of Product\",\n \"includeImages\" => true,\n \"newStatus\" => \"ACTIVE\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to be duplicated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "newTitle",
"description": "The new title of the product.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "String!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "newTitle",
"argValue": " \"Copy of Product\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "includeImages",
"description": "Specifies whether or not to duplicate images.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"list": false,
"non_null": false
},
"defaultValue": "false",
"typeSignature": "Boolean",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "includeImages",
"argValue": " true",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "newStatus",
"description": "The new status of the product. If no value is provided the status will be inherited from the original product.",
"type": {
"kind": "ENUM",
"name": "ProductStatus",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "ProductStatus",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "newStatus",
"argValue": " \"ACTIVE\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productduplicate",
"title": "Duplicate a product asynchronously and return productDuplicateOperation",
"description": "When synchronous is set to `false`, the product is duplicated asynchronously.\n\nThe state of duplication can be queried using the product duplicate operation ID that's returned.\nAfter the duplication process completes, the operation query returns the newly duplicated product in the `newProduct` field.\n",
"query_string": "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}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"newTitle": "Copy of Product",
"includeImages": true,
"newStatus": "ACTIVE",
"synchronous": false
},
"response": {
"data": {
"productDuplicate": {
"productDuplicateOperation": {
"id": "gid://shopify/ProductDuplicateOperation/1010603707",
"status": "CREATED",
"newProduct": null,
"userErrors": []
}
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/slow/graph_api/admin/mutations/product_duplicate_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\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$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to be duplicated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "newTitle",
"description": "The new title of the product.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "String!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "newTitle",
"argValue": " \"Copy of Product\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "includeImages",
"description": "Specifies whether or not to duplicate images.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"list": false,
"non_null": false
},
"defaultValue": "false",
"typeSignature": "Boolean",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "includeImages",
"argValue": " true",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "newStatus",
"description": "The new status of the product. If no value is provided the status will be inherited from the original product.",
"type": {
"kind": "ENUM",
"name": "ProductStatus",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "ProductStatus",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "newStatus",
"argValue": " \"ACTIVE\"",
"typeKind": "MUTATION"
}
]
}
]