API Reference

Create a new address for a customer

post
https://{domain_prefix}.retail.lightspeed.app/api/2026-07/customers//addresses

Creates a new address for the specified customer.

Validation Rules:

  • country_code: Required, must be a valid ISO 3166-1 alpha-2 code (e.g., US, NZ, AU)
  • state_code: Required for US and CA, must be valid for the country
  • postcode: Required, must be valid format for the country
  • type: Required, must be either BILLING or SHIPPING
  • address_line_1: Required, maximum 50 characters
  • city: Required, maximum 28 characters
  • state: Maximum 35 characters

🔒 Requires: customers:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the customer.

Body Params
string
required
length ≤ 50

Primary address line (street address, P.O. box, etc.).

string | null

Secondary address line (apartment, suite, unit, building, floor, etc.).

string
required
length ≤ 28

City or town name.

string
required

ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU).

string
required

Postal code or ZIP code.

string | null

State, province, or region name.

string | null

State or province code. Required for US and CA.

string | null

Suburb or district.

string
enum
required

The type of address.

Allowed:
Responses

400

Bad Request - validation errors

401

Unauthorized

403

Forbidden - insufficient permissions

404

Customer not found

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?