Location
Application address APIs for managing customer addresses.
Operations
GET
# Get addresses
POST
# Create address
GET
# Get address by ID
PUT
# Update address
DEL
# Delete address
Parameters
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
List of addresses
AddressListDetail
address
array of object (Address)
Array of Address
id
string
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
Parameters are not required.
Was this section helpful?
GET
Response
Get addresses
getCustomerAddresses
Parameters
No Parameters
Request body
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
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| value >= -90
| value <= 90
longitude
number
| value >= -180
| value <= 180
Response
200
400
Address created
SaveAddressDetail
id
string
address_id
string
is_default_address
boolean
success
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create address
createCustomerAddress
Parameters
address_id
string
Required
Response
200
404
Address details
CustomerAddress
id
string
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
address_id:
"5f4111111111111111111111"
Was this section helpful?
GET
Response
Get address by ID
getCustomerAddressById
Parameters
address_id
string
Required
Request body
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
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| value >= -90
| value <= 90
longitude
number
| value >= -180
| value <= 180
Response
200
400
404
Address updated
UpdateAddressDetail
id
string
address_id
string
is_updated
boolean
is_default_address
boolean
success
boolean
Examples
Parameters
address_id:
"5f4111111111111111111111"
body:
body
Was this section helpful?
PUT
Response
Update address
updateCustomerAddressById
Parameters
address_id
string
Required
Response
200
404
Address deleted
DeleteAddressDetail
id
string
address_id
string
is_deleted
boolean
Examples
Parameters
address_id:
"5f4444444444444444444444"
Was this section helpful?
DEL
Response
Delete address
deleteCustomerAddressById
Operations
GET
# Get tax profiles
POST
# Create or revalidate tax profile
DEL
# Delete tax profile
FDK Method Name: getTaxProfiles
Retrieve the authenticated customer's saved GST tax profiles.
Parameters
billing_address_id
string
Filter profiles linked to this billing address.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
424
Tax profiles retrieved
TaxProfileListDetail
items
array of object (TaxProfile)
Array of TaxProfile
id
string
gstin
string
Full GSTIN returned without masking.
legal_name
string
trade_name
string
registration_status
string
Enum
profile_status
string
Enum
billing_address_id
string
last_validated_at
string
| date-time
fresh_until
string
| date-time
Derived expiry time after which GST revalidation is required.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tax profiles
getTaxProfiles
FDK Method Name: createTaxProfile
Validate a GSTIN against a billing address and create a new tax profile or revalidate an existing matching profile.
Parameters
No Parameters
Request body
gstin
string
Required
Goods and Services Tax Identification Number.
Minimum Length : 15
Maximum Length : 15
Pattern : ^[0-9A-Za-z]{15}$
billing_address_id
string
Required
Customer billing address to validate against the GST registration.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
201
400
404
422
424
Existing tax profile revalidated
TaxProfileSaveDetail
profile
object (TaxProfile)
TaxProfile
id
string
gstin
string
Full GSTIN returned without masking.
legal_name
string
trade_name
string
registration_status
string
Enum
profile_status
string
Enum
billing_address_id
string
last_validated_at
string
| date-time
fresh_until
string
| date-time
Derived expiry time after which GST revalidation is required.
created
boolean
True when a new profile was created and false when an existing profile was revalidated.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create or revalidate tax profile
createTaxProfile
FDK Method Name: deleteTaxProfile
Soft-delete a tax profile owned by the authenticated customer.
Parameters
profile_id
string
Required
Tax profile identifier.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
404
424
Tax profile deleted
TaxProfileDeleteDetail
id
string
is_deleted
boolean
Examples
Parameters
profile_id:
"5f4777777777777777777777"
Was this section helpful?
DEL
Response