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. |
Field | Type | Description |
---|
offset | number | Offset from the beginning of the returned items list (for paging) |
limit | number | Maximum number of returned items. Default value: 100 . Default value: 10 |
A JSON object of type 'CustomerGroupsSearchResult' with the following fields:
Field | Type | Description |
---|
total | number | The total number of found items (might be more than the number of returned items) |
count | number | The number of returned items |
limit | number | Maximum number of returned items. Maximum allowed value: 100 . Default value: 10 |
offset | number | Offset from the beginning of the returned items list (for paging) |
items | Array | The items list |
Field | Type | Description |
---|
id | number | Unique internal customer group ID |
name | string | Customer group name |
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
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 |
Field | Type | Description |
---|
errorMessage | string | Error message |