Logistics
Serviceability API's
Operations
POST
# Sample File Download
GET
# Get Serviceability TAT sample files generator status
POST
# Region TAT Import or Export
GET
# Get region tat bulk history
POST
# Serviceability Import or Export
GET
# Get Region Serviceability Bulk History
POST
# Creation of Courier Account
GET
# Getting Courier Account list of a company
PUT
# Update Courier Account in database
GET
# Getting Courier Account of a company from database
GET
# Get all countries and associated data
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
country
string
Required
Name of the country.
region
string
Required
Name of the region for which the tat/serviceability file needs to be downloaded.
type
string
Required
Denotes the type of file.
Enum
Response
200
400
Success
BulkRegionServiceabilityTatResultItemData
country
string
Name of the country.
region
string
Name of the region for which the tat/serviceability file needs to be downloaded.
type
string
Denotes the type of data.
Enum
batch_id
string
Unique identifier identifying the perticular request.
status
string
Current status of the request.
Enum
failed_records
array of object
Information of records which failed
file_path
string
Nullable
CDN path of the file.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Get Serviceability TAT sample file generator status
Parameters
organization_id
string
Required
Unique Identifier of Organization
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 12
batch_id
string
Batch id of the execution
Response
200
success
BulkRegionServiceabilityTatResult
items
array of object (BulkRegionServiceabilityTatResultItemData)
Array of BulkRegionServiceabilityTatResultItemData
country
string
Name of the country.
region
string
Name of the region for which the tat/serviceability file needs to be downloaded.
type
string
Denotes the type of data.
Enum
batch_id
string
Unique identifier identifying the perticular request.
status
string
Current status of the request.
Enum
failed_records
array of object
Information of records which failed
file_path
string
Nullable
CDN path of the file.
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
Parameters
organization_id
string
Required
Unique Identifier of Organization
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier of courier partner scheme.
Request body
file_path
string
Nullable
CDN path of the uploaded csv file for bulk import.
country
string
Required
Country for which the tat or serviceability is to be imported or exported.
action
string
Required
Denotes the import or export action to be performed.
Enum
region
string
Required
Region of the country for which import or export is triggered.
Response
200
success
BulkRegionResultItemData
file_path
string
CDN path of the file which was used for bulk import.
failed
integer
Count of the failed records.
failed_records
array of object
Information of records which failed.
action
string
Denotes the import or export action performed.
Enum
batch_id
string
Unique id to identify the import or export query.
country
string
Country for which the import or export action is performed.
success
integer
Denoted if the import or export was successful or failure.
region
string
Region of the country for which import or export is triggered.
status
string
Current status of the import or export action performed.
total
integer
Count of total records.
error_file_path
string
Path of the error file.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier of a courier partner scheme.
page_no
integer
| value >= 1
Index of the item to start returning with.
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page.
Default Value : 12
batch_id
string
Unique identifier of bulk job.
action
string
Import or export bulk type
status
string
Status of the bulk actions
Enum
country
string
Country for which bulk job is initiated
region
string
Region for which bulk job is initiated
start_date
string
| date-time
Fetch job history after a particule date
end_date
string
| date-time
Fetch job history before a particule date
Response
200
success
BulkRegionResult
items
array of object (BulkRegionResultItemData)
Array of BulkRegionResultItemData
file_path
string
CDN path of the file which was used for bulk import.
failed
integer
Count of the failed records.
failed_records
array of object
Information of records which failed.
action
string
Denotes the import or export action performed.
Enum
batch_id
string
Unique id to identify the import or export query.
country
string
Country for which the import or export action is performed.
success
integer
Denoted if the import or export was successful or failure.
region
string
Region of the country for which import or export is triggered.
status
string
Current status of the import or export action performed.
total
integer
Count of total records.
error_file_path
string
Path of the error file.
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
Parameters
organization_id
string
Required
Unique Identifier of Organization
extension_id
string
Required
Unique Identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a courier partner scheme
Request body
file_path
string
Nullable
CDN path of the uploaded csv file for bulk import.
country
string
Required
Country for which the tat or serviceability is to be imported or exported.
action
string
Required
Denotes the import or export action to be performed.
Enum
region
string
Required
Region of the country for which import or export is triggered.
Response
200
400
Success
BulkRegionResultItemData
file_path
string
CDN path of the file which was used for bulk import.
failed
integer
Count of the failed records.
failed_records
array of object
Information of records which failed.
action
string
Denotes the import or export action performed.
Enum
batch_id
string
Unique id to identify the import or export query.
country
string
Country for which the import or export action is performed.
success
integer
Denoted if the import or export was successful or failure.
region
string
Region of the country for which import or export is triggered.
status
string
Current status of the import or export action performed.
total
integer
Count of total records.
error_file_path
string
Path of the error file.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
extension_id
string
Required
Unique Identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 12
batch_id
string
Unique identifier of bulk job
action
string
Import or export bulk type
Enum
status
string
Status of the bulk actions
Enum
country
string
Country for which bulk job is initiated
region
string
Region for which bulk job is initiated
start_date
string
| date-time
Fetch job history after a particule date
end_date
string
| date-time
Fetch job history before a particule date
Response
200
Success
BulkRegionResult
items
array of object (BulkRegionResultItemData)
Array of BulkRegionResultItemData
file_path
string
CDN path of the file which was used for bulk import.
failed
integer
Count of the failed records.
failed_records
array of object
Information of records which failed.
action
string
Denotes the import or export action performed.
Enum
batch_id
string
Unique id to identify the import or export query.
country
string
Country for which the import or export action is performed.
success
integer
Denoted if the import or export was successful or failure.
region
string
Region of the country for which import or export is triggered.
status
string
Current status of the import or export action performed.
total
integer
Count of total records.
error_file_path
string
Path of the error file.
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
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
Unique identifier of the company.
Request body
extension_id
string
Required
Unique identifier of courier partner extension.
account_id
string
Unique identifier of courier partner scheme and company id combination.
scheme_id
string
Required
Unique identifier of courier account.
is_self_ship
boolean
Required
Denotes if the account is of self delivery type.
stage
string
Required
Denotes whether the courier account is in enabled or disabled stage.
Enum
is_own_account
boolean
Required
Denotes whether it is the seller's own account or not.
Response
200
400
success
CourierAccount
extension_id
string
Unique identifier of courier partner extension.
account_id
string
Unique identifier of courier partner scheme and company id combination.
scheme_id
string
Unique identifier of courier partner scheme.
is_self_ship
boolean
Denotes if the account is of self delivery type.
stage
string
Denotes whether the account is in enabled or disabled stage.
Enum
is_own_account
boolean
Denotes whether it is the seller's own account or not.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
Unique identifier of the company.
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
stage
string
Stage of the account. enabled/disabled
payment_mode
string
Filters dp accounts based on payment mode
transport_type
string
Filters dp accounts based on transport_type
Response
200
400
Success
CompanyCourierPartnerAccountListResult
items
array of object (CourierAccountResult)
Array of CourierAccountResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
scheme_id
string
Unique identifier of courier partner scheme.
is_self_ship
boolean
stage
string
Denotes whether the courier account is in enabled or disabled stage.
Enum
is_own_account
boolean
Denotes whether it is the seller's own account or not.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the scheme
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
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
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
Unique identifier of the company.
account_id
string
Required
Unique ID of courier partner account
Request body
extension_id
string
Required
Unique identifier of courier partner extension.
scheme_id
string
Required
Unique identifier of courier partner scheme.
is_self_ship
boolean
Required
Denotes if the account is of self delivery type.
stage
string
Required
Denotes whether the account is in enabled or disabled stage.
Enum
is_own_account
boolean
Required
Denotes whether it is the seller's own account or not.
Response
200
400
Success
CourierAccountResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
scheme_id
string
Unique identifier of courier partner scheme.
is_self_ship
boolean
stage
string
Denotes whether the courier account is in enabled or disabled stage.
Enum
is_own_account
boolean
Denotes whether it is the seller's own account or not.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the scheme
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
This API returns response DpAccount of a company from mongo database.
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
Unique identifier of the company.
account_id
string
Required
Unique identifier of courier partner account
Response
200
400
Success
CourierAccountResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
scheme_id
string
Unique identifier of courier partner scheme.
is_self_ship
boolean
stage
string
Denotes whether the courier account is in enabled or disabled stage.
Enum
is_own_account
boolean
Denotes whether it is the seller's own account or not.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the scheme
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
onboarding
boolean
Only fetch countries which allowed for onboard on Platform.
page_no
integer
Page number.
Default Value : 1
page_size
integer
| value <= 48
Page size.
Default Value : 12
q
string
Search parameter.
Response
200
Success
GetCountries
items
array of object (GetCountriesItems)
Array of GetCountriesItems
id
string
Unique identifier of the country.
name
string
Name of the country.
iso2
string
Two-letter ISO code representing the country.
iso3
string
Three-letter ISO code representing the country.
timezones
array of string
List of time zones used in the country (e.g., ["America/New_York", "America/Los_Angeles"]).
hierarchy
array of object (HierarchyItems)
Levels within the country (e.g., states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"}, {"name": "City", "slug": "city"}]).
Array of HierarchyItems
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").
currency
string
Indicates currency for the country (e.g., "INR").
type
string
Indicates the type of object (e.g., "country").
latitude
string
Geographical latitude of the country (e.g., "37.0902").
longitude
string
Geographical longitude of the country (e.g., "-95.7129").
display_name
string
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
has_next_hierarchy
boolean
More detailed hierarchical data is available, meaning states, cities, or other regions within the country have been populated in the system.
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
The delivery-time endpoints are tailored for managing the expected delivery times between different regions for a specific courier partner within a logistics scheme. The endpoints supports CRUD operations for delivery time records. Each record captures details such as the origin and destination (identified by country, state, city, sector, and pin codes), as well as the minimum and maximum delivery times required to transport goods between these locations. Business partners can use this endpoint to configure region-based delivery times that reflect realistic expectations, which are critical for planning and optimizing logistics operations. By integrating this API, external developers can dynamically manage and update delivery time information based on real-time data or changes in logistics strategies. The delivery time data provided by this endpoint is essential for determining accurate shipping estimates, improving route planning, and setting customer expectations. For instance, during the order allocation process, the core logistics system can utilize this information to decide on the most efficient routes and courier partners, ensuring timely delivery of goods. By managing delivery times effectively, businesses can enhance operational efficiency, reduce delivery delays, and improve overall customer satisfaction.
Operations
POST
# Region based delivery time insert
GET
# Get region based delivery time list
GET
# Get region based delivery time for a given identifier
PUT
# Region based delivery time update
DEL
# Region based delivery time delete
Insert the region based delivery time for a specific region within a courier partner scheme.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
from_country_code
string
Required
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
Required
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
Response
200
400
422
Response status code
RegionTatResult
from_country_code
string
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
id
string
Unique identifier for the delivery time record.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Retrieve a list of delivery time for specific regions within a courier partner scheme.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 12
from_country_code
string
From country ISO2 code for which request is initiated
from_state_code
string
From state code for which request is initiated
from_city_code
string
From city code for which request is initiated
from_sector_code
string
From sector code for which request is initiated
from_pincode
string
From pincode for which request is initiated
to_country_code
string
To country ISO2 code for which request is initiated
to_state_code
string
To state code for which request is initiated
to_city_code
string
To city code for which request is initiated
to_sector_code
string
To sector code for which request is initiated
to_pincode
string
To pincode for which request is initiated
Response
200
400
Response status code
RegionTatItemResult
items
array of object (RegionTatResult)
Array of RegionTatResult
from_country_code
string
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
id
string
Unique identifier for the delivery time record.
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
Retrieve the delivery time details for a specific region within a courier partner scheme using the unique delivery time record identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a delivery time record
Response
200
400
Response status code
RegionTatResult
from_country_code
string
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
id
string
Unique identifier for the delivery time record.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Update the delivery time details for a specific region within a courier partner scheme using the unique delivery time record identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a delivery time record
Request body
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
Response
200
400
422
Response status code
RegionTatResult
from_country_code
string
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
id
string
Unique identifier for the delivery time record.
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Delete the delivery time record for a specific region within a courier partner scheme using the unique delivery time record identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a delivery time record
Response
200
400
422
Response status_code
RegionTatResult
from_country_code
string
ISO2 code representing the country of origin for the delivery.
from_state_code
string
Code representing the state or province of origin within the country.
from_city_code
string
Code representing the city of origin within the state.
from_sector_code
string
Code representing a specific sector or district within the city of origin.
from_pincode
string
Postal or ZIP code of the origin area.
to_country_code
string
ISO2 code representing the destination country.
to_state_code
string
Code representing the state or province of the destination within the country.
to_city_code
string
Code representing the city of destination within the state.
to_sector_code
string
Code representing a specific sector or district within the city of destination.
to_pincode
string
Postal or ZIP code of the destination area.
max_delivery_time
integer
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Minimum time required for delivery from the origin to the destination in seconds.
id
string
Unique identifier for the delivery time record.
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response
This resource allows sellers to create schemes, update, get which are predefined plans with various pre-configured settings. Sellers can then utilize these schemes to create accounts.
Operations
POST
# Create Scheme for courier partner extension
GET
# Get created Schemes for courier partner
PUT
# Update Scheme for courier partner extension
GET
# Get Scheme for courier partner extension by Id
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
extension_id
string
Required
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Required
Name of the scheme.
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Required
Mode of transport associated with the courier partner scheme.
Enum
region
string
Required
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Required
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Required
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Required
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
Required
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
Response
200
400
Success Response Status
CourierPartnerV2SchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
Examples
Parameters
organization_id:
"value"
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_type
string
Indicates whether a scheme is created by an admin for global purposes or customized for a specific company.
Enum
payment_mode
string
Indicates payment mode for a scheme.
Enum
capabilities
array of string
Indicates whether the scheme possesses certain capabilities.
scheme_ids
array of string
List of scheme ids which need to be returned in the response.
Response
200
400
Success Response Status
courierPartnerSchemeV2List
items
array of object (CourierPartnerV2SchemeModel)
List of courier partner schemes
Array of CourierPartnerV2SchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
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
organization_id:
"value"
scheme_type:
"value"
payment_mode:
"value"
capabilities:
"lorem","ipsum"
scheme_ids:
"lorem","ipsum"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique Identifier of Scheme
Request body
name
string
Required
Name of the scheme.
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Required
Mode of transport associated with the courier partner scheme.
Enum
region
string
Required
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Required
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Required
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Required
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
Required
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
Response
200
400
Success Response Status
CourierPartnerV2SchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
Examples
Parameters
organization_id:
"value"
scheme_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique Identifier of Scheme
Response
200
400
Success Response Status
CourierPartnerV2SchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeV2Features)
CourierPartnerSchemeV2Features
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
Examples
Parameters
organization_id:
"value"
scheme_id:
"value"
Was this section helpful?
GET
Response
The serviceability endpoints are designed to manage and track the availability of delivery and related services in specific geographical regions. It provides CRUD operations for serviceability records, which include detailed information about the capabilities offered in each area. These capabilities include first-mile and last-mile service availability, cash on delivery (COD) limits, the ability to perform doorstep returns and quality checks, and other logistics related features such as pickup cutoffs and installation services. Logistics providers can use this endpoint to define service parameters for different regions, identified by country, state, city, sector, and pin codes. By integrating this endpoint into their systems, external developers can programmatically manage serviceability data, ensuring that their logistics operations align with the latest service offerings. The serviceability data captured by this API is crucial for the core decision-making processes when allocating stores and delivery partners (DPs). For example, during the allocation process, the core system can refer to this data to decide which delivery partners are suitable for a particular order based on their service capabilities and regional constraints. This allows businesses to optimize their delivery network and ensure that services are only offered where they are fully supported, leading to more efficient operations and improved customer satisfaction.
Operations
POST
# Serviceability insert
GET
# Get region serviceability list
GET
# Get region serviceability
PUT
# Serviceability update
DEL
# Serviceability delete
Insert the serviceability for a specific region within a courier partner scheme.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
country_code
string
Required
ISO2 code representing the country where the serviceability is being specified.
state_code
string
Code representing the state or province within the country where the serviceability is being specified.
city_code
string
Code representing the city within the state where the serviceability is being specified.
sector_code
string
Code representing a specific sector or district within the city where the serviceability is being specified.
pincode
string
Postal or ZIP code for the specific area within the city where the serviceability is being specified.
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
Response
200
400
422
Response status code
RegionServiceabilityResult
country_code
string
ISO2 code representing the country where the serviceability is being specified.
state_code
string
Code representing the state or province within the country where the serviceability is being specified.
city_code
string
Code representing the city within the state where the serviceability is being specified.
sector_code
string
Code representing a specific sector or district within the city where the serviceability is being specified.
pincode
string
Postal or ZIP code for the specific area within the city where the serviceability is being specified.
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
Unique identifier for the serviceability record.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Retrieve a list of serviceability for specific regions within a courier partner scheme.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 12
country_code
string
Country ISO2 code for which request is initiated
state_code
string
State code for which request is initiated
city_code
string
City code for which request is initiated
sector_code
string
Sector code for which request is initiated
pincode
string
Pincode for which request is initiated
first_mile
boolean
First mile value for which request is initiated
last_mile
boolean
Last mile value for which request is initiated
doorstep_return
boolean
Doorstep return value for which request is initiated
doorstep_qc
boolean
Doorstep qc value for which request is initiated
installation
boolean
Installation value for which request is initiated
Response
200
400
Response status code
RegionServiceabilityItemResult
items
array of object (RegionServiceabilityResult)
Array of RegionServiceabilityResult
country_code
string
ISO2 code representing the country where the serviceability is being specified.
state_code
string
Code representing the state or province within the country where the serviceability is being specified.
city_code
string
Code representing the city within the state where the serviceability is being specified.
sector_code
string
Code representing a specific sector or district within the city where the serviceability is being specified.
pincode
string
Postal or ZIP code for the specific area within the city where the serviceability is being specified.
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
Unique identifier for the serviceability record.
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
Retrieve serviceability for specific region within a courier partner scheme for a given identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a serviceability record
Response
200
400
Response status code
RegionServiceabilityResult
country_code
string
ISO2 code representing the country where the serviceability is being specified.
state_code
string
Code representing the state or province within the country where the serviceability is being specified.
city_code
string
Code representing the city within the state where the serviceability is being specified.
sector_code
string
Code representing a specific sector or district within the city where the serviceability is being specified.
pincode
string
Postal or ZIP code for the specific area within the city where the serviceability is being specified.
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
Unique identifier for the serviceability record.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Update the serviceability for a specific region within a courier partner scheme based on unique identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a serviceability record
Request body
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
Response
200
400
422
Response status code
ServiceabilityDetailsResult
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
Unique identifier for the serviceability record.
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Delete the serviceability for a specific region within a courier partner scheme based on a unique identifier.
Parameters
partner_org_id
string
Required
Unique identifier of partner's organization
courier_partner_extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
Required
Unique identifier of a scheme
id
string
Required
Unique identifier of a serviceability record
Response
200
400
422
Response status code
RegionServiceabilityResult
country_code
string
ISO2 code representing the country where the serviceability is being specified.
state_code
string
Code representing the state or province within the country where the serviceability is being specified.
city_code
string
Code representing the city within the state where the serviceability is being specified.
sector_code
string
Code representing a specific sector or district within the city where the serviceability is being specified.
pincode
string
Postal or ZIP code for the specific area within the city where the serviceability is being specified.
first_mile
boolean
Boolean value indicating whether first-mile service is available or not.
last_mile
boolean
Boolean value indicating whether last-mile service is available or not.
reverse_pickup
boolean
Nullable
Boolean value indicating whether a region is first-mile serviceable or not in return pickup.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
doorstep_return
boolean
Indicates if doorstep return service is available. This refers to the ability to return items directly from the customer's doorstep.
doorstep_qc
boolean
Indicates if doorstep quality check service is available. This refers to the ability to perform quality checks on items at the customer's doorstep.
pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
Unique identifier for the serviceability record.
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response