XM

Create Address

Path:

POST /user/{userId}/address

Users may have the requirement to send items to different people at different locations. To support this requirement, we facilitate adding multiple shipping addresses, and also billing addresses (add one at a time).

Headers

Content-Typeapplication/json

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path

Name: system user ID (user._Id)

Required: true

Type: Body

Name: Address

Required: true

Sample Request

Path:

https://{baseurl}/user/5e97947d3cb8553c0e43d87f/address

Body:

{
"address1":"10400 NE 4th St ",
"city":"Bellevue",
"state":"WA",
"country": "United States",
"zipCode":"98004",
"kind":"shipping",
"name":{
"first":"John",
"last":"Smith"
},
"isVerified":false
‚Äč
}

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.

Sample

{
"_id": "5e97947d3cb8553c0e43d87f",
"isActive": {
"status": true
},
"registrationDate": "2020-04-15T22:34:22.429Z",
"expiryDate": "2070-04-15T22:34:22.429Z",
"roles": [
"5de1646f8c6352091d944f1c"
],
"name": {
"first": "John",
"middle": "A",
"last": "Doe"
},
"phone": [
{
"_id": "5e97947d3cb8553c0e43d880",
"number": "123456789",
"countryCode": "+1",
"extension": "1234",
"kind": "mobile",
"id": "5e97947d3cb8553c0e43d880"
}
],
"email": "[email protected]",
"extra": {
"resetPassword": "requested"
},
"registrationSite": "abcde.com",
"account": "5e97947d3cb8553c0e43d87e",
"userId": 90,
"address": [
{
"isDefault": false,
"isValidated": false,
"_id": "5e98a2a13e9e9e495ed2e3b3",
"address1": "10400 NE 4th St ",
"city": "Bellevue",
"state": "WA",
"country": "United States",
"zipCode": "98004",
"kind": "shipping",
"name": {
"first": "John",
"last": "Smith"
},
"id": "5e98a2a13e9e9e495ed2e3b3"
}
],
"provider": [
{
"registrationDate": "2020-04-15T22:34:22.429Z",
"isActive": true,
"_id": "5e97947d3cb8553c0e43d881",
"name": "LOCAL",
"lastLoginDate": "2020-04-16T18:10:42.600Z",
"id": "5e97947d3cb8553c0e43d881"
}
],
"createdAt": "2020-04-15T23:10:53.773Z",
"updatedAt": "2020-04-16T18:23:29.785Z",
"__v": 0
}

HTTP Code : 404 Message : Not Found

Description: You will see this message when the sytsem user ID is incorrect.

Sample

{
"code": "USER_NOT_FOUND",
"message": "User not found."
}

Changelog

  • July-2020 last updated