Skip to main content

salesChannelArchive

Archives a sales channel. Archived channels are hidden from channel lists and pickers and cannot receive new orders. Existing orders, financials, and reports keep showing them.

Business Rules​

  • The default sales channel cannot be archived. Set another default first.
  • A channel that an active integration sends new orders to cannot be archived. Point the integration at another channel first.
  • Archiving does not cascade. Integration mappings, product listings, prices, and warehouse settings stay as they are, so restoring the channel brings it back unchanged.
  • The handle stays reserved while the channel is archived.
  • Use archiveBlockingReasons on the sales channel to check before archiving.

Error Scenarios​

  • **NOT_FOUND**: the sales channel does not belong to this company.
  • **CONFLICT**: the channel is already archived, or an archiving rule blocks it. The message lists every reason.

Permissions Required​

  • orders:archive_sales_channel permission.
salesChannelArchive(
  input: SalesChannelArchiveInput!
): SalesChannel!

Arguments​

salesChannelArchive.input ● SalesChannelArchiveInput! non-null input common​

Parameters for SalesChannelArchive

Type​

SalesChannel object sales-channels​

Sales Channel​

Represents a sales channel within a brand. Sales channels define different sources through which orders can be placed and managed, including configuration for routing, fulfillment, and order processing behavior.