Skip to main content
Anchor to collectionDuplicate

collectionDuplicate

mutation

Requires write_products access scope. Also: The store must not be on the Starter or Retail plans and user must have permission to create collections. If also copying publications, user must have permission to manage publications.

Duplicates a collection.

An existing collection ID and new title are required.

Publication Duplication

Publications may be excluded by passing copyPublications: false in the input.

Metafields

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

Anchor to Arguments

Arguments

Anchor to inputinput
•CollectionDuplicateInput!
required

The input for duplicating a collection.

Was this section helpful?

Anchor to CollectionDuplicatePayload returnsCollectionDuplicatePayload returns

Anchor to collectioncollection
•Collection

The newly created duplicate collection. Will contain all data if duplication completed synchronously. If async processing is required, the collection will be created but products will be added in the background and can be tracked via the job field or the collection's active_operations field.

Anchor to jobjob
•Job

The background job copying manually included products onto the target collection. Only returned if async processing is required, otherwise products will be copied synchronously when the collection is created.

Anchor to userErrorsuserErrors
•[CollectionDuplicateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?