Partner API
Introduction
Client Libraries
Authentication
POSTThis operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob
POSTThis will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process
POSTSample File Download
GETGet Serviceability TAT sample files generator status
POSTRegion TAT Import or Export
GETGet region tat bulk history
POSTServiceability Import or Export
GETGet Region Serviceability Bulk History
POSTCreation of Courier Account
GETGetting Courier Account list of a company
PUTUpdate Courier Account in database
GETGetting Courier Account of a company from database
POSTCreate Scheme for courier partner extension
PUTUpdate Scheme for courier partner extension
GETGet all countries and associated data
POSTCreate a new theme
POSTDraft extension section
POSTPublish an extension section
POSTStart a Preview of Extension Section
DELClose a Preview of Extension Section
GETGet all pages
POSTCreate page
PUTUpdate multiple pages
GETGet page
PUTUpdate page
DELDelete page
GETGet application themes
GETGet theme by ID
PUTUpdate theme
DELDelete theme
GETGet organization themes
GETGet organization theme details
PATCHUpdate draft theme
PUTSubmit organization theme
DELDelete organization theme
GETGet latest version of theme by slug
POSTCreate new theme in organization
GETGet theme rejection reasons
GETGet theme versions

Logistics

Serviceability API's

Default

Default

Operations
POST
/service/partner/logistics/v1.0/organization/{organization_id}/localities/bulk-sample
# Sample File Download
GET
/service/partner/logistics/v1.0/organization/{organization_id}/localities/bulk-sample
# Get Serviceability TAT sample files generator status
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Region TAT Import or Export
GET
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Get region tat bulk history
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Serviceability Import or Export
GET
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Get Region Serviceability Bulk History
POST
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account
# Creation of Courier Account
GET
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account
# Getting Courier Account list of a company
PUT
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account/{account_id}
# Update Courier Account in database
GET
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account/{account_id}
# Getting Courier Account of a company from database
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme/
# Create Scheme for courier partner extension
PUT
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme/{scheme_id}
# Update Scheme for courier partner extension
GET
/service/partner/logistics/v2.0/organization/{organization_id}/countries
# Get all countries and associated data
POST

Sample File Download

Sample File Download
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
Examples
Parameters
organizationId:
"value"
body:
body
POST
/service/partner/logistics/v1.0/organization/{organization_id}/localities/bulk-sample
Loading...
Response
Loading...
GET

Get Serviceability TAT sample files generator status

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
BulkRegionServiceabilityTatResponse
items
array of object (BulkRegionServiceabilityTatResponseItemData)
Array of BulkRegionServiceabilityTatResponseItemData
page
object (Page)
Page
Examples
Parameters
organizationId:
"value"
pageNo:
1
pageSize:
1
batchId:
"value"
GET
/service/partner/logistics/v1.0/organization/{organization_id}/localities/bulk-sample
Loading...
Response
Loading...
POST

Region TAT Import or Export

Region TAT Import or Export
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
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
organizationId:
"value"
extensionId:
"value"
schemeId:
"value"
body:
body
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
GET

Get region tat bulk history

Get region tat bulk history
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
Fetch job history after a particule date
end_date
string
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponse
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
page
object (Page)
Page
Examples
Parameters
organizationId:
"value"
extensionId:
"value"
schemeId:
"value"
pageNo:
1
pageSize:
1
batchId:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
startDate:
"value"
endDate:
"value"
GET
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
POST

Serviceability Import or Export

Serviceability Import or Export
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
organizationId:
"value"
extensionId:
"value"
schemeId:
"value"
body:
body
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...
GET

Get Region Serviceability Bulk History

Get Region Serviceability Bulk History
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
Fetch job history after a particule date
end_date
string
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponse
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
page
object (Page)
Page
Examples
Parameters
organizationId:
"value"
extensionId:
"value"
schemeId:
"value"
pageNo:
1
pageSize:
1
batchId:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
startDate:
"value"
endDate:
"value"
GET
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...
POST

Creation of Courier Account

This API Creates a new Courier Account
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
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
organizationId:
"value"
companyId:
1
body:
body
POST
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
GET

Getting Courier Account list of a company

This API returns Courier Account of a company.
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
Response
200
400
Response status_code
CompanyCourierPartnerAccountListResponse
items
array of object (CourierAccountResponse)
Array of CourierAccountResponse
page
object (Page)
Page
Examples
Parameters
organizationId:
"value"
companyId:
1
pageNo:
1
pageSize:
1
stage:
"value"
paymentMode:
"value"
transportType:
"value"
GET
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
PUT

Update Courier Account in database

Updates Courier Account
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
CourierAccountResponse
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
Examples
Parameters
organizationId:
"value"
companyId:
1
accountId:
"value"
body:
body
PUT
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
GET

Getting Courier Account of a company from database

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
CourierAccountResponse
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
Examples
Parameters
organizationId:
"value"
companyId:
1
accountId:
"value"
GET
/service/partner/logistics/v1.0/organization/{organization_id}/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
POST

Create Scheme for courier partner extension

Create Scheme for courier partner extension
Parameters
organization_id
string
Required
Unique Identifier of Organization
Request body
extension_id
string
Required
scheme_id
string
name
string
Required
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
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
Response
200
400
Success Response Status
CourierPartnerSchemeModel
extension_id
string
scheme_id
string
name
string
weight
object (ArithmeticOperations)
ArithmeticOperations
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
Examples
Parameters
organizationId:
"value"
body:
body
POST
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme/
Loading...
Response
Loading...
PUT

Update Scheme for courier partner extension

Update Scheme for courier partner extension
Parameters
organization_id
string
Required
Unique Identifier of Organization
scheme_id
string
Required
Unique Identifier of Scheme
Request body
name
string
Required
weight
object (ArithmeticOperations)
Required
ArithmeticOperations
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
Response
200
400
Success Response Status
CourierPartnerSchemeUpdateRequest
name
string
weight
object (ArithmeticOperations)
ArithmeticOperations
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
Examples
Parameters
organizationId:
"value"
schemeId:
"value"
body:
body
PUT
/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme/{scheme_id}
Loading...
Response
Loading...
GET

Get all countries and associated data

Retrieve of all countries.
Parameters
organization_id
string
Required
Unique Identifier of Organization
onboarding
boolean
Only fetch countries which allowed for onboard on Platform.
page_no
integer
page number.
Default Value : 1
page_size
integer
| value <= 48
page size.
Default Value : 12
q
string
search.
Response
200
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (GetCountriesItems)
Array of GetCountriesItems
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
GET
/service/partner/logistics/v2.0/organization/{organization_id}/countries
Loading...
Response
Example not available.
Previous
« Introduction
Next
Create a new theme »