Skip to content

List of customer groups

Request

Returns list of customer groups ordered by priority. List is not paginated.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
languagestring

Language of the translatable fields in the response (e.g. cs). If not provided, the default language of the e-shop is used. Requires the "Foreign Languages" module; without it the request fails with the missing-module error.

Example:language=cs
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/customers/groups?language=cs' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "customerGroups": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}