Sign in
Address Book

Get Addresses

Retrieve a list of shipping addresses for your customer account in the system. With this endpoint, you can get specific addresses based on various parameters, providing pagination and sorting features to help manage results effectively.

get/v4/addresses

Query parameters

searchTermstring

A string representing the term or keywords used to filter the search results for the addresses.This parameter helps you find specific addresses by different attributes.

pageSizeinteger

An integer that defines the number of address records returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 addresses in each response.<br></br> Note: By default, this value is set to 100

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of addresses based on the specified pageSize.<br></br> Note: By default, this value is set to 1.

sortBy'ContactName' | 'CompanyName' | 'Town' | 'CountryCode' | 'ContactEmail' | 'LastModified'

Sort By

A string specifying the field by which to organise the search results. For instance, "ContactName" could be used to sort addresses alphabetically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this field is set to ContactName.

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "ContactName" as sortBy would arrange the addresses from A to Z. <br /> <br />Note: By default, this field is set to Ascending.

Response

Returns a list of addresses.

TotalCountinteger required

An integer representing the total number of address records that match the search criteria. This count provides users with an overview of how many address records are available based on the filters applied.

Example response

{
  "Addresses": [
    {
      "AddressId": "John Brown Default",
      "ContactName": "Jane Doe",
      "CompanyName": "My Company Ltd.",
      "ContactEmail": "jane@example.com",
      "Line1": "10 Sky Lane",
      "CountryCode": "GB",
      "What3Words": "brick.space.employ",
      "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.