Sign in

v14

OpenAPI 3.1.02026-08-03122113375.9 KB
user-addresses

List addresses

List all addresses saved for the authenticated user account.

Use this endpoint to load address books, checkout selectors, and default-address settings.

Response guidance:

  • type distinguishes shipping and billing records.
  • isPrimary identifies the current default for each type.
  • id is required for delete operations and address selection state.
  • An empty array means the user has no saved addresses yet.

Common workflow:

  1. Call this endpoint on account page load and checkout start.
  2. Use POST /user/addresses to add new addresses.
  3. Use DELETE /user/addresses/{id} to remove obsolete addresses.
  4. Call this endpoint again after any create/delete to refresh canonical state.
get/user/addresses

Response

A list of addresses

labelstring nullable

A recognisable label for the address, e.g. "Home", "Work"

type'shipping' | 'billing' required

Type of address, 'shipping' or 'billing'

line1string required

First line of the formatted address

line2string nullable

Second line of the formatted address

citystring required

City or town

statestring required

State or province name

postalCodestring required

Postal or ZIP code

countrystring required

ISO 3166-1 alpha-2 country code

loqateIdstring nullable

The LoqateID of the address, if applicable

isValidatedboolean nullable

Whether the address has been validated using Loqate

isPrimaryboolean nullable

Whether the address is the primary address for this type

idstring required

Unique identifier for the address

createdAtstring nullable

Timestamp when the address was created

updatedAtstring nullable

Timestamp when the address was last updated