Create product group detail
curl --request POST \
--url https://api.noyax.com/api/v1/products/groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"GroupNumber": 2,
"Name": "SEDAN"
}
'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>");
request.AddJsonBody("{\n \"GroupNumber\": 2,\n \"Name\": \"SEDAN\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({GroupNumber: 2, Name: 'SEDAN'})
};
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"
payload = {
"GroupNumber": 2,
"Name": "SEDAN"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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": "2105",
"Message": "ParentGroup must be a detail of the previous group in this company.",
"Errors": [
{
"Code": "2105",
"Message": "ParentGroup must be a detail of the previous group in this company."
}
]
}{
"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
Create product group detail
Adds a detail to a product group.
POST
/
api
/
v1
/
products
/
groups
Create product group detail
curl --request POST \
--url https://api.noyax.com/api/v1/products/groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"GroupNumber": 2,
"Name": "SEDAN"
}
'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>");
request.AddJsonBody("{\n \"GroupNumber\": 2,\n \"Name\": \"SEDAN\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({GroupNumber: 2, Name: 'SEDAN'})
};
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"
payload = {
"GroupNumber": 2,
"Name": "SEDAN"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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": "2105",
"Message": "ParentGroup must be a detail of the previous group in this company.",
"Errors": [
{
"Code": "2105",
"Message": "ParentGroup must be a detail of the previous group in this company."
}
]
}{
"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."
}
]
}GroupNumber(1-5) andNameare required;Namemust be unique within the group.ParentGroupmust 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.
Error codes
Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.| Code | HTTP | Meaning |
|---|---|---|
0002 | 400 | Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have |
0003 | 400 | A field exceeds its maximum length (the message names the field and the limit) |
2101 | 400 | Name is required |
2102 | 400 | The detail name is already used in this group; the response carries the existing record’s ID as ExistingId |
2103 | 400 | GroupNumber must be 1-5 |
2104 | 400 | A group 1 detail cannot have a parent |
2105 | 400 | ParentGroup must be a detail of the previous group |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created