Skip to main content
Version: 3.x

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!
}

Fields

id (ID!)

slug (String!)

Slug of the channel.

name (String!)

Name of the channel.

Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.

isActive (Boolean!)

Whether the channel is active.

Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.

currencyCode (String!)

A currency that is assigned to the channel.

Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.

hasOrders (Boolean!)

Whether a channel has associated orders.

Requires one of the following permissions: MANAGE_CHANNELS.

defaultCountry (CountryDisplay!)

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_APP, AUTHENTICATED_STAFF_USER.

warehouses ([Warehouse!]!)

List of warehouses assigned to this channel.

Added in Saleor 3.5.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.

countries ([CountryDisplay!])

List of shippable countries for the channel.

Added in Saleor 3.6.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

availableShippingMethodsPerCountry ([ShippingMethodsPerCountry!])

Shipping methods that are available for the channel.

Added in Saleor 3.6.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

stockSettings (StockSettings!)

Define the stock setting for this channel.

Added in Saleor 3.7.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.

Interfaces

Node

An object with an ID