CustomerGroups

customer Group Repository V1Get By Id Get

Get customer group by group ID.

get

/V1/customerGroups/{id}

Path parameters
idstringrequired

(Required)

Example: <integer>
Responses
curl -L \
  --url 'http://{{baseurl}}/V1/customerGroups/{id}'
{
  "code": "<string>",
  "tax_class_id": "<integer>",
  "id": "<integer>",
  "tax_class_name": "<string>",
  "extension_attributes": "<object>"
}

OK

customer Group Repository V1Save Put

Save customer group.

put

/V1/customerGroups/{id}

Path parameters
idstringrequired

(Required)

Example: <string>
Header parameters
Content-Typestring
Example: application/json
Body
object
Example: {"group":{"code":"<string>","tax_class_id":"<integer>","id":"<integer>","tax_class_name":"<string>","extension_attributes":"<object>"}}
Responses
curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/customerGroups/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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>"
}

OK

customer Group Repository V1Delete By Id Delete

Delete customer group by ID.

delete

/V1/customerGroups/{id}

Path parameters
idstringrequired

(Required)

Example: <integer>
Responses
curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/customerGroups/{id}'
true

OK

customer Group Repository V1Save Post

Save customer group.

post

/V1/customerGroups

Header parameters
Content-Typestring
Example: application/json
Body
object
Example: {"group":{"code":"<string>","tax_class_id":"<integer>","id":"<integer>","tax_class_name":"<string>","extension_attributes":"<object>"}}
Responses
curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/customerGroups' \
  --header 'Content-Type: application/json' \
  --data '{
    "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>"
}

OK

PreviousAPI referenceNextPermissions