Update an Existing Address

PATCH

{store_url}/api/v1/account/addresses/{address_id}

Updates an existing saved address belonging to the currently authenticated customer.

This endpoint is typically used to:

Edit address details (street, city, coordinates, etc.)

Update recipient name or mobile number

Change the default address

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PATCH '{store_url}/api/v1/account/addresses/55' \
--header 'Content-Type: application/json' \
--data '{
    "address_district": "Al Olaya",
    "address_city_id": 1,
    "address_country_id": 183,
    "address_type": "general",
    "name": "Ahmed Al Saud",
    "mobile": "+966501234567",
    "address_street": "King Fahd Road",
    "address_formatted": "King Fahd Rd, Al Olaya, Riyadh, Saudi Arabia",
    "short_address": "Al Olaya, Riyadh",
    "address_lat": "24.7136",
    "address_lng": "46.6753",
    "meta": {
        "city_name": "Riyadh",
        "postcode": "11564",
        "building_number": "12A",
        "additional_number": "9876",
        "property1": "string",
        "property2": "string"
    },
    "is_default": true
}'

Response Example

200 - Example 1

{
    "id": 55,
    "name": "Ahmed Al Saud",
    "mobile": "+966501234567",
    "address_street": "King Fahd Road",
    "address_district": "Al Olaya",
    "address_formatted": "King Fahd Rd, Al Olaya, Riyadh, Saudi Arabia",
    "short_address": "Al Olaya, Riyadh",
    "address_lat": "24.7136",
    "address_lng": "46.6753",
    "address_type": "home",
    "city": {
        "id": 1,
        "ar_name": "الرياض",
        "en_name": "Riyadh",
        "property1": "string",
        "property2": "string"
    },
    "country": {
        "id": 183,
        "name": "Saudi Arabia",
        "code": "SA",
        "country_code": "+966",
        "currency_code": "SAR",
        "iso_code_2": "SA",
        "iso_code_3": "SAU",
        "property1": "string",
        "property2": "string"
    },
    "meta": {
        "property1": "string",
        "property2": "string"
    },
    "is_customer_default": true,
    "is_default": true,
    "property1": "string",
    "property2": "string"
}

Modified at 2026-02-23 08:58:43

Get an Address by ID

Delete Address