Home›User Management›Addresses

Addresses

Manage saved delivery addresses for a user. Addresses are used to pre-fill the delivery details when calling init.

List Addresses

GET/ret11/api/user-addresses

Auth Required

Include a Bearer token.

Parameter	In	Required	Description
userId	query	optional	Your own platform's user ID for the logged-in user

Returns an array of saved address objects.

Response Example

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "street": "MG Road",
    "landmark": "Near Metro Station",
    "city": "Bengaluru",
    "areaCode": "560001",
    "state": "Karnataka",
    "type": "HOME",
    "lat": 12.9716,
    "lng": 77.5946,
    "receiversName": "John Doe",
    "receiversPhone": "9876543210",
    "createdAt": "2026-01-01T10:00:00.000Z"
  }
]

Create Address

POST/ret11/api/user-addresses

Auth Required

Include a Bearer token.

Request Body

Field	Type	Required	Description
street	string	required	Street name
landmark	string	required	Nearby landmark
city	string	required	City
areaCode	string	required	PIN / postal code
state	string	required	State
type	string	required	Address label: `"HOME"` \| `"WORK"` \| `"OTHER"`
lat	number	required	Latitude
lng	number	required	Longitude
receiversName	string	optional	Recipient name (if different from account holder)
receiversPhone	string	optional	Recipient phone
userId	string	optional	Your own platform's user ID for the logged-in user

Request Example

{
  "street": "12-34, MG Road",
  "landmark": "Near Metro Station",
  "city": "Bengaluru",
  "areaCode": "560001",
  "state": "Karnataka",
  "type": "HOME",
  "lat": 12.9716,
  "lng": 77.5946
}

Response Example

{
  "id": "019b848d-4bb5-7fbb-a92a-3bcc4b092268",
  "street": "12-34, MG Road",
  "landmark": "Near Metro Station",
  "city": "Bengaluru",
  "areaCode": "560001",
  "state": "Karnataka",
  "type": "HOME"
}

Update Address

PATCH/ret11/api/user-addresses/{id}

Auth Required

Include a Bearer token.

Same fields as Create, all optional. Only send the fields you want to change.

Response Example

{
  "id": "019b848d-4bb5-7fbb-a92a-3bcc4b092268",
  "userId": "120123",
  "street": "12-34, MG Road",
  "landmark": "Near Metro Station",
  "city": "Bengaluru",
  "areaCode": "560001",
  "state": "Karnataka",
  "type": "HOME",
  "lat": 12.9716,
  "lng": 77.5946,
  "receiversName": null,
  "createdAt": "2026-06-01T10:00:00.000Z",
  "updatedAt": "2026-06-01T10:05:00.000Z"
}

Delete Address

DELETE/ret11/api/user-addresses/{id}

Auth Required

Include a Bearer token.

Parameter	In	Required	Description
id	path	required	Address UUID to delete
userId	query	optional	Your own platform's user ID for the logged-in user

Returns { "message": "Address deleted successfully" }.