Global Settings

Get Customer Settings

GET /customers/settings

Request

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

Response

Returns customer settings values for global level.

Body

object | application/json
  • data
    object

    Customer Settings.
  • meta
    object

data

Update Customer Settings

PUT /customers/settings

Request

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_settings
    object

    Controls the privacy settings.
  • customer_group_settings
    object

    The settings for a collection of customers.

example-1

Response

Customer settings are returned on a global level.

Body

object | application/json
  • data
    object

    Customer Settings.
  • meta
    object

data

Did you find what you were looking for?