Customers > Customer Groups > customerGroupsCreate
Commerce APICustomersCustomer GroupscustomerGroupsCreate
customerGroupsCreate
POST:customer_groups.json

Description

Create one or multple customer groups.

Permission bit: "customer_groups.create"

Topic: Customer Groups

Arguments

data: [CustomerGroupCreate!]!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

name: String!

Name of the customer group

Example: "Retailers"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


tax_exempt: Boolean

Makes all customers in the customer group as tax-exempt, customers will not be charged any taxes

Example: false


Result

[CustomerGroup!]

Preview (typescript)

Loading module