Skip to main content

Channel

A sales channel, such as a merchant's Shopify store.

type Channel {
id: GlobalID!
channelType: ChannelType!
config: PlatformConfig!
createdAt: Timestamp!
environment: ChannelEnvironment!
exchangeRates: [ExchangeRate!]!
externalId: String!
identifier: String!
internal: Boolean!
name: String!
organisation: Organisation!
presentmentCurrencies: [CurrencyCode!]!
priority: ChannelPriority!
shippableCountries: [CountryCode!]!
shopCurrency: CurrencyCode!
status: ChannelStatus!
timezone: Timezone!
updatedAt: Timestamp!
}

Fields​

Channel.id ● GlobalID! non-null scalar types​

The channel's ID.

Channel.channelType ● ChannelType! non-null enum types​

The platform the channel runs on.

Channel.config ● PlatformConfig! non-null object types​

The channel's Submarine settings.

Channel.createdAt ● Timestamp! non-null scalar types​

The date and time when the channel was created.

Channel.environment ● ChannelEnvironment! non-null enum types​

Whether the channel is a development or production store.

Channel.exchangeRates ● [ExchangeRate!]! non-null object types​

The channel's current hourly exchange rates, one for each presentment currency other than the shop currency.

Channel.externalId ● String! non-null scalar types​

The channel's ID in its external platform, such as the Shopify shop ID.

Channel.identifier ● String! non-null scalar types​

The channel's unique identifier in its external platform, such as the shop's myshopify.com domain.

Channel.internal ● Boolean! non-null scalar types​

Whether the channel is flagged as internal.

Channel.name ● String! non-null scalar types​

The channel's name.

Channel.organisation ● Organisation! non-null object types​

The organisation the channel belongs to.

Channel.presentmentCurrencies ● [CurrencyCode!]! non-null enum types​

The currencies the channel can show prices in.

Channel.priority ● ChannelPriority! non-null enum types​

The channel's processing priority.

Channel.shippableCountries ● [CountryCode!]! non-null enum types​

The codes of the countries that the channel's active delivery profiles cover.

Channel.shopCurrency ● CurrencyCode! non-null enum types​

The channel's shop currency, the base currency its prices are set in.

Channel.status ● ChannelStatus! non-null enum types​

The channel's status.

Channel.timezone ● Timezone! non-null scalar types​

The channel's time zone.

Channel.updatedAt ● Timestamp! non-null scalar types​

The date and time when the channel was last updated.

Returned By​

channel query

Member Of​

ChannelConfigSetPayload object ● CrowdfundingCampaign object ● Customer object ● Order object ● Organisation object ● PaymentMethod object ● PresaleCampaign object ● Subscription object ● SubscriptionPlanGroup object ● Webhook object