Get User Addresses by type
GET/users/:lookupKey/:lookupValue/addresses/
Use this endpoint to retrieve a list of all user addresses. Addresses can be filtered by type.
Request
Path Parameters
lookupKey stringrequired
Lookup key. Read more about user lookup keys
lookupValue stringrequired
The value of the key (id or sourceId)
Query Parameters
type string
Optional. Only retrieve a certain type of address. Possible values:
delivery invoice home
Responses
- 200
- 404
Get User Delivery Addresses 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 User Delivery Addresses by Id - 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": "Arnhem",
"code": "11234",
"company": "Propel",
"country": "NL",
"email": "miles@propel.us",
"fax": "",
"firstName": "Miles",
"gender": "U",
"icp": "N",
"id": 81908,
"isDefault": "N",
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"name": "",
"notes": "Address notes",
"number": "34",
"numberExtension": "A",
"phone": "0032445888",
"postalCode": "6822 DE",
"region": "",
"street": "Noordpad",
"type": "delivery",
"url": "www.propel.us"
}
],
"messages": [],
"total": 1
}
{
"data": [
{
"active": "Y",
"city": "Arnhem",
"code": "11234",
"company": "Propel",
"country": "NL",
"email": "miles@propel.us",
"fax": "",
"firstName": "Miles",
"gender": "U",
"icp": "N",
"id": 81908,
"isDefault": "N",
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"name": "",
"notes": "Address notes",
"number": "34",
"numberExtension": "A",
"phone": "0032445888",
"postalCode": "6822 DE",
"region": "",
"street": "Noordpad",
"type": "delivery",
"url": "www.propel.us"
}
],
"messages": [],
"total": 1
}
Get User Delivery Addresses by Id - 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 User Delivery Addresses by Id - 404
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 70007,
"messages": [
"Parent resource [User] with id [147601] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70007",
"status": 404,
"type": "ParentUserNotFound"
}
}
{
"error": {
"code": 70007,
"messages": [
"Parent resource [User] with id [147601] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70007",
"status": 404,
"type": "ParentUserNotFound"
}
}
Loading...