Skip to main content
Version: 3.x

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!
  countries: [CountryDisplay!]
  availableShippingMethodsPerCountry(
    countries: [CountryCode!]
  ): [ShippingMethodsPerCountry!]
}

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 keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.15
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 keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.15
Channel.metafields.keys ● [String!] list scalar​

Channel.slug ● String! non-null scalar​

Slug of the channel.

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​

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Returned by​

channel query

Member of​

Checkout object ● Group object ● Order object ● ShippingZone object ● User object

Was this page helpful?