Global Settings
Get Customer Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/customers/settingsRequest
Returns the global-level customer settings.
Notes:
- Global customer settings don't apply on a channel when there are channel specific settings configured through Channel Settings.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/customers/settings' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Returns customer settings values for global level.
Body
object | application/json
dataobject
Customer Settings.
data
{
"privacy_settings": {
"ask_shopper_for_tracking_consent": true,
"policy_url": "https://bigcommmerce.com/policy"
},
"customer_group_settings": {
"guest_customer_group_id": 1,
"default_customer_group_id": 1
}
}
Update Customer Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/customers/settingsRequest
Updates the customer settings on the global level.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
Body
object | application/json
Customer Settings.
privacy_settingsobject
Controls the privacy settings.customer_group_settingsobject
The settings for a collection of customers.
example-1
{
"privacy_settings": {
"ask_shopper_for_tracking_consent": true,
"policy_url": "https://bigcommmerce.com/policy"
},
"customer_group_settings": {
"guest_customer_group_id": 0,
"default_customer_group_id": 0
}
}
Response
Customer settings are returned on a global level.
Body
object | application/json
dataobject
Customer Settings.
data
{
"privacy_settings": {
"ask_shopper_for_tracking_consent": true,
"policy_url": "https://bigcommerce.com/policy",
"ask_shopper_for_tracking_consent_on_checkout": false
},
"customer_group_settings": {
"guest_customer_group_id": 0,
"default_customer_group_id": 0
}
}
Did you find what you were looking for?