Skip to main content

Channel

Represents channel.

type Channel implements Node {
  id: ID!
  slug: String!
  name: String!
  isActive: Boolean!
  currencyCode: String!
  hasOrders: Boolean!
  defaultCountry: CountryDisplay!
  warehouses: [Warehouse!]!
  countries: [CountryDisplay!]
  availableShippingMethodsPerCountry(
    countries: [CountryCode!]
  ): [ShippingMethodsPerCountry!]
  stockSettings: StockSettings!
  orderSettings: OrderSettings!
}

Fields​

Channel.id ● ID! non-null scalar​

Channel.slug ● String! non-null scalar​

Slug of the channel.

Channel.name ● String! non-null scalar​

Name of the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.isActive ● Boolean! non-null scalar​

Whether the channel is active.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.currencyCode ● String! non-null scalar​

A currency that is assigned to the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.hasOrders ● Boolean! non-null scalar​

Whether a channel has associated orders.

Requires MANAGE_CHANNELSpermission.

Channel.defaultCountry ● CountryDisplay! non-null object​

Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided.

Added in Saleor 3.1
Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.warehouses ● [Warehouse!]! non-null object​

List of warehouses assigned to this channel.

Added in Saleor 3.5
Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.countries ● [CountryDisplay!] list object​

List of shippable countries for the channel.

Added in Saleor 3.6

Channel.availableShippingMethodsPerCountry ● [ShippingMethodsPerCountry!] list object​

Shipping methods that are available for the channel.

Added in Saleor 3.6
Channel.availableShippingMethodsPerCountry.countries ● [CountryCode!] list enum​

Channel.stockSettings ● StockSettings! non-null object​

Define the stock setting for this channel.

Added in Saleor 3.7
Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.orderSettings ● OrderSettings! non-null object​

Channel-specific order settings.

Added in Saleor 3.12
Requires one of the following permissions: MANAGE_CHANNELSMANAGE_ORDERS

Interfaces​

Node interface​

An object with an ID

Returned by​

channel query ● channels query

Member of​

ChannelActivate object ● ChannelCreate object ● ChannelCreated object ● ChannelDeactivate object ● ChannelDelete object ● ChannelDeleted object ● ChannelReorderWarehouses object ● ChannelStatusChanged object ● ChannelUpdate object ● ChannelUpdated object ● Checkout object ● CollectionChannelListing object ● Group object ● Order object ● PluginConfiguration object ● ProductChannelListing object ● ProductVariantChannelListing object ● SaleChannelListing object ● ShippingMethodChannelListing object ● ShippingZone object ● TaxableObject object ● TaxConfiguration object ● User object ● VoucherChannelListing object

Was this page helpful?