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 deliverable countries
GET
# Get countries
GET
# Get country details
GET
# Get Localities
GET
# Get Locality API
POST
# Validate address
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
GET
Response
200
Success
Hide
results
array of object (CountryEntity)
An array containing multiple instances of CountryEntityResult, which detail individual country entities.
Show
Examples
Parameters
Parameters are not required.
Response
Get deliverable countries
getAllCountries
Parameters
onboardingquery
boolean
List countries which allowed for onboard on Platform.
page_noquery
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizequery
integer
| value <= 250
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
qquery
string
Used to search for matching results based on the provided input.
hierarchyquery
string
Fetch countries that has certain heirarchy present.
phone_codequery
string
Filter countries by phone code (e.g., +1 for United States, +91 for India, etc.).
GET
Response
200
Successfully retrieved all countries with associated data.
Hide
Represents the result of a request for a list of countries, including details of each country and pagination information for navigating through large sets of data.
items
array of object (GetCountriesItems)
A list of country objects containing detailed information about each country.
Show
page
object (Page)
Show
Examples
Parameters
onboarding:
true
page_no:
1
page_size:
6
q:
"400603"
hierarchy:
"pincode"
phone_code:
"+91"
Response
Get countries
getCountries
Get details about a particular country and its address format customized for different business scenarios.
Parameters
country_iso_codepath
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
GET
Response
200
400
Get country data.
Hide
This object represents the details of a country, including its identifiers, geographical codes, and associated fields.
meta
object (CountryMetaFields)
Show
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.
Show
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)
Show
type
string
A string indicating the type of the country entity.
fields
object (GetCountryFields)
Show
Response
Get country details
getCountry
Parameters
locality_typepath
string
Required
A `locality_type` contains unique geographical division.
Enum
countryquery
string
A `country` contains a specific value of the country iso2 code.
statequery
string
A `state` contains a specific value of the state, province.
cityquery
string
A `city` contains a specific value of the city.
page_noquery
integer
Page number.
Default Value : 1
page_sizequery
integer
| value <= 1000
Page size.
Default Value : 12
qquery
string
The search string to search in the list of locality by name.
sectorquery
string
Sector name of mentioned address.
GET
Response
200
400
Get Localities data
Hide
items
array of object (LocalitiesApp)
An array containing multiple instances of Localities, which detail individual localities.
Show
page
object (Page)
Show
Response
Get Localities
getLocalities
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_typepath
string
Required
A `locality_type` contains value geographical division.
Enum
locality_valuepath
string
Required
A `locality_value` contains a specific unique id of the locality.
countryquery
string
A `country` contains a specific value of the country iso2 code.
statequery
string
A `state` contains a specific value of the state, province.
cityquery
string
A `city` contains a specific value of the city.
sectorquery
string
A `sector` is a distinct category or division within an area
GET
Response
200
400
Get Locality data
Hide
Represents a collection of geographical locations, each associated with specific hierarchical data such as cities, states, or countries.
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
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.
Show
Response
Get Locality API
getLocality
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_codepath
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
template_namepath
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.
POST
Response
200
400
Valid
Hide
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
Validate address
validateAddress
Fulfillment options define the different ways an order can be delivered or collected. These options include home delivery, where the order is shipped to the customer's address, and store-pickup, where the customer picks up the order from a store. Express delivery provides a faster shipping option for urgent orders, while standard delivery follows regular shipping timelines. Businesses can configure these options based on location, availability, and customer preferences to enhance logistics efficiency and customer satisfaction.
Operations
GET
# Get fulfillment options
GET
# Get Fulfillment Option Stores
Parameters
product_slugquery
string
The unique identifier of the product.
store_idquery
integer
The unique identifier of the store.
Headers
x-application-data
string
Required
Custom header for this operation
GET
Response
200
Valid
Hide
A list of available delivery service options.
items
array of object (FulfillmentOptionItem)
List of fulfillment option items.
Show
Examples
Parameters
product_slug:
"productj-2"
store_id:
1
Response
Get fulfillment options
getFulfillmentOptions
Fetches a paginated list of stores associated with a given fulfillment option slug.
Parameters
slugpath
string
Required
The unique slug identifier of the fulfillment option.
page_noquery
integer
The current page number for pagination.
Default Value : 1
page_sizequery
integer
The number of items per page.
Default Value : 10
GET
Response
200
Successfully retrieved fulfillment option stores.
Hide
items
array of object (FulfillmentOptionStore)
List of stores with their details.
Show
page
object (Page)
Show
Examples
Parameters
slug:
"standard-delivery"
page_no:
1
page_size:
10
Response
Get Fulfillment Option Stores
getFulfillmentOptionStores
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
Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations.
Parameters
page_noquery
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
Headers
x-location-detail
string
Required
Header carrying structured location information. Example for India: {"country":"INDIA","country_iso_code":"IN","pincode":"400093","city":"Mumbai","state":"Maharashtra"}; example for UAE: {"country":"UNITED ARAB EMIRATES","country_iso_code":"AE","city":"Abu Dhabi","sector":"Abu Dhabi"}.
GET
Response
200
400
Get delivery promise data
Hide
Delivery promise data including store-specific details and pagination info.
items
array of object (StorePromise)
List of delivery promises for each store.
Show
promise
object (Promise)
Show
page
object (Page)
Show
Response