Channel
Details of the channel
interface Channel$1 {
config_meta: ChannelConfigMeta;
currencies: ChannelCurrencies;
date_created: string;
date_modified: string;
external_id: string;
icon_url: string;
id: number;
is_enabled: boolean;
is_listable_from_ui: boolean;
is_visible: boolean;
name: string;
platform: string;
status: ChannelStatus;
type: ChannelType;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
config_meta | Required | ChannelConfigMeta | Optional channel configuration object. |
currencies | Required | ChannelCurrencies | Details about currency assignments for a specific channel. |
date_created | Required | string | Date on which the channel was first created. |
date_modified | Required | string | Date on which the channel was most recently changed. |
external_id | Required | string | Associated ID within a system / platform outside of BC. |
icon_url | Required | string | Link to the platform icon. |
id | Required | number | The ID of the channel. |
is_enabled | Required | boolean | |
is_listable_from_ui | Required | 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 | Required | 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 | Required | string | Name of the channel as it will appear to merchants in the control panel. |
platform | Required | string | The name of the platform for the channel; channel platform and type must be a valid combination. |
status | Required | 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 | Required | ChannelType | The type of channel; channel platform and type must be a valid combination. |