stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > ChannelDefinition

AdminTypes.ChannelDefinition interface

A channel definition represents channels surfaces on the platform. A channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat.

Signature:

export interface ChannelDefinition extends Node 

Extends: Node

Properties

Property Modifiers Type Description
channelName   Scalars[‘String’][‘output’] Name of the channel that this sub channel belongs to.
handle   Scalars[‘String’][‘output’] Unique string used as a public identifier for the channel definition.
id   Scalars[‘ID’][‘output’] The unique ID for the channel definition.
isMarketplace   Scalars[‘Boolean’][‘output’] Whether this channel definition represents a marketplace.
subChannelName   Scalars[‘String’][‘output’] Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).
svgIcon?   Maybe<Scalars[‘String’][‘output’]> (Optional) Icon displayed when showing the channel in admin.