Get Customer Address by Id
GEThttps://api.helice.cloud/v2/customers/:lookupKey/:lookupValue/addresses/:addressId
Use this endpoint to retrieve details for a customer address. The address is identified by id
.
Request
Path Parameters
lookupKey stringrequired
Lookup key. Read more about customer lookup keys
lookupValue stringrequired
The value of the key (id or sourceId)
addressId stringrequired
Address id
Responses
- 200
- 404
Get Customer Address by Id - 200
Response Headers
- application/json
- Schema
- Example (from schema)
- Get Customer Address by Id - 200
Schema
data
object
messages undefined[]
total number
{
"data": {
"active": "Y",
"city": "Arnhem",
"code": "11234",
"company": "",
"country": "NL",
"email": "miles@propel.us",
"fax": "",
"firstName": "Miles",
"gender": "U",
"icp": "N",
"id": 106099,
"isDefault": "Y",
"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": "",
"country": "NL",
"email": "miles@propel.us",
"fax": "",
"firstName": "Miles",
"gender": "U",
"icp": "N",
"id": 106099,
"isDefault": "Y",
"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 Customer Address by Id - 404 (customer) / Get Customer Address by Id - 404 (address)
Response Headers
- application/json
- Schema
- Example (from schema)
- Get Customer Address by Id - 404 (address)
- Get Customer Address by Id - 404 (customer)
Schema
error
object
{
"error": {
"code": 60007,
"messages": [
"Parent resource [Customer] with id [25496] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/60007",
"status": 404,
"type": "ParentCustomerNotFound"
}
}
{
"error": {
"code": 90006,
"messages": [
"Address with id [106055] not found for [Customers] with id [25494]"
],
"moreInfo": "https://www.propel.us/docs/errors/90006",
"status": 404,
"type": "AddressNotFound"
}
}
{
"error": {
"code": 60007,
"messages": [
"Parent resource [Customer] with id [25496] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/60007",
"status": 404,
"type": "ParentCustomerNotFound"
}
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://api.helice.cloud/v2/customers/:lookupKey/:lookupValue/addresses/:addressId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear