Home > @vsf-enterprise/bigcommerce-api > Channel

# Channel interface

Details of the channel

Signature:

export interface Channel 

# Properties

Property Type Description
config_meta ChannelConfigMeta Optional channel configuration object.
currencies ChannelCurrencies Details about currency assignments for a specific channel.
date_created string Date on which the channel was first created.
date_modified string Date on which the channel was most recently changed.
external_id string Associated ID within a system / platform outside of BC.
icon_url string Link to the platform icon.
id number The ID of the channel.
is_enabled boolean
is_listable_from_ui boolean Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.
is_visible boolean Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.
name string Name of the channel as it will appear to merchants in the control panel.
platform string The name of the platform for the channel; channel platform and type must be a valid combination.
status ChannelStatus The status of the channel; channel type, platform, and status must be a valid combination. terminated is not valid for PUT or POST requests. deleted is not valid for POST requests.
type ChannelType The type of channel; channel platform and type must be a valid combination.