> Documentation index: [Saleor](/llms.txt) · [This section](/api-reference/channels/llms.txt)
> Source: https://docs.saleor.io/api-reference/channels/objects/channel

# Channel Object

Represents channel.

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

<a id="fields"></a>

### Fields

<a id="id"></a>

#### [`id`](#id) ● [`ID!`](/api-reference/miscellaneous/scalars/id.md)

The ID of the channel.

<a id="private-metadata"></a>

#### [`privateMetadata`](#private-metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="private-metafield"></a>

#### [`privateMetafield`](#private-metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

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

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="channel-private-metafield-key"></a>

##### [`key`](#channel-private-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="private-metafields"></a>

#### [`privateMetafields`](#private-metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="channel-private-metafields-keys"></a>

##### [`keys`](#channel-private-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="metadata"></a>

#### [`metadata`](#metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="metafield"></a>

#### [`metafield`](#metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="channel-metafield-key"></a>

##### [`key`](#channel-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="metafields"></a>

#### [`metafields`](#metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="channel-metafields-keys"></a>

##### [`keys`](#channel-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="slug"></a>

#### [`slug`](#slug) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Slug of the channel.

<a id="name"></a>

#### [`name`](#name) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Name of the channel.

Requires one of the following permissions: AUTHENTICATED\_APP AUTHENTICATED\_STAFF\_USER

<a id="is-active"></a>

#### [`isActive`](#is-active) ● [`Boolean!`](/api-reference/miscellaneous/scalars/boolean.md)

Whether the channel is active.

Requires one of the following permissions: AUTHENTICATED\_APP AUTHENTICATED\_STAFF\_USER

<a id="currency-code"></a>

#### [`currencyCode`](#currency-code) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

A currency that is assigned to the channel.

Requires one of the following permissions: AUTHENTICATED\_APP AUTHENTICATED\_STAFF\_USER

<a id="has-orders"></a>

#### [`hasOrders`](#has-orders) ● [`Boolean!`](/api-reference/miscellaneous/scalars/boolean.md)

Whether a channel has associated orders.

Requires the MANAGE\_CHANNELS permission.

<a id="default-country"></a>

#### [`defaultCountry`](#default-country) ● [`CountryDisplay!`](/api-reference/miscellaneous/objects/country-display.md)

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\_APP AUTHENTICATED\_STAFF\_USER

<a id="warehouses"></a>

#### [`warehouses`](#warehouses) ● [`[Warehouse!]!`](/api-reference/products/objects/warehouse.md)

List of warehouses assigned to this channel.

Requires one of the following permissions: AUTHENTICATED\_APP AUTHENTICATED\_STAFF\_USER

<a id="countries"></a>

#### [`countries`](#countries) ● [`[CountryDisplay!]`](/api-reference/miscellaneous/objects/country-display.md)

List of shippable countries for the channel.

<a id="available-shipping-methods-per-country"></a>

#### [`availableShippingMethodsPerCountry`](#available-shipping-methods-per-country) ● [`[ShippingMethodsPerCountry!]`](/api-reference/shipping/objects/shipping-methods-per-country.md)

Shipping methods that are available for the channel.

<a id="channel-available-shipping-methods-per-country-countries"></a>

##### [`countries`](#channel-available-shipping-methods-per-country-countries) ● [`[CountryCode!]`](/api-reference/miscellaneous/enums/country-code.md)

<a id="stock-settings"></a>

#### [`stockSettings`](#stock-settings) ● [`StockSettings!`](/api-reference/products/objects/stock-settings.md)

Define the stock setting for this channel.

Requires one of the following permissions: AUTHENTICATED\_APP AUTHENTICATED\_STAFF\_USER

<a id="order-settings"></a>

#### [`orderSettings`](#order-settings) ● [`OrderSettings!`](/api-reference/miscellaneous/objects/order-settings.md)

Channel-specific order settings.

Requires one of the following permissions: MANAGE\_CHANNELS MANAGE\_ORDERS

<a id="checkout-settings"></a>

#### [`checkoutSettings`](#checkout-settings) ● [`CheckoutSettings!`](/api-reference/miscellaneous/objects/checkout-settings.md)

Channel-specific checkout settings.

Requires one of the following permissions: MANAGE\_CHANNELS MANAGE\_CHECKOUTS

<a id="payment-settings"></a>

#### [`paymentSettings`](#payment-settings) ● [`PaymentSettings!`](/api-reference/miscellaneous/objects/payment-settings.md)

Channel-specific payment settings.

Requires one of the following permissions: MANAGE\_CHANNELS HANDLE\_PAYMENTS

<a id="tax-configuration"></a>

#### [`taxConfiguration`](#tax-configuration) ● [`TaxConfiguration!`](/api-reference/taxes/objects/tax-configuration.md)

Channel specific tax configuration.

Added in Saleor 3.20

Requires one of the following permissions: AUTHENTICATED\_STAFF\_USER AUTHENTICATED\_APP

<a id="interfaces"></a>

### Interfaces

<a id="node"></a>

#### [`Node`](/api-reference/miscellaneous/interfaces/node.md)

An object with an ID

<a id="objectwithmetadata"></a>

#### [`ObjectWithMetadata`](/api-reference/miscellaneous/interfaces/object-with-metadata.md)

<a id="returned-by"></a>

### Returned By

[`channel`](/api-reference/channels/queries/channel.md) query  ● [`channels`](/api-reference/channels/queries/channels.md) query

<a id="member-of"></a>

### Member Of

[`AccountChangeEmailRequested`](/api-reference/users/objects/account-change-email-requested.md) object  ● [`AccountConfirmationRequested`](/api-reference/users/objects/account-confirmation-requested.md) object  ● [`AccountConfirmed`](/api-reference/users/objects/account-confirmed.md) object  ● [`AccountDeleted`](/api-reference/users/objects/account-deleted.md) object  ● [`AccountDeleteRequested`](/api-reference/users/objects/account-delete-requested.md) object  ● [`AccountEmailChanged`](/api-reference/users/objects/account-email-changed.md) object  ● [`AccountSetPasswordRequested`](/api-reference/users/objects/account-set-password-requested.md) object  ● [`ChannelActivate`](/api-reference/channels/objects/channel-activate.md) object  ● [`ChannelCreate`](/api-reference/channels/objects/channel-create.md) object  ● [`ChannelCreated`](/api-reference/channels/objects/channel-created.md) object  ● [`ChannelDeactivate`](/api-reference/channels/objects/channel-deactivate.md) object  ● [`ChannelDelete`](/api-reference/channels/objects/channel-delete.md) object  ● [`ChannelDeleted`](/api-reference/channels/objects/channel-deleted.md) object  ● [`ChannelMetadataUpdated`](/api-reference/channels/objects/channel-metadata-updated.md) object  ● [`ChannelReorderWarehouses`](/api-reference/channels/objects/channel-reorder-warehouses.md) object  ● [`ChannelStatusChanged`](/api-reference/channels/objects/channel-status-changed.md) object  ● [`ChannelUpdate`](/api-reference/channels/objects/channel-update.md) object  ● [`ChannelUpdated`](/api-reference/channels/objects/channel-updated.md) object  ● [`Checkout`](/api-reference/checkout/objects/checkout.md) object  ● [`CollectionChannelListing`](/api-reference/products/objects/collection-channel-listing.md) object  ● [`Group`](/api-reference/users/objects/group.md) object  ● [`ListStoredPaymentMethods`](/api-reference/payments/objects/list-stored-payment-methods.md) object  ● [`Order`](/api-reference/orders/objects/order.md) object  ● [`PaymentGatewayInitializeTokenizationSession`](/api-reference/payments/objects/payment-gateway-initialize-tokenization-session.md) object  ● [`PaymentMethodInitializeTokenizationSession`](/api-reference/payments/objects/payment-method-initialize-tokenization-session.md) object  ● [`PaymentMethodProcessTokenizationSession`](/api-reference/payments/objects/payment-method-process-tokenization-session.md) object  ● [`PluginConfiguration`](/api-reference/miscellaneous/objects/plugin-configuration.md) object  ● [`ProductChannelListing`](/api-reference/products/objects/product-channel-listing.md) object  ● [`ProductVariantBackInStockForClickAndCollect`](/api-reference/products/objects/product-variant-back-in-stock-for-click-and-collect.md) object  ● [`ProductVariantBackInStockInChannel`](/api-reference/products/objects/product-variant-back-in-stock-in-channel.md) object  ● [`ProductVariantChannelListing`](/api-reference/products/objects/product-variant-channel-listing.md) object  ● [`ProductVariantDiscountedPriceUpdated`](/api-reference/products/objects/product-variant-discounted-price-updated.md) object  ● [`ProductVariantOutOfStockForClickAndCollect`](/api-reference/products/objects/product-variant-out-of-stock-for-click-and-collect.md) object  ● [`ProductVariantOutOfStockInChannel`](/api-reference/products/objects/product-variant-out-of-stock-in-channel.md) object  ● [`PromotionRule`](/api-reference/discounts/objects/promotion-rule.md) object  ● [`SaleChannelListing`](/api-reference/discounts/objects/sale-channel-listing.md) object  ● [`ShippingMethodChannelListing`](/api-reference/shipping/objects/shipping-method-channel-listing.md) object  ● [`ShippingZone`](/api-reference/shipping/objects/shipping-zone.md) object  ● [`StaffSetPasswordRequested`](/api-reference/users/objects/staff-set-password-requested.md) object  ● [`StoredPaymentMethodDeleteRequested`](/api-reference/payments/objects/stored-payment-method-delete-requested.md) object  ● [`TaxableObject`](/api-reference/taxes/objects/taxable-object.md) object  ● [`TaxConfiguration`](/api-reference/taxes/objects/tax-configuration.md) object  ● [`User`](/api-reference/users/objects/user.md) object  ● [`VoucherChannelListing`](/api-reference/discounts/objects/voucher-channel-listing.md) object