Serviceability

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

Courier Partner Setup & Rules

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

Operations
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
# Update courier rule
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
# Get courier rule
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
# Create 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}/configuration
# Update delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
# Get delivery configuration
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
# Update courier partner rule priority
PUT

Update courier rule

Updates an existing rule within the delivery configuration.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
rule_id
string
Required
Unique identifier of the courier partner rule.
Request body
is_active
boolean
Required
Denotes whether the given courier partner rule is inactive or active.
cp_list
array of object (CourierPartnerList)
A list of courier partners.
Array of CourierPartnerList
extension_id
string
Required
Unique identifier of courier partner extension.
account_id
string
Required
Unique identifier of courier partner scheme and company id combination.
name
string
Required
Name for the courier partner rule.
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Denotes whether the given courier partner rule is inactive or active.
Default Value : true
application_id
string
Unique identifier of the sales channel.
company_id
integer
Unique identifier of the company.
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Sort Strategy of the courier partners.
Enum
created_by
object
Nullable
The Fynd account used to create the courier partner rule.
id
string
Unique identifier of the courier partner rule.
modified_by
object
Nullable
The Fynd account used to modify the courier partner rule.
modified_on
string
| date-time
Nullable
The datetime at which courier partner rule is modified.
name
string
Name for the courier partner rule.
type
string
The type of the rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
Array of CourierPartnerRuleCPListResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
extension_id
string
Unique identifier of courier partner extension.
is_self_ship
boolean
Denotes if the account is of self delivery type.
scheme_rules
object
Denotes the scheme rules associated with the courier partner account.
Examples
Parameters
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
Loading...
Response
Loading...
GET

Get courier rule

Retrieves a single rule within the delivery configuration.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
rule_id
string
Required
Unique identifier of the courier partner rule
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Denotes whether the given courier partner rule is inactive or active.
Default Value : true
application_id
string
Unique identifier of the sales channel.
company_id
integer
Unique identifier of the company.
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Sort Strategy of the courier partners.
Enum
created_by
object
Nullable
The Fynd account used to create the courier partner rule.
id
string
Unique identifier of the courier partner rule.
modified_by
object
Nullable
The Fynd account used to modify the courier partner rule.
modified_on
string
| date-time
Nullable
The datetime at which courier partner rule is modified.
name
string
Name for the courier partner rule.
type
string
The type of the rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
Array of CourierPartnerRuleCPListResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
extension_id
string
Unique identifier of courier partner extension.
is_self_ship
boolean
Denotes if the account is of self delivery type.
scheme_rules
object
Denotes the scheme rules associated with the courier partner account.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}
Loading...
Response
Loading...
POST

Create courier rule

Creates a rule within the delivery configuration.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
Request body
is_active
boolean
Required
Denotes whether the given courier partner rule is inactive or active.
cp_list
array of object (CourierPartnerList)
A list of courier partners.
Array of CourierPartnerList
extension_id
string
Required
Unique identifier of courier partner extension.
account_id
string
Required
Unique identifier of courier partner scheme and company id combination.
name
string
Required
Name for the courier partner rule.
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Denotes whether the given courier partner rule is inactive or active.
Default Value : true
application_id
string
Unique identifier of the sales channel.
company_id
integer
Unique identifier of the company.
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Sort Strategy of the courier partners.
Enum
created_by
object
Nullable
The Fynd account used to create the courier partner rule.
id
string
Unique identifier of the courier partner rule.
modified_by
object
Nullable
The Fynd account used to modify the courier partner rule.
modified_on
string
| date-time
Nullable
The datetime at which courier partner rule is modified.
name
string
Name for the courier partner rule.
type
string
The type of the rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
Array of CourierPartnerRuleCPListResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
extension_id
string
Unique identifier of courier partner extension.
is_self_ship
boolean
Denotes if the account is of self delivery type.
scheme_rules
object
Denotes the scheme rules associated with the courier partner account.
Examples
Parameters
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.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel.
page_no
integer
| value >= 1
Index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
status
string
Filter rules based on rule status
Enum
Response
200
400
success
CourierPartnerRulesListResult
items
array of object (CourierPartnerRuleResult)
Array of CourierPartnerRuleResult
is_active
boolean
Denotes whether the given courier partner rule is inactive or active.
Default Value : true
application_id
string
Unique identifier of the sales channel.
company_id
integer
Unique identifier of the company.
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
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)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Sort Strategy of the courier partners.
Enum
created_by
object
Nullable
The Fynd account used to create the courier partner rule.
id
string
Unique identifier of the courier partner rule.
modified_by
object
Nullable
The Fynd account used to modify the courier partner rule.
modified_on
string
| date-time
Nullable
The datetime at which courier partner rule is modified.
name
string
Name for the courier partner rule.
type
string
The type of the rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
Array of CourierPartnerRuleCPListResult
account_id
string
Unique identifier of courier partner scheme and company id combination.
extension_id
string
Unique identifier of courier partner extension.
is_self_ship
boolean
Denotes if the account is of self delivery type.
scheme_rules
object
Denotes the scheme rules associated with the courier partner account.
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.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules
Loading...
Response
Loading...
PUT

Update delivery configuration

Updates an existing delivery setup for an application, which involves updating sorting settings or rule priorities.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel.
Request body
rule_ids
array of string
A list of courier partner rules.
sort
array of string
Strategy adopted to sort the courier partners.
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Serviceability type of the delivery zone.
active_count
integer
Count of active delivery zones associated with the sales channel.
total_count
integer
Count of total delivery zones associated with the sales channel.
Response
200
400
Success
ApplicationConfig
rule_ids
array of string
A list of courier partner rules.
sort
array of string
Strategy adopted to sort the courier partners.
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Serviceability type of the delivery zone.
active_count
integer
Count of active delivery zones associated with the sales channel.
total_count
integer
Count of total delivery zones associated with the sales channel.
Examples
Parameters
Parameters are not required.
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

Retrieves information about the delivery setup for an application
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel.
Response
200
400
Success
ApplicationConfig
rule_ids
array of string
A list of courier partner rules.
sort
array of string
Strategy adopted to sort the courier partners.
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Serviceability type of the delivery zone.
active_count
integer
Count of active delivery zones associated with the sales channel.
total_count
integer
Count of total delivery zones associated with the sales channel.
Examples
Parameters
Parameters are not required.
GET
/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
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_id
string
Required
Rule id whose priority needs to be changed.
priority
integer
Required
New priority of the rule.
Response
200
400
Success
RulePriorityResult
success
boolean
Denotes if the priority of the rule is changes successfully or not.
Examples
Parameters
Parameters are not required.
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority
Loading...
Response
Loading...

Courier Partners

Courier partners are organizations that specialize in providing delivery services for packages, parcels, documents, or goods. They play a crucial role in the logistics and supply chain industry, ensuring that items are transported efficiently and securely from one location to another. These partners may offer a variety of services, including same-day delivery, international shipping, tracking capabilities, and specialized handling for fragile or high-value items. This resource allows to get the courier partners for the shipments.

Operations
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners
# Serviceable Courier Partners.
POST

Serviceable Courier Partners.

Get all the serviceable courier partners of a destination and the shipments.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique identifier of the sales channel.
Request body
from_location
object (ShipmentsCourierPartnersServiceability)
Required
ShipmentsCourierPartnersServiceability
pincode
string
Postal code or PIN code of the address area.
sector_code
string
Specifies the sector or district code of the address if applicable.
state_code
string
Indicates the state or province code of the address.
city_code
string
Denote the city or municipality code of the address.
country_code
string
Required
ISO2 code for the country of the address.
to_location
object (ShipmentsCourierPartnersServiceability)
Required
ShipmentsCourierPartnersServiceability
pincode
string
Postal code or PIN code of the address area.
sector_code
string
Specifies the sector or district code of the address if applicable.
state_code
string
Indicates the state or province code of the address.
city_code
string
Denote the city or municipality code of the address.
country_code
string
Required
ISO2 code for the country of the address.
shipments
array of object (Shipments)
List of shipments.
Array of Shipments
id
string
Unique identifier of the shipment.
location_id
number
Unique identifier of the selling location.
location_tags
array of string
Tags associated with the selling location.
shipment_weight
number
Weight of the shipment.
shipment_volumetric_weight
number
Volumetric weight of the shipment.
shipment_cost
number
Total Cost of the shipment.
shipment_dimension
object (ShipmentDimension)
ShipmentDimension
height
number
Required
Height of the shipment in centimeters.
length
number
Required
Length of the shipment in centimeters.
width
number
Required
Width of the shipment in centimeters.
courier_partner_schemes
array of string
A List of courier schemes.
articles
array of object (ShipmentsArticles)
List of articles in the shipment.
Array of ShipmentsArticles
item_id
integer
Unique identifier of the item.
category_id
integer
Unique identifier of the category.
brand_id
integer
Unique identifier of the brand.
department_id
integer
Unique identifier of the department.
tags
array of string
Tags associated with the item.
journey
string
Journey type of the shipment forward or return.
Enum
payment_mode
string
Payment mode opted for the shipment.
Enum
Response
200
400
422
Get courier partner data.
ShipmentCourierPartnerResult
courier_partners
array of object (CourierPartners)
Array of CourierPartners
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the courier partner.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
The earliest possible timestamp.
max
string
The latest possible timestamp.
shipments
array of object (ShipmentCourierPartners)
Array of ShipmentCourierPartners
id
string
Unique identifier of the shipment.
courier_partners
array of object (CourierPartners)
Courier partners of the shipment.
Array of CourierPartners
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier of courier partner scheme.
name
string
Name of the courier partner.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
The earliest possible timestamp.
max
string
The latest possible timestamp.
Examples
Parameters
Parameters are not required.
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners
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
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
# Get store rule
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
# Update store rule
GET

Get store rule configuration

Retrieves information about the order routing setup for a single application
Parameters
company_id
integer
Required
Unique identifier of the company.
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
List of rule ids which are active in the application.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration
Loading...
Response
Loading...
POST

Create store rule configuration

Creates a order routing setup for an application, which involves updating sorting settings or rule priorities.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
List of rule ids which are active in the application.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Response
200
400
Success
StoreRuleConfigData
rule_ids
array of string
List of rule ids which are active in the application.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Examples
Parameters
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.
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
List of rule ids which are active in the application.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Response
200
400
Success
StoreRuleConfigData
rule_ids
array of string
List of rule ids which are active in the application.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Examples
Parameters
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
Parameters
company_id
integer
Required
Unique identifier of the company.
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
400
Successful Response
GetStoreRulesApiResult
items
array of object (StoreRuleDataSchema)
Array of StoreRuleDataSchema
id
string
Id of the rule.
name
string
Name of the rule.
company_id
integer
Company id for which the rule is created.
application_id
string
Application id for which the rule is created.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Denotes whether the rule is active or inactive.
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.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
Loading...
Response
Loading...
POST

Create store rule

Create a rule within the order routing rules
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
name
string
Name of the rule.
is_active
boolean
Denotes if the rule is active or not.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Response
200
400
Success
StoreRuleResultSchema
id
string
Id of the rule created.
name
string
Name of the rule created.
type
string
Type of the rule created.
type_based_priority
array of string
Priority of the store type to be used in the rule for sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the rule for sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Denotes if the rule is active or inactive.
Examples
Parameters
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules
Loading...
Response
Loading...
GET

Get store rule

Retrieves a single rule within the order routing rules
Parameters
company_id
integer
Required
Unique identifier of the 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 particular rule object.
Response
200
400
Successful Response
StoreRuleDataSchema
id
string
Id of the rule.
name
string
Name of the rule.
company_id
integer
Company id for which the rule is created.
application_id
string
Application id for which the rule is created.
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Denotes whether the rule is active or inactive.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...
PUT

Update store rule

Updates an existing rule within the order routing rules.
Parameters
company_id
integer
Required
Unique identifier of the 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 particular rule object.
Request body
name
string
Name of the rule.
is_active
boolean
Denotes if the rule is active or not.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
type_based_priority
array of string
Priority of the store type to be used in the basic prioritization sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the basic prioritization sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
Response
200
400
Success
StoreRuleUpdateResultSchema
id
string
Id of the rule created.
name
string
Name of the rule created.
type
string
Type of the rule created.
type_based_priority
array of string
Priority of the store type to be used in the rule for sorting of stores.
tag_based_priority
array of string
Priority of the store tags to be used in the rule for sorting of stores.
store_priority
array of object (StorePrioritySchema)
Priority of explicit stores to be used for sorting of stores.
Array of StorePrioritySchema
id
integer
Id of the store.
name
string
Name of the store.
sort
array of string
Criteria on which the selected stores should be sorted.
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 (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
array of string
parent_ids
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 (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Denotes if the rule is active or inactive.
company_id
integer
Company id for which the rule is created.
application_id
string
Application id for which the rule is created.
Examples
Parameters
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}
Loading...
Response
Loading...

Pincode-based Cash on Delivery

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

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

Update pincode COD support

Modify and update views related to pincode MOP (Mode of Payment).
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
Request body
pincodes
array of integer
Required
A list of pincodes.
country
string
Required
Name of the country.
action
string
Required
Denotes wether to activate or deavtivate pincodes for COD mode of payment.
Enum
Response
200
400
Success
PincodeMOPResult
success
boolean
Denotes if the action was successful or not.
status_code
integer
Status code for the response.
batch_id
string
Unique identifier identifying the perticular request.
country
string
Name of the country.
action
string
Denotes wether to activate or deavtivate pincodes for COD mode of payment.
Enum
pincodes
array of integer
List of pincodes.
updated_pincodes
array of object (PincodeMopUpdateResult)
Details of the updated pincodes.
Array of PincodeMopUpdateResult
pincode
integer
Pincode of the region.
channel_id
string
Unique identifier of the sales channel.
country
string
Country name.
is_active
boolean
Denotes whether the pincode mode of payment is active or not.
Examples
Parameters
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.
Parameters
company_id
string
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
Request body
batch_id
string
Required
Unique identifier for the request.
s3_url
string
Required
CDN url for the uploaded file.
Response
200
400
Success
PincodeBulkViewResult
batch_id
string
s3_url
string
CDN url for the uploaded file.
Examples
Parameters
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.
Parameters
company_id
string
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
page_number
integer
Page number to be fetched.
Default Value : 1
page_size
integer
Determines the items to be displayed in a page
Default Value : 100
Request body
country
string
Name of the country.
Default Value : INDIA
is_active
boolean
Search based on the active or inactive flag.
Default Value : true
pincode
integer
Nullable
Search based on the pincode.
current
integer
Default Value : 1
page_size
integer
Default Value : 100
Response
200
400
Success
PincodeCodStatusListingResult
country
string
Name of the country.
data
array of object (PincodeCodStatusListingResult)
List of pincode details.
Array of PincodeCodStatusListingResult
success
boolean
Denotes if the request was successful or not.
errors
array of object (Error)
List of error object in case of unsuccessful response.
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
Count of the total active pincodes.
total_inactive_pincodes
integer
Count of the total inactive pincodes.
Examples
Parameters
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.
Parameters
company_id
string
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
page_number
integer
Page number to be fetched.
Default Value : 1
page_size
integer
Determines the items to be displayed in a page
Default Value : 100
Request body
entity_type
string
Required
Type of the entity requested.
file_name
string
Name of the file.
Response
200
400
Success
PincodeMopUpdateAuditHistoryResultData
entity_type
string
Type of the entity requested.
page
object (PincodeMopUpdateAuditHistoryPaging)
PincodeMopUpdateAuditHistoryPaging
type
string
size
integer
current
integer
has_next
boolean
item_total
integer
data
array of object (PincodeMopUpdateAuditHistoryResult)
History records of the uploaded files.
Array of PincodeMopUpdateAuditHistoryResult
batch_id
string
Uniquie identifier of the request.
entity_type
string
Type of the entity requested.
error_file_s3_url
string
URL for the error file.
s3_url
string
CDN url for the file uploaded.
file_name
string
Name of the file.
updated_at
string
| date-time
updated_by
string
success
boolean
Denotes if the request was successfully processed.
Examples
Parameters
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history
Loading...
Response
Loading...