XM
Powered By GitBook
Create Address
Path:
1
POST https://{baseurl}/api-commerceIdentity/user/{{userId}}/address
Copied!
Users may have the requirement to send items to different people at different locations. To support this requirement, this API allows adding shipping and billing addresses.
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 system-generated user ID (represented as _Id)
Required : true
Type : requestBody
Name : The customer address.
Required : true

Sample Request

Path:
1
https://{baseurl}/user/5e97947d3cb8553c0e43d87f/address
Copied!
Body:
1
{
2
"address1":"10400 NE 4th St ",
3
"city":"Bellevue",
4
"state":"WA",
5
"country": "United States",
6
"zipCode":"98004",
7
"kind":"shipping",
8
"name":{
9
"first":"John",
10
"last":"Smith"
11
},
12
"isVerified":false
13
14
}
Copied!

Sample Response

HTTP Code : 200 Message : OK
Description: You will see this message when the new address is successfully added to the system. The complete user details are retrieved to rebuild the user profile.
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
{
35
"isDefault": false,
36
"isValidated": false,
37
"_id": "5e98a2a13e9e9e495ed2e3b3",
38
"address1": "10400 NE 4th St ",
39
"city": "Bellevue",
40
"state": "WA",
41
"country": "United States",
42
"zipCode": "98004",
43
"kind": "shipping",
44
"name": {
45
"first": "John",
46
"last": "Smith"
47
},
48
"id": "5e98a2a13e9e9e495ed2e3b3"
49
}
50
],
51
"provider": [
52
{
53
"registrationDate": "2020-04-15T22:34:22.429Z",
54
"isActive": true,
55
"_id": "5e97947d3cb8553c0e43d881",
56
"name": "LOCAL",
57
"lastLoginDate": "2020-04-16T18:10:42.600Z",
58
"id": "5e97947d3cb8553c0e43d881"
59
}
60
],
61
"createdAt": "2020-04-15T23:10:53.773Z",
62
"updatedAt": "2020-04-16T18:23:29.785Z",
63
"__v": 0
64
}
Copied!
HTTP Code : 404 Message : Not Found
Description: You will see this message when the sytsem user ID is incorrect.
Sample
1
{
2
"code": "USER_NOT_FOUND",
3
"message": "User not found."
4
}
Copied!

Changelog

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