/AddressBook GET

Returns the user's addresses as a List Response.

URL
/AddressBook
Verb
GET

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string YES The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the body of the request.

Parameter Data Type Valid Values Description
Address1 string any string A key phrase to search for in the first line of the user's address
Address2 string any string A key phrase to search for in the second line of the user's address
City string any string Search city of the user's address
State string any string Search state of the user's address
PostalCode string any string Search postal code of the user's address
Sort integer 0 - Sort by Address1 Asc

1 - Sort by Address1 Desc

2 - Sort by Address2 Asc

3 - Sort by Address2 Desc

4 - Sort by City Asc

5 - Sort by City Desc

6 - Sort by State Asc

7 - Sort by State Desc

8 - Sort by Postal Code Asc

9 - Sort by Postal Code Desc

11 - Sort by IsDefault Desc
The sort direction you want the feedback results to be.

Optional PagingParameters

Output

If the user id is not valid, you will receive a 404 NotFound and a Message Response indicating the reason.

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
Address1 string Any string The first line of the user's address.
Address2 string Any string The second line of the user's address.
AddressID integer positive # The id of the address
AddressType integer positive # The type of the address
City string Any string The city of the user's address.
CountryCode string Any string The country code of the user's address.
IsDefault boolean true/false Default user's address.
PostalCode string Any string The postal code of the user's address.
State string Any string The state of the user's address.

Links

Rel Description Condition
details Link to the address details and management page