Queries and mutations for managing Customer Groups in the platform.
Queries
Query Customer Groups
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Get Customer Group
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Customer Group
Update Customer Group
| Arguments | |
|---|---|
versionLong | |
actionsArray of CustomerGroupUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Customer Group
| Arguments | |
|---|---|
versionLong | |
idString | Queries with specified ID |
keyString | 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.
idString | Unique identifier of the CustomerGroup. |
versionLong | Current version of the CustomerGroup. |
nameString | Unique name of the CustomerGroup. |
keyString | 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
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of CustomerGroup |
Input types
CustomerGroupDraft
groupNameString | Unique value which must be different from any value used for name in CustomerGroup in the Project.
If not, a DuplicateField error is returned. |
keyString | User-defined unique identifier for the CustomerGroup. |
custom | Custom Fields for the CustomerGroup. |
CustomerGroupUpdateAction
changeName | |
setKey | |
setCustomType | |
setCustomField |
Update actions
Change Name
nameString | New name of the CustomerGroup. |
Set Key
keyString | If key is absent or null, the existing key, if any, will be removed. |
Set Custom Type
typeIdString | |
typeKeyString | |
type | |
fieldsArray of CustomFieldInput |
Set Custom Field
nameString | Name of the Custom Field. |
valueString | 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. |