Create address
curl --request POST \
--url https://api.noyax.com/api/v1/customers/{customerId}/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"District": "Kadıköy",
"Address": "Caferağa Mah. Moda Cad. No: 10"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/addresses");
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 \"District\": \"Kadıköy\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\"\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({District: 'Kadıköy', Address: 'Caferağa Mah. Moda Cad. No: 10'})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/addresses', 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"
payload = {
"District": "Kadıköy",
"Address": "Caferağa Mah. Moda Cad. No: 10"
}
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"District": "Kadıköy",
"City": "İstanbul",
"Country": "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": "1102",
"Message": "District is required.",
"Errors": [
{
"Code": "1102",
"Message": "District 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": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Addresses
Create address
Adds a new address to a customer.
POST
/
api
/
v1
/
customers
/
{customerId}
/
addresses
Create address
curl --request POST \
--url https://api.noyax.com/api/v1/customers/{customerId}/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"District": "Kadıköy",
"Address": "Caferağa Mah. Moda Cad. No: 10"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/addresses");
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 \"District\": \"Kadıköy\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\"\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({District: 'Kadıköy', Address: 'Caferağa Mah. Moda Cad. No: 10'})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/addresses', 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"
payload = {
"District": "Kadıköy",
"Address": "Caferağa Mah. Moda Cad. No: 10"
}
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"District": "Kadıköy",
"City": "İstanbul",
"Country": "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": "1102",
"Message": "District is required.",
"Errors": [
{
"Code": "1102",
"Message": "District 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": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}DistrictandAddressare required. City and country come from the district.- If
IsInvoiceAddressistrue, the previous invoice address loses the flag. - The first address of a customer always becomes the invoice address, regardless of the value sent.
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 |
0580 | 400 | A value given as text (a code or a name) matches more than one record; add the detail that tells them apart (for example City for a district, Country for a city) |
1000 | 404 | Customer not found or not visible to the user. Also returned by sub-record endpoints |
1101 | 400 | Address is required |
1102 | 400 | District is required |
1103 | 400 | District not found |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created