Skip to navigation
GraphQLAdminTypesObjects

Channel

OBJECT
A channel.

Fields

idStringRequired
The ID of the object.
externalIdStringRequired

Associated ID within a system / platform outside of BC.

iconUrlStringRequired
Link to the platform icon.
isListableFromUiBooleanRequired
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.
isVisibleBooleanRequired

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.

nameStringRequired
Name of the channel as it will appear to merchants in the control panel.
platformStringRequired

The name of the platform for the channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.

typeStringRequired

The type of channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.

currenciesChannelCurrencyCodesOptional
Currency Assignments for the channel.
dateCreatedDatetimeOptional
Date on which the channel was first created.
dateModifiedDatetimeOptional
Date on which the channel was most recently changed.
settingsChannelSettingsOptional

Channel-level settings.

siteSiteOptional
A site.
statusChannelStatusOptional

The status of the channel; channel type, platform, and status must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#status to check for valid combination.

googleAgenticCommerceGoogleAgenticCommerceSetupOptional

This channel’s Google Agentic Commerce (UCP) product-feed setup, if any. Null if the channel has never started setup.