We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

collectionDelete

Version 2019-04

Deletes a collection.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

Input Fields

id (ID!) Required

The ID of the collection to be deleted.

Return Fields

deletedCollectionId (ID)

The ID of the collection that was deleted.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Deletes a collection.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

Input Fields

id (ID!) Required

The ID of the collection to be deleted.

Return Fields

deletedCollectionId (ID)

The ID of the collection that was deleted.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Deletes a collection.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

Input Fields

id (ID!) Required

The ID of the collection to be deleted.

Return Fields

deletedCollectionId (ID)

The ID of the collection that was deleted.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up