Get Order Address by Id
GET/orders/:lookupKey/:lookupValue/addresses/:addressId
Use this endpoint to retrieve details for an order address. The address is identified by id
.
Request
Path Parameters
lookupKey stringrequired
Use id
or externalId
lookupValue stringrequired
The id
or externalId
of the order
addressId stringrequired
Address Id
Responses
- 200
- 404
Get Order Address by Id - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Order Address by Id - 200
Schema
data
object
active string
city string
code string
company string
country string
email string
fax string
firstName string
gender string
icp string
id number
isDefault string
lastName string
middleName string
mobile string
name string
notes string
number string
numberExtension string
phone string
postalCode string
region string
street string
type string
url string
messages undefined[]
total number
{
"data": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "julien@propel.us",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81902,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "",
"numberExtension": "",
"phone": "+31206717171",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat 20",
"type": "invoice",
"url": ""
},
"messages": [],
"total": 1
}
{
"data": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "julien@propel.us",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81902,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "",
"numberExtension": "",
"phone": "+31206717171",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat 20",
"type": "invoice",
"url": ""
},
"messages": [],
"total": 1
}
Get Order Address by Id - 404 (order not found) / Get Order Address by Id - 404 (address not found)
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Order Address by Id - 404 (address not found)
- Get Order Address by Id - 404 (order not found)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 15003,
"messages": [
"Parent resource [Order] with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15003",
"status": 404,
"type": "ParentOrderNotFound"
}
}
{
"error": {
"code": 90006,
"messages": [
"Address with id [819021] not found for [Order] with id [195]"
],
"moreInfo": "https://www.propel.us/docs/errors/90006",
"status": 404,
"type": "AddressNotFound"
}
}
{
"error": {
"code": 15003,
"messages": [
"Parent resource [Order] with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15003",
"status": 404,
"type": "ParentOrderNotFound"
}
}
Loading...