JTjtl-software
customerGroup

Create Customer Group

Create a new customer group

post/v2/customerGroups

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopescustomers.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopescustomers.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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.

Request body

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.

Response

The created customer group.

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.