Create new address alias
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new address alias
- Updated on 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/address-aliases/
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
address alias to be created
object
address
integer Required
Address id of the real address
city
string Required
Building city name
cityAlt
string
Building city name in alternative language
orderno
integer
Order number
sourceSystem
integer
Source system id
sourceSystemKey
integer
source system key
streetname
string Required
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string Required
Building number
zipcode
string
Building zipcode
Responses
201
A created Address alias
{
"address": 21685370,
"city": "city",
"cityAlt": "",
"id": 21,
"orderno": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "street",
"streetnameAlt": "",
"streetno": "2",
"zipcode": ""
}object
address
integer
Address id of the real address
city
string
Building city name
cityAlt
string
Building city name in alternative language
id
integer
Primary key
orderno
integer
Order number
sourceSystem
integer
Source system id
sourceSystemKey
integer
source system key
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
zipcode
string
Building zipcode
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
