collectionDelete mutation

Version unstable

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

Argument Description
input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

CollectionDeleteInput 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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-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

Argument Description
input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

CollectionDeleteInput 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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-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

Argument Description
input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

CollectionDeleteInput 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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-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

Argument Description
input ( CollectionDeleteInput! ) required

Specifies the collection to delete by its ID.

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

  • u