Logistics
Serviceability API's
The Country & Locality resource contains extensive data about countries and how they're structured. For instance, in India, it's organized as Country, State, City, and Pincode, while in Australia, it's simpler with State, City, and Zipcode. We've made this structure consistent globally, covering Country, State, City, Pincode, and Sector. Using this resource, you can easily access hierarchical information for each country. This resource helpful for retrieving detailed locality information, such as lists of states for a given country, cities for a given state and country, and more. Moreover, it's crucial for validating customer addresses, like verifying the validity of a pincode. Additionally, it provides in-depth locality data, such as offering city and country information for a specific sector in the UAE.
Operations
POST
# Sample File Download
GET
# Get Serviceability TAT sample files generator status
GET
# Get all countries and associated data
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
country
string
Required
Country involved in the operation.
region
string
Required
Region involved in the operation.
type
string
Required
Type of operation, either serviceability or TAT.
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
A unique identifier for the performed batch operation.
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
organization_id:
"000000000000000000000001"
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
The current page number for paginated results.
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
400
Success
BulkRegionServiceabilityTatResult
items
array of object (BulkRegionServiceabilityTatResultItemData)
Array of bulk region serviceability or TAT result items.
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
A unique identifier for the performed batch operation.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"000000000000000000000001"
page_no:
1
page_size:
1
batch_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
onboard
boolean
Only fetch countries which allowed for onboard on Platform.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
| value <= 300
The number of items to retrieve in each page. Default value is 12
Default Value : 12
q
string
The search string to search in the list of countries by name.
hierarchy
string
The search filter to filter countries based on their available hierarchy.
Enum
Response
200
400
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (GetCountriesItems)
A list of country objects containing detailed information about each country.
Array of GetCountriesItems
id
string
A string serving as the unique identifier.
sub_type
string
A category for classifying the country into a specific subtype.
uid
string
A globally unique identifier for the country.
name
string
The official or widely recognized name of the country used in general contexts.
iso2
string
The 2-letter ISO code for the country.
iso3
string
The 3-letter ISO code for the country.
timezones
array of string
A list of timezones associated with the country.
hierarchy
array of object (HierarchyItems)
A hierarchical list of items representing organizational levels within the country.
Array of HierarchyItems
name
string
The name of the item as displayed to the user, usually in a UI or listing.
display_name
string
It represent a country display name.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
phone_code
string
A country-specific phone code.
currency
object (CurrencyObject)
CurrencyObject
code
string
A string representing the currency code.
name
string
A string representing the currency name.
symbol
string
A string representing the currency symbol.
type
string
The type or classification of the country (e.g., sovereign or dependent).
latitude
string
The latitude of the central point of the country.
longitude
string
The longitude of the central point of the country.
display_name
string
A user-friendly name for the country, typically for display purposes.
has_next_hierarchy
boolean
A boolean indicating whether additional hierarchical regions or divisions are present.
page
object (Page)
Page
item_total
integer
| int32
The total number of 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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"org_id"
onboard:
true
page_no:
1
page_size:
6
q:
"I"
hierarchy:
"pincode"
Was this section helpful?
GET
Response
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
# Region TAT Import or Export
GET
# Get region tat bulk history
POST
# Serviceability Import or Export
GET
# Get Region Serviceability Bulk History
POST
# Create courier account
GET
# List courier accounts
PUT
# Update courier account
GET
# Get courier account
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 for the scheme, used to fetch or modify scheme details.
Request body
file_path
string
Path to the file used in the bulk operation.
country
string
Required
Country involved in the bulk operation.
action
string
Required
Action type for the bulk operation, either import or export.
Enum
region
string
Required
Region involved in the bulk operation.
Response
200
400
Response status_code
BulkRegionResultItemData
file_path
string
Path to the file associated with the result item.
failed
integer
Number of failed records in the operation.
failed_records
array of object
Array of failed records with additional properties.
action
string
Action type for the result item.
batch_id
string
A unique identifier for the performed batch operation.
country
string
Country associated with the result item.
success
integer
Number of successful records in the operation.
region
string
Region associated with the result item.
status
string
Current status of the result item.
Enum
total
integer
Total number of records processed.
error_file_path
string
Path to the file containing error details.
Examples
Parameters
organization_id:
"org_id"
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
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 for the scheme, used to fetch or modify scheme details.
page_no
integer
| value >= 1
The current page number for paginated results.
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
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
Response status_code
BulkRegionResult
items
array of object (BulkRegionResultItemData)
Array of bulk region result items.
Array of BulkRegionResultItemData
file_path
string
Path to the file associated with the result item.
failed
integer
Number of failed records in the operation.
failed_records
array of object
Array of failed records with additional properties.
action
string
Action type for the result item.
batch_id
string
A unique identifier for the performed batch operation.
country
string
Country associated with the result item.
success
integer
Number of successful records in the operation.
region
string
Region associated with the result item.
status
string
Current status of the result item.
Enum
total
integer
Total number of records processed.
error_file_path
string
Path to the file containing error details.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"org_id"
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
page_no:
1
page_size:
10
batch_id:
"65e476c1a70e9a713278c910"
action:
"import"
status:
"processing"
country:
"India"
region:
"Pincode"
start_date:
"2023-09-12T00:00:00.000000"
end_date:
"2023-09-12T23:59:59.999999"
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 for the scheme, used to fetch or modify scheme details.
Request body
file_path
string
Path to the file used in the bulk operation.
country
string
Required
Country involved in the bulk operation.
action
string
Required
Action type for the bulk operation, either import or export.
Enum
region
string
Required
Region involved in the bulk operation.
Response
200
400
Success
BulkRegionResultItemData
file_path
string
Path to the file associated with the result item.
failed
integer
Number of failed records in the operation.
failed_records
array of object
Array of failed records with additional properties.
action
string
Action type for the result item.
batch_id
string
A unique identifier for the performed batch operation.
country
string
Country associated with the result item.
success
integer
Number of successful records in the operation.
region
string
Region associated with the result item.
status
string
Current status of the result item.
Enum
total
integer
Total number of records processed.
error_file_path
string
Path to the file containing error details.
Examples
Parameters
organization_id:
"000000000000000000000001"
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
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 for the scheme, used to fetch or modify scheme details.
page_no
integer
| value >= 1
The current page number for paginated results.
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
404
Success
BulkRegionResult
items
array of object (BulkRegionResultItemData)
Array of bulk region result items.
Array of BulkRegionResultItemData
file_path
string
Path to the file associated with the result item.
failed
integer
Number of failed records in the operation.
failed_records
array of object
Array of failed records with additional properties.
action
string
Action type for the result item.
batch_id
string
A unique identifier for the performed batch operation.
country
string
Country associated with the result item.
success
integer
Number of successful records in the operation.
region
string
Region associated with the result item.
status
string
Current status of the result item.
Enum
total
integer
Total number of records processed.
error_file_path
string
Path to the file containing error details.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"000000000000000000000001"
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
page_no:
1
page_size:
10
batch_id:
"65e4767837d1b6a7040a469c"
action:
"import"
country:
"India"
region:
"region"
start_date:
"2023-09-12T00:00:00.000000"
end_date:
"2023-09-12T23:59:59.999999"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
extension_id
string
Required
The unique identifier for the extension linked to the courier account.
account_id
string
The unique identifier for the courier account.
scheme_id
string
Required
The identifier for the scheme associated with the courier account.
is_self_ship
boolean
Required
Indicates whether the courier account supports self-shipping (true if it does, false otherwise).
stage
string
Required
The current stage of the courier account, either 'enabled' or 'disabled'.
Enum
is_own_account
boolean
Required
Indicates whether the courier account is an own account (true if it is, false otherwise).
Response
200
400
Response status_code
CourierAccountDetailsBody
extension_id
string
The unique identifier for the extension linked to the courier account.
account_id
string
The unique identifier for the courier account.
scheme_id
string
The identifier for the scheme associated with the courier account.
is_self_ship
boolean
Indicates whether the courier account supports self-shipping (true if it does, false otherwise).
stage
string
The current stage of the courier account, either 'enabled' or 'disabled'.
Enum
is_own_account
boolean
Indicates whether the courier account is an own account (true if it is, false otherwise).
Examples
Parameters
organization_id:
"000000000000000000000001"
company_id:
123
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_no
integer
| value >= 1
The current page number for paginated results.
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.
Enum
payment_mode
string
Filters dp accounts based on payment mode
transport_type
string
Filters dp accounts based on transport_type
Enum
account_ids
array of string
Filters dp accounts based on their ids
self_ship
boolean
To filter self ship/non self ship dp accounts
own_account
boolean
Filters seller owned or Fynd Managed dp accounts.
q
string
Filters dp accounts based on account name.
Response
200
Response status_code
CompanyCourierPartnerAccountListResult
items
array of object (CourierAccountResult)
An array containing multiple instances of CourierAccountResult, which details individual courier accounts.
Array of CourierAccountResult
account_id
string
A string that uniquely identifies the courier account.
company_id
integer
The unique identifier of the company.
scheme_id
string
A string that specifies the unique identifier for the scheme associated with the account
extension_id
string
A string that uniquely identifies the courier partner extension.
is_self_ship
boolean
A boolean indicating whether the account is for self-shipping.
stage
string
A string indicating the current stage of the account, which can be either enabled or disabled.
Enum
is_own_account
boolean
A boolean indicating whether the account is owned by the company.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
A string representing the unique identifier for the scheme. This is a required field.
name
string
A string that specifies the name of the scheme. This is a required field.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
A string that specifies the type of transport.
Enum
region
string
A string that indicates the region type.
Enum
delivery_type
string
A string that defines the delivery type.
Enum
payment_mode
array of string
An array of strings specifying the payment modes available.
Enum
stage
string
A string indicating the current stage of the scheme.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"000000000000000000000001"
company_id:
123
page_no:
1
page_size:
10
stage:
"enabled"
payment_mode:
"COD"
transport_type:
"surface"
account_ids:
"67a3c8e60fd6c66371f3665d"
self_ship:
true
own_account:
true
q:
"Scheme 2"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
account_id
string
Required
Unique ID of courier account
Request body
extension_id
string
Required
The unique identifier for the extension linked to the courier account.
account_id
string
The unique identifier for the courier account.
scheme_id
string
Required
The identifier for the scheme associated with the courier account.
is_self_ship
boolean
Required
Indicates whether the courier account supports self-shipping (true if it does, false otherwise).
stage
string
Required
The current stage of the courier account, either 'enabled' or 'disabled'.
Enum
is_own_account
boolean
Required
Indicates whether the courier account is an own account (true if it is, false otherwise).
Response
200
400
Response status_code
CourierAccountDetailsBody
extension_id
string
The unique identifier for the extension linked to the courier account.
account_id
string
The unique identifier for the courier account.
scheme_id
string
The identifier for the scheme associated with the courier account.
is_self_ship
boolean
Indicates whether the courier account supports self-shipping (true if it does, false otherwise).
stage
string
The current stage of the courier account, either 'enabled' or 'disabled'.
Enum
is_own_account
boolean
Indicates whether the courier account is an own account (true if it is, false otherwise).
Examples
Parameters
organization_id:
"000000000000000000000001"
company_id:
123
account_id:
"23"
body:
body
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
account_id
string
Required
Unique ID of courier account
Response
200
400
Response status_code
CourierAccountResult
account_id
string
A string that uniquely identifies the courier account.
company_id
integer
The unique identifier of the company.
scheme_id
string
A string that specifies the unique identifier for the scheme associated with the account
extension_id
string
A string that uniquely identifies the courier partner extension.
is_self_ship
boolean
A boolean indicating whether the account is for self-shipping.
stage
string
A string indicating the current stage of the account, which can be either enabled or disabled.
Enum
is_own_account
boolean
A boolean indicating whether the account is owned by the company.
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
A string representing the unique identifier for the scheme. This is a required field.
name
string
A string that specifies the name of the scheme. This is a required field.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
A string that specifies the type of transport.
Enum
region
string
A string that indicates the region type.
Enum
delivery_type
string
A string that defines the delivery type.
Enum
payment_mode
array of string
An array of strings specifying the payment modes available.
Enum
stage
string
A string indicating the current stage of the scheme.
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
organization_id:
"000000000000000000000001"
company_id:
123
account_id:
"23"
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 for the scheme, used to fetch or modify scheme details.
Request body
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"1"
scheme_id:
"1"
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 for the scheme, used to fetch or modify scheme details.
page_no
integer
| value >= 1
The current page number for paginated results.
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)
An array that contains items of region tat.
Array of RegionTatResult
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
A string serving as the unique identifier.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"1"
scheme_id:
"1"
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 for the scheme, used to fetch or modify scheme details.
id
string
Required
Unique identifier of a delivery time record
Response
200
400
Response status code
RegionTatResult
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_1"
courier_partner_extension_id:
"44"
scheme_id:
"44"
id:
"6524fa7b6b3b9c4d852b1fe8"
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 for the scheme, used to fetch or modify scheme details.
id
string
Required
Unique identifier of a delivery time record
Request body
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_1"
courier_partner_extension_id:
"44"
scheme_id:
"44"
id:
"6524fa7b6b3b9c4d852b1fe8"
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 for the scheme, used to fetch or modify scheme details.
id
string
Required
Unique identifier of a delivery time record
Response
200
400
Response status_code
RegionTatResult
min_delivery_time
integer
Nullable
Minimum time required for delivery from the origin to the destination in seconds.
max_delivery_time
integer
Nullable
Maximum time required for delivery from the origin to the destination in seconds.
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
A string indicating the postal code or PIN code of the address 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
A string indicating the postal code or PIN code of the address area.
forward
object (TATDetails)
TATDetails
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.
reverse
object (TATDetails)
TATDetails
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
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_1"
courier_partner_extension_id:
"44"
scheme_id:
"44"
id:
"6524fa7b6b3b9c4d852b1fe8"
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 for the scheme, used to fetch or modify scheme details.
name
string
Required
Name of the scheme.
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (CourierPartnerSchemeFeatures)
Required
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.
Response
200
400
Success Response Status
CourierPartnerSchemeModelSchema
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (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
organization_id:
"asdb9301hdna0"
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
422
Success Response Status
CourierPartnerSchemeList
items
array of object (CourierPartnerSchemeModelSchema)
List of courier partner schemes
Array of CourierPartnerSchemeModelSchema
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
organization_id:
"asdb9301hdna0"
scheme_type:
"global"
payment_mode:
"COD"
capabilities:
scheme_ids:
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique identifier for the scheme, used to fetch or modify scheme details.
Request body
name
string
Required
Name of the scheme.
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (CourierPartnerSchemeFeatures)
Required
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.
Response
200
400
Success Response Status
CourierPartnerPutSchema
extension_id
string
Unique identifier of courier partner extension.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
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
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (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
organization_id:
"64aec5a93a079bd328537835"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
body:
body
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique identifier for the scheme, used to fetch or modify scheme details.
Response
200
404
Success Response Status
CourierPartnerSchemeModelSchema
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
company_id
string
Unique identifier of company.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
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 (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
organization_id:
"64aec5a93a079bd328537835"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
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 for the scheme, used to fetch or modify scheme details.
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
A string indicating the postal code or PIN code of the address area.
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.
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.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
prepaid_limit
number
Limit on the amount of prepaid payments allowed in the specified region.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
Response
200
400
422
Response status code
RegionServiceabilityResult
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
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
A string indicating the postal code or PIN code of the address area.
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.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
prepaid_limit
number
Limit on the amount of prepaid 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.
reverse_pickup
boolean
Nullable
Indicates if reverse pickup is available.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"10"
scheme_id:
"10"
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 for the scheme, used to fetch or modify scheme details.
page_no
integer
| value >= 1
The current page number for paginated results.
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
Response status code
RegionServiceabilityItemResult
items
array of object (RegionServiceabilityResult)
An array that contains items of region serviceability.
Array of RegionServiceabilityResult
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
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
A string indicating the postal code or PIN code of the address area.
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.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
prepaid_limit
number
Limit on the amount of prepaid 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.
reverse_pickup
boolean
Nullable
Indicates if reverse pickup is available.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
A string serving as the unique identifier.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"10"
scheme_id:
"10"
country_code:
"IN"
state_code:
"MH"
city_code:
"MUM"
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 for the scheme, used to fetch or modify scheme details.
id
string
Required
Unique identifier of a serviceability record
Response
200
400
Success response
RegionServiceabilityResult
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
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
A string indicating the postal code or PIN code of the address area.
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.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
prepaid_limit
number
Limit on the amount of prepaid 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.
reverse_pickup
boolean
Nullable
Indicates if reverse pickup is available.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"10"
scheme_id:
"10"
id:
"66c853ba6a4bd975a29334fc"
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 for the scheme, used to fetch or modify scheme details.
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.
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.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
Response
200
400
422
Response status code
ServiceabilityDetailsResult
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
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
A string indicating the postal code or PIN code of the address area.
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.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
prepaid_limit
number
Limit on the amount of prepaid 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.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
reverse_pickup
boolean
Nullable
Boolean value indicating whether reverse pickup services is available.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"10"
scheme_id:
"10"
id:
"66c853ba6a4bd975a29334fc"
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 for the scheme, used to fetch or modify scheme details.
id
string
Required
Unique identifier of a serviceability record
Response
200
400
Success response
RegionServiceabilityResult
pickup_cutoff
string
Nullable
Time of day by which pickups must be scheduled to be processed on the same day.
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
A string indicating the postal code or PIN code of the address area.
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.
cod_limit
number
Limit on the amount of cash on delivery (COD) payments allowed in the specified region.
prepaid_limit
number
Limit on the amount of prepaid 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.
reverse_pickup
boolean
Nullable
Indicates if reverse pickup is available.
forward_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the forward journey.
reverse_pickup_cutoff
string
Time of day by which pickups must be scheduled to be processed on the same day in the reverse journey.
hand_to_hand_exchange
boolean
Indicates whether the product exchange happens directly between the buyer and seller (e.g., in person), instead of through a third-party service.
holiday_list
array of string
List of holidays for a courier partner scheme.
installation
boolean
Boolean value indicating whether installation services are available in the specified region or not.
id
string
A string serving as the unique identifier.
Examples
Parameters
partner_org_id:
"org_id"
courier_partner_extension_id:
"10"
scheme_id:
"10"
id:
"66c853ba6a4bd975a29334fc"
Was this section helpful?
DEL
Response