getCustomerSettings

Method to get customer settings per channel id

This method sends a POST request to the getCustomerSettings endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getCustomerSettings endpoint exposed by the BigCommerce API.

The channel id cannot be passed manually and is picked up by the middleware from the cookie 'x-bigcommerce-channel-id' in the requests header.

Signature

declare function getCustomerSettings$1(
	options?: MethodOptions
): Promise<CustomerSettingsResponse>;

Parameters

Returns

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

Referenced Types

• CustomerSettingsResponse

Examples

Get customer settings

import { sdk } from '~/sdk.config.ts';

const getCustomerSettingsResponse = await sdk.bigcommerce.getCustomerSettings();