Customer Groups

A Customer can be a member of a customer group (e.g. reseller, gold member). Special prices can be assigned to specific products based on a customer group.

Representations

CustomerGroup

CustomerGroup fields that can be used in query predicates: name.

CustomerGroupDraft

Get CustomerGroup by ID

Endpoint: /{projectKey}/customer-groups/{id}
Method: GET
OAuth2 Scopes: view_customers:{projectKey}
Response Representation: CustomerGroup

Query CustomerGroups

Endpoint: /{projectKey}/customer-groups
Method: GET
OAuth2 Scopes: view_customers:{projectKey}
Response Representation: PagedQueryResult with the results array of CustomerGroup
Query Parameters:

Create a CustomerGroup

Endpoint: /{projectKey}/customer-groups
Method: POST
OAuth2 Scopes: manage_customers:{projectKey}
Request Representation: CustomerGroupDraft
Response Representation: CustomerGroup

Update CustomerGroup

Endpoint: /{projectKey}/customer-groups/{id}
Method: POST
OAuth2 Scopes: manage_customers:{projectKey}
Response Representation: CustomerGroup
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Change Name

Delete CustomerGroup

Endpoint: /{projectKey}/customer-groups/{id}
Method: DELETE
OAuth2 Scopes: manage_customers:{projectKey}
Query Parameters:

comments powered by Disqus