Alokai

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

NameRequiredTypeDescription
contextRequiredBigcommerceIntegrationContext
paramsOptionalRequestVariables

Returns

Returns a response with the Channel's Customer Settings object.

Referenced Types

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 });

On this page