Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Account

Add Address

Add an address to a shopper's account address book.

post/v1/account/addresses

Headers

X-Publishable-Keystring

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Idempotency-Keystring

A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Request body

companystring

The company name associated with this address.

countrystring

The name of the country associated with this address.

country_codestring required

The ISO 3166-1 alpha-2 country code associated with this address.

defaultboolean

Set this to true to make this the default shipping address. There can be only one address with default set to true.

door_codestring nullable

The building door code or community gate code.

emailstring email required

An email address.

first_namestring required

The given name of the person associated with this address.

last_namestring required

The surname of the person associated with this address.

localitystring required

The city name details associated with this address.

namestring

The given and surname of the person associated with this address.

phonestring

A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.

postal_codestring required

The the postal or zip code associated with this address.

regionstring required

Not Required for NON US addresses. The region details such as state or province associated with this address.

region_codestring nullable

The ISO 3166-2 region code associated with this address.

    • If specified, value must be valid for the country.
    • If null, value is inferred from the region.
street_address1string required

The street number and street name of the address.

street_address2string

Any apartment, floor, or unit details.

street_address3string nullable

Any additional street address details.

street_address4string nullable

Any additional street address details.

Example request

{
  "company": "Bolt",
  "country": "United States",
  "country_code": "US",
  "default": true,
  "door_code": "123456",
  "email": "alan.watts@example.com",
  "first_name": "Alan",
  "last_name": "Watts",
  "locality": "Brooklyn",
  "name": "Alan Watts",
  "phone": "+12125550199",
  "postal_code": "10044",
  "region": "NY",
  "region_code": "NY",
  "street_address1": "888 main street",
  "street_address2": "apt 3021",
  "street_address3": "c/o Alicia Watts",
  "street_address4": "Bridge Street Apartment Building B",
  "metadata": {
    "customer_id": 234
  }
}

Response

Address Added Successfully

companystring

The company name associated with this address.

countrystring

The name of the country associated with this address.

country_codestring

The ISO 3166-1 alpha-2 country code associated with this address.

door_codestring nullable

The building door code or community gate code.

email_addressstring email

An email address.

first_namestring

The given name of the person associated with this address.

idstring

The unique Bolt ID associated with this address.

last_namestring

The surname of the person associated with this address.

localitystring

The city name details associated with this address.

namestring

The given and surname of the person associated with this address.

phone_numberstring

A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.

postal_codestring

The postal or zip code associated with this address.

priority'primary' | 'listed' nullable

The shopper-indicated priority of this address compared to other addresses on their account.

regionstring

The region details such as state or province associated with this address.

region_codestring nullable

The the ISO 3166-2 region code associated with this address.

street_address1string

The street number and street name of the address.

street_address2string

Any apartment, floor, or unit details.

street_address3string nullable

Any additional street address details.

street_address4string nullable

Any additional street address details.

defaultboolean

Example response

{
  "company": "Bolt",
  "country": "United States",
  "country_code": "US",
  "door_code": "123456",
  "email_address": "alan.watts@example.com",
  "first_name": "Alan",
  "last_name": "Watts",
  "locality": "Brooklyn",
  "name": "Alan Watts",
  "phone_number": "+12125550199",
  "postal_code": "10044",
  "priority": "primary",
  "region": "NY",
  "region_code": "NY",
  "street_address1": "888 main street",
  "street_address2": "apt 3021",
  "street_address3": "c/o Alicia Watts",
  "street_address4": "Bridge Street Apartment Building B",
  "metadata": {
    "customer_id": 234
  }
}