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

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the channel.

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

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

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

slug

slug · String!

Slug of the channel.

name

name · String!

Name of the channel.

Requires one of the following permissions:AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

isActive

isActive · Boolean!

Whether the channel is active.

Requires one of the following permissions:AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

currencyCode

currencyCode · String!

A currency that is assigned to the channel.

Requires one of the following permissions:AUTHENTICATED_APPAUTHENTICATED_STAFF_USER

hasOrders

hasOrders · Boolean!

Whether a channel has associated orders.

Requires one of the following permissions:MANAGE_CHANNELS

defaultCountry

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