getChannel
Fetches information about the channel
It receives data from the getChannel endpoint exposed by the BigCommerce API
Signature
declare function getChannel(
context: BigcommerceIntegrationContext,
params?: index_d_exports$1.GetChannelParams
): Promise<index_d_exports$1.GetChannelResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | BigcommerceIntegrationContext | |
params | Optional | index_d_exports$1.GetChannelParams |
Returns
Returns a response with the channel object
Referenced Types
Examples
Fetching a channel.
import { sdk } from '~/sdk.config.ts';
const channelResponse = await sdk.bigcommerce.getChannel()Fetching a channel.
import { sdk } from '~/sdk.config.ts';
const channel = 123456;
const channelResponse = await sdk.bigcommerce.getChannel({ channel });