PUT /api/address/1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "address1": "12 Market Road",
  "address2": "Suite 4",
  "city": "Chennai",
  "state": "Tamil Nadu",
  "postcode": "600001",
  "countryId": 99,
  "zoneId": 1,
  "phoneNumber": "9876543210",
  "isDefault": 1
}

{
  "status": 1,
  "message": "Resource updated successfully",
  "data": {
    "addressId": 1,
    "customerId": 1,
    "city": "Chennai",
    "countryId": 99,
    "isDefault": 1
  }
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Customer addresses

Update Address

Put /api/address/:id

Authentication: Vendor bearer token required for protected operations; verify exact permission decorator in controller.

Feature area: Customer Addresses

Implementation source: src/api/vendor/controllers/CustomerController.ts

Request example provenance: Illustrative address body based on address model fields; validate exact DTO requirements.

Response example provenance: Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema.

Example status: Illustrative. The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.

PUT

/

api

/

address

/

{id}

PUT /api/address/1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "address1": "12 Market Road",
  "address2": "Suite 4",
  "city": "Chennai",
  "state": "Tamil Nadu",
  "postcode": "600001",
  "countryId": 99,
  "zoneId": 1,
  "phoneNumber": "9876543210",
  "isDefault": 1
}

{
  "status": 1,
  "message": "Resource updated successfully",
  "data": {
    "addressId": 1,
    "customerId": 1,
    "city": "Chennai",
    "countryId": 99,
    "isDefault": 1
  }
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Path Parameters

id

string

required

Value for id.

Body

application/json

Sample request body. Illustrative address body based on address model fields; validate exact DTO requirements. Treat this as an illustrative example, not a complete DTO contract.

firstName

string

lastName

string

address1

string

address2

string

city

string

state

string

postcode

string

countryId

integer

zoneId

integer

phoneNumber

string

isDefault

integer

Response

Successful response. Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema. Example is illustrative and does not guarantee a stable response contract.

status

integer

message

string

data

object

Show child attributes