Skip to main content
GET
List product group details
Product groups are hierarchical: the parent of a detail (ParentGroup) is always a detail of the previous group.
  • Group 1 details have no parent, so all of them are always selectable.
  • Once a detail is selected in group 2, only the details whose parent is that detail and the details without a parent can be selected in group 3. The same rule applies for 3 → 4 and 4 → 5.
  • A detail without a parent can be selected under every parent. For example a “SUV” body type that is valid for every brand is defined without a parent.
The rule is validated when a product is saved: if Group3 is a detail whose parent is neither the detail selected in Group2 nor empty, the request is rejected with 2013.

Getting the selectable details

When a detail is selected in the previous group, send parentGroup together with groupNumber: the response contains the children of that parent plus the details without a parent, which is exactly what the drop-down on the screen shows.

Error codes

This endpoint has no endpoint-specific error codes. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) still apply.

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; if sent, it is written to created records.

Required range: x >= 1

Query Parameters

groupNumber
integer<int32>

Returns only the details of this group (1-5).

parentGroup
string

Name of a detail of the previous group (groupNumber - 1). Returns only the details whose parent is this detail, plus the details without a parent.

Response

OK

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
null | object[]
required

Response data. Null when Success is false.

Message
null | string

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