Logistics
Serviceability API's
Operations
GET
# Get all countries and associated data.
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.
Response
200
400
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (CountryObject)
Array of CountryObject
id
string
name
string
display_name
string
iso2
string
iso3
string
timezones
array of string
Nullable
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
display_name
string
slug
string
phone_code
string
latitude
string
longitude
string
currency
object (CurrencyObject)
CurrencyObject
code
string
name
string
symbol
string
type
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
organization_id:
"org_id"
onboard:
true
page_no:
1
page_size:
6
q:
"I"
hierarchy:
"pincode"
Was this section helpful?
GET
Response
Operations
POST
# Sample File Download
GET
# Get Serviceability TAT sample files generator status
POST
# Region TAT Import or Export
GET
# Get region tat bulk history
POST
# Serviceability Import or Export
GET
# Get Region Serviceability Bulk History
POST
# Creation of Courier Account
GET
# Getting Courier Account list of a company.
PUT
# Update Courier Account in database.
GET
# Getting Courier Account of a company from database.
POST
# Create Scheme for courier partner extension
PUT
# Update Scheme for courier partner extension
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
country
string
Required
region
string
Required
type
string
Required
Enum
Response
200
400
Success Response Status
BulkRegionServiceabilityTatResponseItemData
country
string
region
string
type
string
Enum
batch_id
string
status
string
failed_records
array of object
file_path
string
Nullable
Examples
Parameters
organization_id:
"org_id"
body:
body
Was this section helpful?
POST
Response
Get Serviceability TAT sample file generator status
Parameters
organization_id
string
Required
Unique Identifier of Organization
page_no
integer
| value >= 1
index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
determines the items to be displayed in a page
Default Value : 12
batch_id
string
Batch id of the execution
Response
200
Response status_code
BulkRegionServiceabilityTatResponseSchema
items
array of object (BulkRegionServiceabilityTatResponseItemData)
Array of BulkRegionServiceabilityTatResponseItemData
country
string
region
string
type
string
Enum
batch_id
string
status
string
failed_records
array of object
file_path
string
Nullable
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
organization_id:
"org_id"
page_no:
1
page_size:
10
batch_id:
"65e473b53ce34d5fd619c07c"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
file_path
string
country
string
Required
action
string
Required
Enum
region
string
Required
Response
200
400
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
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 CP Extension
scheme_id
string
Required
Unique identifier of a scheme
page_no
integer
| value >= 1
index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
determines the items to be displayed in a page
Default Value : 12
batch_id
string
Unique identifier of bulk job
action
string
import or export bulk type
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
Fetch job history after a particule date
end_date
string
| date
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponseSchema
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
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-08-03T00:00:00.000Z"
end_date:
"2023-08-03T00:00:00.000Z"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
file_path
string
country
string
Required
action
string
Required
Enum
region
string
Required
Response
200
400
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
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 CP Extension
scheme_id
string
Required
Unique identifier of a scheme
page_no
integer
| value >= 1
index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
determines the items to be displayed in a page
Default Value : 12
batch_id
string
Unique identifier of bulk job
action
string
import or export bulk type
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
Fetch job history after a particule date
end_date
string
| date
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponseSchema
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
organization_id:
"org_id"
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
page_no:
1
page_size:
10
batch_id:
"65e4767837d1b6a7040a469c"
action:
"import"
status:
"processing"
country:
"India"
region:
"Pincode"
start_date:
"2023-08-03T00:00:00.000Z"
end_date:
"2023-08-03T00:00:00.000Z"
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
account_id
string
Required
scheme_id
string
Required
is_self_ship
boolean
Required
stage
string
Required
Enum
is_own_account
boolean
Required
Response
200
400
Response status_code
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
Examples
Parameters
organization_id:
"org_id"
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
index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
determines the items to be displayed in a page
Default Value : 10
stage
string
stage of the account. enabled/disabled
payment_mode
string
Filters dp accounts based on payment mode
transport_type
string
Filters dp accounts based on transport_type
account_ids
array of string
Filters dp accounts based on their ids
Response
200
Response status_code
CompanyCourierPartnerAccountListResponseSchema
items
array of object (CourierAccountResponseSchema)
Array of CourierAccountResponseSchema
company_id
integer
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierAccountSchemeResponseSchema)
CourierAccountSchemeResponseSchema
extension_id
string
scheme_id
string
name
string
weight
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
organization_id:
"org_id"
company_id:
123
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
account_id
string
Required
scheme_id
string
Required
is_self_ship
boolean
Required
stage
string
Required
Enum
is_own_account
boolean
Required
Response
200
400
Response status_code
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
Examples
Parameters
organization_id:
"org_id"
company_id:
123
account_id:
"23"
body:
body
Was this section helpful?
PUT
Response
This API returns response DpAccount of a company from mongo database.
Parameters
organization_id
string
Required
Unique Identifier of Organization
company_id
integer
Required
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
CourierAccountResponseSchema
company_id
integer
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierAccountSchemeResponseSchema)
CourierAccountSchemeResponseSchema
extension_id
string
scheme_id
string
name
string
weight
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Examples
Parameters
organization_id:
"org_id"
company_id:
123
account_id:
"23"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
extension_id
string
Required
scheme_id
string
Required
name
string
Required
weight
object (ArithmeticOperationsV2)
Required
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Required
Enum
region
string
Required
Enum
delivery_type
string
Required
Enum
payment_mode
array of string
Required
Enum
stage
string
Required
Enum
feature
object (CourierPartnerSchemeFeatures)
Required
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Response
200
400
Success Response Status
CourierPartnerSchemeModel
extension_id
string
scheme_id
string
name
string
weight
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Examples
Parameters
organization_id:
"org_id"
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique Identifier of Scheme
Request body
name
string
Required
weight
object (ArithmeticOperationsV2)
Required
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Required
Enum
region
string
Required
Enum
delivery_type
string
Required
Enum
payment_mode
array of string
Required
Enum
stage
string
Required
Enum
feature
object (CourierPartnerSchemeFeatures)
Required
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Response
200
400
Success Response Status
CourierPartnerSchemeUpdateRequestSchema
name
string
weight
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Examples
Parameters
organization_id:
"org_id"
scheme_id:
"scheme_idpartner1"
body:
body
Was this section helpful?
PUT
Response