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

Fields​

id ● ID!​

The ID of the channel.

privateMetadata ● [MetadataItem!]!​

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

privateMetafield ● String​

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

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

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

keys ● [String!]​

metadata ● [MetadataItem!]!​

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

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

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

keys ● [String!]​

slug ● String!​

Slug of the channel.

name ● String!​

Name of the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

isActive ● Boolean!​

Whether the channel is active.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

currencyCode ● String!​

A currency that is assigned to the channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

hasOrders ● Boolean!​

Whether a channel has associated orders.

Requires the MANAGE_CHANNELSpermission.

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.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

warehouses ● [Warehouse!]!​

List of warehouses assigned to this channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

countries ● [CountryDisplay!]​

List of shippable countries for the channel.

availableShippingMethodsPerCountry ● [ShippingMethodsPerCountry!]​

Shipping methods that are available for the channel.

countries ● [CountryCode!]​

stockSettings ● StockSettings!​

Define the stock setting for this channel.

Requires one of the following permissions: AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

orderSettings ● OrderSettings!​

Channel-specific order settings.

Requires one of the following permissions: MANAGE_CHANNELSMANAGE_ORDERS

checkoutSettings ● CheckoutSettings!​

Channel-specific checkout settings.

Requires one of the following permissions: MANAGE_CHANNELSMANAGE_CHECKOUTS

paymentSettings ● PaymentSettings!​

Channel-specific payment settings.

Requires one of the following permissions: MANAGE_CHANNELSHANDLE_PAYMENTS

taxConfiguration ● TaxConfiguration!​

Channel specific tax configuration.

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

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

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