Serviceability

Logistics Configuration API's allows you to configure zone, application logistics and many more useful features.

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}/application/{application_id}/courier-partner/rules
# Create courier 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}/application/{application_id}/courier-partner/rules/{rule_uid}
# Update courier rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}
# Get courier rule
DEL
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}
# Delete courier rule
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# Apply configuration to an application
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# Get delivery configuration
PATCH
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# To patch any config which can be applied to application.
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
# Update courier partner rule priority
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}/details
# Get courier rule
POST

Create courier rule

Creates a rule within the delivery configuration.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
Request body
id
string
application_id
string
company_id
integer
is_active
boolean
Required
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
Required
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Required
Enum
shipment_adjustment_type
string
Nullable
Enum
type
string
Required
Response
200
400
Response status_code
CourierPartnerRuleResponseSchema
id
string
is_active
boolean
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
conditions
object (CourierPartnerRuleResponseConditions)
CourierPartnerRuleResponseConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Enum
type
string
application_id
string
company_id
integer
shipment_adjustment_type
string
Nullable
Enum
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
q
string
courier-partner rules starting with the specified prefix q
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
status
string
Filter rules based on rule status
Enum
Response
200
Response status_code
CourierPartnerRulesListResponseSchema
items
array of object (CourierPartnerRuleResponseSchema)
Array of CourierPartnerRuleResponseSchema
id
string
is_active
boolean
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
conditions
object (CourierPartnerRuleResponseConditions)
CourierPartnerRuleResponseConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Enum
type
string
application_id
string
company_id
integer
shipment_adjustment_type
string
Nullable
Enum
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
q:
"Test Rule"
page_no:
1
page_size:
1
status:
"true"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
Loading...
Response
Loading...
PUT

Update courier rule

Updates an existing rule within the delivery configuration
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular Dp.
Request body
id
string
application_id
string
company_id
integer
is_active
boolean
Required
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
Required
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Required
Enum
shipment_adjustment_type
string
Nullable
Enum
type
string
Required
Response
200
400
Response status_code
CourierPartnerRuleResponseSchema
id
string
is_active
boolean
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
conditions
object (CourierPartnerRuleResponseConditions)
CourierPartnerRuleResponseConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Enum
type
string
application_id
string
company_id
integer
shipment_adjustment_type
string
Nullable
Enum
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"6524fa7b6b3b9c4d852b1fd8"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}
Loading...
Response
Loading...
GET

Get courier rule

Retrieves a single rule within the delivery configuration.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular Dp.
Response
200
400
Response status_code
CourierPartnerRuleResponseSchema
id
string
is_active
boolean
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
conditions
object (CourierPartnerRuleResponseConditions)
CourierPartnerRuleResponseConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Enum
type
string
application_id
string
company_id
integer
shipment_adjustment_type
string
Nullable
Enum
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"6524fa7b6b3b9c4d852b1fd8"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}
Loading...
Response
Loading...
DEL

Delete courier rule

Delete a single courier rule
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular Dp.
Response
200
400
Response status_code
CourierPartnerRuleDeleteResponseSchema
message
string
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"64d71e3f8ab4c6e2d3f67890"
DEL
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}
Loading...
Response
Loading...
PUT

Apply configuration to an application

Deprecated
Apply configuration to application to set DP rules and Zone configuration
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier of company.
application_id
string
Required
A `application_id` is a unique identifier of sales channel.
Request body
rule_ids
array of string
sort
array of string
Enum
manual_priority
array of string
Response
200
400
Response status_code
ApplicationConfigPutResponseSchema
rule_ids
array of string
sort
array of string
Enum
manual_priority
array of string
application_id
string
company_id
integer
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

This API returns all the Application config that has been applied to the given company and application.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier of company.
application_id
string
Required
A `application_id` is a unique identifier of a sales channel.
Response
200
400
Success. Returns all the Application configs that are present in the application. It fetches Zones, Courier patner config, Promise config and Buybox rule config. Refer Schema and Examples for more details.
ApplicationConfigGetResponseSchema
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
active_count
integer
total_count
integer
courier_partner_config
object (CourierPartnerConfig)
CourierPartnerConfig
rule_ids
array of string
sort
array of string
Enum
manual_priority
array of string
buybox_rule_config
object (BuyboxRuleConfig)
BuyboxRuleConfig
store_type_priority
array of string
store_tag_priority
array of string
sort
array of string
Enum
promise_config
object (PromiseConfig)
PromiseConfig
store_attributes
object (StorePromiseAttributeConfig)
StorePromiseAttributeConfig
is_operational_timing_enabled
boolean
is_order_acceptance_timing_enabled
boolean
is_average_processing_time
boolean
is_holiday_enabled
boolean
delivery_service_attributes
object (DeliveryServiceAttributeConfig)
DeliveryServiceAttributeConfig
is_pickup_cutoff_time_enabled
boolean
is_service_tat_enabled
boolean
is_holiday_enabled
boolean
buffer_field
object (BufferField)
BufferField
unit
string
value
integer
enabled
boolean
promise_types
array of object (PromiseType)
Array of PromiseType
display_name
string
slug
string
description
string
is_active
boolean
is_default
boolean
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
PATCH

To patch any config which can be applied to application.

Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier of company.
application_id
string
Required
A `application_id` is a unique identifier of sales channel.
Request body
courier_partner_config
object (CourierPartnerConfig)
CourierPartnerConfig
rule_ids
array of string
sort
array of string
Enum
manual_priority
array of string
buybox_rule_config
object (BuyboxRuleConfig)
BuyboxRuleConfig
store_type_priority
array of string
store_tag_priority
array of string
sort
array of string
Enum
promise_config
object (PromiseConfig)
PromiseConfig
store_attributes
object (StorePromiseAttributeConfig)
StorePromiseAttributeConfig
is_operational_timing_enabled
boolean
is_order_acceptance_timing_enabled
boolean
is_average_processing_time
boolean
is_holiday_enabled
boolean
delivery_service_attributes
object (DeliveryServiceAttributeConfig)
DeliveryServiceAttributeConfig
is_pickup_cutoff_time_enabled
boolean
is_service_tat_enabled
boolean
is_holiday_enabled
boolean
buffer_field
object (BufferField)
BufferField
unit
string
value
integer
enabled
boolean
Response
200
404
Response status_code
ApplicationConfigPatchResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
PATCH
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
PUT

Update courier partner rule priority

Updates a courier partner rule priority for a single application
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_id
string
Required
priority
integer
Required
Response
200
400
Response status_code
RulePriorityResponseSchema
success
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
Loading...
Response
Loading...
GET

Get courier rule

Retrieves details for a courier partner rule.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
string
Required
A `rule_uid` is a unique identifier for a courier partner rule.
Response
200
400
Response status_code
CourierPartnerRuleResponseDetailSchema
id
string
is_active
boolean
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
account_id
string
name
string
is_self_ship
boolean
scheme_rules
object
stage
string
name
string
conditions
object (CourierPartnerRuleResponseDetailConditions)
CourierPartnerRuleResponseDetailConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
uid
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
product_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (RuleResponseStringDetail)
RuleResponseStringDetail
includes
array of object (RuleConditionStringDetail)
Array of RuleConditionStringDetail
text
string
Nullable
value
string
Nullable
stage
boolean
Nullable
department_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
brand_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
store_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
company_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
promise_types
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
manual_priority
array of string
sort
array of string
Enum
type
string
application_id
string
company_id
integer
shipment_adjustment_type
string
Nullable
Enum
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"6524fa7b6b3b9c4d852b1fd8"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_uid}/details
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
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones
# Create zone
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones
# Get zones
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
# Get zone details
PATCH
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
# Update details of a Zone to enable or disable.
DEL
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
# Delete a Specific Zone
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}/details
# Get details of a delivery zone
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk
# Create bulk zones.
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/history
# Get bulk zones.
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/export
# Create Bulk Export of Zones
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/export/{batch_id}
# Get Bulk Export of Zones
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas
# Creation of GeoArea
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas
# Get all geoareas in the current application.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/{geoarea_id}
# Get details of the specific geoarea
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/{geoarea_id}
# Update the details of existing GeoArea
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk
# Bulk Creation of GeoArea Regions
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/{geoarea_id}
# Get status of GeoAreas created in bulk
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/{geoarea_id}
# Update geoareas and their associated regions in bulk.
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export/{geoarea_id}
# Create job for exporting Geoarea regions
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export/{geoarea_id}
# Get status of Geoarea export job
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export
# Create Bulk Export of Price GeoAreas
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk
# Bulk Creation of GeoAreas
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/history
# Get history of the geoarea in bulk job processed
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/sample
# Get sample file of a Price Zone
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/export/{batch_id}
# Get history of the geoarea in bulk job processed
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/sample
# Download geoarea sample file.
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/sample/{product_type}
# Download Sample Delivery Zone Product Type file.
POST

Create zone

Creates a delivery zone.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
is_active
boolean
Required
slug
string
Required
type
string
Required
access_level
string
Required
Access level of zone
Enum
name
string
Required
company_id
integer
Required
application_id
string
Required
geo_areas
array of string
Required
stores
object (ZoneStores)
ZoneStores
type
string
Required
values
array of integer
Required
product
object (ZoneProduct)
ZoneProduct
type
string
Required
values
array of integer
Required
Response
200
400
403
Response status_code
ZoneResponseV2
name
string
slug
string
company_id
integer
type
string
access_level
string
Access level of the zone (public or private).
application_id
string
is_active
boolean
is_public_opted
boolean
Indicates whether the public zone is opted by any seller or not
is_opted
boolean
Indicates whether the zone is opted or not.
geo_areas
array of string
stores
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
product
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
created_on
string
| date-time
modified_by
string
modified_on
string
| date-time
stage
string
zone_id
string
summary
object (SummaryRegions)
SummaryRegions
regions
array of object (RegionSchema)
Array of RegionSchema
name
string
Display name of the country
count
integer
Count of the total number of regions mapped to a country for the delivery zone.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones
Loading...
Response
Loading...
GET

Get zones

Retrieves a list of delivery zones.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
stage
string
Identifies the specific stage of zone bing requested.
Enum
type
string
Using type, you can filter custom or default zones
Enum
access_level
string
Using access level, you can filter public and private zones as marketplace owner
Enum
status
string
Using status zones listing can be filttered for marketplace owner and 3p sellers
page_size
integer
| value >= 1
Defines the number of items displayed per page.
Default Value : 10
page_no
integer
| value >= 1
current page number.
Default Value : 1
is_active
boolean
Status of Zone (either active or inactive)
q
string
Search with name as a free text.
country_iso_code
string
ISO2 code of the country.
pincode
string
PIN Code of the country.
state
string
State of the country.
city
string
City of the country.
sector
string
Sector name of mentioned address.
store_uid
integer
Unique identifier for a specific store.
region_uid
string
Unique identifier for a geographical region.
Response
200
Zone List of application in descending order of their last modified date.
ListViewResponseV2
items
array of object (ListViewItemsV2)
Array of ListViewItemsV2
zone_id
string
name
string
type
string
access_level
string
Access level of the zone (public or private).
Enum
geo_areas
array of object (GeoArea)
Array of GeoArea
id
string
type
string
name
string
slug
string
stores
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_active
boolean
is_opted
boolean
Indicates whether the zone is opted or not.
is_public_opted
boolean
Indicates whether the public zone is opted by any seller or not
product
object (ListViewProductV2)
ListViewProductV2
type
string
values
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
integer
application_id
string
created_by
string
created_on
string
| date-time
modified_by
string
modified_on
string
| date-time
stage
string
summary
object (Summary)
Summary
stores_count
integer
products_count
integer
regions
array of object (RegionSchema)
Array of RegionSchema
name
string
Display name of the country
count
integer
Count of the total number of regions mapped to a country for the delivery zone.
page
object (ZoneDataItem)
ZoneDataItem
has_next
boolean
item_total
integer
size
integer
current
integer
type
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
stage:
"completed"
type:
"custom"
access_level:
"private"
status:
"active"
page_size:
10
page_no:
1
is_active:
true
q:
"zone"
country_iso_code:
"IN"
pincode:
"500060"
state:
"MAHARASTRA"
city:
"MUMBAI"
sector:
"ABU_DHABI"
store_uid:
2
region_uid:
"64aec5aa3a079bd328539e25"
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones
Loading...
Response
Loading...
GET

Get zone details

Retrieves a single delivery zone
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
zone_id
string
Required
Unique identifier for a particular zone
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
400
Get details of the Zone
GetZoneByIdSchema
zone_id
string
name
string
slug
string
is_active
boolean
is_opted
boolean
product
object (ProductSchema)
ProductSchema
type
string
The classification of product type used in the zone, whether it's a list of categories, departments, tags or item_ids.
Enum
values
array of integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
stores
object (StoresSchema)
StoresSchema
type
string
Classification of whether all stores in the application are considered or a custom selection of stores by the seller.
Enum
values
array of integer
List of store ids mapped to the delivery zone when custom type is selected.
created_by
string
created_on
string
| date-time
modified_by
string
modified_on
string
| date-time
stage
string
overlapping_file_url
string
Nullable
geo_areas
array of string
type
string
Enum
overlapping_zone_names
array of string
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b0"
application_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
Loading...
Response
Loading...
PATCH

Update details of a Zone to enable or disable.

Enable or Disable a Zone under that application.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
zone_id
string
Required
Unique identifier for a particular zone
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
zone_id
string
name
string
type
string
access_level
string
Access level of the zone (public or private).
Enum
slug
string
geo_areas
array of string
company_id
integer
application_id
string
is_active
boolean
is_opted
boolean
Indicates whether the zone is opted or not.
product
object (ProductSchema)
ProductSchema
type
string
Required
The classification of product type used in the zone, whether it's a list of categories, departments, tags or item_ids.
Enum
values
array of integer
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
stores
object (StoresSchema)
StoresSchema
type
string
Required
Classification of whether all stores in the application are considered or a custom selection of stores by the seller.
Enum
values
array of integer
Required
List of store ids mapped to the delivery zone when custom type is selected.
Response
200
400
Response status_code
ZoneUpdateSuccessResponseSchema
name
string
slug
string
company_id
integer
type
string
access_level
string
Access level of the zone (public or private).
application_id
string
is_active
boolean
is_opted
boolean
Indicates whether the zone is opted or not.
geo_areas
array of string
product
object (ProductSchema)
ProductSchema
type
string
The classification of product type used in the zone, whether it's a list of categories, departments, tags or item_ids.
Enum
values
array of integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
stores
object (StoresSchema)
StoresSchema
type
string
Classification of whether all stores in the application are considered or a custom selection of stores by the seller.
Enum
values
array of integer
List of store ids mapped to the delivery zone when custom type is selected.
zone_id
string
created_by
string
created_on
string
| date-time
modified_by
string
modified_on
string
| date-time
stage
string
summary
object (Summary)
Summary
stores_count
integer
products_count
integer
regions
array of object (RegionSchema)
Array of RegionSchema
name
string
Display name of the country
count
integer
Count of the total number of regions mapped to a country for the delivery zone.
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b0"
application_id:
"64aec5a93a079bd328537835"
body:
body
PATCH
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
Loading...
Response
Loading...
DEL

Delete a Specific Zone

Delete a Zone under that application.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
zone_id
string
Required
Unique identifier for a particular zone
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
400
Response status_code
ZoneDeleteSuccessResponseSchema
message
string
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b9"
application_id:
"64aec5a93a079bd328537836"
DEL
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}
Loading...
Response
Loading...
GET

Get details of a delivery zone

Get details of a single delivery zone along with product, store and region details.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
Unique identifier of the company.
zone_id
string
Required
Unique identifier of a particular zone
application_id
string
Required
Unique identifier of the sales channel (application).
Response
200
400
Get details of the zone
GetZoneByIdDetailsSchema
zone_id
string
Unique identifier for the zone.
name
string
Name of the zone.
slug
string
URL-friendly version of the zone name.
is_active
boolean
Indicates whether the zone is active.
is_opted
boolean
Indicates whether the zone is opted or not.
product
object (ProductDetailsSchema)
ProductDetailsSchema
type
string
The classification of product type used in the zone, whether it's a list of categories, departments, tags or item_ids.
Enum
values
array of object (DetailsSchema)
List of values representing the products or the type of products selected for the delivery zone.
Array of DetailsSchema
name
string
Display name of the value.
value
string
Raw value (id) of the store or product or region.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
stores
object (StoresDetailsSchema)
StoresDetailsSchema
type
string
The classification of product type used in the zone, whether it's a list of categories, departments, tags or item_ids.
Enum
values
array of object (StoreValueDetailsSchema)
List of values representing the products or the type of products selected for the delivery zone.
Array of StoreValueDetailsSchema
text
string
value
integer
stage
string
Current stage of the zone in its lifecycle.
overlapping_file_url
string
Nullable
URL of the file containing overlapping zone information.
geo_areas
array of object (GeoAreaDetailsSchema)
Array of GeoAreaDetailsSchema
id
string
Unique identifier for the geographical area.
name
string
Name of the geographical area.
type
string
Type of the zone (custom or default).
Enum
access_level
string
Access level of the zone (public or private).
Enum
overlapping_zone_names
array of string
List of names of overlapping zones.
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b0"
application_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/{zone_id}/details
Loading...
Response
Loading...
POST

Create bulk zones.

Creates bulk zones defined at the application level.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
file_url
string
product_type
string
Enum
Response
200
400
Response status_code
CreateBulkZoneResponseSchema
zone_id
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk
Loading...
Response
Loading...
GET

Get bulk zones.

Fetch bulk zones created at the application level.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
Response status_code
GetBulkZoneHistory
items
array of object (BulkZoneItems)
Array of BulkZoneItems
batch_id
string
entity_type
string
error_file_url
string
Nullable
file_path
string
file_name
string
updated_at
string
| date-time
updated_by
string
Nullable
stage
string
page
object (PageV2)
PageV2
type
string
size
number
current
number
has_next
boolean
item_total
number
Examples
Parameters
application_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/history
Loading...
Response
Loading...
POST

Create Bulk Export of Zones

Export zones defined at the application level.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
placeholder
string
Default Value :
Response
200
Response status_code
ZoneBulkExport
batch_id
string
Examples
Parameters
Parameters are not required.
POST
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/export
Loading...
Response
Loading...
GET

Get Bulk Export of Zones

Get specific zone which is exported at the application level.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
batch_id
string
Required
A `batch_id` is a unique identifier for a particular zone.
Response
200
Response status_code
GetZoneBulkExport
items
array of object (ZoneBulkItem)
Array of ZoneBulkItem
batch_id
string
file_path
string
Nullable
total
integer
failed
integer
error_file_url
string
Nullable
action
string
updated_at
string
| date-time
updated_by
string
type
string
stage
string
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/export/{batch_id}
Loading...
Response
Loading...
POST

Creation of GeoArea

Allows to create and manage GeoAreas, representing groups of geographic regions.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Request body
is_active
boolean
Required
name
string
Required
slug
string
Required
type
string
Required
Enum
areas
array of object (Area)
Required
Array of Area
regions
array of string
country
string
region_type
string
Required
Enum
Response
200
400
GeoArea has been created successfully.
GeoAreaResponseBody
name
string
slug
string
is_active
boolean
areas
array of object (Area)
Array of Area
regions
array of string
country
string
region_type
string
Enum
type
string
Enum
created_on
string
| date-time
modified_on
string
| date-time
created_by
string
modified_by
string
geoarea_id
string
Examples
Parameters
company_id:
1
application_id:
"65e2d5b3a71cf1bff40723f5"
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas
Loading...
Response
Loading...
GET

Get all geoareas in the current application.

Retrieves a listing view of created GeoAreas.
Requires application/logistics/read access scope.
Parameters
application_id
string
Required
A `application_id` is a unique identifier for an application.
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
is_active
boolean
Status of GeoAreas (either active or inactive)
page_no
integer
Current page number
type
string
To fetch the type of a specific geoarea.
q
string
search with name as a free text
country_iso_code
string
ISO2 code of the country
state
string
State name
city
string
City name
pincode
string
Pincode value to search geoareas
sector
string
Sector value to search geoareas
Response
200
Successfully retrieved GeoArea.
GeoAreaGetResponseBody
items
array of object (GeoAreaItemResponseSchema)
Array of GeoAreaItemResponseSchema
company_id
integer
application_id
string
geoarea_id
string
name
string
slug
string
is_active
boolean
region_type
string
Enum
type
string
areas
array of object (AreaExpandedV2)
Array of AreaExpandedV2
country
object (Country)
Country
uid
string
display_name
string
regions
array of object (RegionV2)
Array of RegionV2
uid
string
display_name
string
sub_type
string
parent_id
array of string
created_on
string
| date-time
modified_on
string
| date-time
created_by
string
modified_by
string
page
object (Page2)
Page2
size
integer
item_total
integer
type
string
current
integer
has_next
boolean
Examples
Parameters
application_id:
"65e2d5b3a71cf1bff40723f5"
company_id:
1
page_size:
10
is_active:
true
q:
"geoareas"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas
Loading...
Response
Loading...
GET

Get details of the specific geoarea

This API Returns the data of the specific GeoArea which exists on the platform.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
geoarea_id
string
Required
A unique identifier for the GeoArea.
application_id
string
Required
The unique identifier for the sales channel.
Response
200
404
Response status_code
GeoAreaResponseSchema
name
string
slug
string
application_id
string
company_id
integer
geoarea_id
string
is_active
boolean
type
string
region_type
string
Enum
areas
array of object (AreaExpanded)
Array of AreaExpanded
country
object (Country)
Country
uid
string
display_name
string
regions
array of object (Region)
Array of Region
uid
string
display_name
string
sub_type
string
parent_id
array of string
created_on
string
| date-time
modified_on
string
| date-time
created_by
string
modified_by
string
Examples
Parameters
company_id:
1
geoarea_id:
"659ec3c5959b4db956fd81cf"
application_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/{geoarea_id}
Loading...
Response
Loading...
PUT

Update the details of existing GeoArea

Updates the GeoArea with a new name, regions, etc.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
geoarea_id
string
Required
A unique identifier for the GeoArea.
application_id
string
Required
The unique identifier for the sales channel.
Request body
is_active
boolean
Required
name
string
Required
slug
string
Required
type
string
Required
Enum
areas
array of object (Area)
Required
Array of Area
regions
array of string
country
string
region_type
string
Required
Enum
Response
200
404
Response status code
GeoAreaPutResponseBody
name
string
geoarea_id
string
slug
string
is_active
boolean
areas
array of object (Area)
Array of Area
regions
array of string
country
string
region_type
string
Enum
type
string
created_on
string
| date-time
modified_on
string
| date-time
created_by
string
modified_by
string
upload_type
string
Enum
Examples
Parameters
company_id:
1
geoarea_id:
"659ec3c5959b4db956fd81cf"
application_id:
"64aec5a93a079bd328537835"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/{geoarea_id}
Loading...
Response
Loading...
POST

Bulk Creation of GeoArea Regions

Allows to create and manage GeoAreas, representing groups of geographic regions in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Request body
file_url
string
name
string
slug
string
type
string
Response
200
400
Bulk GeoArea has been created successfully.
BulkGeoAreaResult
geoarea_id
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk
Loading...
Response
Loading...
GET

Get status of GeoAreas created in bulk

Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
geoarea_id
string
Required
A unique identifier for the GeoArea.
Response
200
400
Bulk GeoArea has been fetched successfully.
BulkGeoAreaGetResponseSchema
batch_id
string
file_path
string
Nullable
total
integer
failed
integer
error_file_url
string
Nullable
action
string
updated_at
string
| date-time
updated_by
string
type
string
stage
string
file_url
string
Nullable
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
geoarea_id:
"659ec3c5959b4db956fd81cf"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/{geoarea_id}
Loading...
Response
Loading...
PUT

Update geoareas and their associated regions in bulk.

Update geoarea details and their associated regions through a CSV file in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
Unique identifier for the company
application_id
string
Required
Unique identifier for the sales channel
geoarea_id
string
Required
A unique identifier for the GeoArea.
Request body
file_url
string
name
string
slug
string
type
string
Response
200
400
Bulk GeoArea has been created successfully.
BulkGeoAreaResult
geoarea_id
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
geoarea_id:
"659ec3c5959b4db956fd81cf"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/{geoarea_id}
Loading...
Response
Loading...
POST

Create job for exporting Geoarea regions

Create the job for exporting the regions in Geoarea in CSV format.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier of the company.
application_id
string
Required
The unique identifier of the application.
geoarea_id
string
Required
The unique identifier of the Geoarea.
Response
200
The export process was successfully initiated.
GeoAreaBulkCreationResult
batch_id
string
The unique identifier of the bulk export batch.
Examples
Parameters
company_id:
1
application_id:
"61bc34f2bf3c9b427acc0871"
geoarea_id:
"659ec3c5959b4db956fd81cf"
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export/{geoarea_id}
Loading...
Response
Loading...
GET

Get status of Geoarea export job

Get the status and details of the Geoarea bulk export process.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier of the company.
application_id
string
Required
The unique identifier of the application.
geoarea_id
string
Required
The unique identifier of the Geoarea.
Response
200
404
The export status details.
GeoAreaBulkExportResult
batch_id
string
The unique identifier of the bulk export batch.
file_path
string
Nullable
The file path where the export data will be stored.
total
integer
The total number of records processed in the export.
failed
integer
The number of records that failed to export.
error_file_url
string
Nullable
The URL of the file containing details of errors encountered during the export, if available.
action
string
The action performed during the export process, typically "import" or "export".
updated_at
string
| date-time
The timestamp when the export status was last updated.
updated_by
string
The name or identifier of the user or process that last updated the export status.
type
string
The type of export process, such as "geo_area_bulk_export".
stage
string
The current stage of the export process, such as "initiated", "in_progress", or "completed".
Examples
Parameters
company_id:
1
application_id:
"61bc34f2bf3c9b427acc0871"
geoarea_id:
"659ec3c5959b4db956fd81cf"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export/{geoarea_id}
Loading...
Response
Loading...
POST

Create Bulk Export of Price GeoAreas

Allows to create and manage GeoAreas, representing groups of geographic regions in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Request body
type
string
Type of the geo area export
Response
200
Bulk GeoArea has been created successfully.
PriceGeoAreaExportResult
batch_id
string
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/export
Loading...
Response
Loading...
POST

Bulk Creation of GeoAreas

Allows to create and manage GeoAreas, representing groups of geographic regions in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Request body
type
string
Required
Type of bulk geo area export (e.g. 'price').
Enum
file_url
string
| uri
Required
URL to the file containing bulk geo area data.
Response
200
400
Bulk GeoArea has been created successfully.
BulkGeoAreaResult
geoarea_id
string
Examples
Parameters
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk
Loading...
Response
Loading...
GET

Get history of the geoarea in bulk job processed

Allows to get the history of geoareas that are uploaded in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Response
200
Successfully retrieved the bulk GeoArea export details.
GetBulkPriceZoneHistory
page
object (Pagination)
Pagination
type
string
data type of page
size
integer
Number of items per page
current
integer
Current page number
has_next
boolean
Flag indicating if there is a next page
item_total
integer
Total number of items
items
array of object (BulkPriceZoneItem)
List of bulk price zone history items
Array of BulkPriceZoneItem
batch_id
string
The unique batch ID for the bulk upload
entity_type
string
Entity type of the record
error_file_url
string
| uri
Nullable
URL of the error file if any error occurred
file_path
string
| uri
File path or URL where the bulk file is stored
file_name
string
Name of the file
updated_at
string
| date-time
Timestamp of the last update
updated_by
string
User who last updated the record
stage
string
Stage of the bulk upload process
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/history
Loading...
Response
Loading...
GET

Get sample file of a Price Zone

Generates a sample XLSX file containing template data for Price GeoAreas. This sample file provides the required columns and example values needed for bulk uploading Price GeoArea data.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
Response
200
Successfully retrieved the bulk GeoArea export sample file.
Examples
Parameters
company_id:
1
application_id:
"value"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/bulk/sample
Loading...
Response
Loading...
GET

Get history of the geoarea in bulk job processed

Allows to get the history of geoareas that are uploaded in bulk.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
The unique identifier for the company.
application_id
string
Required
The unique identifier for the sales channel.
batch_id
string
Required
The unique identifier for the sales channel.
Response
200
400
Successfully retrieved the bulk GeoArea export details.
GetExportPriceZoneHistory
batch_id
string
file_path
string
Nullable
total
integer
failed
integer
error_file_url
string
Nullable
action
string
updated_at
string
| date-time
updated_by
string
Nullable
type
string
stage
string
Examples
Parameters
batch_id:
"64aec5a93a079bd328537835"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/export/{batch_id}
Loading...
Response
Loading...
GET

Download geoarea sample file.

Download a sample file for geoarea data.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
Unique identifier of the company
application_id
string
Required
Unique identifier of the sales channel.
Response
200
Successful response
Examples
Parameters
company_id:
123
application_id:
"628dcf139de85c83dc0249c0"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/geoareas/regions/bulk/sample
Loading...
Response
Loading...
GET

Download Sample Delivery Zone Product Type file.

Download a sample file for Delivery Zone with specified product type column (i.e. category, department, Item IDs or tags).
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a company.
application_id
string
Required
Unique identifier of the sales channel.
product_type
string
Required
It denotes the attribute of the product
Enum
Response
200
422
Successful response
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
product_type:
"department"
GET
/service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones/bulk/sample/{product_type}
Loading...
Response
Loading...

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
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/priority
# Update Store Rule priority
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
DEL
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
# Delete store rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}/details
# Get store rule Details
GET

Get store rule configuration

Retrieves information about the order routing setup for a single application
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Response
200
400
Successful Response
StoreRuleConfigData
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
Examples
Parameters
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
page_no
integer
page_size
integer
status
string
Enum
Response
200
Successful Response
GetStoreRulesApiResponseSchema
items
array of object (StoreRuleDataSchema)
Array of StoreRuleDataSchema
id
string
name
string
company_id
integer
application_id
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
meta_conditions
object
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
page_no:
1
page_size:
10
status:
"true"
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
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
name
string
is_active
boolean
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
Required
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
manual_priority
array of integer
sort
array of string
Response
200
400
Response status_code
StoreRuleResponseSchema
id
string
name
string
type
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
Loading...
Response
Loading...
PUT

Update Store Rule priority

Update Store Rule priority
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_id
string
Required
priority
integer
Required
Response
200
400
Response status_code
RulePriorityResponseSchema
success
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c185789"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/priority
Loading...
Response
Loading...
GET

Get store rule

Retrieves a single rule within the order routing rules
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular rule object.
Response
200
400
Successful Response
StoreRuleDataSchema
id
string
name
string
company_id
integer
application_id
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
meta_sort_priority
object
meta_conditions
object
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"65002524f0531e73892a788e"
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular rule object.
Request body
name
string
is_active
boolean
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
Required
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
Required
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
manual_priority
array of integer
sort
array of string
Response
200
400
Response status_code
StoreRuleUpdateResponseSchema
id
string
name
string
type
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRuleV2)
LocationRuleV2
type
string
includes
array of object (LocationRuleValuesV2)
Array of LocationRuleValuesV2
id
string
sub_type
string
display_name
string
parent_uid
string
parent_id
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
company_id
integer
application_id
string
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"65002524f0531e73892a788e"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...
DEL

Delete store rule

Delete a single store rule
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular rule object.
Response
200
400
Response status_code
StoreRuleDeleteResponseSchema
message
string
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"64f93a5bade6f8c4c5b89012"
DEL
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...
GET

Get store rule Details

Retrieves details of a order routing rule.
Requires application/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a company.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uid
string
Required
A `rule_uid` is a unique identifier for a order routing rule.
Response
200
400
Successful Response
StoreRuleDataDetailsSchema
id
string
name
string
company_id
integer
application_id
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
integer
name
string
sort
array of string
manual_priority
array of integer
conditions
object (StoreRuleConditionDetailSchema)
StoreRuleConditionDetailSchema
department_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
category_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
brand_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
to_location
object (StoreRuleLocationDetailSchema)
StoreRuleLocationDetailSchema
includes
array of object (StoreLocationDetail)
Array of StoreLocationDetail
uid
string
display_name
string
sub_type
string
parent_id
string
Nullable
parent_uid
string
Nullable
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperationsV2)
ArithmeticOperationsV2
lt
string
gt
string
lte
string
gte
string
zone_ids
object (RuleResponseStringDetail)
RuleResponseStringDetail
includes
array of object (RuleConditionStringDetail)
Array of RuleConditionStringDetail
text
string
Nullable
value
string
Nullable
stage
boolean
Nullable
company_ids
object (RuleResponseIntegerDetail)
RuleResponseIntegerDetail
includes
array of object (RuleConditionIntegerDetail)
Array of RuleConditionIntegerDetail
text
string
Nullable
value
integer
Nullable
stage
boolean
Nullable
is_active
boolean
meta_sort_priority
object
Nullable
meta_conditions
object
Nullable
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"65002524f0531e73892a788e"
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}/details
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).
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
pincodes
array of integer
Required
country
string
Required
action
string
Required
Enum
Response
200
400
Response Data
PincodeMOPresponseSchema
batch_id
string
success
boolean
status_code
integer
country
string
action
string
pincodes
array of integer
updated_pincodes
array of object (PincodeMopUpdateResponseSchema)
Array of PincodeMopUpdateResponseSchema
pincode
integer
channel_id
string
country
string
is_active
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
batch_id
string
s3_url
string
Required
Response
200
400
Response Data
PincodeBulkViewResponseSchema
batch_id
string
s3_url
string
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
country
string
Default Value : INDIA
is_active
boolean
Default Value : true
pincode
integer
Nullable
current
integer
Default Value : 1
page_size
integer
Default Value : 100
Response
200
Response Data
PincodeCodStatusListingResponseSchema
country
string
data
array of object (PincodeCodDataSchema)
Array of PincodeCodDataSchema
pincode
string
active
boolean
success
boolean
errors
array of object (Error)
Array of Error
type
string
Nullable
value
string
Nullable
message
string
Nullable
page
object (PincodeCodStatusListingPage)
PincodeCodStatusListingPage
type
string
has_next
boolean
item_total
integer
size
integer
current
integer
summary
object (PincodeCodStatusListingSummary)
PincodeCodStatusListingSummary
total_active_pincodes
integer
total_inactive_pincodes
integer
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
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.
Requires application/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
entity_type
string
Required
file_name
string
Response
200
Response Data
PincodeMopUpdateAuditHistoryResponseData
entity_type
string
page
object (PincodeMopUpdateAuditHistoryPaging)
PincodeMopUpdateAuditHistoryPaging
type
string
size
integer
current
integer
has_next
boolean
item_total
integer
data
array of object (PincodeMopUpdateAuditHistoryResponseSchema)
Array of PincodeMopUpdateAuditHistoryResponseSchema
batch_id
string
entity_type
string
error_file_s3_url
string
s3_url
string
file_name
string
updated_at
string
| date-time
updated_by
string
success
boolean
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history
Loading...
Response
Loading...