XM
Powered By GitBook
Retrieve Address by ID
Path:
1
GET https://{baseurl}/api-commerceIdentity/user/{{userId}}/address/{{addressId}}
Copied!
Facilitates retrieval of a specific address. To retrieve all the addresses of a user, the Retrieve All Addresses of User API is recommended.
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : Path
Name : The 24 character system-generated user ID and address ID.
Required : true

Sample Request

Path:
1
https://{baseurl}/user/5e97947d3cb8553c0e43d87f/address/5e97947d3cb8553c0e43d87f
Copied!

Sample Response

HTTP Code : 200 Message : OK
Description: You will see this message when the address is successfully retrieved.
1
{
2
"_id": "5e97947d3cb8553c0e43d87f",
3
"isActive": {
4
"status": true
5
},
6
"registrationDate": "2020-04-15T22:34:22.429Z",
7
"expiryDate": "2070-04-15T22:34:22.429Z",
8
"roles": [
9
"5de1646f8c6352091d944f1c"
10
],
11
"name": {
12
"first": "John",
13
"middle": "A",
14
"last": "Doe"
15
},
16
"phone": [
17
{
18
"_id": "5e97947d3cb8553c0e43d880",
19
"number": "123456789",
20
"countryCode": "+1",
21
"extension": "1234",
22
"kind": "mobile",
23
"id": "5e97947d3cb8553c0e43d880"
24
}
25
],
26
"email": "[email protected]",
27
"extra": {
28
"resetPassword": "requested"
29
},
30
"registrationSite": "abcde.com",
31
"account": "5e97947d3cb8553c0e43d87e",
32
"userId": 90,
33
"address": [],
34
"provider": [
35
{
36
"registrationDate": "2020-04-15T22:34:22.429Z",
37
"isActive": true,
38
"_id": "5e97947d3cb8553c0e43d881",
39
"name": "LOCAL",
40
"lastLoginDate": "2020-04-17T20:53:59.803Z",
41
"id": "5e97947d3cb8553c0e43d881"
42
}
43
],
44
"createdAt": "2020-04-15T23:10:53.773Z",
45
"updatedAt": "2020-04-17T20:54:10.178Z",
46
"__v": 0
47
}
Copied!
HTTP Code : 404 Message : Not Found
Description: You will see this message when the system user ID is incorrect.
Sample
1
{
2
"code": "USER_NOT_FOUND",
3
"message": "User not found."
4
}
Copied!

Changelog

    Last Updated - July 2020
Last modified 3mo ago
Copy link
Contents
Changelog