v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Address Book

Get Addresses

Provide a list of all shipping addresses under your customer account.

get/v4/addresses

Query parameters

searchTermstring

Search Term

pageSizeinteger

The maximum number of records per page.

pageNumberinteger

The number of the requested page, starting at 1.

Sort By

Sort By <br />Default: Alias

sortDir'Ascending' | 'Descending'

Order Direction

Sort Direction <br />Default: Ascending

Response

Returns a list of addresses.

TotalCountinteger required

Total Count <br />The total number of addresses available

Example response

{
  "Addresses": [
    {
      "AddressId": "John Brown Default",
      "ContactName": "Jane Doe",
      "CompanyName": "My Company Ltd.",
      "ContactEmail": "jane@example.com",
      "ContactPhone": "07123887422",
      "Line1": "10 Sky Lane",
      "Line2": "123 Main Street",
      "Line3": "Hills End",
      "Town": "Christchurch",
      "Postcode": "TW20 0HJ",
      "County": "Surrey",
      "CountryCode": "GB",
      "What3Words": "brick.space.employ",
      "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
      "LastUpdatedBy": "User A"
    }
  ],
  "TotalCount": 32
}