Skip to main content
Anchor to ChannelDefinition

ChannelDefinition

object

A specific selling surface within a sales channel platform. A channel definition identifies where products can be sold. Definitions can represent entire platforms (like Facebook or TikTok) or specific sales channels within those platforms, such as Instagram Shops, Instagram Shopping, or TikTok Live.

Each definition includes the parent Channel name and subchannel name to indicate the selling surface hierarchy. The marketplace flag identifies whether this surface represents a marketplace channel such as shops on Facebook, Instagram, or Buy on Google.

Anchor to FieldsFields

Anchor to channelNamechannelName
•String!
non-null

Name of the channel that this sub channel belongs to.

Anchor to handlehandle
•String!
non-null

Unique string used as a public identifier for the channel definition.

Anchor to idid
•ID!
non-null

The unique ID for the channel definition.

Anchor to isMarketplaceisMarketplace
•Boolean!
non-null

Whether this channel definition represents a marketplace.

Anchor to subChannelNamesubChannelName
•String!
non-null

Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).

Anchor to svgIconsvgIcon
•String
Deprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?