CustomerGroups

customer Group Repository V1Get By Id Get

get

Get customer group by group ID.

Path parameters
idstringRequired

(Required)

Example: <integer>
Responses
200
OK
application/json
Responseobject
get
GET /V1/customerGroups/{id} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "code": "<string>",
  "tax_class_id": "<integer>",
  "id": "<integer>",
  "tax_class_name": "<string>",
  "extension_attributes": "<object>"
}

customer Group Repository V1Save Put

put

Save customer group.

Path parameters
idstringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"group":{"code":"<string>","tax_class_id":"<integer>","id":"<integer>","tax_class_name":"<string>","extension_attributes":"<object>"}}
Responses
200
OK
application/json
Responseobject
put
PUT /V1/customerGroups/{id} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "group": {
    "code": "<string>",
    "tax_class_id": "<integer>",
    "id": "<integer>",
    "tax_class_name": "<string>",
    "extension_attributes": "<object>"
  }
}
{
  "code": "<string>",
  "tax_class_id": "<integer>",
  "id": "<integer>",
  "tax_class_name": "<string>",
  "extension_attributes": "<object>"
}

customer Group Repository V1Delete By Id Delete

delete

Delete customer group by ID.

Path parameters
idstringRequired

(Required)

Example: <integer>
Responses
200
OK
application/json
Responseobject
delete
DELETE /V1/customerGroups/{id} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

customer Group Repository V1Save Post

post

Save customer group.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"group":{"code":"<string>","tax_class_id":"<integer>","id":"<integer>","tax_class_name":"<string>","extension_attributes":"<object>"}}
Responses
200
OK
application/json
Responseobject
post
POST /V1/customerGroups HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "group": {
    "code": "<string>",
    "tax_class_id": "<integer>",
    "id": "<integer>",
    "tax_class_name": "<string>",
    "extension_attributes": "<object>"
  }
}
{
  "code": "<string>",
  "tax_class_id": "<integer>",
  "id": "<integer>",
  "tax_class_name": "<string>",
  "extension_attributes": "<object>"
}
PreviousAPI referenceNextPermissions