Logistic
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
Country & Locality
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 detail
POST
# Validate address
GET
Get pincode details
Deprecated
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
400
Get pincode data
PincodeApiResponse
success
boolean
Indicates whether the API request was successful (true) or failed (false).
data
array of object (PincodeDataResponse)
Contains the actual response data when the request is successful, providing details like pincode information or related data.
Array of PincodeDataResponse
error
object (PincodeErrorSchemaResponse)
PincodeErrorSchemaResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get pincode details
getPincodeCity
GET
Get deliverable countries
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
Response
200
400
Get Country List
CountryListResponse
results
array of object (CountryEntityResponse)
A list of country entities, each containing details about individual countries.
Array of CountryEntityResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get deliverable countries
getAllCountries
GET
Get countries
List of supported countries.
Parameters
onboarding
boolean
List countries which allowed for onboard on Platform.
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
| value <= 250
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
q
string
The number of items to retrieve in each page. Default value is 12.
Response
200
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (CountryObject)
List of countries, each containing detailed information about individual country.
Array of CountryObject
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get countries
getCountries
GET
Get country details
Get details about a particular country and its address format customized for different business scenarios.
Parameters
countryIsoCode
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
id
string
Unique identifier for the country.
name
string
It represent a country name.
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
timezones
array of string
Nullable
List of time zones used in the country (e.g., ["America/New_York", "America/Los_Angeles"]).
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
phone_code
string
International dialing code for the country (e.g., "+1").
latitude
string
Geographical latitude of the country (e.g., "37.0902").
longitude
string
Geographical longitude of the country (e.g., "-95.7129").
currency
object (CurrencyObject)
CurrencyObject
type
string
Indicates the type of object (e.g., "country").
fields
object (GetCountryFields)
GetCountryFields
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get country details
getCountry
GET
Get localities
Get geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state.
Parameters
localityType
string
Required
Unique geographical division.
Enum
country
string
Country name.
state
string
State or the province.
city
string
City.
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
| value <= 1000
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
q
string
This parameter is used to filter or search the records.
Response
200
400
Get Localities data
GetLocalities
items
array of object (Localities)
List of localities, each containing detailed information about individual locality.
Array of Localities
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get localities
getLocalities
GET
Get locality detail
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
localityType
string
Required
Geographical division.
Enum
localityValue
string
Required
Name of the locality.
country
string
Country name.
state
string
State or the province.
city
string
City.
Response
200
400
Get Locality data
GetLocality
id
string
A unique identifier for the locality.
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.
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.
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get locality detail
getLocality
POST
Validate address
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
countryIsoCode
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
templateName
string
Required
The type of address form.
Enum
body
object (ValidateAddressRequest)
Required
ValidateAddressRequest
address
string
Complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode.
address1
string
First line of the address, typically containing street or building information.
address2
string
Second line of the address, which can be used for additional address details if needed.
area
string
Locality or area associated with the address.
landmark
string
Prominent nearby landmark that aids in locating the address.
pincode
string
Postal code or PIN code of the address area.
sector
string
Specifies the sector or district of the address if applicable.
city
string
Denote the city or municipality of the address.
state
string
Indicates the state or province of the address.
name
string
Recipient's name associated with the address.
phone
string
Recipient's contact phone number.
email
string
Recipient's email address.
Response
200
400
Valid
ValidateAddressRequest
address
string
Complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode.
address1
string
First line of the address, typically containing street or building information.
address2
string
Second line of the address, which can be used for additional address details if needed.
area
string
Locality or area associated with the address.
landmark
string
Prominent nearby landmark that aids in locating the address.
pincode
string
Postal code or PIN code of the address area.
sector
string
Specifies the sector or district of the address if applicable.
city
string
Denote the city or municipality of the address.
state
string
Indicates the state or province of the address.
name
string
Recipient's name associated with the address.
phone
string
Recipient's contact phone number.
email
string
Recipient's email address.
Examples
Parameters
countryIsoCode:
"IN"
templateName:
"checkout_form"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Validate address
validateAddress
Delivery Zone
A delivery zone is composed of specific localities and corresponding stores equipped to serve them. It represents predefined geographic areas, each comprising a cluster of localities strategically mapped out based on logistical considerations and customer demand. Within these delivery zones, carefully selected stores are designated to fulfil orders, ensuring efficient and timely delivery to customers residing within the specified localities. Each store is strategically positioned to optimize coverage and minimize delivery times, enhancing the overall delivery experience.
Operations
POST
# Get zones
POST
Get zones
Deprecated
Get the delivery zone associated with a given pincode.
Parameters
body
object (GetZoneFromPincodeViewRequest)
Required
GetZoneFromPincodeViewRequest
pincode
string
Required
The postal code or ZIP code used to pinpoint a specific geographic area or location.
country
string
Required
The country where the pincode is located.
Response
200
Response status_code
GetZoneFromPincodeViewResponse
serviceability_type
string
Specifies the type of serviceability for the given pincode, indicating whether it's deliverable or serviceable under certain conditions.
zones
array of string
Lists the zones associated with the pincode, detailing the geographical or logistical zones for service.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get zones
getPincodeZones
Promise
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
POST
# Get product's turnaround time
POST
Get product's turnaround time
Deprecated
Get the estimated delivery time frame for a specific product from a designated store.
Parameters
body
object (TATViewRequest)
Required
TATViewRequest
to_pincode
string
The postal code of the destination location where the fulfillment or shipment is headed.
source
string
The origin or source of the request, indicating where the data or action is coming from.
action
string
The specific operation or request being made, such as viewing, updating, or managing data.
identifier
string
A unique ID used to reference or track the specific request or item within the system.
location_details
array of object (TATLocationDetailsRequest)
Locations involved in the request, including details about both the source and destination.
Array of TATLocationDetailsRequest
journey
string
Indicates the direction of the request or shipment.
It can either be "forward" (from the source to the destination) or "return" (from the destination back to the source).
Response
200
400
Get TAT data
TATViewResponse
to_pincode
string
The postal code of the destination location where the fulfillment or shipment is headed.
request_uuid
string
A unique identifier for the request.
payment_mode
string
The mode of payment used for the transaction.
success
boolean
Whether the request was successful (true/false).
error
object (TATErrorSchemaResponse)
TATErrorSchemaResponse
is_cod_available
boolean
Whether Cash on Delivery (COD) is available for the request.
source
string
The origin or source of the request.
action
string
The action performed or requested (e.g., forward, return).
stormbreaker_uuid
string
A unique identifier related to the stormbreaker process.
to_city
string
The city corresponding to the destination pincode.
identifier
string
A unique identifier for the request or transaction.
location_details
array of object (TATLocationDetailsResponse)
Location involved in the request.
Array of TATLocationDetailsResponse
journey
string
Type of journey, either forward or return.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Get product's turnaround time
getTatProduct
Selling Location
A selling location is a geographical location where your stores and warehouses exists. The Selling location resource efficiently matches customer orders with the nearest store, reducing delivery time for sellers and ensuring customers receive products quickly at the best price, enhancing overall satisfaction.
Operations
POST
# Get selling locations
GET
# Get available selling locations
POST
Get selling locations
Deprecated
Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels.
Parameters
body
object (ReAssignStoreRequest)
Required
ReAssignStoreRequest
configuration
object
Required
Specifies the configuration settings or parameters for the store reassignment.
to_pincode
string
Required
The postal code of the destination location where the fulfillment or shipment is headed.
ignored_locations
array of integer
Required
Locations that should be excluded from the reassignment process.
identifier
string
Required
A unique identifier for the reassignment request.
articles
array of object
Required
List of articles or items involved in the store reassignment.
Response
200
Response status_code
ReAssignStoreResponse
to_pincode
string
The postal code of the destination location where the fulfillment or shipment is headed.
pystormbreaker_uuid
string
A unique identifier for tracking the reassignment operation.
success
boolean
Whether the reassignment was successful or not.
error
object
Details about any errors encountered during the reassignment.
assigned_stores
array of object
List of stores that have been successfully reassigned.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get selling locations
getOptimalLocations
GET
Get available selling locations
Deprecated
Get stores available for the application based on Delivery Zones and Order Orchestration rules.
Parameters
xApplicationId
string
Required
Unique identifier for a particular sales channel.
xApplicationData
string
Required
Sales channel details.
country
string
The country `iso2` code.
state
string
State or the province.
city
string
City.
pincode
integer
Pincode of the area.
sector
string
Specific sector of the city.
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
The number of items to retrieve in each page. Default value is 12.
Response
200
400
Response status_code
GetStoreResponse
items
array of object (StoreItemResponse)
List of locations, each containing detailed information about individual location.
Array of StoreItemResponse
page
object (Page)
Page
Examples
Parameters
xApplicationId:
"value"
xApplicationData:
"value"
country:
"value"
state:
"value"
city:
"value"
pincode:
0
sector:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...