API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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

    List of errors that occurred executing the mutation.

Version 2021-04 (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!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (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!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

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

    List of errors that occurred executing the mutation.

Version 2020-07

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

    List of errors that occurred executing the mutation.

Version 2020-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.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

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

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

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

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

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

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

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

    List of errors that occurred executing the mutation.