Create address
Create and persist a shipping or billing address for the authenticated user.
Use this endpoint when the user confirms a new address in checkout or account settings.
Common ways to call this endpoint:
- Assisted flow: find address -> retrieve details -> create saved address.
- Manual flow: user enters address fields directly, then create.
Request guidance:
- type must be shipping or billing.
- country should be an ISO 3166-1 alpha-2 country code (for example, GB).
- Set loqateId and isValidated when the address came from the lookup endpoints.
- Set isPrimary to true when this should become the default address for that type.
Behavior notes:
- Returns 201 with the newly saved address record.
- A user can store up to 10 addresses in total; additional creates return 400.
- If isPrimary is true, existing primary addresses of the same type are replaced.
- After creation, call GET /user/addresses to refresh the full address list in UI.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Type of address, 'shipping' or 'billing'
shipping, billing First line of the formatted address
1City or town
1State or province name
Postal or ZIP code
1ISO 3166-1 alpha-2 country code
2A recognisable label for the address, e.g. "Home", "Work"
Second line of the formatted address
The LoqateID of the address, if applicable
Whether the address has been validated using Loqate
Whether the address is the primary address for this type
Response
Address created
Information representing a user's address. A user address can be either a shipping or billing address.
Type of address, 'shipping' or 'billing'
shipping, billing First line of the formatted address
1City or town
1State or province name
Postal or ZIP code
1ISO 3166-1 alpha-2 country code
2Unique identifier for the address
A recognisable label for the address, e.g. "Home", "Work"
Second line of the formatted address
The LoqateID of the address, if applicable
Whether the address has been validated using Loqate
Whether the address is the primary address for this type
Timestamp when the address was created
Timestamp when the address was last updated