Queries and mutations for managing Customer Groups in the platform.

Queries

Query Customer Groups

QUERYcustomerGroups
Arguments
where​
String​
sort​
Array of String​
limit​
Int​
offset​
Int​

Get Customer Group

QUERYcustomerGroup
Arguments
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Mutations

Create Customer Group

MUTATIONcreateCustomerGroup
Arguments
draft​

Update Customer Group

MUTATIONupdateCustomerGroup
Arguments
version​
Long​
actions​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Delete Customer Group

MUTATIONdeleteCustomerGroup
Arguments
version​
Long​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output types

CustomerGroup

A customer can be a member in a customer group (e.g. reseller, gold member). A customer group can be used in price calculations with special prices being assigned to certain customer groups.

id​
String​

Unique identifier of the CustomerGroup.

version​
Long​

Current version of the CustomerGroup.

name​
String​

Unique name of the CustomerGroup.

key​
String​

User-defined unique identifier for the CustomerGroup.

createdAt​

Date and time (UTC) the CustomerGroup was initially created.

lastModifiedAt​

Date and time (UTC) the CustomerGroup was last updated.

custom​

Custom Fields of the CustomerGroup.

createdBy​

IDs and references that created the CustomerGroup.

lastModifiedBy​

IDs and references that last modified the CustomerGroup.

CustomerGroupQueryResult

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of CustomerGroup​

Input types

CustomerGroupDraft

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 returned.
key​
String​

User-defined unique identifier for the CustomerGroup.

custom​

Custom Fields for the CustomerGroup.

CustomerGroupUpdateAction

changeName​
setKey​
setCustomType​
setCustomField​

Update actions

Change Name

name​
String​

New name of the CustomerGroup.

Set Key

key​
String​
If key is absent or null, the existing key, if any, will be removed.

Set Custom Type

typeId​
String​
typeKey​
String​
fields​
Array of CustomFieldInput​

Set Custom Field

name​
String​
Name of the Custom Field.
value​
String​
If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.