Skip to main content
PATCH
Update Address

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

X-Customer-Token
string
header
required

Storefront customer authentication token. Issued via POST /admin/customers/{id}/token. Required for accessing /storefront/customers/, /storefront/orders/.

Path Parameters

address_id
string
required

Body

application/json
name
string
required
line1
string
required
city
string
required
postal_code
string
required
country
string
required
company
string
line2
string
state
string
phone
string
type
enum<string>
default:both
Available options:
shipping,
billing,
both
is_default
boolean
default:false

Response

200 - application/json

Success

id
string
name
string
company
string
line1
string
line2
string
city
string
state
string
postal_code
string
country
string

ISO 3166-1 alpha-2

phone
string
type
enum<string>
Available options:
shipping,
billing,
both
is_default
boolean
created_at
string<date-time>