Skip to main content

Channel

Represents a sales or distribution channel within a tenant. Channels define distinct pathways for product sales and customer interaction.

type Channel {
  id: Int!
  channelId: Int! @deprecated
  name: String!
  descriptions: [LocalizedString!]
  catalogRootId: Int
  anonymousUserId: Int
  defaultLetterId: Int @deprecated
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  tenant: Tenant!
  shop: Shop @deprecated
}

Fields​

Channel.id ● Int! non-null scalar​

Unique identifier for the channel. Used for all channel-related operations and references.

Channel.channelId ● Int! deprecated non-null scalar​

DEPRECATED

Use id instead

[DEPRECATED] Legacy channel identifier. Maintained for backward compatibility - use 'id' field instead.

Channel.name ● String! non-null scalar​

Display name of the channel. Used in user interfaces and for channel identification.

Channel.descriptions ● [LocalizedString!] list object​

Localized descriptions of the channel in different languages. Provides multilingual support for channel information display.

Channel.catalogRootId ● Int scalar​

Reference to the root catalog item for this channel. Defines the top-level product hierarchy available through this channel.

Channel.anonymousUserId ● Int scalar​

Reference to the anonymous user account for this channel. Used for handling unauthenticated user sessions and default permissions.

Channel.defaultLetterId ● Int deprecated scalar​

DEPRECATED

To be removed

[DEPRECATED] Legacy letter template identifier. No longer used in current system architecture.

Channel.createdAt ● DateTime! non-null scalar​

Timestamp when the channel was created. Used for auditing and chronological ordering.

Channel.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the channel was last modified. Updated automatically on any channel changes.

Channel.tenant ● Tenant! non-null object​

Resolves the tenant that owns this channel. Provides access to tenant information and settings for the channel.

Errors: TENANT_GET_ERROR, TENANT_NOT_FOUND_ERROR if tenant doesn't exist.

AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

Channel.shop ● Shop deprecated object​

DEPRECATED

This field will be removed in a future version

[DEPRECATED] This field will be removed in a future version

Returned By​

channel query ● channelCreate mutation ● channels query ● channelUpdate mutation

Member Of​

Tenant object