Choose a version:

channelDelete

mutation

Deletes a Channel from the shop. All associated product feeds are removed. Existing orders attributed to the channel are preserved. The channel must have been created via channelCreate.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the channel to delete.

Was this section helpful?

Anchor to ChannelDeletePayload returnsChannelDeletePayload returns

Anchor to deletedIddeletedId •ID: The ID of the deleted channel.
Anchor to userErrorsuserErrors •[ChannelDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

channelDelete reference

Mutation Reference

mutation channelDelete($id: ID!) {

channelDelete(id: $id) {

deletedId

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100"

}