POST

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
X-API-Key
string
header
required

Headers

​
X-Publishable-Key
string
required

The publicly shareable identifier used to identify your Bolt merchant division.

​
X-Merchant-Client-Id
string

A unique identifier for a shopper's device, generated by Bolt. The value is retrieved with Bolt.state.merchantClientId in your frontend context, per-shopper. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics.

Body

application/json

An address saved on an account, i.e. a physical address plus any additional account-specific metadata.

​
first_name
string
required

The first name of the person associated with this address.

Example:

"Alice"

​
last_name
string
required

The last name of the person associated with this address.

Example:

"Baker"

​
street_address1
string
required

The street address associated with this address.

Example:

"535 Mission St, Ste 1401"

​
locality
string
required

The locality (e.g. city, town, etc...) associated with this address.

Example:

"San Francisco"

​
postal_code
string
required

The postal code associated with this address.

Example:

"94105"

​
country_code
enum<string>
required

The country (in its ISO 3166 alpha-2 format) associated with this address.

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BH,
BS,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
Example:

"US"

​
company
string

The company associated with this address.

Example:

"ACME Corporation"

​
street_address2
string

Any additional, optional, street address information associated with this address.

Example:

"c/o Shipping Department"

​
region
string

The region or administrative area (e.g. state, province, county, etc...) associated with this address.

Example:

"CA"

​
email
string<email>

The email address associated with this address.

Example:

"alice@example.com"

​
phone
string<phone>

The phone number associated with this address.

Example:

"+14155550199"

Response

The address was successfully added

An address saved on an account, i.e. a physical address plus any additional account-specific metadata.

​
first_name
string
required

The first name of the person associated with this address.

Example:

"Alice"

​
last_name
string
required

The last name of the person associated with this address.

Example:

"Baker"

​
street_address1
string
required

The street address associated with this address.

Example:

"535 Mission St, Ste 1401"

​
locality
string
required

The locality (e.g. city, town, etc...) associated with this address.

Example:

"San Francisco"

​
postal_code
string
required

The postal code associated with this address.

Example:

"94105"

​
country_code
enum<string>
required

The country (in its ISO 3166 alpha-2 format) associated with this address.

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BH,
BS,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
Example:

"US"

​
id
string<id>
read-only

The address's unique identifier.

Example:

"D4g3h5tBuVYK9"

​
company
string

The company associated with this address.

Example:

"ACME Corporation"

​
street_address2
string

Any additional, optional, street address information associated with this address.

Example:

"c/o Shipping Department"

​
region
string

The region or administrative area (e.g. state, province, county, etc...) associated with this address.

Example:

"CA"

​
email
string<email>

The email address associated with this address.

Example:

"alice@example.com"

​
phone
string<phone>

The phone number associated with this address.

Example:

"+14155550199"

​
is_default
boolean
read-only

Whether or not this is the default address saved.

Example:

true