productDuplicate
mutation

Choose a version:

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, 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.

Anchor to section titled 'Arguments'

Arguments

Anchor to includeImages includeImages Boolean default:false: Specifies whether or not to duplicate images.
Anchor to includeTranslations includeTranslations Boolean default:false: Specifies whether or not to duplicate translations.
Anchor to newStatus newStatus ProductStatus: The new status of the product. If no value is provided the status will be inherited from the original product.
Anchor to newTitle newTitle String! required: The new title of the product.
Anchor to productId productId ID! required: The ID of the product to be duplicated.

Was this section helpful?

Anchor to section titled 'ProductDuplicatePayload returns'

ProductDuplicatePayload returns

Anchor to ProductDuplicatePayload.imageJob imageJob Job: The asynchronous job that duplicates the product images.
Anchor to ProductDuplicatePayload.newProduct newProduct Product: The duplicated product.
Anchor to ProductDuplicatePayload.shop shop Shop! non-null: The user's shop.
Anchor to ProductDuplicatePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

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
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } }",
 "variables": {
    "productId": "gid://shopify/Product/20995642",
    "newTitle": "Copy of Product",
    "includeImages": true,
    "newStatus": "ACTIVE"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  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
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/20995642",
      "newTitle": "Copy of Product",
      "includeImages": true,
      "newStatus": "ACTIVE"
    },
  },
);

const data = await response.json();

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/20995642",
  "newTitle": "Copy of Product",
  "includeImages": true,
  "newStatus": "ACTIVE"
}

response = client.query(query: query, variables: variables)

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/20995642",
      "newTitle": "Copy of Product",
      "includeImages": true,
      "newStatus": "ACTIVE"
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<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
      }
    }
  }
QUERY;

$variables = [
  "productId" => "gid://shopify/Product/20995642",
  "newTitle" => "Copy of Product",
  "includeImages" => true,
  "newStatus" => "ACTIVE",
];

$response = $client->query(["query" => $query, "variables" => $variables]);

Input variables

{
  "productId": "gid://shopify/Product/20995642",
  "newTitle": "Copy of Product",
  "includeImages": true,
  "newStatus": "ACTIVE"
}

productDuplicatemutation

Arguments

ProductDuplicatePayload returns

Examples

productDuplicate
mutation