getCustomerSettings
Get customer settings per channel id
It receives data from the getCustomerSettings endpoint exposed by the BigCommerce API.
Signature
declare function getCustomerSettings(
context: BigcommerceIntegrationContext,
params?: RequestVariables
): Promise<CustomerSettingsResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | BigcommerceIntegrationContext | |
params | Optional | RequestVariables |
Returns
Returns a response with the Channel's Customer Settings object.
Referenced Types
- BigcommerceIntegrationContext
RequestVariables- CustomerSettingsResponse
Examples
Get customer settings
import { sdk } from '~/sdk.config.ts';
const getCustomerSettingsResponse = await sdk.bigcommerce.getCustomerSettings();Get customer settings by channel id
import { sdk } from '~/sdk.config.ts';
const getCustomerSettingsResponse = await sdk.bigcommerce.getCustomerSettings({ channel: 123456 });