Skip to main content

Physical address for delivery or collection

name
string | null

Contact name or company name

address_1
string | null

First line of address (street number and name)

Maximum string length: 80
address_2
string | null

Second line of address

Maximum string length: 80
address_3
string | null

Town/city - this field is typically passed to couriers as the city field

Maximum string length: 80
address_4
string | null

County/region

Maximum string length: 80
address_5
string | null

Additional address information

Maximum string length: 80
code
string | null

Address code for reference. Read-only when setting addresses inline on orders/warehouses — settable only via the delivery addresses endpoint directly.

country_code
string | null

ISO country code (e.g., 'GB', 'US')

Maximum string length: 6
postcode
string | null

Postal/ZIP code

Maximum string length: 10
email_address
string<email> | null

Email address for delivery notifications

Maximum string length: 254
phone_number
string | null

Contact phone number

Maximum string length: 50
external_system_reference1
string | null

Reference ID from external system

external_system_reference2
string | null

Secondary reference ID from external system

external_system_reference3
string | null

Tertiary reference ID from external system