Serviceability

Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.

Country & Locality Information

Handle large-scale operations related to locality data. It retrieve bulk locality data history, import bulk locality data, export bulk locality data, and download locality data templates to facilitate efficient management of location-related information.

Operations
GET
/service/platform/logistics/v2.0/company/{company_id}/countries
# Get countries
GET

Get countries

Retrieve a list of countries for logistical purposes.
Parameters
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.
hierarchy
string
fetch countries that has certain heirarchy present.
company_id
integer
Required
The unique identifier of the company.
Response
200
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (GetCountriesItems)
Array of GetCountriesItems
id
string
name
string
iso2
string
iso3
string
timezones
array of string
hierarchy
array of object (HierarchyItems)
Array of HierarchyItems
display_name
string
slug
string
phone_code
string
currency
string
type
string
latitude
string
longitude
string
display_name
string
has_next_hierarchy
boolean
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.
GET
/service/platform/logistics/v2.0/company/{company_id}/countries
Loading...
Response
Loading...

Courier Partner Setup & Rules

Courier partners are organizations that offer delivery services for packages, parcels, documents, or goods. This resource allows sellers to create schemes, which are predefined plans with various preconfigured settings. Sellers can then utilize these schemes to create accounts and choose self-shipping options if desired. Once set up, sellers can utilize these accounts to establish rules based on factors like customer location and product type. These rules assist in efficiently managing delivery partners and prioritizing deliveries based on specific criteria. For example, a seller specializing in furniture can choose self-ship for items that require assembly and assign a partner for other furniture items.

Operations
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# Create courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# List courier accounts
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Update courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Get courier account
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Update delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Get delivery configuration
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Locality TAT import or export
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Locality TAT change history
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Bulk update serviceability of localities
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Bulk update history
POST

Create courier account

Creates a courier partner account.
Parameters
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 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
CourierAccount
company_id
integer
Company id associated with the account.
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.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
name
string
Name of the scheme.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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.
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
GET

List courier accounts

Retrieves a list of courier partner accounts.
Parameters
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
Enum
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
company_id
integer
Company id associated with the account.
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.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
name
string
Name of the scheme.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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.
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
PUT

Update courier account

Updates an existing courier partner account.
Parameters
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
company_id
integer
Company id associated with the account.
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.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
name
string
Name of the scheme.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
GET

Get courier account

Retrieves a single courier partner account.
Parameters
company_id
integer
Required
Unique identifier of the company.
account_id
string
Required
Unique ID of courier partner account
Response
200
400
Success
CourierAccountResult
company_id
integer
Company id associated with the account.
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.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
name
string
Name of the scheme.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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.
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
PUT

Update delivery configuration

Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
rule_ids
array of string
Required
A list for courier partner rules.
sort
array of string
Required
Sort strategy for the courier partners.
Enum
logistics_as_actual
string
Depicts if the courier partner rule configuration plan is subscribed by the seller for which mode.
Enum
company_id
integer
Required
Unique identifier of the company.
application_id
string
Unique identifier of the sales channel.
Response
200
400
Success
CompanyConfig
rule_ids
array of string
A list for courier partner rules.
sort
array of string
Sort strategy for the courier partners.
Enum
logistics_as_actual
string
Depicts if the courier partner rule configuration plan is subscribed by the seller for which mode.
Enum
company_id
integer
Unique identifier of the company.
application_id
string
Unique identifier of the sales channel.
Examples
Parameters
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

Retrieves information about the delivery setup for a company
Parameters
company_id
integer
Required
Unique identifier of the company.
Response
200
400
Success
CompanyConfig
rule_ids
array of string
A list for courier partner rules.
sort
array of string
Sort strategy for the courier partners.
Enum
logistics_as_actual
string
Depicts if the courier partner rule configuration plan is subscribed by the seller for which mode.
Enum
company_id
integer
Unique identifier of the company.
application_id
string
Unique identifier of the sales channel.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
POST

Locality TAT import or export

Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file. Export locality wise CSV files.
Parameters
company_id
integer
Required
Unique identifier of the company.
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
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
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
GET

Locality TAT change history

Retrieves the history of changes made to TAT(Turn Around Time) for scheme.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier of 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
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
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.
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
POST

Bulk update serviceability of localities

Bulk operations involve either new serviceability settings or updating existing ones in large quantities.
Parameters
company_id
integer
Required
Unique identifier of the company.
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
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
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
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...
GET

Bulk update history

Retrieves the history of changes made to serviceability settings for a scheme.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier of 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
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
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.
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...

Delivery Zone

A delivery zone is composed of specific localities and corresponding stores equipped to serve them. It represents predefined geographic areas, each comprising a cluster of localities strategically mapped out based on logistical considerations and customer demand. Within these delivery zones, carefully selected stores are designated to fulfil orders, ensuring efficient and timely delivery to customers residing within the specified localities. Each store is strategically positioned to optimize coverage and minimize delivery times, enhancing the overall delivery experience.

Operations
GET
/service/platform/logistics/v2.0/company/{company_id}/zones
# Get zones
POST
/service/platform/logistics/v2.0/company/{company_id}/zones
# Create zone
PUT
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
# Update a zone
GET
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
# Get zone details
GET

Get zones

Retrieves a list of delivery zones.
Parameters
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
is_active
boolean
Status of Zone (either active or inactive)
channel_id
string
Zones filtered by an application
q
string
Search with name as a free text
country_iso_code
string
ISO2 code of the country
state
string
State name
city
string
City name
pincode
string
Pincode value to search zones
sector
string
Sector value to search zones
Response
200
400
Zone List of application in descending order of their last modified date.
ListViewResult
page
object (ZoneDataItem)
ZoneDataItem
has_next
boolean
item_total
integer
size
integer
current
integer
type
string
items
array of object (ListViewItems)
Array of ListViewItems
zone_id
string
The unique identifier for the zone.
name
string
The name of the zone.
slug
string
A human-readable and unique identifier for the zone, derived from the name.
stores_count
integer
The number of stores within the zone.
is_active
boolean
A flag indicating whether the zone is active.
regions_count
integer
The number of regions within the zone.
company_id
integer
The unique identifier for the company to which the zone belongs.
store_ids
array of integer
A list of store identifiers associated with the zone.
channels
array of object (ListViewChannels)
The name of the zone.
Array of ListViewChannels
channel_id
string
channel_type
string
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v2.0/company/{company_id}/zones
Loading...
Response
Loading...
POST

Create zone

Creates a delivery zone.
Parameters
company_id
integer
Required
Unique identifier of the company.
Request body
name
string
Required
Name of the zone.
slug
string
Required
A human-readable and unique identifier for the zone, derived from the name.
company_id
integer
Required
Unique identifier of the company for which the zone is created.
is_active
boolean
Required
A flag indicating whether the zone is active.
channels
array of object (GetZoneDataViewChannels)
Required
Channels for which the zone is active.
Array of GetZoneDataViewChannels
channel_id
string
Required
channel_type
string
Required
store_ids
array of integer
Required
A list of store identifiers associated with the zone.
region_type
string
Required
Type of region that belongs in the zone.
Enum
mapping
array of object (ZoneMappingType)
Required
Country to region mapping for the zone.
Array of ZoneMappingType
country
string
Required
Uid for the country.
regions
array of string
Required
List of region uid for the given country.
product
object (ZoneProductTypes)
ZoneProductTypes
type
string
Required
Denotes if the zone is applicable for all the products or specific products.
Enum
tags
array of string
Required
List of product tags.
Response
200
400
Success
ZoneResult
status_code
integer
zone_id
string
success
boolean
Examples
Parameters
company_id:
1
body:
body
POST
/service/platform/logistics/v2.0/company/{company_id}/zones
Loading...
Response
Loading...
PUT

Update a zone

Update an existing delivery zone .
Parameters
company_id
integer
Required
Unique identifier of the company.
zone_id
string
Required
A `zone_id` is a unique identifier for a particular zone.
Request body
zone_id
string
Required
Unique identifier for the zone.
name
string
Required
Name for the zone.
slug
string
Required
A human-readable and unique identifier for the zone, derived from the name.
company_id
integer
Required
Company id associated with the zone.
is_active
boolean
Required
A flag indicating whether the zone is active.
channels
array of object (GetZoneDataViewChannels)
Required
Channels for which the zone is active.
Array of GetZoneDataViewChannels
channel_id
string
Required
channel_type
string
Required
product
object (ZoneProductTypes)
Required
ZoneProductTypes
type
string
Required
Denotes if the zone is applicable for all the products or specific products.
Enum
tags
array of string
Required
List of product tags.
store_ids
array of integer
Required
A list of store identifiers associated with the zone.
region_type
string
Required
Type of region that belongs in the zone.
Enum
mapping
array of object (ZoneMappingType)
Required
Country to region mapping for the zone.
Array of ZoneMappingType
country
string
Required
Uid for the country.
regions
array of string
Required
List of region uid for the given country.
Response
200
400
Success
ZoneSuccessResult
status_code
integer
success
boolean
Examples
Parameters
Parameters are not required.
PUT
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
Loading...
Response
Loading...
GET

Get zone details

Retrieves a single delivery zone.
Parameters
company_id
integer
Required
Unique identifier of the company.
zone_id
string
Required
A `zone_id` is a unique identifier for a particular zone.
Response
200
400
Get details of the Zone
GetZoneByIdSchema
zone_id
string
Unique identifier for the zone.
name
string
Name for the zone.
slug
string
A human-readable and unique identifier for the zone, derived from the name.
company_id
integer
Company id associated with the zone.
is_active
boolean
A flag indicating whether the zone is active.
channels
array of object (GetZoneDataViewChannels)
Channels for which the zone is active.
Array of GetZoneDataViewChannels
channel_id
string
channel_type
string
product
object (ZoneProductTypes)
ZoneProductTypes
type
string
Denotes if the zone is applicable for all the products or specific products.
Enum
tags
array of string
List of product tags.
store_ids
array of integer
A list of store identifiers associated with the zone.
region_type
string
Type of region that belongs in the zone.
Enum
mapping
array of object (ZoneMappingDetailType)
Country to region mapping for the zone.
Array of ZoneMappingDetailType
country
string
Uid for the country.
regions
array of object (ZoneMappingRegions)
List of regions with its details.
Array of ZoneMappingRegions
display_name
string
Name of the region that is in proper casing.
parent_id
array of string
parent_uid
string
Unique identifier for that regions parent.
sub_type
string
What type does the region belong to.
uid
string
Unique identifier for that region.
stores_count
integer
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
Loading...
Response
Loading...

Schemes

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
/service/platform/logistics/v2.0/company/{company_id}/courier-partner/scheme
# Create Scheme for courier partner extension
GET
/service/platform/logistics/v2.0/company/{company_id}/courier-partner/scheme
# Get created Schemes for courier partner
PUT
/service/platform/logistics/v2.0/company/{company_id}/courier-partner/scheme/{scheme_id}
# Update Scheme for courier partner extension
GET
/service/platform/logistics/v2.0/company/{company_id}/courier-partner/scheme/{scheme_id}
# Get Scheme for courier partner extension by Id
POST
/service/platform/logistics/v1.0/company/{company_id}/localities/bulk-sample
# Sample File Download
GET
/service/platform/logistics/v1.0/company/{company_id}/localities/bulk-sample
# Get Serviceability TAT sample files generator status
POST

Create Scheme for courier partner extension

Create Scheme for courier partner extension
Parameters
company_id
integer
Required
The unique identifier of the company.
Request body
extension_id
string
Required
Unique identifier of courier partner extension
scheme_id
string
name
string
Required
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
Enum
region
string
Required
Enum
delivery_type
string
Required
Enum
payment_mode
array of string
Required
Enum
stage
string
Required
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