Skip to main content

Channel Object

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!
taxConfiguration: TaxConfiguration!
}
Expand ▼

Fields

Channel.id ● ID! non-null scalar miscellaneous

The ID of the channel.

Channel.privateMetadata ● [MetadataItem!]! non-null object miscellaneous

List of private metadata items. Requires staff permissions to access.

Channel.privateMetafield ● String scalar miscellaneous

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Channel.privateMetafield.key ● String! non-null scalar miscellaneous

Channel.privateMetafields ● Metadata scalar miscellaneous

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Channel.privateMetafields.keys ● [String!] list scalar miscellaneous

Channel.metadata ● [MetadataItem!]! non-null object miscellaneous

List of public metadata items. Can be accessed without permissions.

Channel.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Channel.metafield.key ● String! non-null scalar miscellaneous

Channel.metafields ● Metadata scalar miscellaneous

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Channel.metafields.keys ● [String!] list scalar miscellaneous

Channel.slug ● String! non-null scalar miscellaneous

Slug of the channel.

Channel.name ● String! non-null scalar miscellaneous

Name of the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.isActive ● Boolean! non-null scalar miscellaneous

Whether the channel is active.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.currencyCode ● String! non-null scalar miscellaneous

A currency that is assigned to the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.hasOrders ● Boolean! non-null scalar miscellaneous

Whether a channel has associated orders.

Requires MANAGE_CHANNELSpermission.

Channel.defaultCountry ● CountryDisplay! non-null object miscellaneous

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.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

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

List of warehouses assigned to this channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.countries ● [CountryDisplay!] list object miscellaneous

List of shippable countries for the channel.

Channel.availableShippingMethodsPerCountry ● [ShippingMethodsPerCountry!] list object shipping

Shipping methods that are available for the channel.

Channel.availableShippingMethodsPerCountry.countries ● [CountryCode!] list enum miscellaneous

Channel.stockSettings ● StockSettings! non-null object products

Define the stock setting for this channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

Channel.orderSettings ● OrderSettings! non-null object miscellaneous

Channel-specific order settings.

Requires one of the following permissions: MANAGE_CHANNELSMANAGE_ORDERS

Channel.checkoutSettings ● CheckoutSettings! non-null object miscellaneous

Channel-specific checkout settings.

Requires one of the following permissions: MANAGE_CHANNELSMANAGE_CHECKOUTS

Channel.paymentSettings ● PaymentSettings! non-null object miscellaneous

Channel-specific payment settings.

Requires one of the following permissions: MANAGE_CHANNELSHANDLE_PAYMENTS

Channel.taxConfiguration ● TaxConfiguration! non-null object taxes

Channel specific tax configuration.

Added in Saleor 3.20
Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

Interfaces

Node interface miscellaneous

An object with an ID

ObjectWithMetadata interface miscellaneous

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 ● PromotionRule object ● SaleChannelListing object ● ShippingMethodChannelListing object ● ShippingZone object ● StaffSetPasswordRequested object ● StoredPaymentMethodDeleteRequested object ● TaxableObject object ● TaxConfiguration object ● User object ● VoucherChannelListing object