curl --request PATCH \
--url https://api.noyax.com/api/v1/products/groups/{groupDetailId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/groups/{groupDetailId}");
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 \"ParentGroupDetailId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
GroupNumber: 2,
Name: 'SEDAN',
ParentGroupDetailId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.noyax.com/api/v1/products/groups/{groupDetailId}', 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/{groupDetailId}"
payload = {
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParentName": "AUDİ",
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "2102",
"Message": "Product group detail name 'SEDAN' is already used in this group.",
"Errors": [
{
"Code": "2102",
"Message": "Product group detail name 'SEDAN' is already used in this group."
}
]
}{
"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": "2100",
"Message": "Product group detail not found.",
"Errors": [
{
"Code": "2100",
"Message": "Product group detail not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Partially update product group detail
Changes only the sent fields of a product group detail.
curl --request PATCH \
--url https://api.noyax.com/api/v1/products/groups/{groupDetailId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/groups/{groupDetailId}");
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 \"ParentGroupDetailId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
GroupNumber: 2,
Name: 'SEDAN',
ParentGroupDetailId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.noyax.com/api/v1/products/groups/{groupDetailId}', 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/{groupDetailId}"
payload = {
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParentName": "AUDİ",
"GroupNumber": 2,
"Name": "SEDAN",
"ParentGroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "2102",
"Message": "Product group detail name 'SEDAN' is already used in this group.",
"Errors": [
{
"Code": "2102",
"Message": "Product group detail name 'SEDAN' is already used in this group."
}
]
}{
"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": "2100",
"Message": "Product group detail not found.",
"Errors": [
{
"Code": "2100",
"Message": "Product group detail not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}- Send
"ParentGroupDetailId": nullto remove the parent; the detail then becomes selectable under every parent. ParentGroupDetailIdcannot be changed while other details use this detail as their parent (2109).
Authorizations
Access token obtained from the Noyax auth service with your API key.
Headers
ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.
x >= 1ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.
x >= 1ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.
x >= 1Path Parameters
Product group detail ID.
Body
Required. Which product group the detail belongs to: 1-5, matching GroupDetailId1...GroupDetailId5 of a product.
2
Required. Detail name, unique within the group. At most 50 characters.
"SEDAN"
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
OK
Whether the operation succeeded.
true
"0000" on success. On failure, the code of the first error; all errors are listed in Errors.
"0000"
Show child attributes
Show child attributes
Error message when Success is false. Messages of all errors are joined into a single text.