← API Documentation

Customer Addresses API

Manage shipping and billing addresses for customers. Each customer can have multiple addresses for different purposes.

Endpoints

List Customer Addresses - GET /api/v1/customers/{customer_id}/addresses/
Create Customer Address - POST /api/v1/customers/{customer_id}/addresses/
Get Customer Address - GET /api/v1/customers/{customer_id}/addresses/{address_id}/
Update Customer Address - PUT /api/v1/customers/{customer_id}/addresses/{address_id}/
Delete Customer Address - DELETE /api/v1/customers/{customer_id}/addresses/{address_id}/

List Customer Addresses

Retrieve all addresses for a specific customer.

Endpoint: GET /api/v1/customers/{customer_id}/addresses/

Scope Required: customers:read

Path Parameters

Parameter	Type	Description
`customer_id`	string	Customer public ID (e.g., `cus_d0b6fmv28q6vn14peun0`)

Request

curl -X GET "https://studio.easel.engineering/api/v1/customers/cus_d0b6fmv28q6vn14peun0/addresses/" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json"

Response

Status: 200 OK

{
  "data": [
    {
      "id": "cad_d0b6fmv28q6vn14peun0",
      "first_name": "John",
      "last_name": "Doe",
      "street1": "123 Main St",
      "street2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "zip": "10001",
      "created_at": "2023-01-01T10:00:00Z",
      "updated_at": "2023-01-01T10:15:00Z"
    },
    {
      "id": "cad_xk3mq7r41p8nt26zv9w0",
      "first_name": "John",
      "last_name": "Doe",
      "street1": "456 Oak Avenue",
      "street2": null,
      "city": "Los Angeles",
      "state": "CA",
      "country": "US",
      "zip": "90210",
      "created_at": "2023-01-02T14:30:00Z",
      "updated_at": "2023-01-02T14:30:00Z"
    }
  ],
  "has_more": false
}

Error Responses

Missing customer ID

Status: 400 Bad Request

{
  "error": "Customer ID is required",
  "code": "MISSING_FIELD"
}

Internal server error

Status: 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Create Customer Address

Create a new address for a specific customer. A customer keeps at most 50
addresses; creating one past that returns INVALID_FIELD.

Endpoint: POST /api/v1/customers/{customer_id}/addresses/

Scope Required: customers:write

Path Parameters

Parameter	Type	Description
`customer_id`	string	Customer public ID (e.g., `cus_d0b6fmv28q6vn14peun0`)

Request Body

{
  "first_name": "John",
  "last_name": "Doe",
  "street1": "123 Main St",
  "street2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "zip": "10001"
}

Fields

Field	Type	Required	Description
`first_name`	string	Yes	First name for this address
`last_name`	string	Yes	Last name for this address
`street1`	string	Yes	Primary street address
`street2`	string	No	Secondary street address (apartment, suite, etc.)
`city`	string	Yes	City name
`state`	string	Depends on country	State, province or the like, as its region code: required in some countries, optional in Ireland, free text elsewhere
`country`	string	Yes	Country code, such as `US`
`zip`	string	Depends on country	ZIP or postal code: required unless the country has none

The state and zip are checked against the country as checkout and the
dashboard check them; see Address Checks.

Request

curl -X POST "https://studio.easel.engineering/api/v1/customers/cus_d0b6fmv28q6vn14peun0/addresses/" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: unique-request-id-12345" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "zip": "10001"
  }'

Optional Headers:

Idempotency-Key: Unique string to prevent duplicate address creation (see Idempotency)

Response

Returns the created address.

Status: 201 Created

{
  "id": "cad_d0b6fmv28q6vn14peun0",
  "first_name": "John",
  "last_name": "Doe",
  "street1": "123 Main St",
  "street2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "zip": "10001",
  "created_at": "2023-01-01T10:00:00Z",
  "updated_at": "2023-01-01T10:00:00Z"
}

Error Responses

Missing customer ID

Status: 400 Bad Request

{
  "error": "Customer ID is required",
  "code": "MISSING_FIELD"
}

Invalid JSON body

Status: 400 Bad Request

{
  "error": "Invalid JSON body",
  "code": "INVALID_JSON"
}

Missing required field

Status: 400 Bad Request

{
  "error": "First name is required",
  "code": "MISSING_FIELD"
}

Missing country

Status: 400 Bad Request

{
  "error": "country is required",
  "code": "MISSING_FIELD"
}

Unknown country

country isn't the code of a country Easel knows.

Status: 400 Bad Request

{
  "error": "Country must be an ISO 3166-1 alpha-2 code, such as \"US\"",
  "code": "INVALID_FIELD"
}

Missing state

The country requires a state and none was sent.

Status: 400 Bad Request

{
  "error": "state is required",
  "code": "MISSING_FIELD"
}

Invalid state

The state isn't one of the country's region codes,
such as a name ("California"), a lowercase code ("ca") or a code with
the country prefix ("US-CA").

Status: 400 Bad Request

{
  "error": "State must be the ISO 3166-2 code of one of the country's subdivisions, without the country prefix, such as \"CA\"",
  "code": "INVALID_FIELD"
}

Missing postal code

The country has postal codes and zip is missing, null or blank.

Status: 400 Bad Request

{
  "error": "zip is required",
  "code": "MISSING_FIELD"
}

Internal server error

Status: 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Get Customer Address

Retrieve a single customer address by its ID.

Endpoint: GET /api/v1/customers/{customer_id}/addresses/{address_id}/

Scope Required: customers:read

Path Parameters

Parameter	Type	Description
`customer_id`	string	Customer public ID (e.g., `cus_d0b6fmv28q6vn14peun0`)
`address_id`	string	Address public ID (e.g., `cad_d0b6fmv28q6vn14peun0`)

Request

curl -X GET "https://studio.easel.engineering/api/v1/customers/cus_d0b6fmv28q6vn14peun0/addresses/cad_d0b6fmv28q6vn14peun0/" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json"

Response

Status: 200 OK

{
  "id": "cad_d0b6fmv28q6vn14peun0",
  "first_name": "John",
  "last_name": "Doe",
  "street1": "123 Main St",
  "street2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "zip": "10001",
  "created_at": "2023-01-01T10:00:00Z",
  "updated_at": "2023-01-01T10:15:00Z"
}

Error Responses

Missing customer ID

Status: 400 Bad Request

{
  "error": "Customer ID is required",
  "code": "MISSING_FIELD"
}

Missing address ID

Status: 400 Bad Request

{
  "error": "Address ID is required",
  "code": "MISSING_FIELD"
}

Address not found

Status: 404 Not Found

{
  "error": "Resource not found",
  "code": "NOT_FOUND"
}

Internal server error

Status: 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Update Customer Address

Update an existing customer address.

Endpoint: PUT /api/v1/customers/{customer_id}/addresses/{address_id}/

Scope Required: customers:write

Path Parameters

Parameter	Type	Description
`customer_id`	string	Customer public ID (e.g., `cus_d0b6fmv28q6vn14peun0`)
`address_id`	string	Address public ID (e.g., `cad_d0b6fmv28q6vn14peun0`)

Request Body

{
  "first_name": "John",
  "last_name": "Smith",
  "street1": "456 Oak Avenue",
  "street2": null,
  "city": "Los Angeles",
  "state": "CA",
  "country": "US",
  "zip": "90210"
}

Fields

Field	Type	Required	Description
`first_name`	string	Yes	First name for this address
`last_name`	string	Yes	Last name for this address
`street1`	string	Yes	Primary street address
`street2`	string	No	Secondary street address (apartment, suite, etc.)
`city`	string	Yes	City name
`state`	string	Depends on country	State, province or the like, as its region code: required in some countries, optional in Ireland, free text elsewhere
`country`	string	Yes	Country code, such as `US`
`zip`	string	Depends on country	ZIP or postal code: required unless the country has none

The state and zip are checked against the country as checkout and the
dashboard check them; see Address Checks.

Request

curl -X PUT "https://studio.easel.engineering/api/v1/customers/cus_d0b6fmv28q6vn14peun0/addresses/cad_d0b6fmv28q6vn14peun0/" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: unique-request-id-67890" \
  -d '{
    "first_name": "John",
    "last_name": "Smith",
    "street1": "456 Oak Avenue",
    "city": "Los Angeles",
    "state": "CA",
    "country": "US",
    "zip": "90210"
  }'

Optional Headers:

Idempotency-Key: Unique string to prevent duplicate address updates (see Idempotency)

Response

Returns the updated address.

Status: 200 OK

{
  "id": "cad_d0b6fmv28q6vn14peun0",
  "first_name": "John",
  "last_name": "Smith",
  "street1": "456 Oak Avenue",
  "street2": null,
  "city": "Los Angeles",
  "state": "CA",
  "country": "US",
  "zip": "90210",
  "created_at": "2023-01-01T10:00:00Z",
  "updated_at": "2023-01-01T11:30:00Z"
}

Error Responses

Missing customer ID

Status: 400 Bad Request

{
  "error": "Customer ID is required",
  "code": "MISSING_FIELD"
}

Missing address ID

Status: 400 Bad Request

{
  "error": "Address ID is required",
  "code": "MISSING_FIELD"
}

Invalid JSON body

Status: 400 Bad Request

{
  "error": "Invalid JSON body",
  "code": "INVALID_JSON"
}

Missing required field

Status: 400 Bad Request

{
  "error": "First name is required",
  "code": "MISSING_FIELD"
}

Missing country

Status: 400 Bad Request

{
  "error": "country is required",
  "code": "MISSING_FIELD"
}

Unknown country

country isn't the code of a country Easel knows.

Status: 400 Bad Request

{
  "error": "Country must be an ISO 3166-1 alpha-2 code, such as \"US\"",
  "code": "INVALID_FIELD"
}

Missing state

The country requires a state and none was sent.

Status: 400 Bad Request

{
  "error": "state is required",
  "code": "MISSING_FIELD"
}

Invalid state

The state isn't one of the country's region codes,
such as a name ("California"), a lowercase code ("ca") or a code with
the country prefix ("US-CA").

Status: 400 Bad Request

{
  "error": "State must be the ISO 3166-2 code of one of the country's subdivisions, without the country prefix, such as \"CA\"",
  "code": "INVALID_FIELD"
}

Missing postal code

The country has postal codes and zip is missing, null or blank.

Status: 400 Bad Request

{
  "error": "zip is required",
  "code": "MISSING_FIELD"
}

Address not found

Status: 404 Not Found

{
  "error": "Resource not found",
  "code": "NOT_FOUND"
}

Internal server error

Status: 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Delete Customer Address

Delete a customer address permanently.

Endpoint: DELETE /api/v1/customers/{customer_id}/addresses/{address_id}/

Scope Required: customers:write

Path Parameters

Parameter	Type	Description
`customer_id`	string	Customer public ID (e.g., `cus_d0b6fmv28q6vn14peun0`)
`address_id`	string	Address public ID (e.g., `cad_d0b6fmv28q6vn14peun0`)

Request

curl -X DELETE "https://studio.easel.engineering/api/v1/customers/cus_d0b6fmv28q6vn14peun0/addresses/cad_d0b6fmv28q6vn14peun0/" \
  -H "Authorization: Bearer your_api_key_here"

Response

Status: 204 No Content

No response body is returned for successful deletions.

Error Responses

Missing customer ID

Status: 400 Bad Request

{
  "error": "Customer ID is required",
  "code": "MISSING_FIELD"
}

Missing address ID

Status: 400 Bad Request

{
  "error": "Address ID is required",
  "code": "MISSING_FIELD"
}

Address not found

An address that doesn't exist or belongs to another customer.

Status: 404 Not Found

{
  "error": "Resource not found",
  "code": "NOT_FOUND"
}

Internal server error

Status: 500 Internal Server Error

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Customer Address Object

Fields

Field	Type	Description
`id`	string	Address public ID
`first_name`	string	First name for this address
`last_name`	string	Last name for this address
`street1`	string	Primary street address
`street2`	string\|null	Secondary street address
`city`	string	City name
`state`	string	Region code where the country has a list, the text sent elsewhere, or an empty string
`country`	string	Country code
`zip`	string\|null	ZIP or postal code, null where none was sent
`created_at`	string	ISO 8601 timestamp
`updated_at`	string	ISO 8601 timestamp

Country Codes

Countries are named by their ISO 3166-1 alpha-2 codes, in uppercase:
US for the United States, CA for Canada, PT for Portugal. Lowercase
codes ("us") and other names are rejected, as are codes for no country,
such as "ZZ". Easel knows every country ISO 3166-1 lists.

Address Format

Addresses follow standard postal address conventions:

street1 contains the primary address (house number, street name)
street2 is optional and contains apartment, suite, unit numbers, etc.
state is the region code where the country has a list (see below)
zip can be null for countries that don't use postal codes

Address Checks

Creating or updating an address checks its state and zip against its
country with the same rules as checkout and the dashboard:

country must be the code of a country Easel knows.
In a country with a list of region codes, state must
be one of its codes. It is required in all of them but Ireland, where it
may be left empty.
In any other country, such as Portugal or Germany, state is free text
and may be empty. It is stored trimmed.
zip is required unless the country is one of those without postal
codes. A blank zip counts as missing.

The first problem found is returned as a 400 Bad Request naming the
field; see the error responses under Create Customer
Address.

Region Codes

Where Easel lists a country's regions, state takes the region's ISO
3166-2 subdivision code without the country prefix, exactly as listed:
"CA" for California (ISO US-CA), "RM" for Rome (IT-RM),
"ON" for Ontario (CA-ON), "13" for Tokyo (JP-13). Names
("California"), lowercase codes ("ca") and prefixed codes
("US-CA") are rejected. Responses return the same code.

Country	`state`
Argentina (`AR`)	Required
Australia (`AU`)	Required
Brazil (`BR`)	Required
Canada (`CA`)	Required
China (`CN`)	Required
India (`IN`)	Required
Ireland (`IE`)	Optional: empty or a county code
Italy (`IT`)	Required
Japan (`JP`)	Required
Mexico (`MX`)	Required
Spain (`ES`)	Required
United States (`US`)	Required
Any other country	Free text, optional

Each country's codes are listed below.

Argentina (`AR`)

Required.

Code	Name
`B`	Buenos Aires
`K`	Catamarca
`H`	Chaco
`U`	Chubut
`C`	Ciudad Autónoma de Buenos Aires
`X`	Córdoba
`W`	Corrientes
`E`	Entre Ríos
`P`	Formosa
`Y`	Jujuy
`L`	La Pampa
`F`	La Rioja
`M`	Mendoza
`N`	Misiones
`Q`	Neuquén
`R`	Río Negro
`A`	Salta
`J`	San Juan
`D`	San Luis
`Z`	Santa Cruz
`S`	Santa Fe
`G`	Santiago del Estero
`V`	Tierra del Fuego
`T`	Tucumán

Australia (`AU`)

Required.

Code	Name
`ACT`	Australian Capital Territory
`NSW`	New South Wales
`NT`	Northern Territory
`QLD`	Queensland
`SA`	South Australia
`TAS`	Tasmania
`VIC`	Victoria
`WA`	Western Australia

Brazil (`BR`)

Required.

Code	Name
`AC`	Acre
`AL`	Alagoas
`AP`	Amapá
`AM`	Amazonas
`BA`	Bahia
`CE`	Ceará
`DF`	Distrito Federal
`ES`	Espírito Santo
`GO`	Goiás
`MA`	Maranhão
`MT`	Mato Grosso
`MS`	Mato Grosso do Sul
`MG`	Minas Gerais
`PA`	Pará
`PB`	Paraíba
`PR`	Paraná
`PE`	Pernambuco
`PI`	Piauí
`RJ`	Rio de Janeiro
`RN`	Rio Grande do Norte
`RS`	Rio Grande do Sul
`RO`	Rondônia
`RR`	Roraima
`SC`	Santa Catarina
`SP`	São Paulo
`SE`	Sergipe
`TO`	Tocantins

Canada (`CA`)

Required.

Code	Name
`AB`	Alberta
`BC`	British Columbia
`MB`	Manitoba
`NB`	New Brunswick
`NL`	Newfoundland and Labrador
`NT`	Northwest Territories
`NS`	Nova Scotia
`NU`	Nunavut
`ON`	Ontario
`PE`	Prince Edward Island
`QC`	Quebec
`SK`	Saskatchewan
`YT`	Yukon

China (`CN`)

Required.

Code	Name
`AH`	Anhui
`BJ`	Beijing
`CQ`	Chongqing
`FJ`	Fujian
`GS`	Gansu
`GD`	Guangdong
`GX`	Guangxi
`GZ`	Guizhou
`HI`	Hainan
`HE`	Hebei
`HL`	Heilongjiang
`HA`	Henan
`HB`	Hubei
`HN`	Hunan
`NM`	Inner Mongolia
`JS`	Jiangsu
`JX`	Jiangxi
`JL`	Jilin
`LN`	Liaoning
`NX`	Ningxia
`QH`	Qinghai
`SN`	Shaanxi
`SD`	Shandong
`SH`	Shanghai
`SX`	Shanxi
`SC`	Sichuan
`TJ`	Tianjin
`XZ`	Tibet
`XJ`	Xinjiang
`YN`	Yunnan
`ZJ`	Zhejiang

Spain (`ES`)

Required.

Code	Name
`C`	A Coruña
`VI`	Álava
`AB`	Albacete
`A`	Alicante
`AL`	Almería
`O`	Asturias
`AV`	Ávila
`BA`	Badajoz
`PM`	Baleares
`B`	Barcelona
`BI`	Bizkaia
`BU`	Burgos
`CC`	Cáceres
`CA`	Cádiz
`S`	Cantabria
`CS`	Castellón
`CR`	Ciudad Real
`CO`	Córdoba
`CU`	Cuenca
`SS`	Gipuzkoa
`GI`	Girona
`GR`	Granada
`GU`	Guadalajara
`H`	Huelva
`HU`	Huesca
`J`	Jaén
`LO`	La Rioja
`GC`	Las Palmas
`LE`	León
`L`	Lleida
`LU`	Lugo
`M`	Madrid
`MA`	Málaga
`MU`	Murcia
`NA`	Navarra
`OR`	Ourense
`P`	Palencia
`PO`	Pontevedra
`SA`	Salamanca
`TF`	Santa Cruz de Tenerife
`SG`	Segovia
`SE`	Sevilla
`SO`	Soria
`T`	Tarragona
`TE`	Teruel
`TO`	Toledo
`V`	Valencia
`VA`	Valladolid
`ZA`	Zamora
`Z`	Zaragoza
`CE`	Ceuta
`ML`	Melilla

Ireland (`IE`)

Optional: leave state empty or send one of these codes.

Code	Name
`CW`	Carlow
`CN`	Cavan
`CE`	Clare
`CO`	Cork
`DL`	Donegal
`D`	Dublin
`G`	Galway
`KY`	Kerry
`KE`	Kildare
`KK`	Kilkenny
`LS`	Laois
`LM`	Leitrim
`LK`	Limerick
`LD`	Longford
`LH`	Louth
`MO`	Mayo
`MH`	Meath
`MN`	Monaghan
`OY`	Offaly
`RN`	Roscommon
`SO`	Sligo
`TA`	Tipperary
`WD`	Waterford
`WH`	Westmeath
`WX`	Wexford
`WW`	Wicklow

India (`IN`)

Required.

Code	Name
`AP`	Andhra Pradesh
`AR`	Arunachal Pradesh
`AS`	Assam
`BR`	Bihar
`CG`	Chhattisgarh
`GA`	Goa
`GJ`	Gujarat
`HR`	Haryana
`HP`	Himachal Pradesh
`JH`	Jharkhand
`KA`	Karnataka
`KL`	Kerala
`MP`	Madhya Pradesh
`MH`	Maharashtra
`MN`	Manipur
`ML`	Meghalaya
`MZ`	Mizoram
`NL`	Nagaland
`OD`	Odisha
`PB`	Punjab
`RJ`	Rajasthan
`SK`	Sikkim
`TN`	Tamil Nadu
`TS`	Telangana
`TR`	Tripura
`UP`	Uttar Pradesh
`UK`	Uttarakhand
`WB`	West Bengal
`AN`	Andaman and Nicobar Islands
`CH`	Chandigarh
`DH`	Dadra and Nagar Haveli and Daman and Diu
`DL`	Delhi
`JK`	Jammu and Kashmir
`LA`	Ladakh
`LD`	Lakshadweep
`PY`	Puducherry

Italy (`IT`)

Required.

Code	Name
`AG`	Agrigento
`AL`	Alessandria
`AN`	Ancona
`AO`	Aosta
`AR`	Arezzo
`AP`	Ascoli Piceno
`AT`	Asti
`AV`	Avellino
`BA`	Bari
`BT`	Barletta-Andria-Trani
`BL`	Belluno
`BN`	Benevento
`BG`	Bergamo
`BI`	Biella
`BO`	Bologna
`BZ`	Bolzano
`BS`	Brescia
`BR`	Brindisi
`CA`	Cagliari
`CL`	Caltanissetta
`CB`	Campobasso
`CE`	Caserta
`CT`	Catania
`CZ`	Catanzaro
`CH`	Chieti
`CO`	Como
`CS`	Cosenza
`CR`	Cremona
`KR`	Crotone
`CN`	Cuneo
`EN`	Enna
`FM`	Fermo
`FE`	Ferrara
`FI`	Firenze
`FG`	Foggia
`FC`	Forlì-Cesena
`FR`	Frosinone
`GE`	Genova
`GO`	Gorizia
`GR`	Grosseto
`IM`	Imperia
`IS`	Isernia
`AQ`	L'Aquila
`SP`	La Spezia
`LT`	Latina
`LE`	Lecce
`LC`	Lecco
`LI`	Livorno
`LO`	Lodi
`LU`	Lucca
`MC`	Macerata
`MN`	Mantova
`MS`	Massa-Carrara
`MT`	Matera
`ME`	Messina
`MI`	Milano
`MO`	Modena
`MB`	Monza e Brianza
`NA`	Napoli
`NO`	Novara
`NU`	Nuoro
`OR`	Oristano
`PD`	Padova
`PA`	Palermo
`PR`	Parma
`PV`	Pavia
`PG`	Perugia
`PU`	Pesaro e Urbino
`PE`	Pescara
`PC`	Piacenza
`PI`	Pisa
`PT`	Pistoia
`PN`	Pordenone
`PZ`	Potenza
`PO`	Prato
`RG`	Ragusa
`RA`	Ravenna
`RC`	Reggio Calabria
`RE`	Reggio Emilia
`RI`	Rieti
`RN`	Rimini
`RM`	Roma
`RO`	Rovigo
`SA`	Salerno
`SS`	Sassari
`SV`	Savona
`SI`	Siena
`SR`	Siracusa
`SO`	Sondrio
`SU`	Sud Sardegna
`TA`	Taranto
`TE`	Teramo
`TR`	Terni
`TO`	Torino
`TP`	Trapani
`TN`	Trento
`TV`	Treviso
`TS`	Trieste
`UD`	Udine
`VA`	Varese
`VE`	Venezia
`VB`	Verbano-Cusio-Ossola
`VC`	Vercelli
`VR`	Verona
`VV`	Vibo Valentia
`VI`	Vicenza
`VT`	Viterbo

Japan (`JP`)

Required.

Code	Name
`01`	Hokkaido
`02`	Aomori
`03`	Iwate
`04`	Miyagi
`05`	Akita
`06`	Yamagata
`07`	Fukushima
`08`	Ibaraki
`09`	Tochigi
`10`	Gunma
`11`	Saitama
`12`	Chiba
`13`	Tokyo
`14`	Kanagawa
`15`	Niigata
`16`	Toyama
`17`	Ishikawa
`18`	Fukui
`19`	Yamanashi
`20`	Nagano
`21`	Gifu
`22`	Shizuoka
`23`	Aichi
`24`	Mie
`25`	Shiga
`26`	Kyoto
`27`	Osaka
`28`	Hyogo
`29`	Nara
`30`	Wakayama
`31`	Tottori
`32`	Shimane
`33`	Okayama
`34`	Hiroshima
`35`	Yamaguchi
`36`	Tokushima
`37`	Kagawa
`38`	Ehime
`39`	Kochi
`40`	Fukuoka
`41`	Saga
`42`	Nagasaki
`43`	Kumamoto
`44`	Oita
`45`	Miyazaki
`46`	Kagoshima
`47`	Okinawa

Mexico (`MX`)

Required.

Code	Name
`AGU`	Aguascalientes
`BCN`	Baja California
`BCS`	Baja California Sur
`CAM`	Campeche
`CHP`	Chiapas
`CHH`	Chihuahua
`CMX`	Ciudad de México
`COA`	Coahuila
`COL`	Colima
`DUR`	Durango
`MEX`	Estado de México
`GUA`	Guanajuato
`GRO`	Guerrero
`HID`	Hidalgo
`JAL`	Jalisco
`MIC`	Michoacán
`MOR`	Morelos
`NAY`	Nayarit
`NLE`	Nuevo León
`OAX`	Oaxaca
`PUE`	Puebla
`QUE`	Querétaro
`ROO`	Quintana Roo
`SLP`	San Luis Potosí
`SIN`	Sinaloa
`SON`	Sonora
`TAB`	Tabasco
`TAM`	Tamaulipas
`TLA`	Tlaxcala
`VER`	Veracruz
`YUC`	Yucatán
`ZAC`	Zacatecas

United States (`US`)

Required.

Code	Name
`AL`	Alabama
`AK`	Alaska
`AZ`	Arizona
`AR`	Arkansas
`CA`	California
`CO`	Colorado
`CT`	Connecticut
`DE`	Delaware
`DC`	District of Columbia
`FL`	Florida
`GA`	Georgia
`HI`	Hawaii
`ID`	Idaho
`IL`	Illinois
`IN`	Indiana
`IA`	Iowa
`KS`	Kansas
`KY`	Kentucky
`LA`	Louisiana
`ME`	Maine
`MD`	Maryland
`MA`	Massachusetts
`MI`	Michigan
`MN`	Minnesota
`MS`	Mississippi
`MO`	Missouri
`MT`	Montana
`NE`	Nebraska
`NV`	Nevada
`NH`	New Hampshire
`NJ`	New Jersey
`NM`	New Mexico
`NY`	New York
`NC`	North Carolina
`ND`	North Dakota
`OH`	Ohio
`OK`	Oklahoma
`OR`	Oregon
`PA`	Pennsylvania
`RI`	Rhode Island
`SC`	South Carolina
`SD`	South Dakota
`TN`	Tennessee
`TX`	Texas
`UT`	Utah
`VT`	Vermont
`VA`	Virginia
`WA`	Washington
`WV`	West Virginia
`WI`	Wisconsin
`WY`	Wyoming
`AS`	American Samoa
`GU`	Guam
`MP`	Northern Mariana Islands
`PR`	Puerto Rico
`VI`	U.S. Virgin Islands
`AA`	Armed Forces Americas
`AE`	Armed Forces Europe
`AP`	Armed Forces Pacific

Postal Codes

zip is required except in these countries, which have no postal codes or
where post is delivered without one: United Arab Emirates (AE), Antigua and Barbuda (AG), Angola (AO), Antarctica (AQ), Aruba (AW), Burkina Faso (BF), Burundi (BI), Benin (BJ), Bolivia (BO), Bonaire, Sint Eustatius and Saba (BQ), Bahamas (BS), Bouvet Island (BV), Botswana (BW), Belize (BZ), Congo (Democratic Republic) (CD), Central African Republic (CF), Congo (Republic) (CG), Côte d'Ivoire (CI), Cook Islands (CK), Cameroon (CM), Curaçao (CW), Djibouti (DJ), Dominica (DM), Eritrea (ER), Fiji (FJ), Gabon (GA), Grenada (GD), Ghana (GH), Gambia (GM), Equatorial Guinea (GQ), Guyana (GY), Hong Kong (HK), Ireland (IE), Jamaica (JM), Kiribati (KI), Comoros (KM), Saint Kitts and Nevis (KN), Saint Lucia (LC), Libya (LY), Mali (ML), Macao (MO), Mauritania (MR), Montserrat (MS), Malawi (MW), Nauru (NR), Niue (NU), Panama (PA), Palestine (PS), Qatar (QA), Rwanda (RW), Solomon Islands (SB), Seychelles (SC), Sierra Leone (SL), Suriname (SR), South Sudan (SS), São Tomé and Príncipe (ST), Sint Maarten (SX), Syria (SY), Chad (TD), French Southern Territories (TF), Togo (TG), Tokelau (TK), Timor-Leste (TL), Tonga (TO), Tuvalu (TV), Uganda (UG), Vanuatu (VU), Samoa (WS), Yemen (YE), Zimbabwe (ZW).

Customer Addresses API

Endpoints

List Customer Addresses

Path Parameters

Request

Response

Error Responses

Create Customer Address

Path Parameters

Request Body

Fields

Request

Response

Error Responses

Get Customer Address

Path Parameters

Request

Response

Error Responses

Update Customer Address

Path Parameters

Request Body

Fields

Request

Response

Error Responses

Delete Customer Address

Path Parameters

Request

Response

Error Responses

Customer Address Object

Fields

Country Codes

Address Format

Address Checks

Region Codes

Argentina (AR)

Australia (AU)

Brazil (BR)

Canada (CA)

China (CN)

Spain (ES)

Ireland (IE)

India (IN)

Italy (IT)

Japan (JP)

Mexico (MX)

United States (US)

Postal Codes

Argentina (`AR`)

Australia (`AU`)

Brazil (`BR`)

Canada (`CA`)

China (`CN`)

Spain (`ES`)

Ireland (`IE`)

India (`IN`)

Italy (`IT`)

Japan (`JP`)

Mexico (`MX`)

United States (`US`)