Skip to main content

ChannelDelete Object

Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.

Requires the MANAGE_CHANNELSpermission.

Triggers the following webhook events:

  • CHANNEL_DELETED (async): A channel was deleted.
type ChannelDelete {
channelErrors: [ChannelError!]! @deprecated
errors: [ChannelError!]!
channel: Channel
}

Fields

errors ● [ChannelError!]!

channel ● Channel

Show deprecated

Returned By

channelDelete mutation