Logistic
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
The Country & Locality resource contains extensive data about countries and how they're structured. For instance, in India, it's organized as Country, State, City, and Pincode, while in Australia, it's simpler with State, City, and Zipcode. We've made this structure consistent globally, covering Country, State, City, Pincode, and Sector. Using this resource, you can easily access hierarchical information for each country. This resource helpful for retrieving detailed locality information, such as lists of states for a given country, cities for a given state and country, and more. Moreover, it's crucial for validating customer addresses, like verifying the validity of a pincode. Additionally, it provides in-depth locality data, such as offering city and country information for a specific sector in the UAE.
Operations
GET
# Get pincode details
GET
# Get deliverable countries
GET
# Get countries
GET
# Get country details
GET
# Get Localities
GET
# Get Locality API
POST
# Validate address
Get details of a specific pincode, such as obtaining its city and state information.
Parameters
pincode
string
Required
Postal code or PIN code of the address area.
Response
200
Get pincode data
PincodeDetailsResult
success
boolean
Whether operation was successful.
data
array of object (PincodeData)
Contains the actual response data when the request is successful, providing details like pincode information or related data.
Array of PincodeData
parents
array of object (PincodeParentsResult)
List of object representing a collection of geographical locations, each associated with specific hierarchical data such as cities, states, or countries.
Array of PincodeParentsResult
sub_type
string
Specific type of locality hierarchy the pincode belongs to (e.g., city, state, country).
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
name
string
The actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
uid
string
Unique identifier for the locality.
meta
object (PincodeMetaResult)
Deprecated
PincodeMetaResult
zone
string
Geographical region to which the pincode belongs,
often used to categorize or group pincodes for regional management or postal purposes.
internal_zone_id
integer
A unique identifier used within the system to track or reference the specific zone associated with the pincode.
deliverables
array of string
List of deliverables associated with the pincode.
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
error
object (PincodeErrorSchemaResult)
PincodeErrorSchemaResult
message
string
Nullable
The error message describing the issue.
value
string
Nullable
A specific code or identifier related to the error, used for referencing or categorizing the error.
type
string
Nullable
The classification of the error, indicating the kind of issue.
meta_code
object (CountryMeta)
CountryMeta
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
phone_code
string
International dialing code for the country (e.g., +1).
parent_id
string
Nullable
Identifier for the parent of the current locality.
zone
string
Geographical region to which the locality belongs, often used to categorize or group regions for regional management or postal purposes.
deliverables
array of string
List of deliverables associated with the locality.
Minimum Items : 0
hierarchy
array of object (CountryHierarchy)
Levels within the country (e.g., states, cities) and their slugs (e.g., [{name: State, slug: state}, {name: City, slug: city}]).
Array of CountryHierarchy
display_name
string
A string representing the display name of the hierarchy level.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
latitude
string
Geographical latitude of the country (e.g., 37.0902).
longitude
string
Geographical longitude of the country (e.g., -95.7129).
country_code
string
The ISO 3166-1 alpha-2 code representing the country (e.g., IN for India, US for the United States).
isd_code
string
The International Subscriber Dialing (ISD) code, also known as the country dialing code, used for making international phone calls to the country (e.g., +91 for India, +1 for the United States).
lat_long
object (PincodesLatLongData)
PincodesLatLongData
type
string
Specifies the type of geographical feature or data, typically Point for coordinates in geographic data systems.
coordinates
array of string
Contains the latitude and longitude values representing the precise location. The format is usually an array with two values: [longitude, latitude].
localities
array of object (LocalityParent)
Representing the localities that are associated with or contained within the current locality.
It provides detailed information about the parent localities, including their names, identifiers, and hierarchical relationships.
Array of LocalityParent
id
string
A string serving as the unique identifier.
name
string
A string representing the name of the locality.
display_name
string
A string providing the display name of the locality.
meta
object
Deprecated
An object with additional properties for metadata, defaulting to an empty object.
Default Value : [object Object]
parent_ids
array of string
Nullable
A nullable array of strings listing the identifiers of parent localities, defaulting to an empty array.
Default Value :
type
string
A string indicating the type of locality.
serviceability
object
An object with additional properties for serviceability details, defaulting to an empty object.
Default Value : [object Object]
parent_uid
string
Nullable
A nullable string for the unique identifier of the parent locality, defaulting to an empty string.
Default Value : null
code
string
Unique Identifier of the Geolocality
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
sub_type
string
Indicates the specific type of locality hierarchy the pincode belongs to (e.g., city, state, country).
name
string
The actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
uid
string
This field stands for Unique Identifier, a unique value assigned to each instance to ensure differentiation and reference.
error
object (PincodeErrorSchemaResult)
PincodeErrorSchemaResult
message
string
Nullable
The error message describing the issue.
value
string
Nullable
A specific code or identifier related to the error, used for referencing or categorizing the error.
type
string
Nullable
The classification of the error, indicating the kind of issue.
request_uuid
string
Nullable
Unique identifier for a request.
stormbreaker_uuid
string
Unique identifier generated by stormbreaker service.
Examples
Parameters
pincode:
"415110"
Was this section helpful?
GET
Response
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
Response
200
Success
CountryResult
results
array of object (CountryEntity)
An array containing multiple instances of CountryEntityResult, which detail individual country entities.
Array of CountryEntity
meta
object (CountryMeta)
CountryMeta
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
phone_code
string
International dialing code for the country (e.g., +1).
parent_id
string
Nullable
Identifier for the parent of the current locality.
zone
string
Geographical region to which the locality belongs, often used to categorize or group regions for regional management or postal purposes.
deliverables
array of string
List of deliverables associated with the locality.
Minimum Items : 0
hierarchy
array of object (CountryHierarchy)
Levels within the country (e.g., states, cities) and their slugs (e.g., [{name: State, slug: state}, {name: City, slug: city}]).
Array of CountryHierarchy
display_name
string
A string representing the display name of the hierarchy level.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
latitude
string
Geographical latitude of the country (e.g., 37.0902).
longitude
string
Geographical longitude of the country (e.g., -95.7129).
country_code
string
The ISO 3166-1 alpha-2 code representing the country (e.g., IN for India, US for the United States).
isd_code
string
The International Subscriber Dialing (ISD) code, also known as the country dialing code, used for making international phone calls to the country (e.g., +91 for India, +1 for the United States).
logistics
object (LogisticsResult)
Deprecated
LogisticsResult
dp
object
Delivery partner details.
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
type
string
Specifies the type of geographical feature or data, typically Point for coordinates in geographic data systems.
is_active
boolean
Whether the country entity is currently active or not.
parent_id
array of string
Identifier for the parent of the current locality.
sub_type
string
Specific type of locality hierarchy the pincode belongs to (e.g., city, state, country).
name
string
Name of the country.
uid
string
Unique identifier for the country.
onboarding_allowed
boolean
Denotes whether a seller can get onboarded to a perticular country.
serviceability
Undefined Type
Defines the attributes related to the serviceability of a specific region or entity.
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
A string indicating the type of geographical data.
coordinates
array of number
An array of numbers representing the latitude and longitude coordinates of the pincode.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
onboarding
boolean
List countries which allowed for onboard on Platform.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
| value <= 250
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
q
string
Used to search for matching results based on the provided input.
hierarchy
string
Fetch countries that has certain heirarchy present.
phone_code
string
Filter countries by phone code (e.g., +1 for United States, +91 for India, etc.).
Response
200
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (GetCountriesItems)
A list of country objects containing detailed information about each country.
Array of GetCountriesItems
id
string
A string serving as the unique identifier.
sub_type
string
A category for classifying the country into a specific subtype.
uid
string
A globally unique identifier for the country.
name
string
The official or widely recognized name of the country used in general contexts.
iso2
string
The 2-letter ISO code for the country.
iso3
string
The 3-letter ISO code for the country.
timezones
array of string
A list of timezones associated with the country.
hierarchy
array of object (HierarchyItems)
A hierarchical list of items representing organizational levels within the country.
Array of HierarchyItems
name
string
The name of the item as displayed to the user, usually in a UI or listing.
display_name
string
It represent a country display name.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
phone_code
string
A country-specific phone code.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
type
string
The type or classification of the country (e.g., sovereign or dependent).
latitude
string
The latitude of the central point of the country.
longitude
string
The longitude of the central point of the country.
display_name
string
A user-friendly name for the country, typically for display purposes.
has_next_hierarchy
boolean
A boolean indicating whether additional hierarchical regions or divisions are present.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
onboarding:
true
page_no:
1
page_size:
6
q:
"400603"
hierarchy:
"pincode"
phone_code:
"+91"
Was this section helpful?
GET
Response
Get details about a particular country and its address format customized for different business scenarios.
Parameters
country_iso_code
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
Response
200
400
Get country data.
GetCountry
meta
object (CountryMetaFields)
CountryMetaFields
application_fields
object (ApplicationFields)
ApplicationFields
address
array of object (GetCountryFieldsAddress)
Nullable
Array of GetCountryFieldsAddress
display_name
string
The name displayed for the address field.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
required
boolean
Indicates whether the field is mandatory for input.
edit
boolean
Indicates whether the field is editable.
input
string
The type of input type for the field (e.g., textbox, etc.).
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
Type of field validation (e.g., regex, length).
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
The regular expression pattern used for field validation.
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
Minimum length of the field.
max
integer
Nullable
Maximum length of the field.
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
error_text
string
Nullable
Error message text displayed when validation fails or input is incorrect.
serviceability_fields
array of string
Nullable
An array of strings representing fields related to the serviceability of the country.
address_template
object (GetCountryFieldsAddressTemplateApplication)
GetCountryFieldsAddressTemplateApplication
checkout_form
string
A string representing the template used for displaying address fields in a checkout form.
store_os_form
string
A string representing the template used for displaying address fields in a store operating system form.
default_display
string
A string representing the default template used for displaying address fields.
id
string
A string serving as the unique identifier.
name
string
A string representing the official name of the country.
display_name
string
A string providing the display name of the country, typically used for user-friendly identification.
iso2
string
A string representing the ISO 3166-1 alpha-2 code for the country, which is a two-letter code used internationally.
iso3
string
A string representing the ISO 3166-1 alpha-3 code for the country, which is a three-letter code used for international identification.
timezones
array of string
Nullable
A nullable array of strings listing the timezones applicable to the country.
hierarchy
array of object (CountryHierarchy)
An array referencing the CountryHierarchy schema, detailing the administrative or geographical structure of the country.
Array of CountryHierarchy
display_name
string
A string representing the display name of the hierarchy level.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
phone_code
string
A string indicating the country's international phone dialing code, not restricted to a predefined list.
latitude
string
A string representing the latitude of the country's geographic center.
longitude
string
A string representing the longitude of the country's geographic center.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
type
string
A string indicating the type of the country entity.
fields
object (GetCountryFields)
GetCountryFields
address
array of object (GetCountryFieldsAddress)
An array containing instances of GetCountryFieldsAddress, which detail the address fields for a country.
Array of GetCountryFieldsAddress
display_name
string
The name displayed for the address field.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
required
boolean
Indicates whether the field is mandatory for input.
edit
boolean
Indicates whether the field is editable.
input
string
The type of input type for the field (e.g., textbox, etc.).
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
Type of field validation (e.g., regex, length).
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
The regular expression pattern used for field validation.
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
Minimum length of the field.
max
integer
Nullable
Maximum length of the field.
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
error_text
string
Nullable
Error message text displayed when validation fails or input is incorrect.
serviceability_fields
array of string
An array of strings representing fields related to the serviceability of the country.
address_template
object (GetCountryFieldsAddressTemplate)
GetCountryFieldsAddressTemplate
checkout_form
string
A string representing the template used for displaying address fields for respective entity.
store_os_form
string
A string representing the template used for displaying address fields for respective entity.
default_display
string
A string representing the default template used for displaying address fields.
Examples
Parameters
country_iso_code:
"IN"
Was this section helpful?
GET
Response
Parameters
locality_type
string
Required
A `locality_type` contains unique geographical division.
Enum
country
string
A `country` contains a specific value of the country iso2 code.
state
string
A `state` contains a specific value of the state, province.
city
string
A `city` contains a specific value of the city.
page_no
integer
Page number.
Default Value : 1
page_size
integer
| value <= 1000
Page size.
Default Value : 12
q
string
The search string to search in the list of locality by name.
sector
string
Sector name of mentioned address.
Response
200
400
Get Localities data
GetLocalitiesApp
items
array of object (LocalitiesApp)
An array containing multiple instances of Localities, which detail individual localities.
Array of LocalitiesApp
id
string
A string serving as the unique identifier.
custom_meta
object
Custom meta to store custom json against hierarchy.
name
string
The name of the locality.
display_name
string
The display name of the locality.
parent_ids
array of string
List of parent locality Ids.
Default Value :
meta
object
Deprecated
Additional metadata for the locality.
Default Value : [object Object]
type
string
The type of the locality.
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
A string indicating the type of geographical data.
coordinates
array of number
An array of numbers representing the latitude and longitude coordinates of the pincode.
parent_uid
string
Nullable
Unique identifier of the parent locality, if available.
localities
array of object (LocalityParent)
List of child localities.
Array of LocalityParent
id
string
A string serving as the unique identifier.
name
string
A string representing the name of the locality.
display_name
string
A string providing the display name of the locality.
meta
object
Deprecated
An object with additional properties for metadata, defaulting to an empty object.
Default Value : [object Object]
parent_ids
array of string
Nullable
A nullable array of strings listing the identifiers of parent localities, defaulting to an empty array.
Default Value :
type
string
A string indicating the type of locality.
serviceability
object
An object with additional properties for serviceability details, defaulting to an empty object.
Default Value : [object Object]
parent_uid
string
Nullable
A nullable string for the unique identifier of the parent locality, defaulting to an empty string.
Default Value : null
code
string
Unique Identifier of the Geolocality
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
code
string
Unique identifier of the geolocality.
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
locality_type:
"pincode"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
page_no:
1
page_size:
1
q:
"111045"
Was this section helpful?
GET
Response
Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details.
Parameters
locality_type
string
Required
A `locality_type` contains value geographical division.
Enum
locality_value
string
Required
A `locality_value` contains a specific unique id of the locality.
country
string
A `country` contains a specific value of the country iso2 code.
state
string
A `state` contains a specific value of the state, province.
city
string
A `city` contains a specific value of the city.
sector
string
A `sector` is a distinct category or division within an area
Response
200
400
Get Locality data
GetLocalityApp
id
string
A string serving as the unique identifier.
name
string
The actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
meta
object
Deprecated
Contains meta information related to the locality.
parent_uid
string
Nullable
Unique identifier for the immediate parent of the locality.
serviceability
Undefined Type
Defines the serviceability information for a perticular courier partner's scheme for the locality.
code
string
Code assigned to a locality, which is unique to its immediate parent.
custom_meta
object
Custom meta to store custom json against hierarchy.
parent_ids
array of string
Identifiers for the parent of the current locality.
Default Value :
type
string
Specifies the category of the address component, such as pincode, state, city, country, or sector.
Enum
localities
array of object (LocalityParent)
Representing the localities that are associated with or contained within the current locality.
It provides detailed information about the parent localities, including their names, identifiers, and hierarchical relationships.
Array of LocalityParent
id
string
A string serving as the unique identifier.
name
string
A string representing the name of the locality.
display_name
string
A string providing the display name of the locality.
meta
object
Deprecated
An object with additional properties for metadata, defaulting to an empty object.
Default Value : [object Object]
parent_ids
array of string
Nullable
A nullable array of strings listing the identifiers of parent localities, defaulting to an empty array.
Default Value :
type
string
A string indicating the type of locality.
serviceability
object
An object with additional properties for serviceability details, defaulting to an empty object.
Default Value : [object Object]
parent_uid
string
Nullable
A nullable string for the unique identifier of the parent locality, defaulting to an empty string.
Default Value : null
code
string
Unique Identifier of the Geolocality
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
Examples
Parameters
locality_type:
"pincode"
locality_value:
"111045"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
Was this section helpful?
GET
Response
Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system.
Parameters
country_iso_code
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
template_name
string
Required
The type of address form.
Enum
Request body
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address_meta
object
Has other Meta Data.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
The ISO code of the country for which the bulk export is being processed.
Response
200
400
Valid
ValidateAddressDetails
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address_meta
object
Has other Meta Data.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
The ISO code of the country for which the bulk export is being processed.
Examples
Parameters
country_iso_code:
"IN"
template_name:
"checkout_form"
body:
body
Was this section helpful?
POST
Response
Courier partners are organizations that specialize in providing delivery services for packages, parcels, documents, or goods. They play a crucial role in the logistics and supply chain industry, ensuring that items are transported efficiently and securely from one location to another. These partners may offer a variety of services, including same-day delivery, international shipping, tracking capabilities, and specialized handling for fragile or high-value items. This resource allows to get the courier partners for the shipments.
Operations
POST
# Serviceable Courier Partners
Get all the serviceable courier partners of a destination and the shipments.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique identifier of the sales channel.
Request body
from_location
object (ShipmentsCourierPartnersServiceability)
Required
ShipmentsCourierPartnersServiceability
pincode
string
A string indicating the postal code or PIN code of the address area.
sector_code
string
Specifies the sector or district code of the address if applicable.
state_code
string
Indicates the state or province code of the address.
city_code
string
Denote the city or municipality code of the address.
country_code
string
Required
ISO2 code for the country of the address.
to_location
object (ShipmentsCourierPartnersServiceability)
Required
ShipmentsCourierPartnersServiceability
pincode
string
A string indicating the postal code or PIN code of the address area.
sector_code
string
Specifies the sector or district code of the address if applicable.
state_code
string
Indicates the state or province code of the address.
city_code
string
Denote the city or municipality code of the address.
country_code
string
Required
ISO2 code for the country of the address.
shipments
array of object (CPShipments)
List of shipments.
Array of CPShipments
id
string
A string serving as the unique identifier.
location_id
number
Unique identifier of the selling location.
location_tags
array of string
Tags associated with the selling location.
shipment_weight
number
Weight(grams) of the shipment.
shipment_volumetric_weight
number
Volumetric weight(grams) of the shipment.
shipment_cost
number
Total Cost of the shipment.
shipment_dimension
object (ShipmentDimension)
ShipmentDimension
height
number
Required
Height of the shipment in centimeters.
length
number
Required
Length of the shipment in centimeters.
width
number
Required
Width of the shipment in centimeters.
is_default
boolean
If the dimensions are default.
unit
string
Measurement unit for dimensions.
courier_partner_schemes
array of string
A List of courier schemes.
location_type
string
Type of that particular location.
articles
array of object (ShipmentsArticles)
List of articles in the shipment.
Array of ShipmentsArticles
id
string
A string serving as the unique identifier.
item_id
integer
The Item Id of the article.
sla
string
Gives sla for that article.
tags
array of string
Tags assigned to Item.
size
string
The size of the article.
group_id
string
The group Id of the article.
weight
object (ArticleWeight)
ArticleWeight
shipping
integer
Required
The weight(grams) of the article for shipping purposes, typically measured in a specified unit.
unit
string
Required
The unit of measurement used for the weight value.
is_default
boolean
Required
A boolean indicating whether this weight is the default weight for the article.
attributes
object (ArticleAttributes)
ArticleAttributes
battery_operated
string
Required
Yes/no indicating whether the article is powered by batteries.
is_flammable
string
Required
Yes/no indicating whether the article is considered flammable or poses a fire hazard.
category_id
integer
The category Id of the article.
department_id
integer
The Department Id of the article.
dimension
object (ArticleDimension)
ArticleDimension
height
number
Required
The height of the article.
is_default
boolean
Required
A boolean indicating whether this dimension is the default dimension.
length
number
Required
The length of the article.
unit
string
Required
The unit of measurement used for the dimensions.
width
number
Required
The width of the article.
price
number
Final Price of the article after discounts.
brand_id
integer
The brand Id of the article.
quantity
integer
The quantity of the article.
manufacturing_time
integer
The manufacturing time of the article.
manufacturing_time_unit
string
The unit of measurement for manufacturing time.
mto_quantity
integer
The Made to Order quantity of the article.
is_gift
boolean
A boolean indicating whether the article is a gift.
is_set
boolean
A boolean indicating whether the article is a set.
set
object (ArticleSet)
ArticleSet
name
string
The name of the article set.
quantity
integer
The quantity of the article set.
size_distribution
object (ArticleSizeDistribution)
ArticleSizeDistribution
sizes
array of object (SetSize)
Required
A collection of different size options and their corresponding pieces.
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Required
The number of pieces in the set.
size
string
Required
The size description of the set.
set_quantity
integer
The quantity of the article set.
delivery_slots
object (ArticleDeliverySlots)
ArticleDeliverySlots
delivery_date
string
| date-time
The delivery date for the article.
min_slot
string
The minimum delivery time slot.
max_slot
string
The maximum delivery time slot.
return_reason
object (ArticleReturnReason)
ArticleReturnReason
qc_type
array of string
List of strings representing the return reason values, such as doorstep or pre-delivery quality checks.
Enum
journey
string
Journey type of the shipment forward or return.
Enum
payment_mode
string
Payment mode opted for the shipment.
Enum
Response
200
400
422
Get courier partner data.
ShipmentCourierPartnerResult
courier_partners
array of object (CourierPartners)
List of courier partners available for the shipment.
Array of CourierPartners
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the courier partner.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
shipments
array of object (ShipmentCourierPartners)
List of shipment details associated with courier partners.
Array of ShipmentCourierPartners
id
string
A string serving as the unique identifier.
courier_partners
array of object (CourierPartners)
Courier partners of the shipment.
Array of CourierPartners
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the courier partner.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
Was this section helpful?
POST
Response
The promise is a time range or date when the order is expected to be delivered to the customer from the date of order. The Promise resource provides the estimated delivery time for a given product from the store to the customer's location. This is typically presented as a range, such as from April 19th to April 22nd, and this can be expressed in minutes, hours, or days, depending on the product.
Operations
GET
# Get delivery promise
Get delivery promises for both global and store levels based on a specific locality type.
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
Headers
x-location-detail
string
Required
Custom header for this operation
x-application-data
string
Required
Custom header for this operation
Response
200
400
Get delivery promise data
GetPromiseDetails
items
array of object (StorePromise)
List of delivery promises for each store.
Array of StorePromise
uid
integer
Unique identifier of a store.
code
string
Code assigned to a store.
name
string
Name of a store.
promise
object (Promise)
Promise
min
string
| date-time
Earliest delivery time.
max
string
| date-time
Latest delivery time.
promise
object (Promise)
Promise
min
string
| date-time
Earliest delivery time.
max
string
| date-time
Latest delivery time.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
page_no:
1
page_size:
6
Was this section helpful?
GET
Response