Skip to main content

channel Query

Look up a channel by ID or slug.

channel(
  id: ID
  slug: String
): Channel
Details
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!
}

Arguments​

id ● ID​

ID of the channel.

slug ● String​

Slug of the channel.

Type​

Channel​

Represents channel.