Location
Platform address APIs for managing customer addresses on behalf of users.
Operations
GET
# Get addresses
POST
# Create address
GET
# Get address by ID
PUT
# Update address
DEL
# Delete address
Parameters
company_id
string
Required
application_id
string
Required
user_id
string
Required
User ID to get addresses for.
Pattern : ^[0-9a-fA-F]{24}$
tags
string
Filter addresses by tags (comma-separated).
checkout_mode
string
Filter by checkout mode.
Enum
is_default
boolean
Filter for default address only.
mobile_no
string
Filter by mobile number.
Response
200
400
List of addresses
AddressListDetail
address
array of object (Address)
Array of Address
_id
string
user_id
string
name
string
address
string
address_type
string
area
string
area_code
string
area_code_slug
string
city
string
state
string
state_code
string
country
string
country_code
string
country_iso_code
string
country_phone_code
string
phone
string
email
string
| email
Nullable
meta
object
landmark
string
sector
string
google_map_point
object
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| value >= -90
| value <= 90
longitude
number
| value >= -180
| value <= 180
is_default_address
boolean
checkout_mode
string
Enum
tags
array of string
app_id
string
is_anonymous
boolean
created_by_user_id
string
pincode
string
store_name
string
expire_at
string
| date-time
Nullable
_custom_json
object
created_on
string
| date-time
last_modified
string
pii_masking
boolean
validation_config
object (ValidationConfig)
ValidationConfig
user_address_count
integer
address_max_limit
integer
Examples
Parameters
company_id:
"1"
application_id:
"5f4000000000000000000001"
user_id:
"5f4222222222222222222222"
Was this section helpful?
GET
Response
Get addresses
getCustomerAddresses
Parameters
company_id
string
Required
application_id
string
Required
Request body
user_id
string
Required
name
string
Required
address
string
Required
address_type
string
area
string
area_code
string
Required
city
string
Required
state
string
Required
country
string
Required
country_code
string
phone
string
Required
landmark
string
is_default_address
boolean
checkout_mode
string
Enum
tags
array of string
_custom_json
object
Response
200
400
Address created
SaveAddressDetail
id
string
address_id
string
is_default_address
boolean
success
boolean
Examples
Parameters
company_id:
"1"
application_id:
"5f4000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create address
createCustomerAddress
Parameters
company_id
string
Required
application_id
string
Required
address_id
string
Required
user_id
string
Required
User ID who owns the address.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
404
Address details
Address
_id
string
user_id
string
name
string
address
string
address_type
string
area
string
area_code
string
area_code_slug
string
city
string
state
string
state_code
string
country
string
country_code
string
country_iso_code
string
country_phone_code
string
phone
string
email
string
| email
Nullable
meta
object
landmark
string
sector
string
google_map_point
object
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| value >= -90
| value <= 90
longitude
number
| value >= -180
| value <= 180
is_default_address
boolean
checkout_mode
string
Enum
tags
array of string
app_id
string
is_anonymous
boolean
created_by_user_id
string
pincode
string
store_name
string
expire_at
string
| date-time
Nullable
_custom_json
object
created_on
string
| date-time
last_modified
string
Examples
Parameters
company_id:
"1"
application_id:
"5f4000000000000000000001"
address_id:
"5f4111111111111111111111"
user_id:
"5f4222222222222222222222"
Was this section helpful?
GET
Response
Get address by ID
getCustomerAddress
Parameters
company_id
string
Required
application_id
string
Required
address_id
string
Required
Request body
user_id
string
Required
name
string
address
string
address_type
string
area
string
area_code
string
city
string
state
string
country
string
country_code
string
phone
string
landmark
string
is_default_address
boolean
checkout_mode
string
Enum
tags
array of string
_custom_json
object
Response
200
400
404
Address updated
UpdateAddressDetail
id
string
address_id
string
is_updated
boolean
is_default_address
boolean
success
boolean
Examples
Parameters
company_id:
"1"
application_id:
"5f4000000000000000000001"
address_id:
"5f4111111111111111111111"
body:
body
Was this section helpful?
PUT
Response
Update address
updateCustomerAddress
Parameters
company_id
string
Required
application_id
string
Required
address_id
string
Required
user_id
string
Required
User ID who owns the address.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
400
Address deleted
DeleteAddressDetail
id
string
address_id
string
is_deleted
boolean
Examples
Parameters
company_id:
"1"
application_id:
"5f4000000000000000000001"
address_id:
"5f4333333333333333333333"
user_id:
"5f4222222222222222222222"
Was this section helpful?
DEL
Response