curl --request PATCH \
--url https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}");
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 \"DistrictId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\",\n \"PostalCode\": \"34710\",\n \"IsInvoiceAddress\": true,\n \"CoordinateX\": 40.9877,\n \"CoordinateY\": 29.0254\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({
DistrictId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
Address: 'Caferağa Mah. Moda Cad. No: 10',
PostalCode: '34710',
IsInvoiceAddress: true,
CoordinateX: 40.9877,
CoordinateY: 29.0254
})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}"
payload = {
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"PostalCode": "34710",
"IsInvoiceAddress": True,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictName": "Kadıköy",
"CityName": "İstanbul",
"CountryName": "Türkiye",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"FullAddress": "<string>",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1106",
"Message": "IsInvoiceAddress cannot be unset. Set another address as the invoice address instead.",
"Errors": [
{
"Code": "1106",
"Message": "IsInvoiceAddress cannot be unset. Set another address as the invoice address instead."
}
]
}{
"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": "1100",
"Message": "Address not found.",
"Errors": [
{
"Code": "1100",
"Message": "Address not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Partially update address
Changes only the sent fields of a address.
curl --request PATCH \
--url https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}");
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 \"DistrictId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\",\n \"PostalCode\": \"34710\",\n \"IsInvoiceAddress\": true,\n \"CoordinateX\": 40.9877,\n \"CoordinateY\": 29.0254\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({
DistrictId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
Address: 'Caferağa Mah. Moda Cad. No: 10',
PostalCode: '34710',
IsInvoiceAddress: true,
CoordinateX: 40.9877,
CoordinateY: 29.0254
})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/{customerId}/addresses/{addressId}"
payload = {
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"PostalCode": "34710",
"IsInvoiceAddress": True,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictName": "Kadıköy",
"CityName": "İstanbul",
"CountryName": "Türkiye",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"FullAddress": "<string>",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1106",
"Message": "IsInvoiceAddress cannot be unset. Set another address as the invoice address instead.",
"Errors": [
{
"Code": "1106",
"Message": "IsInvoiceAddress cannot be unset. Set another address as the invoice address instead."
}
]
}{
"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": "1100",
"Message": "Address not found.",
"Errors": [
{
"Code": "1100",
"Message": "Address not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}- A field that is not sent stays unchanged, a field sent as
nullis cleared. - Validation runs on the whole merged record; setting a required field to
nullis rejected. IsInvoiceAddresscannot be set tofalse; mark another address as the invoice address first.
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 >= 1Body
Required. ID of a district from GET /api/v1/definitions/districts. City and country come from the district.
Required. Street address.
"Caferağa Mah. Moda Cad. No: 10"
Postal code.
"34710"
Whether this is the invoice address. A customer always has exactly one invoice address.
true
Location coordinate X.
40.9877
Location coordinate Y.
29.0254
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.