List addresses visible to this user

Request

Only available to Buyer Users.

Security

OAuth2(Required scopes: FullAccessMeAddressAdminShopper)

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""AddressName""CompanyName""City""Street1""Street2""LastName""FirstName""State""Zip"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"AddressName""ID""DateCreated""CompanyName""FirstName""LastName""Street1""Street2""City""State"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/me/addresses?search=string&searchOn=ID&sortBy=AddressName&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Only available to Buyer Users.

Bodyapplication/json

ItemsArray of objects(BuyerAddress)

Example:

[
  {
    "ID": "",
    "Shipping": false,
    "Billing": false,
    "Editable": false,
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}