Skip to main content
PATCH
/
api
/
platform
/
v1
/
shoppers
/
{shopper_ref}
/
addresses
/
{address_ref}
.json
Update a shopper address
curl --request PATCH \
  --url https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/addresses/{address_ref}.json \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "external_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "company_name": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "address_3": "<string>",
    "address_4": "<string>",
    "city": "<string>",
    "province": "<string>",
    "province_code": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "zip": "<string>",
    "phone": "<string>",
    "latitude": 123,
    "longitude": 123,
    "time_zone": "<string>",
    "is_default": true
  }
}
'
{
  "id": 123,
  "external_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "company": "<string>",
  "address": "<string>",
  "address_2": "<string>",
  "address_3": "<string>",
  "address_4": "<string>",
  "city": "<string>",
  "state": "<string>",
  "province": "<string>",
  "province_code": "<string>",
  "country": "<string>",
  "country_code": "<string>",
  "zip": "<string>",
  "phone": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "time_zone": "<string>",
  "default": true,
  "is_default": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

shopper_ref
string
required

Shopper external ID

address_ref
string
required

Address external ID

Body

application/json
address
object

Response

Address updated

id
integer
external_id
string | null
first_name
string | null
last_name
string | null
company
string | null
address
string | null
address_2
string | null
address_3
string | null
address_4
string | null
city
string | null
state
string | null
province
string | null
province_code
string | null
country
string | null
country_code
string | null
zip
string | null
phone
string | null
latitude
string | null
longitude
string | null
time_zone
string | null
default
boolean
is_default
boolean