XM

Get Address by Kind

Path:

GET /user/{system user ID}/address/{kind}

Description: This endpoint is deprecated.

Headers

Content-Type : application/json

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path

Name: System 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":"Billing",
"name":{
"first":"John",
"last":"Doe"
},
"isVerified":true
‚Äč
}

16.0.6. Response

HTTP Code : 200 Message : OK

Description: You will see this message when address is successfully retrieved.

Sample

[
{
"isDefault": false,
"isValidated": false,
"_id": "5e98a2a13e9e9e495ed2e3b3",
"address1": "10400 NE 4th St ",
"city": "Bellevue",
"state": "WA",
"country": "United States",
"zipCode": "98004",
"kind": "Billing",
"name": {
"first": "John",
"last": "Doe"
},
"address2": null,
"attention": null,
"company": null,
"email": null,
"phone": null,
"id": "5e98a2a13e9e9e495ed2e3b3"
}
]

HTTP Code : 404 Message : Not Found

Description: You will see this error when the system user ID is incorrect.

Sample

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

Changelog

  • July-2020 last updated