Channel
Represents channel.
type Channel implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
privateMetafield(key: String!): String
privateMetafields(keys: [String!]): Metadata
metadata: [MetadataItem!]!
metafield(key: String!): String
metafields(keys: [String!]): Metadata
slug: String!
name: String!
isActive: Boolean!
currencyCode: String!
hasOrders: Boolean!
defaultCountry: CountryDisplay!
warehouses: [Warehouse!]!
countries: [CountryDisplay!]
availableShippingMethodsPerCountry(
countries: [CountryCode!]
): [ShippingMethodsPerCountry!]
stockSettings: StockSettings!
orderSettings: OrderSettings!
checkoutSettings: CheckoutSettings!
paymentSettings: PaymentSettings!
}
Fields
Channel.id
● ID!
non-null scalar
The ID of the channel.
Channel.privateMetadata
● [MetadataItem!]!
non-null object
List of private metadata items. Requires staff permissions to access.
Added in Saleor 3.15
Channel.privateMetafield
● String
scalar
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.15
Channel.privateMetafield.key
●String!
non-null scalar
Channel.privateMetafields
● Metadata
scalar
Private metadata. Requires staff permissions to access. Use
Added in Saleor 3.15keys
to control which fields you want to include. The default is to include everything.
Channel.privateMetafields.keys
●[String!]
list scalar
Channel.metadata
● [MetadataItem!]!
non-null object
List of public metadata items. Can be accessed without permissions.
Added in Saleor 3.15
Channel.metafield
● String
scalar
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.15
Channel.metafield.key
●String!
non-null scalar
Channel.metafields
● Metadata
scalar
Public metadata. Use
Added in Saleor 3.15keys
to control which fields you want to include. The default is to include everything.
Channel.metafields.keys
●[String!]
list scalar
Channel.slug
● String!
non-null scalar
Slug of the channel.
Channel.name
● String!
non-null scalar
Name of the channel.
Channel.isActive
● Boolean!
non-null scalar
Whether the channel is active.
Channel.currencyCode
● String!
non-null scalar
A currency that is assigned to the channel.
Channel.hasOrders
● Boolean!
non-null scalar
Whether a channel has associated orders.
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
Channel.warehouses
● [Warehouse!]!
non-null object
List of warehouses assigned to this channel.
Added in Saleor 3.5
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
Channel.orderSettings
● OrderSettings!
non-null object
Channel-specific order settings.
Added in Saleor 3.12
Channel.checkoutSettings
● CheckoutSettings!
non-null object
Channel-specific checkout settings.
Added in Saleor 3.15This API is currently in Feature Preview and can be subject to changes at later point.
Channel.paymentSettings
● PaymentSettings!
non-null object
Channel-specific payment settings.
Added in Saleor 3.16This API is currently in Feature Preview and can be subject to changes at later point.
Interfaces
Node
interface
An object with an ID
ObjectWithMetadata
interface
Returned by
channel
query ● channels
query
Member of
AccountChangeEmailRequested
object ● AccountConfirmationRequested
object ● AccountConfirmed
object ● AccountDeleted
object ● AccountDeleteRequested
object ● AccountEmailChanged
object ● AccountSetPasswordRequested
object ● ChannelActivate
object ● ChannelCreate
object ● ChannelCreated
object ● ChannelDeactivate
object ● ChannelDelete
object ● ChannelDeleted
object ● ChannelMetadataUpdated
object ● ChannelReorderWarehouses
object ● ChannelStatusChanged
object ● ChannelUpdate
object ● ChannelUpdated
object ● Checkout
object ● CollectionChannelListing
object ● Group
object ● ListStoredPaymentMethods
object ● Order
object ● PaymentGatewayInitializeTokenizationSession
object ● PaymentMethodInitializeTokenizationSession
object ● PaymentMethodProcessTokenizationSession
object ● PluginConfiguration
object ● ProductChannelListing
object ● ProductVariantChannelListing
object ● SaleChannelListing
object ● ShippingMethodChannelListing
object ● ShippingZone
object ● StaffSetPasswordRequested
object ● StoredPaymentMethodDeleteRequested
object ● TaxableObject
object ● TaxConfiguration
object ● User
object ● VoucherChannelListing
object