Skip to main content
Anchor to CollectionDeletePayload

CollectionDeletePayload

payload

Return type for collectionDelete mutation.

•ID

The ID of the collection that was deleted. Returns null if the collection doesn't exist.

•Shop!
non-null

The shop associated with the collection.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Deletes a collection and removes it permanently from the store. This operation cannot be undone and will remove the collection from all sales channels where it was published.

For example, when merchants discontinue seasonal promotions or reorganize their catalog structure, they can delete outdated collections like "Back to School 2023" to keep their store organized.

Use CollectionDelete to:

  • Remove outdated or unused collections from stores
  • Clean up collection structures during catalog reorganization
  • Implement collection management tools with deletion capabilities

Products within the deleted collection remain in the store but are no longer grouped under that collection.

Learn more about collection management.


Was this section helpful?