Serviceability
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
Handle large-scale operations related to locality data. It retrieve bulk locality data history, import bulk locality data, export bulk locality data, and download locality data templates to facilitate efficient management of location-related information.
Operations
GET
# Get all countries and associated data
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
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
company_id:
123
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
# Create courier account
GET
# List courier accounts
PUT
# Update courier account
GET
# Get courier account
PUT
# Update delivery configuration
GET
# Get delivery configuration
POST
# Locality TAT import or export
GET
# Locality TAT change history
POST
# Bulk update serviceability of localities
GET
# Bulk update history
GET
# Fetching of Package Material Rules from database.
GET
# Get self-ship details
PATCH
# Update self-ship details
Parameters
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
company_id:
123
body:
body
Was this section helpful?
POST
Response
Parameters
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 case sensitive partial 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
company_id:
123
page_no:
1
page_size:
10
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
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
company_id:
123
account_id:
"23"
body:
body
Was this section helpful?
PUT
Response
Parameters
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
company_id:
123
account_id:
"23"
Was this section helpful?
GET
Response
Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
sort
array of string
An array of strings specifying sorting preferences.
Enum
Response
200
400
Response status_code
CompanyConfig
company_id
integer
The unique identifier of the company.
sort
array of string
Array defining the sorting order.
Enum
logistics_as_actual
string
Defines the logistics control type.
Enum
Examples
Parameters
company_id:
123
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Response
200
400
Response status_code
CompanyConfig
company_id
integer
The unique identifier of the company.
sort
array of string
Array defining the sorting order.
Enum
logistics_as_actual
string
Defines the logistics control type.
Enum
Examples
Parameters
company_id:
123
Was this section helpful?
GET
Response
Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
Export locality wise CSV files.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier 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.
modified_on
string
| date-time
The timestamp when the record last modified.
created_on
string
| date-time
The timestamp when the record was created.
Examples
Parameters
company_id:
1
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
body:
body
Was this section helpful?
POST
Response
Retrieves the history of changes made to TAT(Turn Around Time) for scheme.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier 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
Nullable
Status of the bulk actions
Enum
country
string
Country for which bulk job is initiated
region
string
Region for which bulk job is initiated
start_date
string
| date-time
Fetch job history after a particule date
end_date
string
| date-time
Fetch job history before a particule date
Response
200
Success
BulkRegionResult
items
array of object (BulkRegionResultItemData)
Array of 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.
modified_on
string
| date-time
The timestamp when the record last modified.
created_on
string
| date-time
The timestamp when the record was created.
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
company_id:
1
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
page_no:
1
page_size:
1
batch_id:
"000000000000000000000001"
action:
"import"
status:
"true"
country:
"INDIA"
region:
"MAHARASTRA"
start_date:
"2023-09-12T00:00:00.000000"
end_date:
"2023-09-12T23:59:59.999999"
Was this section helpful?
GET
Response
Bulk operations involve either new serviceability settings or updating existing ones in large quantities.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier 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.
modified_on
string
| date-time
The timestamp when the record last modified.
created_on
string
| date-time
The timestamp when the record was created.
Examples
Parameters
company_id:
1
extension_id:
"651ffabb556007fa462c9c06"
scheme_id:
"651ffcb8400bbc458aa4ac7d"
body:
body
Was this section helpful?
POST
Response
Retrieves the history of changes made to serviceability settings for a scheme.
Parameters
company_id
integer
Required
Unique identifier of the company.
extension_id
string
Required
Unique Identifier of courier partner extension.
scheme_id
string
Required
Unique identifier 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
Nullable
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.
modified_on
string
| date-time
The timestamp when the record last modified.
created_on
string
| date-time
The timestamp when the record was created.
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
company_id:
1
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
This API returns response of Package Materials Rules.
Parameters
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
is_installed
string
Filter to get installed extensions only
Enum
Response
200
Response status_code
InstallCourierPartnerResponseSchema
items
array of object (InstallCourierPartnerItemsSchema)
A list of items detailing the courier partner installation details, each item follows the structure defined in `InstallCourierPartnerItemsSchema`.
Array of InstallCourierPartnerItemsSchema
description
string
A brief description of the courier partner or its services.
extention_type
string
The type of the courier partner extension, which is not constrained to predefined values.
is_hidden
boolean
Indicates if the courier partner is hidden from the available list, typically used for internal testing or staging.
is_installed
boolean
A flag indicating whether the courier partner has been successfully installed and is active.
launch_type
string
The type of launch for the courier partner, not constrained to predefined values.
logo
object
An object representing the logo of the courier partner, potentially including different sizes or formats.
modified_at
string
| date-time
The timestamp when the courier partner installation record was last modified.
name
string
The name of the courier partner.
organization_id
string
The unique identifier of the organization associated with the courier partner.
_id
string
The unique identifier of the courier partner installation record.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
123
page_no:
1
page_size:
10
is_installed:
"true"
Was this section helpful?
GET
Response
Get the self-ship details such as TAT, activation status, and unit for a specified company.
Parameters
company_id
integer
Required
Unique identifier of the company
Response
200
400
Successfully updated self-ship details
SelfshipSchema
tat
integer
Turn around time in the specified unit, used to define the delivery time commitment.
is_active
boolean
Indicates whether the self-ship feature is active for the company.
unit
string
Specifies the unit of time for turn around time, such as hours or days.
Enum
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Updates the self-ship details such as TAT, activation status, and unit for a specified company.
Parameters
company_id
integer
Required
Unique identifier of the company
Request body
tat
integer
Required
Turn around time in the specified unit, used to define the delivery time commitment.
is_active
boolean
Required
Indicates whether the self-ship feature is active for the company.
unit
string
Required
Specifies the unit of time for turn around time, such as hours or days.
Enum
Response
200
400
Successfully updated self-ship details
SelfshipSchema
tat
integer
Turn around time in the specified unit, used to define the delivery time commitment.
is_active
boolean
Indicates whether the self-ship feature is active for the company.
unit
string
Specifies the unit of time for turn around time, such as hours or days.
Enum
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PATCH
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
POST
# Sample File Download
GET
# Get Serviceability TAT sample files generator status
Parameters
company_id
integer
Required
The unique identifier of the company.
Request body
extension_id
string
Required
Unique identifier of courier partner extension.
scheme_id
string
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
company_id:
1
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
The unique identifier of the company.
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
company_id:
1
scheme_type:
"global"
payment_mode:
"COD"
capabilities:
scheme_ids:
Was this section helpful?
GET
Response
Parameters
scheme_id
string
Required
Unique identifier for the scheme, used to fetch or modify scheme details.
company_id
integer
Required
The unique identifier of the company.
Request body
name
string
Required
The name of the courier partner 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
The type of transport used in the courier service.
Enum
region
string
Required
The region for the service intra-city, inter-city, or inter-country.
Enum
delivery_type
string
Required
The type of delivery hyperlocal, same-day, one-day, two-day, etc.
Enum
payment_mode
array of string
Required
The accepted payment modes for the service Cash on Delivery (COD) or Prepaid.
Enum
stage
string
Required
The current status of the scheme either enabled or disabled.
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
scheme_id:
"651ffcb8400bbc458aa4ac7d"
company_id:
1
body:
body
Was this section helpful?
PUT
Response
Parameters
scheme_id
string
Required
Unique identifier for the scheme, used to fetch or modify scheme details.
company_id
integer
Required
The unique identifier of the company.
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
scheme_id:
"651ffcb8400bbc458aa4ac7d"
company_id:
1
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
The unique identifier of the company.
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 Response Status
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
company_id:
1
body:
body
Was this section helpful?
POST
Response
Get Serviceability TAT sample file generator status
Parameters
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
company_id
integer
Required
The unique identifier of the company.
Response
200
400
Response status_code
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
page_no:
1
page_size:
1
batch_id:
"000000000000000000000001"
company_id:
1
Was this section helpful?
GET
Response
Packaging material refers to the materials used to wrap and protect products during shipping or storage. Shipments are collections of products being transported together. The Custom packaging resource enables sellers to create rules based on brand, category, or department, which can be applied to this shipments. These rules are then linked to specific packaging materials, detailing weight and quantity capacities. Sellers can thus efficiently combine or split shipments, optimizing delivery partner costs and enhancing logistics flexibility.
Operations
POST
# Create packaging material
GET
# Get packaging materials
POST
# Create packaging rule
GET
# Get packaging material rule
PATCH
# Update packaging rule
PATCH
# Update packaging material
GET
# Get packaging material
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
page_no
integer
The current page number for paginated results.
Request body
name
string
Required
Name of the packaging material.
width
number
Required
Width of the packaging material dimensions in centimeter.
height
number
Required
Height of the packaging material dimensions in centimeter.
length
number
Required
Length of the packaging material dimensions in centimeter.
rules
array of object (PackageMaterialRule)
Product group rules associated with the packaging.
Array of PackageMaterialRule
rule_id
string
Unique identifier of the package rule.
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
Minimum product's quantity that a packaging can contain.
max
integer
Maximum product's quantity that a packaging can contain.
weight
integer
Volumetric weight in gram.
store_ids
array of integer
Required
Stores where the packaging is avaiable.
Minimum Items : 1
weight
number
Required
Package's weight in gram.
error_rate
number
Required
Error Rate associated with the packaging dimensions.
package_type
string
Required
Type of package material.
Enum
size
string
Required
Physical size of the packaging.
Enum
media
array of string
Image urls associated with the packaging material.
channels
array of object (Channel)
Required
Sales channel where packaging is applicable.
Array of Channel
type
string
Type of the channel.
Enum
id
string
Unique identifier of the channel.
track_inventory
boolean
Denotes if the track of the inventory should be kept.
status
string
Required
Current status of the packaging material, if it is active or inactive.
Enum
max_weight
number
Maximum weight(grams) holding capacity.
package_vol_weight
number
Volumetric weight(grams) that a packaging material can carry.
auto_calculate
boolean
Denotes whether the volumetric weight(grams) should be auto calculated or not.
Response
201
400
Response status_code
PackageMaterialResult
company_id
integer
The unique identifier for the company.
name
string
The name of the package material.
id
string
Unique identifier for the package material.
item_id
integer
Unique identifier for the item.
width
number
The width of the package material.
height
number
The height of the package material.
length
number
The length of the package material.
rules
array of object (PackageMaterialRule)
List of rules associated with the package material.
Array of PackageMaterialRule
rule_id
string
Unique identifier of the package rule.
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
Minimum product's quantity that a packaging can contain.
max
integer
Maximum product's quantity that a packaging can contain.
weight
integer
Volumetric weight in gram.
store_ids
array of integer
List of store IDs where the package material is available.
Minimum Items : 1
weight
number
The weight(grams) of the package material.
error_rate
number
The error rate associated with the package material.
package_type
string
The type of the package material.
Enum
size
string
Size of the package material.
media
array of string
List of media associated with the package material.
channels
array of object (Channel)
List of channels for the package material.
Array of Channel
type
string
Type of the channel.
Enum
id
string
Unique identifier of the channel.
track_inventory
boolean
Whether inventory tracking is enabled for the package material.
is_active
boolean
Indicates whether the package material is active.
status
string
The current status of the package material.
Enum
max_weight
number
Maximum weight(grams) the package material can handle.
package_vol_weight
number
Volumetric weight(grams) of the package material.
auto_calculate
boolean
Whether the weight(grams) of the package material is auto-calculated.
Examples
Parameters
company_id:
1
page_no:
1
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_no
integer
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
q
string
Used to search for matching results based on the provided input.
size
string
Filters items based on given size
package_type
string
Filters items based on given package_type
Enum
Response
200
400
Response status_code
PackagesListResult
items
array of object (PackageItem)
Contains the list of package items with pagination details.
Array of PackageItem
name
string
The name of the package item.
weight
number
The weight(grams) of the package item.
track_inventory
boolean
Indicates if the inventory is tracked for this package item.
length
number
The length of the package item.
channels
array of object (PackageChannel)
A list of channels associated with the package item.
Array of PackageChannel
store_filter
object (StoreFilter)
StoreFilter
type
string
Specifies whether the store filter includes or excludes certain stores.
Enum
ids
array of integer
A list of store IDs to filter.
app_id
string
The application ID associated with the package channel.
package_type
string
Type of package material.
Enum
rules
array of object (PackageRuleSchema)
A list of rules associated with the package item.
Array of PackageRuleSchema
quantity
object (Quantity)
Quantity
min
integer
Minimum quantity of products allowed for this rule.
max
integer
Maximum quantity of products allowed for this rule.
rule_id
string
The unique identifier for the package rule.
weight
number
The weight(grams) associated with the package rule.
height
number
The height of the package item.
error_rate
number
The error rate associated with the package item.
width
number
The width of the package item.
is_active
boolean
Indicates if the package item is active.
size
string
The size of the package item.
company_id
integer
The company ID associated with the package item.
item_id
integer
The unique identifier for the package item.
max_weight
number
The maximum weight(grams) of the package item.
media
array of object
Additional media associated with the package item.
package_vol_weight
number
The volumetric weight(grams) of the package item.
status
string
The status of the package item.
Enum
auto_calculate
boolean
Indicates if the package item is auto-calculated.
id
string
The unique identifier for the package item.
page
object (PackagePageInfo)
PackagePageInfo
type
string
The type of pagination (e.g., page-based).
size
integer
The number of items per page.
current
integer
The current page number.
has_next
boolean
Indicates if there is a next page of results.
has_previous
boolean
Indicates if there is a previous page of results.
item_total
integer
The total number of items available.
Examples
Parameters
company_id:
101
page_no:
1
page_size:
101
q:
"ship"
size:
"M"
package_type:
"Box"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
Request body
name
string
Required
The name of the packaging rule.
company_id
integer
Required
The unique identifier for the company.
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
An array of unique identifier integer ids of the category.
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
An array of product integer IDs included in the package rule.
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
An array of product tag IDs included in the package rule.
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
An array of department IDs included in the package rule.
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
An array of attributes included in the package rule.
type
string
Required
Type of the packaging rule.
is_active
boolean
Indicates if the packaging rule is active.
Response
201
400
Response status_code
PackageRuleResult
id
string
Unique id of a package rule.
name
string
Name of a package rule.
company_id
integer
Unique identifier of a company associated with the package rule.
type
string
Type of the rule created.
is_active
boolean
Denotes if the rule is active or inactive.
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
An array of product tag IDs included in the package rule.
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
An array of product integer IDs included in the package rule.
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
An array of department IDs included in the package rule.
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
An array of attributes included in the package rule.
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
An array of unique identifier integer ids of the category.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Response
200
404
Response status_code
PackageRuleResult
id
string
Unique id of a package rule.
name
string
Name of a package rule.
company_id
integer
Unique identifier of a company associated with the package rule.
type
string
Type of the rule created.
is_active
boolean
Denotes if the rule is active or inactive.
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
An array of product tag IDs included in the package rule.
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
An array of product integer IDs included in the package rule.
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
An array of department IDs included in the package rule.
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
An array of attributes included in the package rule.
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
An array of unique identifier integer ids of the category.
Examples
Parameters
company_id:
100
rule_id:
"64b4337a0c607fbfbcd0156b"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Request body
name
string
Required
The name of the packaging rule.
company_id
integer
Required
The unique identifier for the company.
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
An array of unique identifier integer ids of the category.
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
An array of product integer IDs included in the package rule.
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
An array of product tag IDs included in the package rule.
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
An array of department IDs included in the package rule.
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
An array of attributes included in the package rule.
type
string
Required
Type of the packaging rule.
is_active
boolean
Indicates if the packaging rule is active.
Response
200
400
Response status_code
PackageRuleResult
id
string
Unique id of a package rule.
name
string
Name of a package rule.
company_id
integer
Unique identifier of a company associated with the package rule.
type
string
Type of the rule created.
is_active
boolean
Denotes if the rule is active or inactive.
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
An array of product tag IDs included in the package rule.
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
An array of product integer IDs included in the package rule.
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
An array of department IDs included in the package rule.
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
An array of attributes included in the package rule.
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
An array of unique identifier integer ids of the category.
Examples
Parameters
company_id:
100
rule_id:
"64b4337a0c607fbfbcd0156b"
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
package_material_id
string
Required
A `package_material_id` is a unique identifier for a Package Material
Request body
name
string
Required
Name of the packaging material.
width
number
Required
Width of the packaging material dimensions in centimeter.
height
number
Required
Height of the packaging material dimensions in centimeter.
length
number
Required
Length of the packaging material dimensions in centimeter.
rules
array of object (PackageMaterialRule)
Product group rules associated with the packaging.
Array of PackageMaterialRule
rule_id
string
Unique identifier of the package rule.
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
Minimum product's quantity that a packaging can contain.
max
integer
Maximum product's quantity that a packaging can contain.
weight
integer
Volumetric weight in gram.
store_ids
array of integer
Required
Stores where the packaging is avaiable.
Minimum Items : 1
weight
number
Required
Package's weight in gram.
error_rate
number
Required
Error Rate associated with the packaging dimensions.
package_type
string
Required
Type of package material.
Enum
size
string
Required
Physical size of the packaging.
Enum
media
array of string
Image urls associated with the packaging material.
channels
array of object (Channel)
Required
Sales channel where packaging is applicable.
Array of Channel
type
string
Type of the channel.
Enum
id
string
Unique identifier of the channel.
track_inventory
boolean
Denotes if the track of the inventory should be kept.
status
string
Required
Current status of the packaging material, if it is active or inactive.
Enum
max_weight
number
Maximum weight(grams) holding capacity.
package_vol_weight
number
Volumetric weight(grams) that a packaging material can carry.
auto_calculate
boolean
Denotes whether the volumetric weight(grams) should be auto calculated or not.
Response
200
400
Response status_code
PackageMaterialResult
company_id
integer
The unique identifier for the company.
name
string
The name of the package material.
id
string
Unique identifier for the package material.
item_id
integer
Unique identifier for the item.
width
number
The width of the package material.
height
number
The height of the package material.
length
number
The length of the package material.
rules
array of object (PackageMaterialRule)
List of rules associated with the package material.
Array of PackageMaterialRule
rule_id
string
Unique identifier of the package rule.
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
Minimum product's quantity that a packaging can contain.
max
integer
Maximum product's quantity that a packaging can contain.
weight
integer
Volumetric weight in gram.
store_ids
array of integer
List of store IDs where the package material is available.
Minimum Items : 1
weight
number
The weight(grams) of the package material.
error_rate
number
The error rate associated with the package material.
package_type
string
The type of the package material.
Enum
size
string
Size of the package material.
media
array of string
List of media associated with the package material.
channels
array of object (Channel)
List of channels for the package material.
Array of Channel
type
string
Type of the channel.
Enum
id
string
Unique identifier of the channel.
track_inventory
boolean
Whether inventory tracking is enabled for the package material.
is_active
boolean
Indicates whether the package material is active.
status
string
The current status of the package material.
Enum
max_weight
number
Maximum weight(grams) the package material can handle.
package_vol_weight
number
Volumetric weight(grams) of the package material.
auto_calculate
boolean
Whether the weight(grams) of the package material is auto-calculated.
Examples
Parameters
company_id:
100
package_material_id:
"656630b9cc661113138d995b"
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
package_material_id
string
Required
A `package_material_id` is a unique identifier for a Package Material
Response
200
404
Response status_code
PackageItem
name
string
The name of the package item.
weight
number
The weight(grams) of the package item.
track_inventory
boolean
Indicates if the inventory is tracked for this package item.
length
number
The length of the package item.
channels
array of object (PackageChannel)
A list of channels associated with the package item.
Array of PackageChannel
store_filter
object (StoreFilter)
StoreFilter
type
string
Specifies whether the store filter includes or excludes certain stores.
Enum
ids
array of integer
A list of store IDs to filter.
app_id
string
The application ID associated with the package channel.
package_type
string
Type of package material.
Enum
rules
array of object (PackageRuleSchema)
A list of rules associated with the package item.
Array of PackageRuleSchema
quantity
object (Quantity)
Quantity
min
integer
Minimum quantity of products allowed for this rule.
max
integer
Maximum quantity of products allowed for this rule.
rule_id
string
The unique identifier for the package rule.
weight
number
The weight(grams) associated with the package rule.
height
number
The height of the package item.
error_rate
number
The error rate associated with the package item.
width
number
The width of the package item.
is_active
boolean
Indicates if the package item is active.
size
string
The size of the package item.
company_id
integer
The company ID associated with the package item.
item_id
integer
The unique identifier for the package item.
max_weight
number
The maximum weight(grams) of the package item.
media
array of object
Additional media associated with the package item.
package_vol_weight
number
The volumetric weight(grams) of the package item.
status
string
The status of the package item.
Enum
auto_calculate
boolean
Indicates if the package item is auto-calculated.
id
string
The unique identifier for the package item.
Examples
Parameters
company_id:
100
package_material_id:
"656630b9cc661113138d994b"
Was this section helpful?
GET
Response