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 API
GET
# Get deliverable countries
GET
# Get all countries and associated data.
GET
# Get country details
GET
# Get Localities by Name Prefix
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
Get pincode data
PincodeApiResponseSchema
success
boolean
Indicates whether the API request was successful (true) or failed (false).
data
array of object (PincodeDataResponseSchema)
Contains the actual response data when the request is successful, providing details like pincode information or related data.
Array of PincodeDataResponseSchema
parents
array of object (PincodeParentsResponseSchema)
List of object representing a collection of geographical locations, each associated with specific hierarchical data such as cities, states, or countries.
Array of PincodeParentsResponseSchema
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 (PincodeMetaResponseSchema)
PincodeMetaResponseSchema
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.
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
error
object (PincodeErrorResponseSchema)
PincodeErrorResponseSchema
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 (CountryMetaResponseSchema)
CountryMetaResponseSchema
iso2
string
iso3
string
currency
object (CurrencyObject)
CurrencyObject
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
It represent a country name.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
phone_code
string
parent_id
string
Nullable
zone
string
deliverables
array of string
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
display_name
string
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
logistics
object (LogisticsResponseSchema)
LogisticsResponseSchema
dp
object
Provide entity responsible for handling the delivery of goods.
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 number
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 (PincodeErrorResponseSchema)
PincodeErrorResponseSchema
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
Nullable
stormbreaker_uuid
string
Nullable
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get Pincode API
getPincodeCity
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
Response
200
Get Country List
CountryListResponseSchema
results
array of object (CountryEntityResponseSchema)
A list of country entities, each containing details about individual countries.
Array of CountryEntityResponseSchema
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
is_active
boolean
Whether the country entity is currently active or not.
parent_id
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
Country name.
uid
string
Unique identifier for the country.
lat_long
object
meta
object (CountryMetaResponseSchema)
CountryMetaResponseSchema
iso2
string
iso3
string
currency
object (CurrencyObject)
CurrencyObject
code
string
The currency code, typically a three-letter ISO code (e.g., "USD" for US Dollar).
name
string
It represent a country name.
symbol
string
The symbol used to represent the currency (e.g., "$" for US Dollar).
phone_code
string
parent_id
string
Nullable
zone
string
deliverables
array of string
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
display_name
string
slug
string
A URL-friendly version of the name, often used for referencing or querying purposes.
logistics
object (LogisticsResponseSchema)
LogisticsResponseSchema
dp
object
Provide entity responsible for handling the delivery of goods.
logistics
object (LogisticsResponseSchema)
LogisticsResponseSchema
dp
object
Provide entity responsible for handling the delivery of goods.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get deliverable countries
getAllCountries
Parameters
onboard
boolean
Only fetch 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 <= 300
The number of items to retrieve in each page. Default value is 12
Default Value : 12
q
string
The search string to search in the list of countries by name.
hierarchy
string
The search filter to filter countries based on their available hierarchy.
Response
200
400
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
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
display_name
string
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
It represent a country name.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
onboard:
true
page_no:
1
page_size:
6
q:
"I"
hierarchy:
"pincode"
Was this section helpful?
GET
Response
Get all countries and associated data.
getCountries
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
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
display_name
string
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
It represent a country name.
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).
pre_fill
string
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
type
string
value
string
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
type
string
value
string
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
country_iso_code:
"IN"
Was this section helpful?
GET
Response
Get country details
getCountry
Parameters
page_no
integer
| value >= 1
Starting index of the items.
Default Value : 1
page_size
integer
| value >= 1
Number of items per page.
Default Value : 10
q
string
Localities starting with the specified prefix.
Response
200
400
Get Locality 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).
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 :
meta
object
Default Value : [object Object]
type
string
Specifies the category of the address component, such as pincode, state, city, country, or sector.
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 number
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
code
string
localities
array of object (LocalityParent)
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
Default Value : [object Object]
parent_ids
array of string
Nullable
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.
serviceability
object
Default Value : [object Object]
parent_uid
string
Nullable
Default Value :
code
string
Unique 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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
10
q:
"40000"
Was this section helpful?
GET
Response
Get Localities by Name Prefix
getLocalitiesByPrefix
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.
name
string
Search for localities. Either provide a full name or a search term.
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).
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 :
meta
object
Default Value : [object Object]
type
string
Specifies the category of the address component, such as pincode, state, city, country, or sector.
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 number
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
code
string
localities
array of object (LocalityParent)
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
Default Value : [object Object]
parent_ids
array of string
Nullable
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.
serviceability
object
Default Value : [object Object]
parent_uid
string
Nullable
Default Value :
code
string
Unique 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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
locality_type:
"pincode"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
page_no:
1
page_size:
6
name:
"400001"
Was this section helpful?
GET
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_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
Default Value : [object Object]
parent_ids
array of string
Nullable
Identifiers for the parent of the current locality.
Default Value :
parent_uid
string
Nullable
type
string
Specifies the category of the address component, such as pincode, state, city, country, or sector.
code
string
Unique code of the Geolocality
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
Default Value : [object Object]
parent_ids
array of string
Nullable
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.
serviceability
object
Default Value : [object Object]
parent_uid
string
Nullable
Default Value :
code
string
Unique 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:
"400001"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
Was this section helpful?
GET
Response
Get locality detail
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_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
Nullable
Recipient's name associated with the address.
phone
string
Nullable
Recipient's contact phone number.
email
string
Nullable
Recipient's email address.
country_iso_code
string
A string containing the recipient's email address.
Response
200
400
Valid
ValidateAddressRequestSchema
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
Nullable
Recipient's name associated with the address.
phone
string
Nullable
Recipient's contact phone number.
email
string
Nullable
Recipient's email address.
country_iso_code
string
A string containing the recipient's email address.
Examples
Parameters
country_iso_code:
"IN"
template_name:
"default_display"
body:
body
Was this section helpful?
POST
Response
Validate address
validateAddress
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
GET
# Shows zones defined at the application level
GET
# Get all geoareas in the current application.
Displays the list of zones defined at the application level.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
stage
string
Identifies the specific stage of zone bing requested.
Enum
type
string
Using type, you can filter custom or default zones
Enum
page_size
integer
| value >= 1
Defines the number of items displayed per page.
Default Value : 10
page_no
integer
| value >= 1
current page number.
Default Value : 1
is_active
boolean
Status of Zone (either active or inactive)
q
string
Search with name as a free text.
country_iso_code
string
ISO2 code of the country.
pincode
string
PIN Code of the country.
state
string
State of the country.
city
string
City of the country.
sector
string
Sector name of mentioned address.
store_uid
integer
Unique identifier for a specific store.
region_uid
string
Unique identifier for a geographical region.
Response
200
Zone List of application in descending order of their last modified date.
ListViewResponseSchemaV2
items
array of object (ListViewItemsV2)
Array of ListViewItemsV2
zone_id
string
name
string
type
string
access_level
string
Access level of the zone (public or private).
Enum
geo_areas
array of object (GeoArea)
Array of GeoArea
id
string
type
string
name
string
slug
string
stores
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_active
boolean
is_opted
boolean
Indicates whether the zone is opted or not.
is_public_opted
boolean
Indicates whether the public zone is opted by any seller or not
product
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
integer
application_id
string
created_by
string
created_on
string
| date-time
modified_by
string
modified_on
string
| date-time
stage
string
summary
object (Summary)
Summary
stores_count
integer
products_count
integer
regions
array of object (RegionSchema)
Array of RegionSchema
name
string
count
integer
page
object (ZoneDataItem)
ZoneDataItem
has_next
boolean
item_total
integer
size
integer
current
integer
type
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
page_size:
10
page_no:
1
is_active:
true
q:
"zone"
country_iso_code:
"IN"
pincode:
"500060"
state:
"MAHARASTRA"
city:
"MUMBAI"
sector:
"ABU_DHABI"
store_uid:
2
region_uid:
"64aec5aa3a079bd328539e25"
Was this section helpful?
GET
Response
Shows zones defined at the application level
getZones
Parameters
application_id
string
Required
A `application_id` is a unique identifier for an application.
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
page_no
integer
Current page number
type
string
To fetch the type of a specific geoarea.
is_active
boolean
Status of GeoAreas (either active or inactive)
q
string
search with name as a free text
country_iso_code
string
ISO2 code of the country
state
string
State name
city
string
City name
pincode
string
Pincode value to search geoareas
sector
string
Sector value to search geoareas
Response
200
Successfully retrieved GeoArea.
GeoAreaGetResponseBody
items
array of object (GeoAreaItemResponseSchema)
Array of GeoAreaItemResponseSchema
geoarea_id
string
name
string
slug
string
is_active
boolean
region_type
string
Enum
type
string
areas
array of object (AreaExpandedV2)
Array of AreaExpandedV2
country
object (Country)
Country
uid
string
display_name
string
regions
array of object (RegionV2)
Array of RegionV2
uid
string
display_name
string
sub_type
string
parent_id
array of string
created_on
string
| date-time
modified_on
string
| date-time
created_by
string
modified_by
string
company_id
integer
application_id
string
page
object (Page2)
Page2
size
integer
item_total
integer
type
string
current
integer
has_next
boolean
Examples
Parameters
application_id:
"65e2d5b3a71cf1bff40723f5"
company_id:
1
page_size:
10
is_active:
true
q:
"geoareas"
Was this section helpful?
GET
Response
Get all geoareas in the current application.
getGeoAreas
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
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 (PromiseDetails)
PromiseDetails
min
string
| date-time
Earliest delivery time.
max
string
| date-time
Latest delivery time.
promise
object (PromiseDetails)
PromiseDetails
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.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
6
Was this section helpful?
GET
Response
Get delivery promise
getDeliveryPromise
Packaging material refers to the materials used to wrap and protect products during shipping or storage. Shipments are collections of products being transported together. The Custom packaging resource enables sellers to create rules based on brand, category, or department, which can be applied to this shipments. These rules are then linked to specific packaging materials, detailing weight and quantity capacities. Sellers can thus efficiently combine or split shipments, optimizing delivery partner costs and enhancing logistics flexibility.
Operations
POST
# Create and return shipments.
Parameters
company_id
integer
Required
The ID of the company.
application_id
string
Required
The ID of the application.
Request body
to_serviceability
object (LocationDetailsServiceability)
Required
LocationDetailsServiceability
pincode
string
The pincode of the serviceability location.
sector
string
The sector of the serviceability location.
state
string
The state of the serviceability location.
country
string
Required
The country of the serviceability location.
city
string
The city of the serviceability location.
country_iso_code
string
Required
The ISO code of the country.
location
object (ServiceabilityLocation)
ServiceabilityLocation
longitude
string
Required
The longitude of the serviceability location.
latitude
string
Required
The latitude of the serviceability location.
location_articles
array of object (GenerateShipmentsLocationArticles)
Required
A list of location-based article details.
Array of GenerateShipmentsLocationArticles
fulfillment_id
integer
Required
The fulfillment ID.
from_serviceability
object (LocationDetailsServiceability)
Required
LocationDetailsServiceability
pincode
string
The pincode of the serviceability location.
sector
string
The sector of the serviceability location.
state
string
The state of the serviceability location.
country
string
Required
The country of the serviceability location.
city
string
The city of the serviceability location.
country_iso_code
string
Required
The ISO code of the country.
location
object (ServiceabilityLocation)
ServiceabilityLocation
longitude
string
Required
The longitude of the serviceability location.
latitude
string
Required
The latitude of the serviceability location.
fulfillment_type
string
Required
The type of fulfillment.
fulfillment_tags
array of string
Required
Fulfillment level tags.
articles
array of object (LocationDetailsArticle)
Required
A list of articles and their details.
Array of LocationDetailsArticle
id
string
Required
The ID of the article.
item_id
integer
Required
The Item ID of the article.
tags
array of string
Required
Tags assigned to Item.
size
string
Required
The size of the article.
group_id
string
The group ID of the article.
group_info
object
group information of the article
Default Value : [object Object]
group_info_ids
array of string
group information of the ids of the article
Default Value :
weight
object (ArticleWeight)
Required
ArticleWeight
shipping
integer
Required
The weight of the article for shipping purposes, typically measured in a specified unit.
unit
string
Required
The unit of measurement used for the weight value (e.g., kilogram, pounds).
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
Required
The category ID of the article.
department_id
integer
Required
dimension
object (ArticleDimension)
Required
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
Required
Final Price of the article after discounts.
brand_id
integer
Required
The brand ID of the article.
quantity
integer
Required
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
Required
A boolean indicating whether the article is a gift.
is_set
boolean
Required
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)
Required
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 string having return reason values.
Enum
ewaybill_enabled
boolean
is_home_delivery
boolean
journey
string
Required
The journey details for the shipment.
payment_mode
string
The payment mode for the shipment.
Response
200
400
Valid
GenerateShipmentsAndCourierPartnerResponseSchema
shipments
array of object (Shipments)
A list of generated shipments.
Array of Shipments
fulfillment_id
integer
The fulfillment ID.
fulfillment_tags
array of string
Tags of the location.
fulfillment_type
string
Location Type.
ewaybill_enabled
boolean
Nullable
Denotes if ewaybill is enabled.
mps
boolean
Denotes if mps is enabled.
meta
object
Meta information of shipment.
is_cod_available
boolean
Denotes if cod is available for the shipment.
count
integer
Shipment replication count.
articles
array of object (ShipmentsArticles)
A list of articles in the shipment.
Array of ShipmentsArticles
id
string
The ID of the shipment article.
quantity
integer
The quantity of the shipment article.
item_id
integer
The Item ID of the article.
size
string
The size of the article.
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)
A collection of different size options and their corresponding pieces.
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
The number of pieces in the set.
size
string
The size description of the set.
sla
string
SLA in UTC format of article.
meta
object (ShipmentArticleMeta)
ShipmentArticleMeta
is_set
boolean
A boolean indicating whether the article is a set.
set
object
An ArticleSet object describing the attributes of the set, if the article is a set.
is_set_article
boolean
A boolean indicating whether the article is included in the set.
set_quantity
integer
It represents the number of set of this article.
split_article_id
string
This key is used to identify the bundle products.
promo_ids
array of string
The list of promo ids applied on this article.
department_id
integer
DepartmentId of the product.
category_id
integer
CategoryId of the product.
brand_id
integer
BrandId of the product.
group_id
string
GroupId of the shipment.
group_info
object
group information of the article
Default Value : [object Object]
group_info_ids
object
group information of the article
Default Value : [object Object]
tags
array of string
Tags of the product.
courier_partners
array of object (ShipmentCourierPartners)
Array of ShipmentCourierPartners
extension_id
string
The ID of the courier partner.
scheme_id
string
The scheme ID of the courier partner.
area_code
object (AreaCode)
AreaCode
source
string
The starting area code.
destination
string
The ending area code.
tat
object (CourierPartnersTat)
CourierPartnersTat
min
integer
The minimum transit time.
max
integer
The maximum transit time.
display_name
string
The display name of the courier partner.
is_qc_enabled
boolean
A boolean indicating quality control by the courier partner.
is_self_ship
boolean
A boolean indicating it is self delivery DP support.
is_own_account
boolean
A boolean indicating if courier partner is self managed.
forward_pickup_cutoff
string
Nullable
Forward Pickup Cutoff time.
reverse_pickup_cutoff
string
Nullable
Reverse Pickup Cutoff time.
ndr_attempts
integer
Nullable
NDR Attempts.
weight
integer
Nullable
volumetric_weight
integer
Nullable
transport_type
string
Nullable
promise
object (PromiseObject)
PromiseObject
min
string
The minimum promised delivery time in ISO 8601 format.
max
string
The maximum promised delivery time in ISO 8601 format.
customer_promise
object (PromiseData)
PromiseData
min
string
The minimum promised delivery time in ISO 8601 format.
max
string
The maximum promised delivery time in ISO 8601 format.
meta
object (PromiseMeta)
PromiseMeta
seller_promise
object (PromiseData)
PromiseData
min
string
The minimum promised delivery time in ISO 8601 format.
max
string
The maximum promised delivery time in ISO 8601 format.
courier_partner_promise
object (CourierPartnerPromiseData)
CourierPartnerPromiseData
min
string
The minimum promised delivery time in ISO 8601 format.
max
string
The maximum promised delivery time in ISO 8601 format.
attributes
object (DeliveryTat)
DeliveryTat
tat
object (DeliveryTatSchema)
DeliveryTatSchema
min
integer
The minimum tat in integer.
max
integer
The maximum tat in integer.
customer_initial_promise
object (PromiseData)
PromiseData
min
string
The minimum promised delivery time in ISO 8601 format.
max
string
The maximum promised delivery time in ISO 8601 format.
tags
array of object
Tags associated with the shipment.
is_mto
boolean
A boolean indicating if the courier partner supports "Made to Order" service.
is_gift
boolean
A boolean indicating if the courier partner supports gift shipments.
is_locked
boolean
A boolean indicating if the courier partner is locked.
packaging
object (Packaging)
Packaging
name
string
The name of the packaging.
id
string
The ID of the packaging.
dimension
object (PackagingDimension)
PackagingDimension
length
number
The length dimension of packaging.
width
number
The width dimension of packaging.
height
number
The height dimension of packaging.
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.
weight
number
Actual weight of the shipment.
volumetric_weight
number
Volumetric weight of the shipment.
is_auto_assign
boolean
A boolean indicating auto-assignment of the fullfilment location.
shipment_type
string
Shipment type i.e. whether is single article single shipment or bulk shipment.
from_serviceability
object
error
object (ShipmentError)
ShipmentError
type
string
message
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_cod_available
boolean
A boolean indicating if COD (COD) is available.
Examples
Parameters
company_id:
101
application_id:
"7524dac0e2e6dec99c1856d9"
body:
body
Was this section helpful?
POST
Response