Address - vPlan

There is no direct endpoint for interacting with an Address.

Address can be added or changed via the Order object.
The Address can be removed from an Order by setting the Address object to null.

Because of geo coordinates a unique address (street1, street2, postcode, city, state and country) is only stored once,
and can be attached to multiple orders. Updating the geo coordinates will update them for all orders.

Address

string <uuid>

read-onlyoptional

Unique identifier

city

string

optional

<= 60 characters

country

string

optional

<= 55 characters

postcode

string

optional

<= 16 characters

Default:

NULL

state

string

optional

<= 60 characters

street1

string

optional

<= 100 characters

street2

string

optional

<= 100 characters

hash

string

read-onlyoptional

Hash based on the trimmed values of street1, street2, postcode, city, state and country.

Internally used in case latitude and longitude are not given but already know

<= 64 characters

Example:

2ee8ceab31952d603682752d4bde0c259ba8081ed6c755f73081ce9462530b5b

latitude

number

optional

The geographic coordinate that specifies the north–south position

>= -90<= 90

Example:

52.3156048

longitude

number

optional

The geographic coordinate that specifies the east-west position

>= -180<= 180

Example:

6.496432

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z