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
FDK Method Name: getCustomerAddresses
Retrieve addresses visible to the authenticated user. Optionally filter by repeated address_id parameters; matching IDs are combined with the existing filters. Unknown or inaccessible IDs are omitted. The response envelope, ordering, masking, and user-wide address count are unchanged.
Parameters
address_id
array of string
Optional address IDs to filter by. Repeat the query key for multiple IDs. IDs are matched with OR semantics and duplicates are ignored. Omit the parameter to list all matching addresses. Empty or malformed IDs return 400.
Minimum Items : 1
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
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 a tax profile
POST
# Validate GST registration without saving a profile
DEL
# Delete tax profile
FDK Method Name: getTaxProfiles
Retrieve the authenticated customer's saved GST tax profiles with address_id references. Includes verified, stale, and invalid profiles; deleted profiles are omitted. Fetch full addresses separately using getCustomerAddresses with repeated address_id parameters.
Parameters
address_id
array of string
Optional address IDs to filter by. Repeat the query key for multiple IDs; profiles linked to any supplied address are returned. Duplicate IDs are ignored. Omit the parameter to list all profiles. Empty or malformed IDs return 400.
Minimum Items : 1
Response
200
400
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
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, its registered legal name, and the customer address pincode and state, then save the profile. City, district, and locality are not compared. All three request fields are required. An existing profile for the same GSTIN and address is revalidated. For validation without saving, use validateTaxProfile.
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}$
name
string
Required
Company legal name to validate against the GST registration.
Minimum Length : 1
Maximum Length : 200
address_id
string
Required
Customer address to validate and link to the saved tax profile.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
201
400
404
422
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
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. False when an existing profile was revalidated.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create or revalidate a tax profile
createTaxProfile
FDK Method Name: validateTaxProfile
Validate a GSTIN against its registered legal name. When address_id is provided, also validate the customer's address pincode and state. City, district, and locality are not compared. This operation never creates, updates, or revalidates a saved profile. Call createTaxProfile to save a profile; saving repeats validation.
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}$
name
string
Required
Company legal name to validate against the GST registration.
Minimum Length : 1
Maximum Length : 200
address_id
string
Optional customer address to validate against the GST registration.
Pattern : ^[0-9a-fA-F]{24}$
Response
200
400
404
422
GST registration validated without saving a profile
TaxProfileValidationDetail
validation
object (TaxProfileValidationResult)
TaxProfileValidationResult
gstin
string
Full GSTIN returned without masking.
legal_name
string
trade_name
string
registration_status
string
Enum
address_id
string
Present when the request included an address that was validated.
Pattern : ^[0-9a-fA-F]{24}$
validated_at
string
| date-time
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Validate GST registration without saving a profile
validateTaxProfile
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
Tax profile deleted
TaxProfileDeleteDetail
id
string
is_deleted
boolean
Examples
Parameters
profile_id:
"5f4777777777777777777777"
Was this section helpful?
DEL
Response