Customer Groups

A Customer can be a member of a Customer Group (for example, reseller, gold member). Special prices can be assigned to specific products based on a Customer Group.

A maximum number of 1 000 Customer Groups can be created per Project. Learn more about this limit.

Representations

CustomerGroup

CustomerGroupDraft

CustomerGroupPagedQueryResponse

CustomerGroupReference

CustomerGroupResourceIdentifier

CustomerGroup

`id` String	Unique ID of the Customer Group.
`version` Int	Current version of the Customer Group.
`key` String	User-defined unique identifier for the Customer Group.
`createdAt` DateTime	Date and time (UTC) the Customer Group was initially created.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Date and time (UTC) the Customer Group was last updated.
`lastModifiedBy`BETA LastModifiedBy	Present on resources updated after 1 February 2019 except for events not tracked.
`name` String	Unique name of the Customer Group.
`custom` CustomFields	Custom Fields for the Customer Group.

CustomerGroupDraft

`key` String	User-defined unique identifier for the Customer Group. Keys can only contain alphanumeric characters, underscores, and hyphens. MaxLength: `256`MinLength: `2`Pattern: `^[A-Za-z0-9_-]+$`
`groupName` String	Unique value which must be different from any value used for `name` in CustomerGroup in the Project. If not, a `DuplicateField` error is thrown.
`custom` CustomFieldsDraft	Custom Fields for the Customer Group.

CustomerGroupPagedQueryResponse

PagedQueryResult with results containing an array of CustomerGroup.

`limit` Int	Number of results requested in the query request.
`offset` Int	Offset supplied by the client or server default. It is the number of elements skipped, not a page number.
`count` Int	Actual number of results returned.
`total` Int	Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`. When the results are filtered with a Query Predicate, `total` is subject to a limit.
`results` Array of CustomerGroup	CustomerGroups matching the query.

CustomerGroupReference

Reference to a CustomerGroup.

`id` String	Unique ID of the referenced CustomerGroup.
`typeId` String	`"customer-group"`
`obj` CustomerGroup	Contains the representation of the expanded Customer Group. Only present in responses to requests with Reference Expansion for Customer Groups.

CustomerGroupResourceIdentifier

ResourceIdentifier to a CustomerGroup.

`id` String	Unique ID of the referenced CustomerGroup. Either `id` or `key` is required.
`key` String	Unique key of the referenced CustomerGroup. Either `id` or `key` is required.
`typeId` String	`"customer-group"`

Get CustomerGroup

Get CustomerGroup by ID

GET

https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id}

OAuth 2.0 Scopes:

view_customers:{projectKey}, view_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CustomerGroup.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CustomerGroup

Request Example:cURL

curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Get CustomerGroup by Key

GET

https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key}

OAuth 2.0 Scopes:

view_customers:{projectKey}, view_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CustomerGroup.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CustomerGroup

Request Example:cURL

curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Query CustomerGroups

GET

https://api.{region}.commercetools.com/{projectKey}/customer-groups

OAuth 2.0 Scopes:

view_customers:{projectKey}, view_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	Queryable field: `name` The parameter can be passed multiple times.
`/^var[.][a-zA-Z0-9]+$/` Any string parameter matching this regular expression	Predicate parameter values. The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results returned.
`offset` Int	Number of results skipped.
`withTotal` Boolean	Calculate total number of results.

Response:

200CustomerGroupPagedQueryResponse

Request Example:cURL

curl -X GET https://api.{region}.commercetools.com/{projectKey}/customer-groups -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Create CustomerGroup

POST

https://api.{region}.commercetools.com/{projectKey}/customer-groups

OAuth 2.0 Scopes:

manage_customers:{projectKey}, manage_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:CustomerGroupDraft

Response:

201CustomerGroup

Request Example:cURL

curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "groupName" : "Webshop user"
}
DATA

Update CustomerGroup

Update CustomerGroup by ID

POST

https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id}

OAuth 2.0 Scopes:

manage_customers:{projectKey}, manage_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CustomerGroup.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

`version` Int	Expected version of the Customer Group on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.
`actions` Array of CustomerGroupUpdateAction	Update actions to be performed on the Customer Group.

Response:

200CustomerGroup

Request Example:cURL

curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeName",
    "name" : "New Name"
  } ]
}
DATA

Update CustomerGroup by Key

POST

https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key}

OAuth 2.0 Scopes:

manage_customers:{projectKey}, manage_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CustomerGroup.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

`version` Int	Expected version of the Customer Group on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.
`actions` Array of CustomerGroupUpdateAction	Update actions to be performed on the Customer Group.

Response:

200CustomerGroup

Request Example:cURL

curl -X POST https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeName",
    "name" : "New Name"
  } ]
}
DATA

Update actions

Change Name

`action` String	`"changeName"`
`name` String	New name of the Customer Group.

Example: json

{
  "action" : "changeName",
  "name" : "New Name"
}

Set Key

`key` String	If `key` is absent or `null`, the existing key, if any, will be removed.
`action` String	`"setKey"`

Example: json

{
  "action" : "setKey",
  "key" : "newKey"
}

Set Custom Type

This action sets or removes the custom type for an existing Customer Group. If present, this action overwrites any existing custom type and fields.

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	If absent, the custom type and any existing CustomFields are removed.
`fields` FieldContainer	Valid JSON object, based on the FieldDefinitions of the Type. Sets the custom fields to this value.

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

Set Custom Field

`action` String	`"setCustomField"`
`name` String	Name of the Custom Field.
`value` Any	Value must be of type Value. If `value` is absent or `null`, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

Delete CustomerGroup

Delete CustomerGroup by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id}

OAuth 2.0 Scopes:

manage_customers:{projectKey}, manage_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CustomerGroup.

Query parameters:

`expand` Expansion	The parameter can be passed multiple times.
`version` Int	Last seen version of the resource.

Response:

200CustomerGroup

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customer-groups/{id}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Delete CustomerGroup by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key}

OAuth 2.0 Scopes:

manage_customers:{projectKey}, manage_customer_groups:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CustomerGroup.

Query parameters:

`expand` Expansion	The parameter can be passed multiple times.
`version` Int	Last seen version of the resource.

Response:

200CustomerGroup

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/customer-groups/key={key}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'