Serviceability
Manages logistics and shipping, including tracking orders, managing shipments, and calculating shipping costs.
Courier Partner Setup & Rules
Courier partners are organizations that offer delivery services for packages, parcels, documents, or goods. This resource allows sellers to create schemes, which are predefined plans with various preconfigured settings. Sellers can then utilize these schemes to create accounts and choose self-shipping options if desired. Once set up, sellers can utilize these accounts to establish rules based on factors like customer location and product type. These rules assist in efficiently managing delivery partners and prioritizing deliveries based on specific criteria. For example, a seller specializing in furniture can choose self-ship for items that require assembly and assign a partner for other furniture items.
Operations
PUT
# Update courier rule
GET
# Get courier rule
POST
# Create rourier rule
GET
# Get courier rules
PUT
# Update delivery configuration
GET
# Get delivery configuration
PATCH
# Update self ship configuration
GET
# Get self ship configuration
PUT
# Update courier partner rule priority
PUT
Update courier rule
Updates an existing rule within the delivery configuration.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
rule_id
string
Required
A `rule_id` is a unique identifier for a particular Dp.
Request body
is_active
boolean
Required
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
Required
account_id
string
Required
name
string
Required
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Required
Enum
Response
200
400
Response status_code
CourierPartnerRuleResponse
is_active
boolean
application_id
string
company_id
integer
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Enum
created_by
object
Nullable
id
string
modified_by
object
Nullable
modified_on
string
Nullable
name
string
type
string
cp_list
array of object (CourierPartnerRuleCPListResponse)
Array of CourierPartnerRuleCPListResponse
account_id
string
extension_id
string
is_self_ship
boolean
scheme_rules
object
Examples
Parameters
company_id:
1
application_id:
"value"
rule_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update courier rule
updateCourierRule
GET
Get courier rule
Retrieves a single rule within the delivery configuration.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
rule_id
string
Required
A `rule_id` is a unique identifier for a rule.
Response
200
400
Response status_code
CourierPartnerRuleResponse
is_active
boolean
application_id
string
company_id
integer
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Enum
created_by
object
Nullable
id
string
modified_by
object
Nullable
modified_on
string
Nullable
name
string
type
string
cp_list
array of object (CourierPartnerRuleCPListResponse)
Array of CourierPartnerRuleCPListResponse
account_id
string
extension_id
string
is_self_ship
boolean
scheme_rules
object
Examples
Parameters
company_id:
1
application_id:
"value"
rule_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get courier rule
getCourierPartnerRule
POST
Create rourier rule
Creates a rule within the delivery configuration.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
Request body
is_active
boolean
Required
cp_list
array of object (CourierPartnerList)
Array of CourierPartnerList
extension_id
string
Required
account_id
string
Required
name
string
Required
conditions
object (CourierPartnerRuleConditions)
Required
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Required
Enum
Response
200
400
Response status_code
CourierPartnerRuleResponse
is_active
boolean
application_id
string
company_id
integer
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Enum
created_by
object
Nullable
id
string
modified_by
object
Nullable
modified_on
string
Nullable
name
string
type
string
cp_list
array of object (CourierPartnerRuleCPListResponse)
Array of CourierPartnerRuleCPListResponse
account_id
string
extension_id
string
is_self_ship
boolean
scheme_rules
object
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create rourier rule
createCourierPartnerRule
GET
Get courier rules
Retrieve a list of rules within the delivery configuration.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
Unique Identifier of sales channel
page_no
integer
| value >= 1
index of the item to start returning with
Default Value : 1
page_size
integer
| value >= 1
determines the items to be displayed in a page
Default Value : 10
status
string
Filter rules based on rule status
Enum
Response
200
400
Response status_code
CourierPartnerRulesListResponse
items
array of object (CourierPartnerRuleResponse)
Array of CourierPartnerRuleResponse
is_active
boolean
application_id
string
company_id
integer
conditions
object (CourierPartnerRuleConditions)
CourierPartnerRuleConditions
forward
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
reverse
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
payment_mode
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
store_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
shipment_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_cost
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
shipment_volumetric_weight
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
sort
array of string
Enum
created_by
object
Nullable
id
string
modified_by
object
Nullable
modified_on
string
Nullable
name
string
type
string
cp_list
array of object (CourierPartnerRuleCPListResponse)
Array of CourierPartnerRuleCPListResponse
account_id
string
extension_id
string
is_self_ship
boolean
scheme_rules
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"value"
page_no:
1
page_size:
1
status:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get courier rules
getCourierPartnerRules
PUT
Update delivery configuration
Updates an existing delivery setup for an application, which involves updating sorting settings or rule priorities.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier of company.
application_id
string
Required
A `application_id` is a unique identifier of sales channel.
Request body
rule_ids
array of string
sort
array of string
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Response
200
400
Response status_code
ApplicationConfig
rule_ids
array of string
sort
array of string
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update delivery configuration
updateApplicationConfiguration
GET
Get delivery configuration
Retrieves information about the delivery setup for an 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
Response status_code
ApplicationConfig
rule_ids
array of string
sort
array of string
Enum
zones
object (ZoneConfig)
ZoneConfig
serviceability_type
string
Examples
Parameters
company_id:
1
application_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get delivery configuration
getApplicationConfiguration
PATCH
Update self ship configuration
Deprecated
Updates self ship setup for an existing application
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
is_active
boolean
Required
tat
number
Required
Response
200
400
Response Data
ApplicationSelfShipConfigResponse
error
object (ServiceabilityErrorResponse)
ServiceabilityErrorResponse
message
string
value
string
type
string
data
object (ApplicationSelfShipConfig)
ApplicationSelfShipConfig
self_ship
object (SelfShipResponse)
Nullable
SelfShipResponse
is_active
boolean
tat
number
success
boolean
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update self ship configuration
patchApplicationServiceabilitySelfShipment
GET
Get self ship configuration
Retrieves the self ship setup for a single application
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
400
Response Data
ApplicationSelfShipConfigResponse
error
object (ServiceabilityErrorResponse)
ServiceabilityErrorResponse
message
string
value
string
type
string
data
object (ApplicationSelfShipConfig)
ApplicationSelfShipConfig
self_ship
object (SelfShipResponse)
Nullable
SelfShipResponse
is_active
boolean
tat
number
success
boolean
Examples
Parameters
company_id:
"value"
application_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get self ship configuration
getApplicationServiceabilitySelfShipment
PUT
Update courier partner rule priority
Updates a courier partner rule priority 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.
Request body
rule_id
string
Required
priority
integer
Required
Response
200
400
Response status_code
RulePriorityResponse
success
boolean
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update courier partner rule priority
updateCourierPartnerRulePriority
Order Routing Rules
Order routing rules determine how orders are directed to fulfillment centers. Order routing rules helps sellers to optimize fullfilment based on parameters like distance, inventory availability and depth, pricing, shipping cost, store processing efficiency, location type, and tag. For instance, a seller offering electronic goods can implement a rule directing heavy products like refrigerator to warehouses for fulfillment, while lighter items are fulfilled by other stores.
Operations
GET
# 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
GET
Get store rule configuration
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
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Examples
Parameters
company_id:
1
application_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get store rule configuration
getApplicationConfig
POST
Create store rule configuration
Creates a order routing setup for an application, which involves updating sorting settings or rule priorities.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create store rule configuration
insertApplicationConfig
PUT
Update store rules configuration
Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Response
200
400
Response status_code
StoreRuleConfigData
rule_ids
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update store rules configuration
updateStoreRulesConfig
GET
Get store rules
Retrieves an existing 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.
page_no
integer
page_size
integer
status
string
Enum
Response
200
400
Successful Response
GetStoreRulesApiResponse
items
array of object (StoreRuleDataSchema)
Array of StoreRuleDataSchema
id
string
name
string
company_id
integer
application_id
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"value"
page_no:
1
page_size:
1
status:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get store rules
getStoreRules
POST
Create store rule
Create a rule within the order routing rules
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
name
string
is_active
boolean
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
Required
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
Required
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
Response
200
400
Response status_code
StoreRuleResponseSchema
id
string
name
string
type
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)
Array of LocationRuleValues
id
string
sub_type
string
name
string
display_name
string
parent_id
string
parent_ids
array of string
customer_radius
object (CustomerRadiusSchema)
CustomerRadiusSchema
unit
string
lt
integer
lte
integer
gt
integer
gte
integer
store_type
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
product_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
store_tags
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
order_place_date
object (ArithmeticOperations)
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
zone_ids
object (StringComparisonOperations)
StringComparisonOperations
includes
array of string
is_active
boolean
Examples
Parameters
company_id:
1
application_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create store rule
createStoreRules
GET
Get store rule
Retrieves a single rule within the order routing rules
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_id
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uid
string
Required
A `rule_uid` is a unique identifier for a particular rule object.
Response
200
400
Successful Response
StoreRuleDataSchema
id
string
name
string
company_id
integer
application_id
string
type_based_priority
array of string
tag_based_priority
array of string
store_priority
array of object (StorePrioritySchema)
Array of StorePrioritySchema
id
string
name
string
sort
array of string
conditions
object (StoreRuleConditionSchema)
StoreRuleConditionSchema
department_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
category_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
brand_ids
object (IntComparisonOperations)
IntComparisonOperations
includes
array of integer
to_location
object (LocationRule)
LocationRule
type
string
includes
array of object (LocationRuleValues)