Skip to main content
POST
Create product group detail
  • GroupNumber (1-5) and Name are required; Name must be unique within the group.
  • ParentGroupDetailId must be a detail of the previous group (2105). A group 1 detail cannot have a parent (2104).
  • A detail left without a parent can be selected under every parent of that group.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Body

GroupNumber
integer<int32>

Required. Which product group the detail belongs to: 1-5, matching GroupDetailId1...GroupDetailId5 of a product.

Example:

2

Name
null | string

Required. Detail name, unique within the group. At most 50 characters.

Example:

"SEDAN"

ParentGroupDetailId
null | string<uuid>

ID of the parent detail, which must belong to the previous group (GroupNumber - 1). Leave it empty to make the detail selectable under every parent. Group 1 details cannot have a parent.

Response

Created

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.