Customers > Customer Groups > customerGroups
Commerce APICustomersCustomer GroupscustomerGroups
customerGroups
GET:customer_groups.json

Description

Get all or specific customer groups of a given shop.

This is a typical bulk get endpoint.

Permission bit: "customer_groups.read"

Topic: Customer Groups

Arguments

ids: [String!]

List of customer group ids. See also: Unique Identifiers

Example: ["cg_EQzGqWoY"]


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

[CustomerGroup!]

Preview (typescript)

Loading module