Skip to main content
PATCH
/
user
/
address
/
{addressId}
Update a shipping address
curl --request PATCH \
  --url https://store.salesive.com/api/v1/user/address/{addressId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "name": "Jane Smith",
  "phone": "+2348099887766",
  "email": "jane@example.com",
  "address": "12 Marina Road",
  "city": "Lagos",
  "state": "Lagos",
  "zipCode": "100001",
  "country": "Nigeria",
  "latitude": 6.5244,
  "longitude": 3.3792,
  "landmark": "<string>",
  "isDefault": false
}
'
{}

Request

PATCH /user/address/{addressId}
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json

{
    "name": "Jane A. Smith",
    "phone": "+2348011112222"
}

Path parameters

ParameterTypeDescription
addressIdstringThe id of the address to update.
Updating the core address fields (address, city, state, or country) re-runs address validation against the shipping provider, which requires the address to also carry an email and latitude/longitude. Updating only contact fields such as name or phone skips that step.

Successful response

{
    "status": 200,
    "success": true,
    "message": "Address updated successfully",
    "data": {
        "address": {
            "_id": "651f8a9b2c3d4e5f60718300",
            "name": "Jane A. Smith",
            "phone": "+2348011112222",
            "city": "Lagos",
            "state": "Lagos",
            "country": "Nigeria",
            "isDefault": false,
            "updatedAt": "2026-06-18T03:25:00.000Z"
        }
    }
}

Error responses

{
    "status": 400,
    "success": false,
    "message": "\"addressId\" length must be 24 characters long",
    "data": {}
}
{
    "status": 404,
    "success": false,
    "message": "Address not found or unauthorized",
    "data": {}
}

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Path Parameters

addressId
string
required

Body

application/json
name
string
required
Example:

"Jane Smith"

phone
string
required
Example:

"+2348099887766"

email
string<email>
Example:

"jane@example.com"

address
string
Example:

"12 Marina Road"

city
string
Example:

"Lagos"

state
string
Example:

"Lagos"

zipCode
string
Example:

"100001"

country
string
Example:

"Nigeria"

latitude
number
Example:

6.5244

longitude
number
Example:

3.3792

landmark
string
isDefault
boolean
Example:

false

Response

Address updated.

The response is of type object.