Get Addresses by type
GET/orders/:lookupKey/:lookupValue/addresses
Use this endpoint to retrieve a list of all order addresses. Addresses can be filtered by type.
Request
Path Parameters
lookupKey stringrequired
Use id or externalId
lookupValue stringrequired
The id or externalId of the order
Query Parameters
type string
possible values:
delivery invoice
Responses
- 200
- 404
Get Delivery Addresses - 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 Delivery Addresses - 200
Schema
Array [
]
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": "w.spies@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": ""
},
{
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81903,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "20",
"numberExtension": "",
"phone": "",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat",
"type": "delivery",
"url": ""
}
],
"messages": [],
"total": 2
}
{
"data": [
{
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "w.spies@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": ""
},
{
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81903,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "20",
"numberExtension": "",
"phone": "",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat",
"type": "delivery",
"url": ""
}
],
"messages": [],
"total": 2
}
Get Delivery Addresses - 404
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 Delivery Addresses - 404
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": 15003,
"messages": [
"Parent resource [Order] with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15003",
"status": 404,
"type": "ParentOrderNotFound"
}
}
Loading...