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 detail
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
400
Get pincode data
PincodeDetails
success
boolean
Indicates whether the API request was successful (true) or failed (false).
data
array of object (PincodeDataResult)
Contains the actual response data when the request is successful, providing details like pincode information or related data.
Array of PincodeDataResult
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)
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
A user-readable description of the error, explaining what went wrong.
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 (CountryMetaResult)
CountryMetaResult
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
currency
object (CurrencyObject)
CurrencyObject
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
Name of the country.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
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
It represent a country display name.
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
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 (PincodeLatLongData)
PincodeLatLongData
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].
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
A user-readable description of the error, explaining what went wrong.
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
Unique identifier for a request.
stormbreaker_uuid
string
Unique identifier generated by stormbreaker service.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
Response
200
400
Success
CountryListResult
results
array of object (CountryEntityResult)
A list of country entities, each containing details about individual countries.
Array of CountryEntityResult
meta
object (CountryMetaResult)
CountryMetaResult
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
currency
object (CurrencyObject)
CurrencyObject
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
Name of the country.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
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
It represent a country display name.
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
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)
LogisticsResult
dp
object (DP)
DP
fm_priority
integer
First Mile Priority; focuses on the initial segment of the logistics process, from the point of origin to the first distribution center.
lm_priority
integer
Last Mile Priority; deals with the final stage of the delivery process, where goods are delivered from the distribution center to the final destination.
rvp_priority
integer
Reverse Pickup Priority; pertains to the process of collecting goods from the customer for return or exchange.
payment_mode
string
The method of payment used for transactions, such as credit card, debit card, cash on delivery, etc.
operations
array of string
Refers to the various activities and processes involved in managing and executing the delivery and logistics operations.
Minimum Items : 1
area_code
string
Nullable
A code that identifies a specific geographic area, often used for sorting and routing deliveries.
assign_dp_from_sb
boolean
Indicates whether the delivery partner (DP) is assigned from stormbreaker service.
internal_account_id
string
An identifier used internally to track accounts or entities within the organization's system.
external_account_id
string
Nullable
An identifier used to reference accounts or entities outside the organization's system, such as partner accounts.
transport_mode
string
The method of transportation used for delivering goods, such as road, rail, air, or sea.
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
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
lat_long
object (PincodeLatLongData)
PincodeLatLongData
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].
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
Search countries by pincode, city, country name etc
hierarchy
string
Fetch countries that has certain heirarchy present.
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
id
string
Unique identifier for the country.
name
string
Name of the country.
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
display_name
string
It represent a country display name.
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
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
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
Name of the country.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
type
string
Indicates the type of object (e.g., "country").
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.
Examples
Parameters
Parameters are not required.
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
id
string
Unique identifier for the country.
name
string
Name of the country.
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
display_name
string
It represent a country display name.
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
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
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
Name of the country.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
type
string
Indicates the type of object (e.g., "country").
fields
object (GetCountryFields)
GetCountryFields
address
array of object (GetCountryFieldsAddress)
Specifies the fields and attributes related to address information, including display names, input types, and validation rules. This section defines the details needed for address collection and formatting.
Array of GetCountryFieldsAddress
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
slug
string
URL-friendly version of the name, often used for referencing or querying purposes.
required
boolean
Indicates whether the field is mandatory for the user to fill out.
edit
boolean
Specifies if the field can be edited by the user.
input
string
Defines the type of input control used for the field (e.g., textbox).
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
Specifies the validation method, such as regex for regular expression validation.
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
Regular expression pattern used to validate the field.
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
The minimum number of characters or digits allowed.
max
integer
Nullable
The maximum number of characters or digits allowed.
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Identifier for the specific operation or query being performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
locality_type
string
Specifies the type of locality to be retrieved, such as city, state, or pincode (e.g., "city", "state", "pincode").
locality_value
string
The specific value of the locality being queried, such as the name of the city or the pincode (e.g., "Mumbai", "400093").
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter the results.
state
string
Nullable
The name of the state within the specified country.
city
string
Nullable
The name of the city within the specified state.
sector
string
Nullable
The name of the sector or area within the specified city.
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Identifier for the specific operation or query being performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
locality_type
string
Specifies the type of locality to be retrieved, such as city, state, or pincode (e.g., "city", "state", "pincode").
locality_value
string
The specific value of the locality being queried, such as the name of the city or the pincode (e.g., "Mumbai", "400093").
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter the results.
state
string
Nullable
The name of the state within the specified country.
city
string
Nullable
The name of the city within the specified state.
sector
string
Nullable
The name of the sector or area within the specified city.
error_text
string
Nullable
The message shown to the user if the input does not meet the validation criteria.
serviceability_fields
array of string
Lists the specific address fields used to determine whether a location is serviceable. These fields are crucial for validating service coverage and availability.
address_template
object (GetCountryFieldsAddressTemplate)
GetCountryFieldsAddressTemplate
checkout_form
string
The format used to display or collect address information during checkout.
store_os_form
string
The format used for address entry or display in the store's operating system.
default_display
string
The general format for displaying address information.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
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
locality_type
string
Required
Unique geographical division.
Enum
country
string
Country name.
state
string
State or the province.
city
string
City.
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 <= 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.
sector
string
A `sector` is a distinct category or division within an area
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
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).
meta
object
Contains meta information related to the locality.
lat_long
object (PincodeLatLongData)
PincodeLatLongData
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].
parent_uid
string
Nullable
Unique identifier for the immediate parent of the locality.
custom_meta
object
Custom meta to store custom json against hierarchy.
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
serviceability
Undefined Type
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
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.
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.
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.
Examples
Parameters
Parameters are not required.
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
Geographical division.
Enum
locality_value
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.
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.
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 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.
meta
object
Contains meta information related to the locality.
parent_uid
string
Nullable
Unique identifier for the immediate parent of the locality.
serviceability
object
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.
Examples
Parameters
Parameters are not required.
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
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
ValidateAddressDetails
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
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
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
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 (Shipments)
List of shipments.
Array of Shipments
id
string
Unique identifier of the shipment.
location_id
number
Unique identifier of the selling location.
location_tags
array of string
Tags associated with the selling location.
shipment_weight
number
Weight of the shipment.
shipment_volumetric_weight
number
Volumetric weight 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.
courier_partner_schemes
array of string
A List of courier schemes.
articles
array of object (ShipmentsArticles)
List of articles in the shipment.
Array of ShipmentsArticles
item_id
integer
Unique identifier of the item.
category_id
integer
Unique identifier of the category.
brand_id
integer
Unique identifier of the brand.
department_id
integer
Unique identifier of the department.
tags
array of string
Tags associated with the item.
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)
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
The earliest possible timestamp.
max
string
The latest possible timestamp.
shipments
array of object (ShipmentCourierPartners)
Array of ShipmentCourierPartners
id
string
Unique identifier of the shipment.
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
The earliest possible timestamp.
max
string
The latest possible timestamp.
Examples
Parameters
Parameters are not required.
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
POST
# Get product's turnaround time
GET
# Get delivery promise
Get the estimated delivery time frame for a specific product from a designated store.
Parameters
No Parameters
Request body
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 (TATLocationDetailsDetails)
Locations involved in the request, including details about both the source and destination.
Array of TATLocationDetailsDetails
fulfillment_id
integer
A unique identifier of the fulfilling location.
from_pincode
string
The postal code of the location from which the fulfillment originates.
articles
array of object (TATArticlesDetails)
List of articles included in the fulfillment request, which provides details about the items to be processed or shipped.
Array of TATArticlesDetails
category
object (TATCategoryDetails)
TATCategoryDetails
level
string
Specifies the hierarchical level of the category (e.g., country, state, city).
id
integer
Represents the unique identifier for the category at the specified level.
manufacturing_time_unit
string
The unit of measurement for the manufacturing time, such as hours or days.
manufacturing_time
integer
The amount of time required to manufacture the article, specified in the unit given by `manufacturing_time_unit`.
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
Success
TATViewResult
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 (TATErrorSchemaResult)
TATErrorSchemaResult
message
string
Nullable
A user-readable description of the error, explaining what went wrong.
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.
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 (TATLocationDetailsResult)
Location involved in the request.
Array of TATLocationDetailsResult
fulfillment_id
integer
A unique identifier of the fulfilling location.
from_pincode
string
The postal code of the location from which the fulfillment originates.
articles
array of object (TATArticlesResult)
List of articles included in the fulfillment request, which provides details about the items to be processed or shipped.
Array of TATArticlesResult
manufacturing_time_unit
string
The unit of measurement for the manufacturing time such as hours or days.
error
object (TATErrorSchemaResult)
TATErrorSchemaResult
message
string
Nullable
A user-readable description of the error, explaining what went wrong.
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.
is_cod_available
boolean
Indicates whether Cash on Delivery (COD) is available for the articles.
promise
object (TATPromiseResult)
TATPromiseResult
timestamp
object (TATTimestampResult)
TATTimestampResult
min
integer
The earliest possible timestamp.
max
integer
The latest possible timestamp.
formatted
object (TATFormattedResult)
TATFormattedResult
min
string
The earliest possible timestamp.
max
string
The latest possible timestamp.
manufacturing_time
integer
The time required to manufacture the articles, measured in the unit specified by manufacturing_time_unit.
category
object (TATCategoryDetails)
TATCategoryDetails
level
string
Specifies the hierarchical level of the category (e.g., country, state, city).
id
integer
Represents the unique identifier for the category at the specified level.
_manufacturing_time_seconds
integer
The manufacturing time converted into seconds.
journey
string
Type of journey, either forward or return.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
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
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.
delivery_promise
object (Promise)
Promise
min
string
| date-time
Earliest delivery time.
max
string
| date-time
Latest delivery time.
delivery_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.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response