Logistic
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
The Country & Locality resource contains extensive data about countries and how they're structured. For instance, in India, it's organized as Country, State, City, and Pincode, while in Australia, it's simpler with State, City, and Zipcode. We've made this structure consistent globally, covering Country, State, City, Pincode, and Sector. Using this resource, you can easily access hierarchical information for each country. This resource helpful for retrieving detailed locality information, such as lists of states for a given country, cities for a given state and country, and more. Moreover, it's crucial for validating customer addresses, like verifying the validity of a pincode. Additionally, it provides in-depth locality data, such as offering city and country information for a specific sector in the UAE.
Operations
GET
# Get deliverable countries
GET
# Get countries
GET
# Get country details
GET
# Get Localities
GET
# Get Locality API
POST
# Validate address
Get a list of countries within the specified delivery zones for that application.
Parameters
No Parameters
Response
200
Success
CountryResult
results
array of object (CountryEntity)
An array containing multiple instances of CountryEntityResult, which detail individual country entities.
Array of CountryEntity
meta
object (CountryMeta)
CountryMeta
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
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
A string representing the display name of the hierarchy level.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
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
Delivery partner details.
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
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
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
Defines the attributes related to the serviceability of a specific region or entity.
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
A string indicating the type of geographical data.
coordinates
array of number
An array of numbers representing the latitude and longitude coordinates of the pincode.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get deliverable countries
getAllCountries
Parameters
onboardingin query
boolean
List countries which allowed for onboard on Platform.
page_noin query
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizein query
integer
| value <= 250
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
qin query
string
Used to search for matching results based on the provided input.
hierarchyin query
string
Fetch countries that has certain heirarchy present.
phone_codein query
string
Filter countries by phone code (e.g., +1 for United States, +91 for India, etc.).
Response
200
Successfully retrieved all countries with associated data.
GetCountries
Represents the result of a request for a list of countries, including details of each country and pagination information for navigating through large sets of data.
items
array of object (GetCountriesItems)
A list of country objects containing detailed information about each country.
Array of GetCountriesItems
id
string
A string serving as the unique identifier.
sub_type
string
A category for classifying the country into a specific subtype.
uid
string
A globally unique identifier for the country.
name
string
The official or widely recognized name of the country used in general contexts.
iso2
string
The 2-letter ISO code for the country.
iso3
string
The 3-letter ISO code for the country.
timezones
array of string
A list of timezones associated with the country.
hierarchy
array of object (HierarchyItems)
A hierarchical list of items representing organizational levels within the country.
Array of HierarchyItems
name
string
The name of the item as displayed to the user, usually in a UI or listing.
display_name
string
It represent a country display name.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
phone_code
string
A country-specific phone code.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
type
string
The type or classification of the country (e.g., sovereign or dependent).
latitude
string
The latitude of the central point of the country.
longitude
string
The longitude of the central point of the country.
display_name
string
A user-friendly name for the country, typically for display purposes.
has_next_hierarchy
boolean
A boolean indicating whether additional hierarchical regions or divisions are present.
page
object (Page)
Page
item_total
integer
| int32
The total number of all items across all pages.
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, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
onboarding:
true
page_no:
1
page_size:
6
q:
"400603"
hierarchy:
"pincode"
phone_code:
"+91"
Was this section helpful?
GET
Response
Get countries
getCountries
Get details about a particular country and its address format customized for different business scenarios.
Parameters
country_iso_codein path
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
This object represents the details of a country, including its identifiers, geographical codes, and associated fields.
meta
object (CountryMetaFields)
CountryMetaFields
application_fields
object (ApplicationFields)
ApplicationFields
address
array of object (GetCountryFieldsAddress)
Nullable
List of address-related fields for the application.
Array of GetCountryFieldsAddress
display_name
string
The name displayed for the address field.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
required
boolean
Indicates whether the field is mandatory for input.
edit
boolean
Indicates whether the field is editable.
input
string
The type of input type for the field (e.g., textbox, etc.).
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
Type of field validation (e.g., regex, length).
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
The regular expression pattern used for field validation.
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
Minimum length of the field.
max
integer
Nullable
Maximum length of the field.
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
error_text
string
Nullable
Error message text displayed when validation fails or input is incorrect.
serviceability_fields
array of string
Nullable
An array of strings representing fields related to the serviceability of the country.
address_template
object (GetCountryFieldsAddressTemplateApplication)
GetCountryFieldsAddressTemplateApplication
checkout_form
string
A string representing the template used for displaying address fields in a checkout form.
store_os_form
string
A string representing the template used for displaying address fields in a store operating system form.
default_display
string
A string representing the default template used for displaying address fields.
id
string
A string serving as the unique identifier.
name
string
A string representing the official name of the country.
display_name
string
A string providing the display name of the country, typically used for user-friendly identification.
iso2
string
A string representing the ISO 3166-1 alpha-2 code for the country, which is a two-letter code used internationally.
iso3
string
A string representing the ISO 3166-1 alpha-3 code for the country, which is a three-letter code used for international identification.
timezones
array of string
Nullable
A nullable array of strings listing the timezones applicable to the country.
hierarchy
array of object (CountryHierarchy)
An array referencing the CountryHierarchy schema, detailing the administrative or geographical structure of the country.
Array of CountryHierarchy
display_name
string
A string representing the display name of the hierarchy level.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
phone_code
string
A string indicating the country's international phone dialing code, not restricted to a predefined list.
latitude
string
A string representing the latitude of the country's geographic center.
longitude
string
A string representing the longitude of the country's geographic center.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
type
string
A string indicating the type of the country entity.
fields
object (GetCountryFields)
GetCountryFields
address
array of object (GetCountryFieldsAddress)
An array containing instances of GetCountryFieldsAddress, which detail the address fields for a country.
Array of GetCountryFieldsAddress
display_name
string
The name displayed for the address field.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
required
boolean
Indicates whether the field is mandatory for input.
edit
boolean
Indicates whether the field is editable.
input
string
The type of input type for the field (e.g., textbox, etc.).
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
Type of field validation (e.g., regex, length).
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
The regular expression pattern used for field validation.
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
Minimum length of the field.
max
integer
Nullable
Maximum length of the field.
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
Unique identifier for the operation or action to be performed.
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
The type of resource being referenced in the path.
Enum
value
string
The specific value or identifier associated with the path resource.
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
The name of the country to filter results by, if specified.
state
string
Nullable
The name of the state to filter results by, if specified.
city
string
Nullable
The name of the city to filter results by, if specified.
sector
string
Nullable
The name of the sector to filter results by, if specified.
error_text
string
Nullable
Error message text displayed when validation fails or input is incorrect.
serviceability_fields
array of string
An array of strings representing fields related to the serviceability of the country.
address_template
object (GetCountryFieldsAddressTemplate)
GetCountryFieldsAddressTemplate
checkout_form
string
A string representing the template used for displaying address fields for respective entity.
store_os_form
string
A string representing the template used for displaying address fields for respective entity.
default_display
string
A string representing the default template used for displaying address fields.
Was this section helpful?
GET
Response
Get country details
getCountry
Parameters
locality_typein path
string
Required
A `locality_type` contains unique geographical division.
Enum
countryin query
string
A `country` contains a specific value of the country iso2 code.
statein query
string
A `state` contains a specific value of the state, province.
cityin query
string
A `city` contains a specific value of the city.
page_noin query
integer
Page number.
Default Value : 1
page_sizein query
integer
| value <= 1000
Page size.
Default Value : 12
qin query
string
The search string to search in the list of locality by name.
sectorin query
string
Sector name of mentioned address.
Response
200
400
Get Localities data
GetLocalitiesApp
items
array of object (LocalitiesApp)
An array containing multiple instances of Localities, which detail individual localities.
Array of LocalitiesApp
id
string
A string serving as the unique identifier.
custom_meta
object
Custom meta to store custom json against hierarchy.
name
string
The name of the locality.
display_name
string
The display name of the locality.
parent_ids
array of string
List of parent locality Ids.
Default Value :
meta
object
Additional metadata for the locality.
Default Value : [object Object]
type
string
The type of the locality.
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
A string indicating the type of geographical data.
coordinates
array of number
An array of numbers representing the latitude and longitude coordinates of the pincode.
parent_uid
string
Nullable
Unique identifier of the parent locality, if available.
localities
array of object (LocalityParent)
List of child localities.
Array of LocalityParent
id
string
A string serving as the unique identifier.
name
string
A string representing the name of the locality.
display_name
string
A string providing the display name of the locality.
meta
object
An object with additional properties for metadata, defaulting to an empty object.
Default Value : [object Object]
parent_ids
array of string
Nullable
A nullable array of strings listing the identifiers of parent localities, defaulting to an empty array.
Default Value :
type
string
A string indicating the type of locality.
serviceability
object
An object with additional properties for serviceability details, defaulting to an empty object.
Default Value : [object Object]
parent_uid
string
Nullable
A nullable string for the unique identifier of the parent locality, defaulting to an empty string.
Default Value : null
code
string
Unique Identifier 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.
code
string
Unique identifier 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.
page
object (Page)
Page
item_total
integer
| int32
The total number of all items across all pages.
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, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
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_typein path
string
Required
A `locality_type` contains value geographical division.
Enum
locality_valuein path
string
Required
A `locality_value` contains a specific unique id of the locality.
countryin query
string
A `country` contains a specific value of the country iso2 code.
statein query
string
A `state` contains a specific value of the state, province.
cityin query
string
A `city` contains a specific value of the city.
sectorin query
string
A `sector` is a distinct category or division within an area
Response
200
400
Get Locality data
GetLocalityApp
Represents a collection of geographical locations, each associated with specific hierarchical data such as cities, states, or countries.
id
string
A string serving as the unique identifier.
name
string
The actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
meta
object
Contains meta information related to the locality.
parent_uid
string
Nullable
Unique identifier for the immediate parent of the locality.
serviceability
Undefined Type
Defines the serviceability information for a perticular courier partner's scheme for the locality.
code
string
Code assigned to a locality, which is unique to its immediate parent.
custom_meta
object
Custom meta to store custom json against hierarchy.
parent_ids
array of string
Identifiers for the parent of the current locality.
Default Value :
type
string
Specifies the category of the address component, such as pincode, state, city, country, or sector.
Enum
localities
array of object (LocalityParent)
Representing the localities that are associated with or contained within the current locality.
It provides detailed information about the parent localities, including their names, identifiers, and hierarchical relationships.
Array of LocalityParent
id
string
A string serving as the unique identifier.
name
string
A string representing the name of the locality.
display_name
string
A string providing the display name of the locality.
meta
object
An object with additional properties for metadata, defaulting to an empty object.
Default Value : [object Object]
parent_ids
array of string
Nullable
A nullable array of strings listing the identifiers of parent localities, defaulting to an empty array.
Default Value :
type
string
A string indicating the type of locality.
serviceability
object
An object with additional properties for serviceability details, defaulting to an empty object.
Default Value : [object Object]
parent_uid
string
Nullable
A nullable string for the unique identifier of the parent locality, defaulting to an empty string.
Default Value : null
code
string
Unique Identifier 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.
Was this section helpful?
GET
Response
Get Locality API
getLocality
Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system.
Parameters
country_iso_codein path
string
Required
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
template_namein path
string
Required
The type of address form.
Enum
Request body
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address_meta
object
Has other Meta Data.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
The ISO code of the country for which the bulk export is being processed.
Response
200
400
Valid
ValidateAddressDetails
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address_meta
object
Has other Meta Data.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
The ISO code of the country for which the bulk export is being processed.
Was this section helpful?
POST
Response
Validate address
validateAddress
Fulfillment options define the different ways an order can be delivered or collected. These options include home delivery, where the order is shipped to the customer's address, and store-pickup, where the customer picks up the order from a store. Express delivery provides a faster shipping option for urgent orders, while standard delivery follows regular shipping timelines. Businesses can configure these options based on location, availability, and customer preferences to enhance logistics efficiency and customer satisfaction.
Operations
GET
# Get fulfillment options
GET
# Get Fulfillment Option Stores
Parameters
product_slugin query
string
The unique identifier of the product.
store_idin query
integer
The unique identifier of the store.
Headers
x-application-datain header
string
Required
Custom header for this operation
Response
200
Valid
FulfillmentOptionsList
A list of available delivery service options.
items
array of object (FulfillmentOptionItem)
List of fulfillment option items.
Array of FulfillmentOptionItem
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
Examples
Parameters
product_slug:
"productj-2"
store_id:
1
Was this section helpful?
GET
Response
Get fulfillment options
getFulfillmentOptions
Fetches a paginated list of stores associated with a given fulfillment option slug.
Parameters
slugin path
string
Required
The unique slug identifier of the fulfillment option.
page_noin query
integer
The current page number for pagination.
Default Value : 1
page_sizein query
integer
The number of items per page.
Default Value : 10
Response
200
Successfully retrieved fulfillment option stores.
FulfillmentOptionStores
items
array of object (FulfillmentOptionStore)
List of stores with their details.
Array of FulfillmentOptionStore
uid
integer
Unique identifier for the store.
store_code
string
Store code identifier.
address
object (Address)
Address
address1
string
Primary address line, typically containing street or building information.
address2
string
Secondary address line, typically containing landmark or area information.
country
string
Country where the store is located.
pincode
string
Postal code of the store location.
postal_code
string
Postal code or ZIP code of the store location.
city
string
City where the store is located.
state
string
State where the store is located.
latitude
number
| float
Latitude coordinate of the store.
longitude
number
| float
Longitude coordinate of the store.
country_code
string
Two digit ISO country code of the store location.
lat_long
object (LatLong)
Geographic coordinates in GeoJSON Point format.
LatLong
type
string
The type of geographical coordinates.
coordinates
array of number
The list of coordinates (latitude and longitude).
company_id
integer
The unique identifier of the company.
name
string
Name of the store.
store_type
string
Type of store (e.g., high_street, mall, warehouse).
Enum
tags
array of string
Tags associated with the store.
avg_order_processing_time
integer
Average order processing time in seconds.
timezone
string
Timezone of the store location.
holiday_list
array of array of string
List of holidays as date range tuples [start_date, end_date].
customfields
object
Custom fields associated with the store.
is_open
boolean
This field is marked as true when the store is configured to be closed for every day of the week..
promise_customfields
object
Custom fields related to delivery promises used when stores have different delivery promises for different days.
distance
object (StoreDistance)
StoreDistance
value
number
| float
Nullable
Distance value from the user's location.
unit
string
Unit of measurement for the distance (e.g., 'm' for meters, 'km' for kilometers).
reason
string
Nullable
Reason if distance cannot be calculated (e.g., 'invalid_customer_location').
timing
object (StoreTimingDetails)
StoreTimingDetails
operational_timing
array of object (StoreTiming)
Operational hours for each weekday, this is the time when the store is physically open for customers.
Array of StoreTiming
weekday
string
Day of the week.
Enum
open
boolean
Indicates whether the store is open on this weekday.
opening
object (Time)
Opening time for this weekday.
Time
hour
integer
Hour of the day in 24-hour format (0-23).
minute
integer
Minute of the hour (0-59).
closing
object (Time)
Closing time for this weekday.
Time
hour
integer
Hour of the day in 24-hour format (0-23).
minute
integer
Minute of the hour (0-59).
order_acceptance_timing
array of object (StoreTiming)
Order acceptance hours for each weekday, this is the time when the store is open for accepting orders.
Array of StoreTiming
weekday
string
Day of the week.
Enum
open
boolean
Indicates whether the store is open on this weekday.
opening
object (Time)
Opening time for this weekday.
Time
hour
integer
Hour of the day in 24-hour format (0-23).
minute
integer
Minute of the hour (0-59).
closing
object (Time)
Closing time for this weekday.
Time
hour
integer
Hour of the day in 24-hour format (0-23).
minute
integer
Minute of the hour (0-59).
page
object (Page)
Page
item_total
integer
| int32
The total number of all items across all pages.
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, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
slug:
"standard-delivery"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Get Fulfillment Option Stores
getFulfillmentOptionStores
The promise is a time range or date when the order is expected to be delivered to the customer from the date of order. The Promise resource provides the estimated delivery time for a given product from the store to the customer's location. This is typically presented as a range, such as from April 19th to April 22nd, and this can be expressed in minutes, hours, or days, depending on the product.
Operations
GET
# Get delivery promise
Delivery Promise Configurations involve estimating and communicating the anticipated delivery date or time to customers, taking into account parameters like store processing time, delivery partner time to delivery, and buffer time. This helps establish precise delivery expectations based on both the delivery partner's capabilities and the store's operations.
Parameters
page_noin query
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizein query
integer
The number of items to retrieve in each page. Default value is 12.
Default Value : 12
Headers
x-location-detailin header
string
Required
Header carrying structured location information. Example for India: {"country":"INDIA","country_iso_code":"IN","pincode":"400093","city":"Mumbai","state":"Maharashtra"}; example for UAE: {"country":"UNITED ARAB EMIRATES","country_iso_code":"AE","city":"Abu Dhabi","sector":"Abu Dhabi"}.
Response
200
400
Get delivery promise data
GetPromiseDetails
Delivery promise data including store-specific details and pagination info.
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 (Promise)
Promise
min
string
| date-time
Earliest delivery time.
max
string
| date-time
Latest delivery time.
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 all items across all pages.
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, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Was this section helpful?
GET
Response