Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
customerGroup

Get Customer Group

Get a specific customergroup

get/v2/customerGroups/{customergroupId}

Path parameters

customergroupIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the Customergroup to return.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns the customergroup for the given id.

idstring uuid
namestring

The name of the customer group.

isDefaultboolean

Indicates if the customer group is the default group. Only one group can be selected as the default group.

discountnumber

The discounted percentage for the customer group.

isNetPriceboolean

Indicates if the customer group sees the net price in the online shop.

Example response

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}