channelDelete Mutation

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 one of the following permissions:MANAGE_CHANNELS

Triggers the following webhook events:

CHANNEL_DELETED (async): A channel was deleted.

Applied directives

@webhookEventsInfo(asyncEvents: [CHANNEL_DELETED], syncEvents: [])

channelDelete(id: ID!, input: ChannelDeleteInput): ChannelDelete

Returns

ChannelDelete

Show return type

type ChannelDelete {
  channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
  errors: [ChannelError!]!
  channel: Channel
}

Arguments

id

id · ID!

ID of a channel to delete.

input

input · ChannelDeleteInput

Fields required to delete a channel.

Schema: Saleor 3.23.43. Download SDL.