Skip to main content

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
/service/application/logistics/v1.0/pincode/{pincode}
# Get pincode details
GET
/service/application/logistics/v1.0/country-list
# Get deliverable countries
GET
/service/application/logistics/v1.0/countries
# Get countries
GET
/service/application/logistics/v1.0/countries/{country_iso_code}
# Get country details
GET
/service/application/logistics/v1.0/localities/{locality_type}
# Get localities
GET
/service/application/logistics/v1.0/localities/{locality_type}/{locality_value}
# Get locality detail
POST
/service/application/logistics/v1.0/country/{country_iso_code}/address/templates/{template_name}/validate
# Validate address
GET

Get pincode details

Deprecated
Retrieve details of a specific pincode, such as obtaining its city and state information.
Parameters
pincode
string
Required
A `pincode` contains a specific address of a location.
Response
200
400
Get pincode data
PincodeApiResponse
success
boolean
data
array of object (PincodeDataResponse)
Array of PincodeDataResponse
error
object (PincodeErrorSchemaResponse)
PincodeErrorSchemaResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/pincode/{pincode}
Loading...
Response
Loading...
GET

Get deliverable countries

Retrieves 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)
Array of CountryEntityResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/country-list
Loading...
Response
Loading...
GET

Get countries

Fetch the list of supported countries.
Parameters
onboarding
boolean
Only fetch countries which allowed for onboard on Platform.
pageNo
integer
page number.
Default Value : 1
pageSize
integer
| value <= 250
page size.
Default Value : 12
q
string
search.
Response
200
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (CountryObject)
Array of CountryObject
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/countries
Loading...
Response
Example response not available.
GET

Get country details

Fetch details about a particular country and its address format customized for different business scenarios.
Parameters
countryIsoCode
string
Required
The `country_iso_code` is ISO-2 (alpha-2) code for the country.
Response
200
400
Get country data.
GetCountry
id
string
name
string
display_name
string
iso2
string
iso3
string
timezones
array of string
Nullable
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
phone_code
string
latitude
string
longitude
string
currency
object (CurrencyObject)
CurrencyObject
type
string
fields
object (GetCountryFields)
GetCountryFields
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/countries/{country_iso_code}
Loading...
Response
Example response not available.
GET

Get localities

Retrieve 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
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.
pageNo
integer
page number.
Default Value : 1
pageSize
integer
| value <= 1000
page size.
Default Value : 12
q
string
search.
Response
200
400
Get Localities data
GetLocalities
items
array of object (Localities)
Array of Localities
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/localities/{locality_type}
Loading...
Response
Example response not available.
GET

Get locality detail

Retrieve 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
A `locality_type` contains value geographical division.
Enum
localityValue
string
Required
A `locality_value` contains a specific name 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.
Response
200
400
Get Locality data
GetLocality
id
string
name
string
display_name
string
parent_ids
array of string
Default Value :
type
string
localities
array of object (LocalityParent)
Array of LocalityParent
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/logistics/v1.0/localities/{locality_type}/{locality_value}
Loading...
Response
Example response not available.
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 code of the country.
templateName
string
Required
The type of address form.
Enum
body
object (ValidateAddressRequest)
Required
ValidateAddressRequest
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.
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
A string representing the recipient's name or the organization name associated with the address.
phone
string
An integer representing the recipient's contact phone number.
email
string
A string containing the recipient's email address.
Response
200
400
Valid
ValidateAddressRequest
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.
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
A string representing the recipient's name or the organization name associated with the address.
phone
string
An integer representing the recipient's contact phone number.
email
string
A string containing the recipient's email address.
Examples
Parameters
countryIsoCode:
"IN"
templateName:
"checkout_form"
body:
body
Was this section helpful?
POST
/service/application/logistics/v1.0/country/{country_iso_code}/address/templates/{template_name}/validate
Loading...
Response
Example response not available.

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
/service/application/logistics/v1.0/pincode/zones
# Get zones
POST

Get zones

Deprecated
Retrieve the delivery zone associated with a given pincode
Parameters
body
object (GetZoneFromPincodeViewRequest)
Required
GetZoneFromPincodeViewRequest
pincode
string
Required
country
string
Required
Response
200
Response status_code
GetZoneFromPincodeViewResponse
serviceability_type
string
zones
array of string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/logistics/v1.0/pincode/zones
Loading...
Response
Loading...

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
/service/application/logistics/v1.0/
# Get product's turnaround time
POST

Get product's turnaround time

Deprecated
Retrieve the estimated delivery timeframe for a specific product from a designated store.
Parameters
body
object (TATViewRequest)
Required
TATViewRequest
to_pincode
string
source
string
action
string
identifier
string
location_details
array of object (TATLocationDetailsRequest)
Array of TATLocationDetailsRequest
journey
string
Response
200
400
Get TAT data
TATViewResponse
to_pincode
string
request_uuid
string
payment_mode
string
success
boolean
error
object (TATErrorSchemaResponse)
TATErrorSchemaResponse
is_cod_available
boolean
source
string
action
string
stormbreaker_uuid
string
to_city
string
identifier
string
location_details
array of object (TATLocationDetailsResponse)
Array of TATLocationDetailsResponse
journey
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/logistics/v1.0/
Loading...
Response
Loading...

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
/service/application/logistics/v1.0/reassign_stores
# Get selling locations
GET
/service/application/logistics/v1.0/locations
# Get available selling locations
POST

Get selling locations

Deprecated
Determines and returns the best fulfillment center for customers by analyzing their location, product availability, and inventory levels.
Parameters
body
object (ReAssignStoreRequest)
Required
ReAssignStoreRequest
configuration
object
Required
to_pincode
string
Required
ignored_locations
array of integer
Required
identifier
string
Required
articles
array of object
Required
Response
200
Response status_code
ReAssignStoreResponse
to_pincode
string
pystormbreaker_uuid
string
success
boolean
error
object
assigned_stores
array of object
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/logistics/v1.0/reassign_stores
Loading...
Response
Loading...
GET

Get available selling locations

Deprecated
Retrieves stores available for the application based on Delivery Zones and Order Orchestration rules.
Parameters
xApplicationId
string
Required
A `x-application-id` is a unique identifier for a particular sale channel.
xApplicationData
string
Required
A `x-application-data` is a unique identifier for a particular sale channel.
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.
pincode
integer
A `pincode` contains a specific value of the city.
sector
string
A `sector` contains a specific value of the city.
pageNo
integer
page number.
pageSize
integer
page size.
Response
200
400
Response status_code
GetStoreResponse
items
array of object (StoreItemResponse)
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
/service/application/logistics/v1.0/locations
Loading...
Response
Loading...