Skip to main content

channelDelete

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

Requires MANAGE_CHANNELSpermission.
channelDelete(
  id: ID!
  input: ChannelDeleteInput
): ChannelDelete

Arguments​

channelDelete.id ● ID! non-null scalar​

ID of a channel to delete.

channelDelete.input ● ChannelDeleteInput input​

Fields required to delete a channel.

Type​

ChannelDelete object​

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

Requires MANAGE_CHANNELSpermission.
Was this page helpful?