Get information about all customer groups in an Ecwid store.
Headers
Name
Type
Description
Authorization
string
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
Query parameters
Field
Type
Description
offset
number
Offset from the beginning of the returned items list (for paging)
limit
number
Maximum number of returned items. Maximum allowed value: 1000. Default value: 100
keyword
string
Customer group search term. Used to search in customer group name only. If your keywords contain special characters, it may make sense to URL encode them before making a request.
customerGroupIds
string
Filter customer groups by several group IDs (e.g./customer_groups?customerGroupIds=0,1,2)
Response
A JSON object of type 'CustomerGroupsSearchResult' with the following fields:
CustomerGroupsSearchResult
Field
Type
Description
total
number
The total number of created customer groups (may differ from the number of returned items)
count
number
The number of returned items (excluding the default customer group)
offset
number
Offset from the beginning of the returned items list (for paging)
limit
number
Maximum number of returned items. Maximum allowed value: 1000. Default value: 100
items
Array
The items list
CustomerGroupsSearchEntry
Field
Type
Description
id
number
Unique internal customer group ID
name
string
Customer group name
Errors
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
HTTP Status
Meaning
400
Request parameters are malformed
402
Store doesn't have access to customer groups feature, it's available on Business plan an higher
415
Unsupported content-type: expected application/json or text/json
500
Cannot retrieve the customer groups info because of an error on the server