Skip to main content

Serviceability

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

Courier Partner Setup & Rules

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

Operations
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# Create courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# List courier accounts
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Update courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Get courier account
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
# Update courier rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
# Get courier rule
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
# Create rourier rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
# Get courier rules
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Update delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Get delivery configuration
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# Update delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# Get delivery configuration
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Locality TAT import or export
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
# Locality TAT change history
PATCH
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship
# Update self ship configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship
# Get self ship configuration
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Bulk update serviceability of localities
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
# Bulk update history
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/region/{region_id}
# Get serviceability of a locality
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/region/{region_id}
# Update Serviceability of a locality
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
# Update courier partner rule priority
POST

Create courier account

Creates a courier partner account.
Parameters
body
object (CourierAccount)
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
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
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
GET

List courier accounts

Retrieves a list of courier partner accounts.
Parameters
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 10
stage
string
Optional
stage of the account. enabled/disabled
paymentMode
string
Optional
Filters dp accounts based on payment mode
transportType
string
Optional
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
pageNo:
0
pageSize:
0
stage:
"value"
paymentMode:
"value"
transportType:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
PUT

Update courier account

Updates an existing courier partner account.
Parameters
accountId
string
Unique ID of courier account
body
object (CourierAccount)
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
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
accountId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
GET

Get courier account

Retrieves a single courier partner account.
Parameters
accountId
string
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
accountId:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
PUT

Update courier rule

Updates an existing rule within the delivery configuration.
Parameters
ruleId
string
A `rule_id` is a unique identifier for a particular Dp.
body
object (CourierPartnerRule)
CourierPartnerRule
is_active
boolean
cp_list
array of object (CourierPartnerList)
Optional
Array of CourierPartnerList
name
string
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
sort
array of string
Enum
Response
200
400
Response status_code
CourierPartnerRule
is_active
boolean
cp_list
array of object (CourierPartnerList)
Optional
Array of CourierPartnerList
name
string
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
sort
array of string
Enum
Examples
Parameters
ruleId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
Loading...
Response
Loading...
GET

Get courier rule

Retrieves a single rule within the delivery configuration.
Parameters
ruleId
string
A `rule_id` is a unique identifier for a rule.
Response
200
400
Response status_code
CourierPartnerRule
is_active
boolean
cp_list
array of object (CourierPartnerList)
Optional
Array of CourierPartnerList
name
string
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
sort
array of string
Enum
Examples
Parameters
ruleId:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
Loading...
Response
Loading...
POST

Create rourier rule

Creates a rule within the delivery configuration.
Parameters
body
object (CourierPartnerRule)
CourierPartnerRule
is_active
boolean
cp_list
array of object (CourierPartnerList)
Optional
Array of CourierPartnerList
name
string
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
sort
array of string
Enum
Response
200
400
Response status_code
CourierPartnerRule
is_active
boolean
cp_list
array of object (CourierPartnerList)
Optional
Array of CourierPartnerList
name
string
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
sort
array of string
Enum
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
Loading...
Response
Loading...
GET

Get courier rules

Retrieve a list of rules within the delivery configuration.
Parameters
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 10
status
string
Optional
Filter rules based on rule status
Enum
Response
200
400
Response status_code
CourierPartnerRulesListResponse
items
array of object (CourierPartnerRule)
Array of CourierPartnerRule
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
status:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
Loading...
Response
Loading...
PUT

Update delivery configuration

Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences.
Parameters
body
object (CompanyConfig)
CompanyConfig
rule_ids
array of string
sort
array of string
Enum
logistics_as_actual
boolean
Optional
Response
200
400
Response status_code
CompanyConfig
rule_ids
array of string
sort
array of string
Enum
logistics_as_actual
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

Retrieves information about the delivery setup for a company
Parameters
No Parameters
Response
200
400
Response status_code
CompanyConfig
rule_ids
array of string
sort
array of string
Enum
logistics_as_actual
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
PUT

Update delivery configuration

Updates an existing delivery setup for an application, which involves updating sorting settings or rule priorities.
Parameters
body
object (ApplicationConfig)
ApplicationConfig
rule_ids
array of string
Optional
sort
array of string
Optional
Enum
zones
object (ZoneConfig)
Optional
ZoneConfig
Response
200
400
Response status_code
ApplicationConfig
rule_ids
array of string
Optional
sort
array of string
Optional
Enum
zones
object (ZoneConfig)
Optional
ZoneConfig
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

Retrieves information about the delivery setup for an application
Parameters
No Parameters
Response
200
400
Response status_code
ApplicationConfig
rule_ids
array of string
Optional
sort
array of string
Optional
Enum
zones
object (ZoneConfig)
Optional
ZoneConfig
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
POST

Locality TAT import or export

Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file. Export locality wise CSV files.
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
body
object (BulkRegionJobSerializer)
BulkRegionJobSerializer
file_path
string
Optional
country
string
action
string
Enum
region
string
Response
200
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
Optional
failed_records
array of object
Optional
action
string
batch_id
string
country
string
success
integer
Optional
region
string
status
string
total
integer
Optional
error_file_path
string
Optional
Examples
Parameters
extensionId:
"value"
schemeId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
GET

Locality TAT change history

Retrieves the history of changes made to TAT(Turn Around Time) for scheme.
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 12
batchId
string
Optional
Unique identifier of bulk job
action
string
Optional
import or export bulk type
status
string
Optional
Status of the bulk actions
country
string
Optional
Country for which bulk job is initiated
region
string
Optional
Region for which bulk job is initiated
startDate
string
Optional
Fetch job history after a particule date
endDate
string
Optional
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
extensionId:
"value"
schemeId:
"value"
pageNo:
0
pageSize:
0
batchId:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
startDate:
"value"
endDate:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat
Loading...
Response
Loading...
PATCH

Update self ship configuration

Updates self ship setup for an existing application
Parameters
body
object (SelfShipResponse)
SelfShipResponse
is_active
boolean
tat
number
Response
200
400
Response Data
ApplicationSelfShipConfigResponse
error
object (ServiceabilityErrorResponse)
Optional
ServiceabilityErrorResponse
data
object (ApplicationSelfShipConfig)
Optional
ApplicationSelfShipConfig
success
boolean
Examples
Parameters
body:
body
Was this section helpful?
PATCH
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship
Loading...
Response
Loading...
GET

Get self ship configuration

Retrieves the self ship setup for a single application
Parameters
No Parameters
Response
200
400
Response Data
ApplicationSelfShipConfigResponse
error
object (ServiceabilityErrorResponse)
Optional
ServiceabilityErrorResponse
data
object (ApplicationSelfShipConfig)
Optional
ApplicationSelfShipConfig
success
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship
Loading...
Response
Loading...
POST

Bulk update serviceability of localities

Bulk operations involve either new serviceability settings or updating existing ones in large quantities.
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
body
object (BulkRegionJobSerializer)
BulkRegionJobSerializer
file_path
string
Optional
country
string
action
string
Enum
region
string
Response
200
400
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
Optional
failed_records
array of object
Optional
action
string
batch_id
string
country
string
success
integer
Optional
region
string
status
string
total
integer
Optional
error_file_path
string
Optional
Examples
Parameters
extensionId:
"value"
schemeId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...
GET

Bulk update history

Retrieves the history of changes made to serviceability settings for a scheme.
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 12
batchId
string
Optional
Unique identifier of bulk job
action
string
Optional
import or export bulk type
status
string
Optional
Status of the bulk actions
country
string
Optional
Country for which bulk job is initiated
region
string
Optional
Region for which bulk job is initiated
startDate
string
Optional
Fetch job history after a particule date
endDate
string
Optional
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
extensionId:
"value"
schemeId:
"value"
pageNo:
0
pageSize:
0
batchId:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
startDate:
"value"
endDate:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk
Loading...
Response
Loading...
GET

Get serviceability of a locality

Rerieves serviceability settings of a single courier scheme for a given locality
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
regionId
string
Unique identifier of a region
Response
200
400
Response status_code
ServiceabilityModel
lm_cod_limit
integer
is_qc
boolean
pickup_cutoff
string
Nullable
route_code
string
Nullable
is_first_mile
boolean
is_return
boolean
is_installation
boolean
is_last_mile
boolean
Examples
Parameters
extensionId:
"value"
schemeId:
"value"
regionId:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/region/{region_id}
Loading...
Response
Loading...
PUT

Update Serviceability of a locality

Updates serviceability settings of a single courier scheme for a given locality
Parameters
extensionId
string
Unique Identifier of CP Extension
schemeId
string
Unique identifier of a scheme
regionId
string
Unique identifier of a region
body
object (ServiceabilityModel)
ServiceabilityModel
lm_cod_limit
integer
is_qc
boolean
pickup_cutoff
string
Nullable
route_code
string
Nullable
is_first_mile
boolean
is_return
boolean
is_installation
boolean
is_last_mile
boolean
Response
200
400
Response status_code
ServiceabilityModel
lm_cod_limit
integer
is_qc
boolean
pickup_cutoff
string
Nullable
route_code
string
Nullable
is_first_mile
boolean
is_return
boolean
is_installation
boolean
is_last_mile
boolean
Examples
Parameters
extensionId:
"value"
schemeId:
"value"
regionId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/region/{region_id}
Loading...
Response
Loading...
PUT

Update courier partner rule priority

Updates a courier partner rule priority for a single application
Parameters
body
object (RulePriorityRequest)
RulePriorityRequest
rule_id
string
priority
integer
Response
200
400
Response status_code
RulePriorityResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
Loading...
Response
Loading...

Delivery Zone

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

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

Get zones

Retrieves a list of delivery zones.
Parameters
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 10
isActive
boolean
Optional
Status of Zone (either active or inactive)
channelId
string
Optional
Zones filtered by an application
q
string
Optional
search with name as a free text
country
string
Optional
ISO2 code of the country
state
string
Optional
State name
city
string
Optional
City name
pincode
string
Optional
Pincode value to search zones
sector
string
Optional
Sector value to search zones
Response
200
400
Zone List of application in descending order of their last modified date.
ListViewResponse
page
object (ZoneDataItem)
ZoneDataItem
items
array of object (ListViewItems)
Array of ListViewItems
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v2.0/company/{company_id}/zones
Loading...
Response
Example response not available.
POST

Create zone

Creates a delivery zone.
Parameters
body
object (CreateZoneData)
CreateZoneData
name
string
slug
string
company_id
integer
is_active
boolean
channels
array of object (GetZoneDataViewChannels)
Array of GetZoneDataViewChannels
store_ids
array of integer
region_type
string
Enum
mapping
array of object (ZoneMappingType)
Array of ZoneMappingType
assignment_preference
string
Optional
Default Value : optimal
Enum
Response
200
400
Response status_code
ZoneResponse
status_code
integer
zone_id
string
success
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v2.0/company/{company_id}/zones
Loading...
Response
Loading...
PUT

Update a zone

Update an existing delivery zone .
Parameters
zoneId
string
A `zone_id` is a unique identifier for a particular zone.
body
object (UpdateZoneData)
UpdateZoneData
zone_id
string
name
string
slug
string
company_id
integer
is_active
boolean
channels
array of object (GetZoneDataViewChannels)
Array of GetZoneDataViewChannels
product
object (ZoneProductTypes)
ZoneProductTypes
store_ids
array of integer
region_type
string
Enum
mapping
array of object (ZoneMappingType)
Array of ZoneMappingType
assignment_preference
string
Optional
Default Value : optimal
Enum
Response
200
400
Response status_code
ZoneSuccessResponse
status_code
integer
success
boolean
Examples
Parameters
zoneId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
Loading...
Response
Loading...
GET

Get zone details

Retrieves a single delivery zone.
Parameters
zoneId
string
A `zone_id` is a unique identifier for a particular zone.
Response
200
400
Get details of the Zone
GetZoneByIdSchema
zone_id
string
name
string
slug
string
company_id
integer
Optional
is_active
boolean
channels
array of object (GetZoneDataViewChannels)
Array of GetZoneDataViewChannels
product
object (ZoneProductTypes)
ZoneProductTypes
store_ids
array of integer
region_type
string
Enum
mapping
array of object (ZoneMappingType)
Array of ZoneMappingType
assignment_preference
string
Optional
Default Value : optimal
Enum
stores_count
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}
Loading...
Response
Example response not available.

Order Routing Rules

Order routing rules determine how orders are directed to fulfillment centers. Order routing rules helps sellers to optimize fullfilment based on parameters like distance, inventory availability and depth, pricing, shipping cost, store processing efficiency, location type, and tag. For instance, a seller offering electronic goods can implement a rule directing heavy products like refrigerator to warehouses for fulfillment, while lighter items are fulfilled by other stores.

Operations
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
# Get store rule configuration
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
# Create store rule configuration
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
# Update store rules configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
# Get store rules
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
# Create store rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
# Get store rule
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
# Update store rule
GET

Get store rule configuration

Retrieves information about the order routing setup for a single application
Parameters
No Parameters
Response
200
400
Successful Response
StoreRuleConfigData
rule_ids
array of string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
Loading...
Response
Loading...
POST

Create store rule configuration

Creates a order routing setup for an application, which involves updating sorting settings or rule priorities.
Parameters
body
object (StoreRuleConfigData)
StoreRuleConfigData
rule_ids
array of string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
Loading...
Response
Loading...
PUT

Update store rules configuration

Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities.
Parameters
body
object (StoreRuleConfigData)
StoreRuleConfigData
rule_ids
array of string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
Loading...
Response
Loading...
GET

Get store rules

Retrieves an existing order routing setup for a single application
Parameters
pageNo
integer
Optional
pageSize
integer
Optional
status
string
Optional
Enum
Response
200
400
Successful Response
GetStoreRulesApiResponse
items
array of object (StoreRuleDataSchema)
Optional
Array of StoreRuleDataSchema
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
pageSize:
0
status:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
Loading...
Response
Loading...
POST

Create store rule

Create a rule within the order routing rules
Parameters
body
object (CreateStoreRuleRequestSchema)
CreateStoreRuleRequestSchema
name
string
Optional
is_active
boolean
Optional
conditions
object (StoreRuleConditionSchema)
Optional
StoreRuleConditionSchema
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Response
200
400
Response status_code
StoreRuleResponseSchema
id
string
Optional
name
string
Optional
type
string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
conditions
object (StoreRuleConditionSchema)
Optional
StoreRuleConditionSchema
is_active
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
Loading...
Response
Loading...
GET

Get store rule

Retrieves a single rule within the order routing rules
Parameters
ruleUid
string
A `rule_uid` is a unique identifier for a particular rule object.
Response
200
400
Successful Response
StoreRuleDataSchema
id
string
Optional
name
string
Optional
company_id
integer
Optional
application_id
string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
conditions
object (StoreRuleConditionSchema)
Optional
StoreRuleConditionSchema
is_active
boolean
Optional
Examples
Parameters
ruleUid:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...
PUT

Update store rule

Updates an existing rule within the order routing rules.
Parameters
ruleUid
string
A `rule_uid` is a unique identifier for a particular rule object.
body
object (CreateStoreRuleRequestSchema)
CreateStoreRuleRequestSchema
name
string
Optional
is_active
boolean
Optional
conditions
object (StoreRuleConditionSchema)
Optional
StoreRuleConditionSchema
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
Response
200
400
Response status_code
StoreRuleUpdateResponseSchema
id
string
Optional
name
string
Optional
type
string
Optional
type_based_priority
array of string
Optional
tag_based_priority
array of string
Optional
store_priority
array of object (StorePrioritySchema)
Optional
Array of StorePrioritySchema
sort
array of string
Optional
conditions
object (StoreRuleConditionSchema)
Optional
StoreRuleConditionSchema
is_active
boolean
Optional
company_id
integer
Optional
application_id
string
Optional
Examples
Parameters
ruleUid:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...

Pincode-based Cash on Delivery

Cash on delivery is a payment option available for customers when placing an order. This feature allows sellers to activate 'cash on delivery' for certain areas while disabling it for others. Currently, Cash on Delivery can be set up at the pincode level specifically for India.

Operations
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-update
# Update pincode COD support
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-bulk-update
# Bulk update pincode COD support
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-data
# Get COD enabled pincodes
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history
# Get audit trail
POST

Update pincode COD support

Modify and update views related to pincode MOP (Mode of Payment).
Parameters
body
object (PincodeMopData)
PincodeMopData
pincodes
array of integer
country
string
action
string
Response
200
400
Response Data
PincodeMOPresponse
success
boolean
status_code
integer
batch_id
string
country
string
action
string
pincodes
array of integer
Optional
updated_pincodes
array of object (PincodeMopUpdateResponse)
Optional
Array of PincodeMopUpdateResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-update
Loading...
Response
Loading...
POST

Bulk update pincode COD support

Updates the cash on delivery settings for multiple specified pin codes simultaneously.
Parameters
body
object (PincodeMopBulkData)
PincodeMopBulkData
batch_id
string
s3_url
string
Response
200
400
Response Data
PincodeBulkViewResponse
batch_id
string
s3_url
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-bulk-update
Loading...
Response
Loading...
POST

Get COD enabled pincodes

Retrieves a list of pincodes along with the count based on whether cash on delivery settings.
Parameters
body
object (PincodeCodStatusListingRequest)
PincodeCodStatusListingRequest
country
string
Optional
Default Value : INDIA
is_active
boolean
Optional
Default Value : true
pincode
integer
Nullable
Optional
current
integer
Optional
Default Value : 1
page_size
integer
Optional
Default Value : 100
Response
200
400
Response Data
PincodeCodStatusListingResponse
country
string
data
array of object (PincodeCodStatusListingResponse)
Array of PincodeCodStatusListingResponse
success
boolean
errors
array of object (Error)
Optional
Array of Error
page
object (PincodeCodStatusListingPage)
PincodeCodStatusListingPage
summary
object (PincodeCodStatusListingSummary)
PincodeCodStatusListingSummary
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-data
Loading...
Response
Loading...
POST

Get audit trail

Retrieves the history of changes made to cash on delivery settings for pincodes.
Parameters
body
object (PincodeMopUpdateAuditHistoryRequest)
PincodeMopUpdateAuditHistoryRequest
entity_type
string
file_name
string
Optional
Response
200
400
Response Data
PincodeMopUpdateAuditHistoryResponseData
entity_type
string
Optional
page
object (PincodeMopUpdateAuditHistoryPaging)
PincodeMopUpdateAuditHistoryPaging
data
array of object (PincodeMopUpdateAuditHistoryResponse)
Array of PincodeMopUpdateAuditHistoryResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history
Loading...
Response
Loading...

Selling Location

A selling location is nothing but a geographical location where your stores and warehouses exists. The Selling location resource efficiently matches customer orders with the nearest store, reducing delivery time for sellers and ensuring customers receive products quickly at the best price, enhancing overall satisfaction.

Operations
GET
/service/platform/logistics/v1.0/company/{company_id}/logistics/stores
# Get all stores
POST
/service/platform/logistics/v1.0/company/{company_id}/optimal-locations
# Get selling locations
GET

Get all stores

Deprecated
Retrieves a list of locations.
Parameters
No Parameters
Response
200
Response status_code
GetStoresViewResponse
page
object (ServiceabilityPageResponse)
ServiceabilityPageResponse
items
array of object (ItemResponse)
Optional
Array of ItemResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/logistics/stores
Loading...
Response
Loading...
POST

Get selling locations

Retrieves a list selling locations which are best suited to fullfil an order for a customer.
Parameters
body
object (OptimlLocationsRequestSchema)
OptimlLocationsRequestSchema
channel_id
string
channel_type
string
Enum
channel_identifier
string
Optional
Enum
to_serviceability
object (LocationDetailsServiceability)
LocationDetailsServiceability
article
object (OptimalLocationsArticles)
Optional
OptimalLocationsArticles
Response
200
400
Optimal Locations Success
OptimalLocationsResponse
assigned_stores
array of object (OptimalLocationAssignedStoresResponse)
Array of OptimalLocationAssignedStoresResponse
faulty_articles
array of object (ErrorResponse)
Optional
Array of ErrorResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/optimal-locations
Loading...
Response
Loading...

Shipment Packaging

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
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
# Create packaging material
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
# Get packaging materials
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
# Create packaging rule
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
# Get packaging rules
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
# Update packaging rule
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
# Get packaging material rule
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
# Update packaging material
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
# Get packaging material
POST

Create packaging material

Creates a packaging material
Parameters
body
object (PackageMaterial)
PackageMaterial
name
string
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Optional
Array of PackageMaterialRule
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
Optional
channels
array of object (Channel)
Array of Channel
track_inventory
boolean
Optional
status
string
Enum
max_weight
number
Optional
package_vol_weight
number
Optional
auto_calculate
boolean
Optional
Response
201
400
Response status_code
PackageMaterialResponse
name
string
id
string
Optional
item_id
integer
Optional
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Optional
Array of PackageMaterialRule
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
Optional
channels
array of object (Channel)
Array of Channel
track_inventory
boolean
Optional
status
string
Enum
max_weight
number
Optional
package_vol_weight
number
Optional
auto_calculate
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
Loading...
Response
Example response not available.
GET

Get packaging materials

Retrieves a list of packaging materials
Parameters
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 10
q
string
Optional
perform regex search on items matching name for given value
size
string
Optional
filters items based on given size
packageType
string
Optional
filters items based on given package_type
Response
200
400
Response status_code
PackageMaterialList
items
object (PackageMaterialResponse)
Optional
PackageMaterialResponse
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
Loading...
Response
Example response not available.
POST

Create packaging rule

Creates a packaging rule
Parameters
body
object (PackageRule)
PackageRule
name
string
company_id
integer
type
string
is_active
boolean
Optional
product_tag
object (PackageRuleProductTag)
Optional
PackageRuleProductTag
product_id
object (PackageRuleProduct)
Optional
PackageRuleProduct
category_id
object (PackageRuleCategory)
Optional
PackageRuleCategory
Response
201
400
Response status_code
PackageRuleResponse
id
string
Optional
name
string
company_id
integer
type
string
is_active
boolean
Optional
product_tag
object (PackageRuleProductTag)
Optional
PackageRuleProductTag
product_id
object (PackageRuleProduct)
Optional
PackageRuleProduct
category_id
object (PackageRuleCategory)
Optional
PackageRuleCategory
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
Loading...
Response
Example response not available.
GET

Get packaging rules

Retrieve packaging rules
Parameters
pageNo
integer
| value >= 1
Optional
index of the item to start returning with
Default Value : 1
pageSize
integer
| value >= 1
Optional
determines the items to be displayed in a page
Default Value : 10
isActive
string
Optional
filters items based on given is_active
Response
200
400
Response status_code
PackageMaterialRuleList
items
object (PackageRuleResponse)
Optional
PackageRuleResponse
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
Loading...
Response
Example response not available.
PATCH

Update packaging rule

Update an existing packaging rule
Parameters
ruleId
string
A `package_material_rule_id` is a unique identifier for a Package Material Rule
body
object (PackageRule)
PackageRule
name
string
company_id
integer
type
string
is_active
boolean
Optional
product_tag
object (PackageRuleProductTag)
Optional
PackageRuleProductTag
product_id
object (PackageRuleProduct)
Optional
PackageRuleProduct
category_id
object (PackageRuleCategory)
Optional
PackageRuleCategory
Response
200
400
Response status_code
PackageRuleResponse
id
string
Optional
name
string
company_id
integer
type
string
is_active
boolean
Optional
product_tag
object (PackageRuleProductTag)
Optional
PackageRuleProductTag
product_id
object (PackageRuleProduct)
Optional
PackageRuleProduct
category_id
object (PackageRuleCategory)
Optional
PackageRuleCategory
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
Loading...
Response
Example response not available.
GET

Get packaging material rule

Retrieve packaging rule details.
Parameters
ruleId
string
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Response
200
400
Response status_code
PackageRuleResponse
id
string
Optional
name
string
company_id
integer
type
string
is_active
boolean
Optional
product_tag
object (PackageRuleProductTag)
Optional
PackageRuleProductTag
product_id
object (PackageRuleProduct)
Optional
PackageRuleProduct
category_id
object (PackageRuleCategory)
Optional
PackageRuleCategory
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
Loading...
Response
Example response not available.
PATCH

Update packaging material

Update an existing packaging material
Parameters
packageMaterialId
string
A `package_material_id` is a unique identifier for a Package Material
body
object (PackageMaterial)
PackageMaterial
name
string
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Optional
Array of PackageMaterialRule
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
Optional
channels
array of object (Channel)
Array of Channel
track_inventory
boolean
Optional
status
string
Enum
max_weight
number
Optional
package_vol_weight
number
Optional
auto_calculate
boolean
Optional
Response
200
400
Response status_code
PackageMaterialResponse
name
string
id
string
Optional
item_id
integer
Optional
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Optional
Array of PackageMaterialRule
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
Optional
channels
array of object (Channel)
Array of Channel
track_inventory
boolean
Optional
status
string
Enum
max_weight
number
Optional
package_vol_weight
number
Optional
auto_calculate
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
Loading...
Response
Example response not available.
GET

Get packaging material

Retrieve a single packaging material
Parameters
packageMaterialId
string
A `package_material_id` is a unique identifier for a Package Material
Response
200
400
Response status_code
PackageMaterialResponse
name
string
id
string
Optional
item_id
integer
Optional
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Optional
Array of PackageMaterialRule
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
Optional
channels
array of object (Channel)
Array of Channel
track_inventory
boolean
Optional
status
string
Enum
max_weight
number
Optional
package_vol_weight
number
Optional
auto_calculate
boolean
Optional
Examples
Parameters
packageMaterialId:
"value"
Was this section helpful?
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
Loading...
Response
Loading...