v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB

Addresses

Get Address

Endpoint to get an Address by ID.

get/business/v2/addresses/{addressId}

Path parameters

addressIdstring required

The Address ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a single Address.

idstring

The Address ID.

recipientstring

The recipient of the Address

namestring

The actual name of the Address.

line1string

The Address street.

line2string

An optional other street.

countrystring

The country of the Address.

countystring

The county of the Address.

citystring

The city of the Address.

post_codestring

The postal code of the Address.

delivery_phone_numberstring

Delivery phone number

default_shippingboolean

True if the Address is the default shipping address.

typestring

The type of the Address.

category'USER' | 'COMPANY'

user_idstring

The User ID, only if category of the Address is USER.

creation_timestring

The date and time when the Address was created.

last_updatestring

The date and time when the Address was last updated.

Example response

{
  "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"
}