Serviceability
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
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
# Update courier rule
GET
# Get courier rule
POST
# Create courier rule
GET
# Get courier rules
PUT
# Apply configuration to an application
GET
# Get delivery configuration
PATCH
# To patch any config which can be applied to application
PUT
# Update courier partner rule priority
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
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
The unique identifier for the courier partner extension.
account_id
string
Required
The unique identifier for the courier partner account.
name
string
Required
Name for the courier partner rule.
manual_priority
array of string
Required
Has the list of courier partner account Ids that are to be given priority.
filters
string
Required
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Enum
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Indicates whether the courier partner rule is currently active.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
manual_priority
array of string
Has the list of courier partner accounts that are to be given priority.
filters
string
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Specifies the sorting preference for courier partners based on the rule (e.g., fastest or custom).
Enum
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
name
string
The name of the courier partner rule.
type
string
The type of the courier partner rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
A list of courier partner schemes associated with this rule.
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 (CourierPartnerSchemeDetailsModel)
CourierPartnerSchemeDetailsModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
stage
string
Represents the current stage of the courier partner account (e.g., active, inactive, etc.).
Examples
Parameters
company_id:
1
application_id:
"64b510aa3e4268a2946fd3da"
rule_uid:
"675ee1819e570ecacfda8c29"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel
rule_uid
string
Required
Unique identifier of the courier partner rule
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Indicates whether the courier partner rule is currently active.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
manual_priority
array of string
Has the list of courier partner accounts that are to be given priority.
filters
string
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Specifies the sorting preference for courier partners based on the rule (e.g., fastest or custom).
Enum
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
name
string
The name of the courier partner rule.
type
string
The type of the courier partner rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
A list of courier partner schemes associated with this rule.
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 (CourierPartnerSchemeDetailsModel)
CourierPartnerSchemeDetailsModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
stage
string
Represents the current stage of the courier partner account (e.g., active, inactive, etc.).
Examples
Parameters
company_id:
1
application_id:
"64b510aa3e4268a2946fd3da"
rule_uid:
"675ee1819e570ecacfda8c29"
Was this section helpful?
GET
Response
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
The unique identifier for the courier partner extension.
account_id
string
Required
The unique identifier for the courier partner account.
name
string
Required
Name for the courier partner rule.
manual_priority
array of string
Required
Has the list of courier partner account Ids that are to be given priority.
filters
string
Required
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Enum
Response
200
400
Success
CourierPartnerRuleResult
is_active
boolean
Indicates whether the courier partner rule is currently active.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
manual_priority
array of string
Has the list of courier partner accounts that are to be given priority.
filters
string
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Specifies the sorting preference for courier partners based on the rule (e.g., fastest or custom).
Enum
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
name
string
The name of the courier partner rule.
type
string
The type of the courier partner rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
A list of courier partner schemes associated with this rule.
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 (CourierPartnerSchemeDetailsModel)
CourierPartnerSchemeDetailsModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
stage
string
Represents the current stage of the courier partner account (e.g., active, inactive, etc.).
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
Unique identifier of the company.
application_id
string
Required
Unique Identifier of sales channel.
page_no
integer
| value >= 1
The current page number for paginated results.
Default Value : 1
page_size
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
status
string
Filter rules based on rule status
Enum
Response
200
Success
CourierPartnerRulesListResult
items
array of object (CourierPartnerRuleResult)
Array of courier partner rule results.
Array of CourierPartnerRuleResult
is_active
boolean
Indicates whether the courier partner rule is currently active.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
manual_priority
array of string
Has the list of courier partner accounts that are to be given priority.
filters
string
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Enum
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
reverse
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
sort
array of string
Specifies the sorting preference for courier partners based on the rule (e.g., fastest or custom).
Enum
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_on
string
| date-time
The timestamp when the record last modified.
name
string
The name of the courier partner rule.
type
string
The type of the courier partner rule.
cp_list
array of object (CourierPartnerRuleCPListResult)
A list of courier partner schemes associated with this rule.
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 (CourierPartnerSchemeDetailsModel)
CourierPartnerSchemeDetailsModel
extension_id
string
Unique identifier of courier partner extension.
scheme_id
string
Unique identifier for the scheme, used to fetch or modify scheme details.
name
string
Name of the scheme.
weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
Specifies a less than operation, comparing values smaller than the provided value.
gt
integer
Nullable
Specifies a greater than operation, comparing values larger than the provided value.
lte
integer
Nullable
Specifies a less than or equal to operation, comparing values smaller than or equal to the provided value.
gte
integer
Nullable
Specifies a greater than or equal to operation, comparing values larger than or equal to the provided value.
transport_type
string
Mode of transport associated with the courier partner scheme.
Enum
region
string
Serviceable region associated with the courier partner scheme.
Enum
delivery_type
string
Type of delivery associated with the courier partner scheme.
Enum
payment_mode
array of string
Mode of payment associated with the courier partner scheme.
Enum
stage
string
Indicates if the courier partner scheme is currently active or inactive.
Enum
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
ndr_attempts
integer
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
Indicates if the courier partner offers doorstep quality check services.
qr
boolean
Specifies whether the courier partner supports QR code-based operations.
mps
boolean
Denotes if the courier partner supports multi-part shipment services.
ndr
boolean
Indicates if the Non-Delivery Report (NDR) feature is supported by the courier partner.
ndr_attempts
integer
Number of attempts allowed for resolving Non-Delivery Reports (NDR).
dangerous_goods
boolean
Specifies if the courier partner handles the transportation of dangerous goods.
fragile_goods
boolean
Indicates whether the courier partner manages the shipment of fragile goods.
restricted_goods
boolean
Indicates if the courier partner handles restricted goods, as per regulatory guidelines.
cold_storage_goods
boolean
Denotes if the courier partner provides cold storage facilities for goods.
doorstep_exchange
boolean
Indicates if the courier partner supports doorstep exchange services.
doorstep_return
boolean
Specifies if the courier partner offers doorstep return services.
product_installation
boolean
Indicates if the courier partner provides product installation services upon delivery.
openbox_delivery
boolean
Specifies whether the courier partner supports open-box delivery, allowing customers to inspect goods before accepting.
status_updates
string
Describes the type of status updates provided by the courier partner (e.g., real-time, periodic).
multi_pick_single_drop
boolean
Indicates if the courier partner supports multiple pickups to a single drop location.
single_pick_multi_drop
boolean
Indicates whether the courier partner supports single pickup to multiple drop locations.
multi_pick_multi_drop
boolean
Denotes if the courier partner offers services for multiple pickups to multiple drop locations.
ewaybill
boolean
Specifies if the courier partner requires or supports the generation of e-waybills for shipments.
qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a quality check shipment.
non_qc_shipment_item_quantity
integer
Nullable
Defines the maximum quantity of items allowed in a non-quality check shipment.
stage
string
Represents the current stage of the courier partner account (e.g., active, inactive, etc.).
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
page_no:
1
page_size:
1
status:
"true"
Was this section helpful?
GET
Response
Apply configuration to application to set DP rules and Zone configuration
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
A list of rule Ids to be applied in the configuration.
sort
array of string
A list of sorting methods, including options for 'fastest' and 'manual_priority'.
Enum
manual_priority
array of string
A list of manually prioritized items in the configuration.
Response
200
400
Response status_code
ApplicationConfigPut
rule_ids
array of string
A list of rule Ids associated with the configuration.
sort
array of string
Specifies the sorting preference for courier partners based on the rule (e.g., fastest or custom).
Enum
manual_priority
array of string
Has the list of courier partner accounts that are to be given priority.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
Was this section helpful?
PUT
Response
This API returns all the Application config that has been applied to the given company and application.
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.
ApplicationConfigGetResult
zones
object (ZoneConfig)
Deprecated
ZoneConfig
serviceability_type
string
Specifies the type of serviceability for the zone.
active_count
integer
The number of active zones.
total_count
integer
The total number of zones.
courier_partner_config
object (CourierPartnerConfig)
CourierPartnerConfig
rule_ids
array of string
A list of rule Ids applied for courier partner selection.
sort
array of string
A list of sorting methods, with options like 'fastest' and 'manual_priority'.
Enum
manual_priority
array of string
A list of items to be manually prioritized for courier partner selection.
buybox_rule_config
object (BuyboxRuleConfig)
BuyboxRuleConfig
store_type_priority
array of string
A list of store types prioritized for the buybox selection.
store_tag_priority
array of string
A list of store tags prioritized for the buybox selection.
sort
array of string
A list of sorting methods, including options for 'fastest' and 'manual_priority'.
Enum
promise_types
array of object (PromiseType)
A list of promise types available in the application.
Array of PromiseType
display_name
string
The name displayed for the promise type.
slug
string
A unique identifier for the promise type.
description
string
A brief description of the promise type.
is_active
boolean
Indicates whether the promise type is active.
is_default
boolean
Indicates whether the promise type is set as default.
is_all_dps_considered
boolean
Indicates whether all delivery points (DPs) are considered for the promise type.
promise_config
object (PromiseConfig)
PromiseConfig
store_attributes
object (StorePromiseAttributeConfig)
StorePromiseAttributeConfig
is_operational_timing_enabled
boolean
Indicates whether operational timing is enabled for the store.
is_order_acceptance_timing_enabled
boolean
Indicates whether order acceptance timing is enabled for the store.
is_average_processing_time
boolean
Indicates whether average processing time is considered in the promise calculations.
is_holiday_enabled
boolean
Indicates whether holidays are considered in the promise calculations.
delivery_service_attributes
object (DeliveryServiceAttributeConfig)
DeliveryServiceAttributeConfig
is_pickup_cutoff_time_enabled
boolean
Indicates whether the pickup cutoff time is enabled.
is_service_tat_enabled
boolean
Indicates whether the service turnaround time (TAT) is enabled.
is_holiday_enabled
boolean
Indicates whether holidays are considered in delivery calculations.
is_all_dps_considered
boolean
Indicates whether all delivery points (DPs) are considered for the promise type.
buffer_field
object (BufferField)
BufferField
unit
string
The unit of measurement for the buffer field.
Enum
value
integer
The numerical value of the buffer field.
enabled
boolean
Indicates whether the buffer field is enabled.
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
Was this section helpful?
GET
Response
Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples
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
A list of rule Ids applied for courier partner selection.
sort
array of string
A list of sorting methods, with options like 'fastest' and 'manual_priority'.
Enum
manual_priority
array of string
A list of items to be manually prioritized for courier partner selection.
buybox_rule_config
object (BuyboxRuleConfig)
BuyboxRuleConfig
store_type_priority
array of string
A list of store types prioritized for the buybox selection.
store_tag_priority
array of string
A list of store tags prioritized for the buybox selection.
sort
array of string
A list of sorting methods, including options for 'fastest' and 'manual_priority'.
Enum
promise_config
object (PromiseConfig)
PromiseConfig
store_attributes
object (StorePromiseAttributeConfig)
StorePromiseAttributeConfig
is_operational_timing_enabled
boolean
Indicates whether operational timing is enabled for the store.
is_order_acceptance_timing_enabled
boolean
Indicates whether order acceptance timing is enabled for the store.
is_average_processing_time
boolean
Indicates whether average processing time is considered in the promise calculations.
is_holiday_enabled
boolean
Indicates whether holidays are considered in the promise calculations.
delivery_service_attributes
object (DeliveryServiceAttributeConfig)
DeliveryServiceAttributeConfig
is_pickup_cutoff_time_enabled
boolean
Indicates whether the pickup cutoff time is enabled.
is_service_tat_enabled
boolean
Indicates whether the service turnaround time (TAT) is enabled.
is_holiday_enabled
boolean
Indicates whether holidays are considered in delivery calculations.
is_all_dps_considered
boolean
Indicates whether all delivery points (DPs) are considered for the promise type.
buffer_field
object (BufferField)
BufferField
unit
string
The unit of measurement for the buffer field.
Enum
value
integer
The numerical value of the buffer field.
enabled
boolean
Indicates whether the buffer field is enabled.
Response
200
404
Response status_code
ApplicationConfigPatchResult
success
boolean
Whether operation was successful.
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
Was this section helpful?
PATCH
Response
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
A string that uniquely identifies the rule.
priority
integer
Required
An integer representing the priority level assigned to the rule.
Response
200
400
Success
RulePriorityResult
success
boolean
Whether operation was successful.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
Was this section helpful?
PUT
Response
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
# 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
A string indicating the 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
A string indicating the 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 (CPShipments)
List of shipments.
Array of CPShipments
id
string
A string serving as the unique identifier.
location_id
number
Unique identifier of the selling location.
location_tags
array of string
Tags associated with the selling location.
shipment_weight
number
Weight(grams) of the shipment.
shipment_volumetric_weight
number
Volumetric weight(grams) 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.
is_default
boolean
If the dimensions are default.
unit
string
Measurement unit for dimensions.
courier_partner_schemes
array of string
A List of courier schemes.
location_type
string
Type of that particular location.
articles
array of object (ShipmentsArticles)
List of articles in the shipment.
Array of ShipmentsArticles
id
string
A string serving as the unique identifier.
item_id
integer
The Item Id of the article.
sla
string
Gives sla for that article.
tags
array of string
Tags assigned to Item.
size
string
The size of the article.
group_id
string
The group Id of the article.
weight
object (ArticleWeight)
ArticleWeight
shipping
integer
Required
The weight(grams) of the article for shipping purposes, typically measured in a specified unit.
unit
string
Required
The unit of measurement used for the weight value.
is_default
boolean
Required
A boolean indicating whether this weight is the default weight for the article.
attributes
object (ArticleAttributes)
ArticleAttributes
battery_operated
string
Required
Yes/no indicating whether the article is powered by batteries.
is_flammable
string
Required
Yes/no indicating whether the article is considered flammable or poses a fire hazard.
category_id
integer
The category Id of the article.
department_id
integer
The Department Id of the article.
dimension
object (ArticleDimension)
ArticleDimension
height
number
Required
The height of the article.
is_default
boolean
Required
A boolean indicating whether this dimension is the default dimension.
length
number
Required
The length of the article.
unit
string
Required
The unit of measurement used for the dimensions.
width
number
Required
The width of the article.
price
number
Final Price of the article after discounts.
brand_id
integer
The brand Id of the article.
quantity
integer
The quantity of the article.
manufacturing_time
integer
The manufacturing time of the article.
manufacturing_time_unit
string
The unit of measurement for manufacturing time.
mto_quantity
integer
The Made to Order quantity of the article.
is_gift
boolean
A boolean indicating whether the article is a gift.
is_set
boolean
A boolean indicating whether the article is a set.
set
object (ArticleSet)
ArticleSet
name
string
The name of the article set.
quantity
integer
The quantity of the article set.
size_distribution
object (ArticleSizeDistribution)
ArticleSizeDistribution
sizes
array of object (SetSize)
Required
A collection of different size options and their corresponding pieces.
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Required
The number of pieces in the set.
size
string
Required
The size description of the set.
set_quantity
integer
The quantity of the article set.
delivery_slots
object (ArticleDeliverySlots)
ArticleDeliverySlots
delivery_date
string
| date-time
The delivery date for the article.
min_slot
string
The minimum delivery time slot.
max_slot
string
The maximum delivery time slot.
return_reason
object (ArticleReturnReason)
ArticleReturnReason
qc_type
array of string
List of strings representing the return reason values, such as doorstep or pre-delivery quality checks.
Enum
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)
List of courier partners available for 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
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
shipments
array of object (ShipmentCourierPartners)
List of shipment details associated with courier partners.
Array of ShipmentCourierPartners
id
string
A string serving as the unique identifier.
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
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
delivery_promise
object (CourierPartnerPromise)
CourierPartnerPromise
min
string
| date-time
Minimum courier partner delivery promise time.
max
string
| date-time
Maximum courier partner delivery promise time.
attributes
object (CourierPartnerAttributes)
CourierPartnerAttributes
tat
object (CourierPartnerTAT)
CourierPartnerTAT
min
integer
Minimum turnaround time.
max
integer
Maximum turnaround time.
Examples
Parameters
company_id:
1
application_id:
"65f467177f066cb22e159e8f"
body:
body
Was this section helpful?
POST
Response
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
# Create zone
GET
# Get zones
GET
# Get zone details
PATCH
# Update details of a Zone to enable or disable
DEL
# Delete a Specific Zone
POST
# Create Bulk Export of Zones
GET
# Get Bulk Export of Zones
POST
# Creation of GeoArea
GET
# Get all geoareas in the current application
GET
# Get details of the specific geoarea
PUT
# Update the details of existing GeoArea
POST
# Bulk Creation of GeoArea Regions
GET
# Get status of GeoAreas created in bulk
PUT
# Update geoareas and their associated regions in bulk
POST
# Create job for exporting Geoarea regions
GET
# Get status of Geoarea export job
GET
# Download geoarea sample file
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
Indicates whether the zone is active or not.
slug
string
Required
Slug or URL-friendly version of the zone name.
name
string
Required
Name of the zone.
company_id
integer
Required
Identifier of the company associated with the zone.
application_id
string
Required
Identifier for the application related to the zone.
geo_areas
array of string
Required
List of geographical areas associated with the zone.
stores
object (ZoneStores)
Required
ZoneStores
type
object
Required
Type of zone store.
values
object
Required
List of store Ids associated with the zone.
product
object (ZoneProduct)
Required
ZoneProduct
type
object
Required
Type of zone product.
values
object
Required
List of product Ids or identifiers for the zone.
Response
200
400
Response status_code
ZoneSchema
name
Undefined Type
Name of the zone.
slug
Undefined Type
Slug identifier for the zone.
company_id
Undefined Type
Id of the company that owns the zone.
application_id
Undefined Type
Application Id associated with the zone.
is_active
Undefined Type
Whether the zone is active or not.
geo_areas
Undefined Type
List of geographical areas associated with the zone.
stores
Undefined Type
List of stores in the zone, referencing a schema for list view products.
product
Undefined Type
List of products in the zone, referencing a schema for list view products.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
stage
Undefined Type
Current stage of the zone.
zone_id
Undefined Type
Unique identifier for the zone.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Was this section helpful?
POST
Response
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
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
Used to search for matching results based on the provided input.
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.
Response
200
400
Zone List of application in descending order of their last modified date.
ListViewSchema
items
array of object (ListViewItems)
List of zone items, each representing a zone's details.
Array of ListViewItems
zone_id
string
Unique identifier for the zone.
name
string
Name of the zone.
geo_areas
array of object (GeoArea)
Array of geographical areas associated with the zone.
Array of GeoArea
id
string
Unique identifier for the geographical area.
type
string
Type of the geographical area.
name
string
Name of the geographical area.
slug
string
Slug for the zone.
stores
object (ListViewProduct)
ListViewProduct
type
string
Type of the product in the zone.
values
array of string
List of values representing the products in the zone.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_active
boolean
Indicates if the zone is active.
product
object (ListViewProduct)
ListViewProduct
type
string
Type of the product in the zone.
values
array of string
List of values representing the products in the zone.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
integer
Unique identifier for the company.
application_id
string
Unique identifier for the application.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
stage
string
Current stage of the zone.
Enum
summary
object (Summary)
Summary
stores_count
integer
Count of stores in the summary.
products_count
integer
Count of products in the summary.
regions
array of object (RegionSchema)
Array of regions included in the summary.
Array of RegionSchema
name
string
Name of the region.
count
integer
Count of items in the region.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
stage:
"completed"
page_size:
10
page_no:
1
is_active:
true
q:
"zone"
country_iso_code:
"IN"
pincode:
"500060"
state:
"MAHARASTRA"
city:
"MUMBAI"
sector:
"ABU_DHABI"
Was this section helpful?
GET
Response
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
Unique identifier for the zone.
name
string
Name of the zone.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
is_active
boolean
Indicates whether the zone is currently active.
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
List of values representing the products or the type of products selected for the delivery zone.
oneOf Schema from below
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
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
stage
string
Current stage/status of the zone.
overlapping_file_url
string
Nullable
URL for the file with overlapping zones (if applicable).
geo_areas
array of string
List of geographical areas associated with the zone.
overlapping_zone_names
array of string
List of names of zones that overlap with this one.
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b0"
application_id:
"64aec5a93a079bd328537835"
Was this section helpful?
GET
Response
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
The unique identifier of the zone to be updated.
name
string
The name of the zone.
type
string
The type of the zone.
Enum
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
geo_areas
array of string
List of geographical areas associated with the zone.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
is_active
boolean
Indicates whether the zone is active.
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
List of values representing the products or the type of products selected for the delivery zone.
oneOf Schema from below
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
ZoneUpdateSuccessResult
name
string
The updated name of the zone.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
is_active
boolean
Indicates whether the zone is active after the update.
geo_areas
array of string
Updated list of geographical areas associated with the zone.
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
List of values representing the products or the type of products selected for the delivery zone.
oneOf Schema from below
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
The unique identifier of the updated zones.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b0"
application_id:
"64aec5a93a079bd328537835"
body:
body
Was this section helpful?
PATCH
Response
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
ZoneDeleteSuccessResult
message
string
A message indicating the success of the zone deletion.
Examples
Parameters
company_id:
1
zone_id:
"65971d573d51c4dcb94929b9"
application_id:
"64aec5a93a079bd328537836"
Was this section helpful?
DEL
Response
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
object
Placeholder for export data.
Default Value :
Response
200
Response status_code
ZoneBulkExport
batch_id
string
A unique identifier for the performed batch operation.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Was this section helpful?
POST
Response
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
Undefined Type
A list of items related to the zone bulk export.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
batch_id:
"64aec5a93a079bd328537835"
Was this section helpful?
GET
Response
Allows to create and manage GeoAreas, representing groups of geographic regions.
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
Indicates whether the geo area is active or not.
name
string
Required
The name of the geo area.
slug
string
Required
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
type
string
Required
Specifies whether the geo area is for delivery or price purposes.
Enum
areas
array of object (Area)
Required
A list of areas that are part of this geo area.
Array of Area
regions
array of string
A list of region identifiers within the area.
country
string
The country associated with the area.
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
Response
200
400
GeoArea has been created successfully.
GeoAreaResponseBody
name
string
The name of the geo area.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
is_active
boolean
Indicates whether the geo area is active.
areas
array of object (Area)
A list of areas included in the geo area.
Array of Area
regions
array of string
A list of region identifiers within the area.
country
string
The country associated with the area.
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
type
string
Specifies whether the geo area is for price or delivery purposes.
Enum
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
geoarea_id
string
A unique identifier for the geo area.
Examples
Parameters
company_id:
1
application_id:
"65e2d5b3a71cf1bff40723f5"
body:
body
Was this section helpful?
POST
Response
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
Used to search for matching results based on the provided input.
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 (GeoAreaItemResult)
A list of geoarea items returned in the response.
Array of GeoAreaItemResult
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
geoarea_id
string
The unique identifier for the geoarea.
name
string
The name of the geoarea.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
is_active
boolean
Indicates whether the geoarea is active.
region_type
string
Nullable
The type of region (e.g., non-pincode, pincode).
type
string
The type of geoarea.
areas
array of object (AreaExpanded)
A list of areas associated with the geoarea.
Array of AreaExpanded
country
object (Country)
Country
uid
string
A unique identifier for the country.
display_name
string
The display name of the country.
regions
array of object (Region)
Array of regions included in the summary.
Array of Region
uid
string
A string that uniquely identifies the country entity.
display_name
string
A string representing the display name of the region, which is typically used for user-friendly identification.
sub_type
string
A string indicating the subtype of the entity, which is not restricted to a predefined list.
parent_id
array of string
A nullable string that serves as an identifier for the parent entity of the country, if applicable.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
page
object (Page2)
Page2
size
integer
The number of items displayed per page.
item_total
integer
The total number of items across all pages.
type
string
The type of pagination (e.g., number for numbered pagination).
current
integer
The current page number.
has_next
boolean
A boolean indicating if there is a next page of results.
Examples
Parameters
application_id:
"65e2d5b3a71cf1bff40723f5"
company_id:
1
page_size:
10
is_active:
true
page_no:
1
q:
"geoareas"
country_iso_code:
"IN"
state:
"Maharashtra"
city:
"Mumbai"
pincode:
"400603"
sector:
"Abu Dhabi"
Was this section helpful?
GET
Response
This API Returns the data of the specific GeoArea which exists on the platform.
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
GeoAreaDetails
name
string
The name of the geographical area.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
application_id
string
The unique identifier of the application.
company_id
integer
The unique identifier of the company.
geoarea_id
string
A unique identifier for the geoarea.
is_active
boolean
Indicates whether the geoarea is active.
type
string
The type of geoarea (e.g., city, country).
region_type
string
Nullable
The type of region (pincode or non-pincode).
areas
array of object (AreaExpanded)
List of areas associated with the geoarea.
Array of AreaExpanded
country
object (Country)
Country
uid
string
A unique identifier for the country.
display_name
string
The display name of the country.
regions
array of object (Region)
Array of regions included in the summary.
Array of Region
uid
string
A string that uniquely identifies the country entity.
display_name
string
A string representing the display name of the region, which is typically used for user-friendly identification.
sub_type
string
A string indicating the subtype of the entity, which is not restricted to a predefined list.
parent_id
array of string
A nullable string that serves as an identifier for the parent entity of the country, if applicable.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
Examples
Parameters
company_id:
1
geoarea_id:
"659ec3c5959b4db956fd81cf"
application_id:
"64aec5a93a079bd328537835"
Was this section helpful?
GET
Response
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
Indicates whether the geo area is active or not.
name
string
Required
The name of the geo area.
slug
string
Required
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
type
string
Required
Specifies whether the geo area is for delivery or price purposes.
Enum
areas
array of object (Area)
Required
A list of areas that are part of this geo area.
Array of Area
regions
array of string
A list of region identifiers within the area.
country
string
The country associated with the area.
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
Response
200
404
Response status code
GeoAreaPutResponseBody
name
string
Name of the geo area.
geoarea_id
string
Unique identifier for the geo area.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
is_active
boolean
Indicates whether the geo area is active or not.
areas
array of object (Area)
List of areas included within the geo area.
Array of Area
regions
array of string
A list of region identifiers within the area.
country
string
The country associated with the area.
region_type
string
Nullable
Specifies the type of region, either 'pincode' or 'non-pincode'.
type
string
Type of the geo area.
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
created_by
object (CreatedBy)
Nullable
CreatedBy
id
string
Nullable
Identifier of the user or system that created the object.
modified_by
object (ModifiedBy)
Nullable
ModifiedBy
id
string
Nullable
Identifier of the user or system that created the object.
upload_type
string
Specifies whether the geo area was uploaded manually or in bulk.
Enum
Examples
Parameters
company_id:
1
geoarea_id:
"659ec3c5959b4db956fd81cf"
application_id:
"64aec5a93a079bd328537835"
body:
body
Was this section helpful?
PUT
Response
Allows to create and manage GeoAreas, representing groups of geographic regions in bulk.
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
URL of the file for bulk geo area details.
name
string
The name of the geo area.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
type
string
Type of geo area (delivery or price).
Response
200
400
Bulk GeoArea has been created successfully.
BulkGeoAreaResult
geoarea_id
string
Unique identifier for the geo area.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Was this section helpful?
POST
Response
Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk.
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.
BulkGeoAreaGetResult
batch_id
string
A unique identifier for the performed batch operation.
file_path
string
Nullable
Path to the file for the geo area.
total
integer
The total number of records in the batch.
failed
integer
The number of failed records.
error_file_url
string
Nullable
URL for the error file.
action
string
The action taken for the geo area update.
updated_at
string
| date-time
The timestamp when the file was updated.
updated_by
string
The user who updated the file.
type
string
Type of geo area operation (e.g., upload or update).
stage
string
The current stage of the geo area update.
file_url
string
Nullable
URL of the file related to the geo area.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
geoarea_id:
"659ec3c5959b4db956fd81cf"
Was this section helpful?
GET
Response
Update geoarea details and their associated regions through a CSV file in bulk.
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
URL of the file for bulk geo area details.
name
string
The name of the geo area.
slug
string
A slug is a human-readable URL segment, typically generated from a title with special characters removed.
type
string
Type of geo area (delivery or price).
Response
200
400
Bulk GeoArea has been created successfully.
BulkGeoAreaResult
geoarea_id
string
Unique identifier for the geo area.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
geoarea_id:
"659ec3c5959b4db956fd81cf"
body:
body
Was this section helpful?
PUT
Response
Create the job for exporting the regions in Geoarea in CSV format.
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
A unique identifier for the performed batch operation.
Examples
Parameters
company_id:
1
application_id:
"61bc34f2bf3c9b427acc0871"
geoarea_id:
"659ec3c5959b4db956fd81cf"
Was this section helpful?
POST
Response
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
A unique identifier for the performed batch operation.
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
Nullable
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"
Was this section helpful?
GET
Response
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"
Was this section helpful?
GET
Response
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
# Get store rule configuration
POST
# Create store rule configuration
PUT
# Update store rules configuration
GET
# Get store rules
POST
# Create store rule
GET
# Get store rule
PUT
# Update store rule
PUT
# Update Store Rule priority
Retrieves information about the order routing setup for a single application
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
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.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
Was this section helpful?
GET
Response
Creates a order routing setup for an application, which involves updating sorting settings or rule priorities.
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
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.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
Response
200
400
Response status_code
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.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
Was this section helpful?
POST
Response
Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities.
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
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.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
Response
200
400
Response status_code
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.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
page_no
integer
The current page number for paginated results.
page_size
integer
Determines the items to be displayed in a page
status
string
Filter rules based on rule status
Enum
Response
200
Successful Response
GetStoreRulesApiResult
items
array of object (StoreRuleDataSchema)
List of store rule data.
Array of StoreRuleDataSchema
id
string
A string serving as the unique identifier.
name
string
Name of the rule.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of 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.
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
page_no:
1
page_size:
10
status:
"true"
Was this section helpful?
GET
Response
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
Name of the rule.
manual_priority
array of integer
Has the list of stores that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
is_active
boolean
Denotes if the rule is active or not.
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
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
Response status_code
StoreRuleResultSchema
id
string
A string serving as the unique identifier.
name
string
Name of the rule created.
manual_priority
array of integer
Has the list of stores that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
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
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
is_active
boolean
Denotes if the rule is active or inactive.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
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
A string serving as the unique identifier.
name
string
Name of the rule.
manual_priority
array of integer
Has the list of courier partner accounts that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of 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.
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
is_active
boolean
Denotes whether the rule is active or inactive.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"65002524f0531e73892a788e"
Was this section helpful?
GET
Response
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
Name of the rule.
manual_priority
array of integer
Has the list of stores that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
is_active
boolean
Denotes if the rule is active or not.
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
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
Response status_code
StoreRuleUpdateResultSchema
id
string
A string serving as the unique identifier.
name
string
Name of the rule created.
manual_priority
array of integer
Has the list of stores that are to be given priority.
meta_sort_priority
object
Has mapping for the store custom fields and its values for basic prioritization.
meta_conditions
object
Has mapping for the store custom fields and its values. for conditions
filters
string
Denotes weather specific filters are applied to stores or all stores are considered.
Enum
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
Array of integer values to be included in the comparison.
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
to_location
object (LocationRule)
LocationRule
type
string
Specifies the type of the location rule (e.g., inclusion, exclusion).
Enum
includes
array of object (LocationRuleValues)
A list of location-based values included in the rule, which could specify particular locations or criteria.
Array of LocationRuleValues
uid
string
Unique identifier for the location.
sub_type
string
Subtype of the location, not restricted to a predefined list.
Enum
name
string
Name of the location.
display_name
string
Display name of the location.
parent_id
array of string
Array of identifiers for the parent of the current locality.
parent_ids
array of string
Array of parent identifiers for the location.
id
string
Unique identifier for the location.
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
The unit of measurement for the radius (e.g., kilometers, miles).
lt
integer
The less-than comparison value for the radius.
lte
integer
The less-than-or-equal comparison value for the radius.
gt
integer
The greater-than comparison value for the radius.
gte
integer
The greater-than-or-equal comparison value for the radius.
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
Array of integer values to be included in the comparison.
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
order_place_date
object (DateOperations)
DateOperations
lt
string
| date-time
Nullable
Less than condition for date.
gt
string
| date-time
Nullable
Greater than condition for date.
lte
string
| date-time
Nullable
Less than or equal to condition for date.
gte
string
| date-time
Nullable
Greater than or equal to condition for date.
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
Array of string values to be included in the comparison.
is_active
boolean
Denotes if the rule is active or inactive.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
rule_uid:
"65002524f0531e73892a788e"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_id
string
Required
A string that uniquely identifies the rule.
priority
integer
Required
An integer representing the priority level assigned to the rule.
Response
200
400
Response status_code
RulePriorityResult
success
boolean
Whether operation was successful.
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c185789"
body:
body
Was this section helpful?
PUT
Response
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
# Update pincode COD support
POST
# Bulk update pincode COD support
POST
# Get COD enabled pincodes
POST
# Get audit trail
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
Whether operation was successful.
status_code
integer
Deprecated
Status code for the response.
batch_id
string
A unique identifier for the performed batch operation.
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
company_id:
1
application_id:
"64b54e711c0570666d5612bb"
body:
body
Was this section helpful?
POST
Response
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
A unique identifier for the performed batch operation.
s3_url
string
Required
CDN url for the uploaded file.
Response
200
400
Success
PincodeBulkViewResult
batch_id
string
A unique identifier for the performed batch operation.
s3_url
string
CDN URL for the uploaded file.
Examples
Parameters
company_id:
"1"
application_id:
"1"
body:
body
Was this section helpful?
POST
Response
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
The current page number for listing.
Default Value : 1
page_size
integer
The number of items per page in the listing.
Default Value : 100
Response
200
Success
PincodeCodStatusListingResult
country
string
Name of the country.
data
array of object (PincodeCodStatusItem)
List of pincode details.
Array of PincodeCodStatusItem
active
boolean
Denoted if the pincode is active or not.
pincode
string
A string indicating the postal code or PIN code of the address area.
success
boolean
Whether operation was successful.
errors
array of object (Error)
List of error object in case of unsuccessful response.
Array of Error
type
string
Nullable
The type of the error.
value
string
Nullable
The value associated with the error.
message
string
Nullable
The error message describing the issue.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
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
company_id:
"1"
application_id:
"0000000000000000000001"
page_number:
1
page_size:
10
body:
body
Was this section helpful?
POST
Response
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.
Enum
file_name
string
Name of the file.
Response
200
400
Success
PincodeMopUpdateAuditHistoryResultData
entity_type
string
Type of the entity requested.
Enum
page
object (PincodeMopUpdateAuditHistoryPaging)
PincodeMopUpdateAuditHistoryPaging
type
string
The type of paging.
size
integer
The size of the page.
current
integer
The current page number.
has_next
boolean
Indicates whether there is another page of results.
item_total
integer
The total number of items in the history.
data
array of object (PincodeMopUpdateAuditHistoryResult)
History records of the uploaded files.
Array of PincodeMopUpdateAuditHistoryResult
batch_id
string
A unique identifier for the performed batch operation.
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
The timestamp when the file was updated.
updated_by
string
The user who updated the file.
success
boolean
Whether operation was successful.
Examples
Parameters
company_id:
"1"
application_id:
"000000000000000000001"
page_number:
1
page_size:
20
body:
body
Was this section helpful?
POST
Response