Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Addresses

Search Addresses

Endpoint to search Addresses.

get/business/v2/addresses

Query parameters

userIdstring

The User ID.

Example:XMPL1234-000001

The User ID.

category'USER' | 'COMPANY'

The User CATEGORY.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing Addresses.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "recipient": "JohnSmith",
      "name": "Foo Street 75",
      "line1": "Bar Street 64",
      "line2": "Other street 31",
      "country": "GB",
      "county": "LD",
      "city": "London",
      "post_code": "00000",
      "delivery_phone_number": "+441234567890",
      "type": "SHIPPING",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-01T12:48:40Z"
    }
  ]
}