List product group details
curl --request GET \
--url https://api.noyax.com/api/v1/products/groups \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/groups");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/products/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/products/groups"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroup": "AUDİ"
}
],
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Groups
List product group details
Lists the selectable values of the product groups.
GET
/
api
/
v1
/
products
/
groups
List product group details
curl --request GET \
--url https://api.noyax.com/api/v1/products/groups \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/groups");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/products/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/products/groups"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroup": "AUDİ"
}
],
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Product groups are hierarchical: the parent of a detail (
The rule is validated when a product is saved: if
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.
AUDİ (group 1)
└── SEDAN (group 2, parent AUDİ)
└── JETTA (group 3, parent SEDAN)
SUV (group 2, no parent) -> selectable with every brand
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, sendparentGroup 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.
GET /api/v1/products/groups?groupNumber=3&parentGroup=<group 2 selection name>
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
Headers
Query Parameters
Response
OK