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
GET
# Get delivery configuration
PATCH
# To patch any config which can be applied to application
PUT
# Update courier partner rule priority
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique Identifier of sales channel
rule_uidpath
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.
Show
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
Nullable
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Default Value : all
Enum
conditions
object (CourierPartnerRuleConditions)
Required
Show
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Enum
PUT
Response
200
400
Success
Hide
Represents the details of a courier partner rule, including its status, priority, filtering options, and associated conditions and sorting preferences.
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
Nullable
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Default Value : all
Enum
conditions
object (CourierPartnerRuleConditions)
Show
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
Show
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
Show
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.
Show
Response
Update courier rule
updateCourierRule
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique Identifier of sales channel
rule_uidpath
string
Required
Unique identifier of the courier partner rule
GET
Response
200
400
Success
Hide
Represents the details of a courier partner rule, including its status, priority, filtering options, and associated conditions and sorting preferences.
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
Nullable
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Default Value : all
Enum
conditions
object (CourierPartnerRuleConditions)
Show
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
Show
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
Show
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.
Show
Response
Get courier rule
getCourierPartnerRule
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
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.
Show
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
Nullable
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Default Value : all
Enum
conditions
object (CourierPartnerRuleConditions)
Required
Show
sort
array of string
Required
Sort Strategy for the courier partners.
Enum
type
string
Denotes the type of the rule.
Enum
POST
Response
200
400
Success
Hide
Represents the details of a courier partner rule, including its status, priority, filtering options, and associated conditions and sorting preferences.
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
Nullable
Denotes weather specific filters are applied to courier partner accounts or all accounts are considered.
Default Value : all
Enum
conditions
object (CourierPartnerRuleConditions)
Show
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
Show
id
string
A string serving as the unique identifier.
modified_by
object (ModifiedBy)
Nullable
Show
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.
Show
Response
Create courier rule
createCourierPartnerRule
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique Identifier of sales channel.
page_noquery
integer
| value >= 1
The current page number for paginated results.
Default Value : 1
page_sizequery
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
statusquery
string
Filter rules based on rule status
Enum
GET
Response
200
Success
Hide
items
array of object (CourierPartnerRuleResult)
Array of courier partner rule results.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
page_no:
1
page_size:
1
status:
"true"
Response
Get courier rules
getCourierPartnerRules
This API returns all the Application config that has been applied to the given company and application.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier of company.
application_idpath
string
Required
A `application_id` is a unique identifier of a sales channel.
GET
Response
200
400
Success. Returns all the Application configs that are present in the application. It fetches Zones, Courier partner config, Promise config and Buybox rule config. Refer Schema and Examples for more details.
Hide
zones
object (ZoneConfig)
Show
courier_partner_config
object (CourierPartnerConfig)
Show
buybox_rule_config
object (BuyboxRuleConfig)
Show
promise_types
array of object (PromiseType)
A list of promise types available in the application.
Show
promise_config
object (PromiseConfig)
Show
Response
Get delivery configuration
getApplicationConfiguration
Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier of company.
application_idpath
string
Required
A `application_id` is a unique identifier of sales channel.
Request body
courier_partner_config
object (CourierPartnerConfig)
Show
buybox_rule_config
object (BuyboxRuleConfig)
Show
promise_config
object (PromiseConfig)
Show
PATCH
Response
200
404
Response status_code
Hide
success
boolean
Whether operation was successful.
Response
To patch any config which can be applied to application
patchApplicationConfiguration
Updates a courier partner rule priority for a single application
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
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.
PUT
Response
200
400
Success
Hide
success
boolean
Whether operation was successful.
Response
Update courier partner rule priority
updateCourierPartnerRulePriority
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_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
Request body
from_location
object (ShipmentsCourierPartnersServiceability)
Required
Show
to_location
object (ShipmentsCourierPartnersServiceability)
Required
Show
shipments
array of object (CPShipments)
List of shipments.
Show
journey
string
Journey type of the shipment forward or return.
Enum
payment_mode
string
Payment mode opted for the shipment.
Enum
POST
Response
200
400
422
Get courier partner data.
Hide
courier_partners
array of object (CourierPartners)
List of courier partners available for the shipment.
Show
shipments
array of object (ShipmentCourierPartners)
List of shipment details associated with courier partners.
Show
delivery_promise
object (CourierPartnerPromise)
Show
Response
Serviceable Courier Partners
getCourierPartners
Operations
POST
# Get available application courier partners
Retrieves a list of courier partners available for shipping based on serviceability criteria, shipment details, and delivery rules.
Parameters
company_idpath
integer
Required
The ID of the company.
application_idpath
string
Required
The ID of the application.
Request body
to_serviceability
object (LocationDetailsServiceability)
Required
Show
shipments
array of object (CourierPartnerShipments)
Required
A list of shipments for the courier partner request.
Show
journey
string
Required
The journey details for the courier partner request.
payment_mode
string
The payment mode for the courier partner request.
skip_delivery_rules
boolean
This flag decided whether to run delivery rules configuration for delivery rule fetch or not.
POST
Response
200
400
Valid
Hide
Defines the result of generating shipments with courier partner details.
journey
string
Describes the shipment's journey or route.
to_serviceability
object (CourierPartnerToServiceability)
Show
shipments
array of object (CourierPartnerShipments)
List of shipments generated for the courier partner.
Show
payment_mode
string
Specifies the mode of payment for the shipment.
to_city
string
The destination city for the shipment.
is_cod_available
boolean
Indicates if cash on delivery (COD) is available.
Response
Get available application courier partners
getApplicationCourierPartnersList
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
GET
# Download zone products bulk patch sample file
POST
# Create bulk zone products patch job
GET
# Get bulk zone products patch job status
POST
# Atomically add or remove products on zones (concurrency-safe)
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
fulfillment_option_slug
string
Nullable
Slug representing the fulfillment option.
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
The unique identifier of the company.
application_id
string
Required
The unique identifier of the application.
geo_areas
array of string
Required
List of geographical areas associated with the zone.
stores
object (ZoneStores)
Required
Show
product
object (ZoneProduct)
Required
Show
POST
Response
200
400
Response status_code
Hide
Response schema for zone data.
name
Undefined Type
Name of the zone.
fulfillment_option_slug
string
Nullable
Slug representing the fulfillment option.
slug
Undefined Type
Slug identifier for the zone.
company_id
Undefined Type
The unique identifier of the company.
application_id
Undefined Type
The unique identifier of the application.
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
Show
modified_by
object (ModifiedBy)
Nullable
Show
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.
Response
Create zone
createZone
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
stagequery
string
Identifies the specific stage of zone bing requested.
Enum
page_sizequery
integer
| value >= 1
Defines the number of items displayed per page.
Default Value : 10
page_noquery
integer
| value >= 1
Current page number.
Default Value : 1
fulfillment_option_slugquery
string
Slug identifier for filtering by fulfillment option.
is_activequery
boolean
Status of Zone (either active or inactive)
qquery
string
Used to search for matching results based on the provided input.
country_iso_codequery
string
ISO2 code of the country.
pincodequery
string
PIN Code of the country.
statequery
string
State of the country.
cityquery
string
City of the country.
sectorquery
string
Sector name of mentioned address.
GET
Response
200
400
Zone List of application in descending order of their last modified date.
Hide
Represents a paginated list of zones with associated metadata and items.
items
array of object (ListViewItems)
List of zone items, each representing a zone's details.
Show
page
object (Page)
Show
fo_details
object (FoDetails)
Show
Response
Get zones
getZones
Parameters
company_idpath
integer
Required
The unique identifier for the company.
zone_idpath
string
Required
Unique identifier for a particular zone
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
GET
Response
200
400
Get details of the Zone
Hide
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)
Show
stores
object (StoresSchema)
Show
created_by
object (CreatedBy)
Nullable
Show
modified_by
object (ModifiedBy)
Nullable
Show
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.
Response
Get zone details
getZone
Parameters
company_idpath
integer
Required
The unique identifier for the company.
zone_idpath
string
Required
Unique identifier for a particular zone
application_idpath
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)
Show
stores
object (StoresSchema)
Show
PATCH
Response
200
400
Response status_code
Hide
Represents the success result of a zone update operation.
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)
Show
stores
object (StoresSchema)
Show
zone_id
string
The unique identifier of the updated zones.
created_by
object (CreatedBy)
Nullable
Show
modified_by
object (ModifiedBy)
Nullable
Show
created_on
string
| date-time
The timestamp when the record was created.
modified_on
string
| date-time
The timestamp when the record last modified.
Response
Update details of a Zone to enable or disable
updateZone
Parameters
company_idpath
integer
Required
The unique identifier for the company.
zone_idpath
string
Required
Unique identifier for a particular zone
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
DEL
Response
200
400
Response status_code
Hide
Represents the success result for a zone deletion operation.
message
string
A message indicating the success of the zone deletion.
Response
Delete a Specific Zone
deleteZone
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
placeholder
object
Placeholder for export data.
Default Value :
POST
Response
200
Response status_code
Hide
Represents a bulk export of zone data.
batch_id
string
A unique identifier for the performed batch operation.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Response
Create Bulk Export of Zones
createBulkExport
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
batch_idpath
string
Required
A `batch_id` is a unique identifier for a particular zone.
GET
Response
200
Response status_code
Hide
Represents the result of a bulk zone export.
items
Undefined Type
A list of items related to the zone bulk export.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
batch_id:
"64aec5a93a079bd328537835"
Response
Get Bulk Export of Zones
getBulkExport
Allows to create and manage GeoAreas, representing groups of geographic regions.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
The unique identifier for the sales channel.
Request body
is_polygon
boolean
Nullable
Indicates whether geo area is polygon or not.
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.
Show
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
POST
Response
200
400
GeoArea has been created successfully.
Hide
Represents the response body containing geo area information after creation or update.
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.
Show
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
is_polygon
boolean
Nullable
Indicates whether geo area is polygon or not.
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
Show
modified_by
object (ModifiedBy)
Nullable
Show
geoarea_id
string
A unique identifier for the geo area.
Response
Creation of GeoArea
createGeoArea
Parameters
application_idpath
string
Required
A `application_id` is a unique identifier for an application.
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_sizequery
integer
| value >= 1
Determines the items to be displayed in a page
Default Value : 10
is_activequery
boolean
Status of GeoAreas (either active or inactive)
page_noquery
integer
Current page number
typequery
string
To fetch the type of a specific geoarea.
qquery
string
Used to search for matching results based on the provided input.
country_iso_codequery
string
ISO2 code of the country
statequery
string
State name
cityquery
string
City name
pincodequery
string
Pincode value to search geoareas
sectorquery
string
Sector value to search geoareas
GET
Response
200
Successfully retrieved GeoArea.
Hide
items
array of object (GeoAreaItemResult)
A list of geoarea items returned in the response.
Show
page
object (Page2)
Show
Response
Get all geoareas in the current application
getGeoAreas
This API Returns the data of the specific GeoArea which exists on the platform.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
geoarea_idpath
string
Required
A unique identifier for the GeoArea.
application_idpath
string
Required
The unique identifier for the sales channel.
GET
Response
200
404
Response status_code
Hide
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.
is_polygon
boolean
Nullable
Indicates whether geo area is polygon or not.
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.
Show
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
Show
modified_by
object (ModifiedBy)
Nullable
Show
Response
Get details of the specific geoarea
getGeoArea
Parameters
company_idpath
integer
Required
The unique identifier for the company.
geoarea_idpath
string
Required
A unique identifier for the GeoArea.
application_idpath
string
Required
The unique identifier for the sales channel.
Request body
is_polygon
boolean
Nullable
Indicates whether geo area is polygon or not.
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.
Show
region_type
string
Nullable
Defines whether the region is based on pincode or non-pincode.
PUT
Response
200
404
Response status code
Hide
name
string
Name of the geo area.
geoarea_id
string
Unique identifier for the geo area.
is_polygon
boolean
Nullable
Indicates whether geo area is polygon or not.
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.
Show
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
Show
modified_by
object (ModifiedBy)
Nullable
Show
upload_type
string
Specifies whether the geo area was uploaded manually or in bulk.
Enum
Response
Update the details of existing GeoArea
updateGeoArea
Allows to create and manage GeoAreas, representing groups of geographic regions in bulk.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
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).
POST
Response
200
400
Bulk GeoArea has been created successfully.
Hide
Represents the result for bulk geo area processing.
geoarea_id
string
Unique identifier for the geo area.
Response
Bulk Creation of GeoArea Regions
createBulkGeoArea
Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
The unique identifier for the sales channel.
geoarea_idpath
string
Required
A unique identifier for the GeoArea.
GET
Response
200
400
Bulk GeoArea has been fetched successfully.
Hide
Represents the result of a bulk geo area upload operation.
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.
Response
Get status of GeoAreas created in bulk
getBulkGeoArea
Update geoarea details and their associated regions through a CSV file in bulk.
Parameters
company_idpath
integer
Required
Unique identifier for the company
application_idpath
string
Required
Unique identifier for the sales channel
geoarea_idpath
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).
PUT
Response
200
400
Bulk GeoArea has been created successfully.
Hide
Represents the result for bulk geo area processing.
geoarea_id
string
Unique identifier for the geo area.
Response
Update geoareas and their associated regions in bulk
updateBulkGeoArea
Create the job for exporting the regions in Geoarea in CSV format.
Parameters
company_idpath
integer
Required
The unique identifier of the company.
application_idpath
string
Required
The unique identifier of the application.
geoarea_idpath
string
Required
The unique identifier of the Geoarea.
POST
Response
200
The export process was successfully initiated.
Hide
batch_id
string
A unique identifier for the performed batch operation.
Examples
Parameters
company_id:
1
application_id:
"61bc34f2bf3c9b427acc0871"
geoarea_id:
"659ec3c5959b4db956fd81cf"
Response
Create job for exporting Geoarea regions
createGeoAreaExportJob
Parameters
company_idpath
integer
Required
The unique identifier of the company.
application_idpath
string
Required
The unique identifier of the application.
geoarea_idpath
string
Required
The unique identifier of the Geoarea.
GET
Response
200
404
The export status details.
Hide
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.
Response
Get status of Geoarea export job
getGeoAreaExportJobStatus
Parameters
company_idpath
integer
Required
Unique identifier of the company
application_idpath
string
Required
Unique identifier of the sales channel.
GET
Response
200
Successful response
Examples
Parameters
company_id:
123
application_id:
"628dcf139de85c83dc0249c0"
Response
Download geoarea sample file
downloadGeoareaSampleFile
Downloads a CSV sample template file for bulk patching zone products. The template includes headers for zone_id, product_type, products, and action.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
GET
Response
200
Successful response with the CSV sample file.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
Response
Download zone products bulk patch sample file
downloadZoneProductsBulkSampleFile
Initiates a bulk zone products patch operation by accepting a CSV file URL. The file is validated and a background job is created for processing zone product additions or removals.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
file_url
string
Required
URL of the CSV file containing the zone products bulk patch data.
POST
Response
200
400
Response status_code
Hide
Represents a bulk export of zone data.
batch_id
string
A unique identifier for the performed batch operation.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Response
Create bulk zone products patch job
createZoneProductsBulkPatchJob
Retrieves the status and details of a specific bulk zone products patch job by its batch identifier.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
batch_idpath
string
Required
A unique identifier for the bulk zone products patch job.
GET
Response
200
404
Response status_code
Hide
Represents the status and details of a bulk zone products patch job.
batch_id
string
A unique identifier for the performed batch operation.
file_path
string
Nullable
CDN path of the uploaded file.
total
integer
Total number of records in the batch.
failed
integer
Number of failed records in the batch.
error_file_url
string
Nullable
URL to the error file containing details of failed records.
action
string
The action performed during the bulk operation.
Enum
updated_at
string
| date-time
Timestamp when the batch was last updated.
updated_by
string
User who last updated the batch.
type
string
Type of the bulk operation.
Enum
company_id
integer
The unique identifier for the company.
application_id
string
A unique identifier for the sales channel.
stage
string
Current stage of the bulk operation.
Enum
partial
integer
Number of partially processed records.
result_file_url
string
Nullable
URL to the result file after processing is complete.
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
batch_id:
"65f2f36dcf9ffae64b112646"
Response
Get bulk zone products patch job status
getZoneProductsBulkPatchJobStatus
Synchronously adds or removes products on one or more zones. Each item is applied with an atomic MongoDB array operator (`$addToSet` for add, `$pull` for remove) rather than a read-modify-write of the whole product list, so concurrent writes to the same zone never lose each other's changes. `product_type` must match the existing zone's product type. Product ids are not validated against the catalog (this is a synchronous API; callers send already-known ids). Returns a per-item status and a summary; per-item failures (e.g. zone not found, product type mismatch) do not fail the whole request.
Parameters
company_idpath
integer
Required
The unique identifier for the company.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
items
array of object (ZoneProductsAtomicPatchItem)
Required
List of per-zone product patch operations.
Minimum Items : 1
Show
POST
Response
200
400
Per-item results and summary of the atomic products patch.
Hide
Per-item results and roll-up summary of an atomic zone products patch.
items
array of object (ZoneProductsAtomicPatchResultItem)
Show
summary
object (ZoneProductsAtomicPatchSummary)
Show
Examples
Parameters
company_id:
1
application_id:
"64aec5a93a079bd328537835"
body:
body
Response
Atomically add or remove products on zones (concurrency-safe)
patchZoneProductsAtomic
Fulfillment options define the different ways an order can be delivered or collected. These options include home delivery, where the order is shipped to the customer's address, and store-pickup, where the customer picks up the order from a store. Express delivery provides a faster shipping option for urgent orders, while standard delivery follows regular shipping timelines. Businesses can configure these options based on location, availability, and customer preferences to enhance logistics efficiency and customer satisfaction.
Operations
POST
# Create a new fulfillment option
GET
# Retrieve fulfillment options with optional filters.
GET
# Get fulfillment options
DEL
# Delete fulfillment options
PUT
# Update an existing fulfillment option
GET
# Get products for a specific fulfillment option.
GET
# Get stores for a specific fulfillment option.
POST
# Upload bulk fulfillment options.
POST
# Validate bulk fulfillment options.
GET
# Validate bulk fulfillment options.
Creates a new fulfillment option for the specified company and application.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
Request body
name
string
Name of the fulfillment option.
slug
string
Unique identifier for the fulfillment option.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
description
string
Description of the fulfillment option.
is_default
boolean
Whether this is the default fulfillment option.
type
string
Type of fulfillment option.
Enum
status
string
Status of the fulfillment option.
Enum
default_for
object (FulfillmentOptionDefaultFor)
Show
business_unit
array of object (BusinessUnit)
Name of the ordering-channel or business, e.g. storefront, storeos.
Show
fulfillment_stores
object (FulfillmentStores)
Show
products
object (FulfillmentProducts)
Show
cp_schemes
object (CourierPartnerSchemes)
Show
id
string
Unique identifier for the fulfillment option.
POST
Response
200
422
Successful response with fulfillment options
Hide
name
string
Name of the fulfillment option.
slug
string
Unique identifier for the fulfillment option.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
description
string
Description of the fulfillment option.
is_default
boolean
Whether this is the default fulfillment option.
type
string
Type of fulfillment option.
Enum
status
string
Status of the fulfillment option.
Enum
default_for
object (FulfillmentOptionDefaultFor)
Show
business_unit
array of object (BusinessUnit)
Name of the ordering-channel or business, e.g. storefront, storeos.
Show
fulfillment_stores
object (FulfillmentStores)
Show
products
object (FulfillmentProducts)
Show
cp_schemes
object (CourierPartnerSchemes)
Show
id
string
Unique identifier for the fulfillment option.
Response
Create a new fulfillment option
createFulfillmentOption
Fetches fulfillment options for an application. Queryable by product_slug, store_id, and status.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
product_slugquery
string
The unique identifier (slug) of the product.
store_idquery
integer
| value >= 0
The unique identifier of the store.
statusquery
string
Status of the fulfillment option. Must be either `ACTIVE` or `INACTIVE`.
Enum
GET
Response
200
422
Successful response with fulfillment options
Hide
A list of available delivery service options.
items
array of object (FulfillmentOptionItem)
List of fulfillment option items.
Show
Examples
Parameters
Parameters are not required.
Response
Retrieve fulfillment options with optional filters.
getFulfillmentOptionsList
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
slugpath
string
Required
Slug of the fulfillment option for retrieving details.
product_idquery
integer
The unique identifier of the product.
store_idquery
integer
The unique identifier of the store.
GET
Response
200
422
Successful response with fulfillment options
Hide
name
string
Name of the fulfillment option.
slug
string
Unique identifier for the fulfillment option.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
description
string
Description of the fulfillment option.
is_default
boolean
Whether this is the default fulfillment option.
type
string
Type of fulfillment option.
Enum
status
string
Status of the fulfillment option.
Enum
default_for
object (FulfillmentOptionDefaultFor)
Show
business_unit
array of object (BusinessUnit)
Name of the ordering-channel or business, e.g. storefront, storeos.
Show
fulfillment_stores
object (FulfillmentStores)
Show
products
object (FulfillmentProducts)
Show
cp_schemes
object (CourierPartnerSchemes)
Show
id
string
Unique identifier for the fulfillment option.
Response
Get fulfillment options
getFulfillmentOptions
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
slugpath
string
Required
Slug of the fulfillment option for retrieving details.
DEL
Response
200
404
Successful response with fulfillment options
Hide
success
boolean
Indicates if the operation was successful
message
string
Optional message providing additional information about the operation
Response
Delete fulfillment options
deleteFulfillmentOptions
Updates the details of an existing fulfillment option for the specified company and application
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
slugpath
string
Required
Slug of the fulfillment option for retrieving details.
Request body
name
string
Name of the fulfillment option.
slug
string
Unique identifier for the fulfillment option.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
description
string
Description of the fulfillment option.
is_default
boolean
Whether this is the default fulfillment option.
type
string
Type of fulfillment option.
Enum
status
string
Status of the fulfillment option.
Enum
default_for
object (FulfillmentOptionDefaultFor)
Show
business_unit
array of object (BusinessUnit)
Name of the ordering-channel or business, e.g. storefront, storeos.
Show
fulfillment_stores
object (FulfillmentStores)
Show
products
object (FulfillmentProducts)
Show
cp_schemes
object (CourierPartnerSchemes)
Show
id
string
Unique identifier for the fulfillment option.
PUT
Response
200
404
Successful response with fulfillment options
Hide
name
string
Name of the fulfillment option.
slug
string
Unique identifier for the fulfillment option.
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
description
string
Description of the fulfillment option.
is_default
boolean
Whether this is the default fulfillment option.
type
string
Type of fulfillment option.
Enum
status
string
Status of the fulfillment option.
Enum
default_for
object (FulfillmentOptionDefaultFor)
Show
business_unit
array of object (BusinessUnit)
Name of the ordering-channel or business, e.g. storefront, storeos.
Show
fulfillment_stores
object (FulfillmentStores)
Show
products
object (FulfillmentProducts)
Show
cp_schemes
object (CourierPartnerSchemes)
Show
id
string
Unique identifier for the fulfillment option.
Response
Update an existing fulfillment option
putFulfillmentOption
Retrieves products available for a specific fulfillment option in an application.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
slugpath
string
Required
Slug of the fulfillment option for retrieving details.
qquery
string
Query to search product by name.
store_idquery
integer
Required
The unique identifier of the store.
GET
Response
200
400
Successful response with fulfillment options
Hide
items
object (FulfillmentOptionProduct)
Show
page
object (Page)
Show
Response
Get products for a specific fulfillment option.
getFulfillmentOptionProducts
Retrieves stores available for a specific fulfillment option in an application.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
slugpath
string
Required
Slug of the fulfillment option for retrieving details.
qquery
string
Query to search product by name.
GET
Response
200
400
Successful response with fulfillment options
Hide
items
array of object (FulfillmentOptionStore)
List of stores with their details.
Show
page
object (Page)
Show
Response
Get stores for a specific fulfillment option.
getFulfillmentOptionStores
Uploads a bulk list of fulfillment options for an application, allowing multiple fulfillment configurations to be processed at once.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
Request body
file_path
string
The URL of file from which data will be imported.
type
string
Specifies the type of bulk fulfillment request.
Enum
POST
Response
200
400
Successful response with fulfillment options
Hide
request_id
string
Unique identifier for the request.
request
object (FulfillmentOptionValidate)
Show
fulfillment_option_slug
string
Slug representing the fulfillment option.
file_url
string
| uri
URL of the uploaded file.
total
integer
Total number of records processed.
success
integer
Number of successful records.
failed
integer
Number of failed records.
action
string
Action performed in the request.
Enum
updated_at
string
| date-time
Timestamp of the last update.
updated_by
string
Nullable
Identifier of the user who updated the request.
type
string
Type of the bulk import process.
Enum
company_id
integer
The unique identifier of the company.
application_id
string
The unique identifier of the application.
stage
string
Current stage of the import process.
Response
Upload bulk fulfillment options.
uploadBulkFulfillmentOptions
Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
typepath
string
Required
Type of entity being validated (stores or products).
Enum
Request body
store_type
string
Type of store related to fulfillment.
Enum
file_path
string
| uri
URL of the uploaded file.
action
string
Action to be performed, such as import.
type
string
Entity type being processed.
Enum
fulfillment_option_slug
string
Slug representing the fulfillment option.
request
object (FulfillmentOptionValidate)
Show
POST
Response
200
400
Successful response with fulfillment options
Hide
Data for validating a bulk fulfillment option request.
request_id
string
Unique id generated for bulk operation.
Response
Validate bulk fulfillment options.
validateBulkFulfillmentOptions
Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products.
Parameters
company_idpath
integer
Required
Unique identifier of the company.
application_idpath
string
Required
Unique identifier of the sales channel.
bulk_idpath
string
Required
Unique id created by validate api.
GET
Response
200
400
Successful response with fulfillment options
Hide
store_type
string
Type of store related to fulfillment.
Enum
file_path
string
| uri
URL of the uploaded file.
action
string
Action to be performed, such as import.
type
string
Entity type being processed.
Enum
fulfillment_option_slug
string
Slug representing the fulfillment option.
request
object (FulfillmentOptionValidate)
Show
Response
Validate bulk fulfillment options.
getBulkFulfillmentValidationStatus
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_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
GET
Response
200
400
Successful Response
Hide
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.
Show
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
Get store rule configuration
getApplicationConfig
Creates a order routing setup for an application, which involves updating sorting settings or rule priorities.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
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.
Show
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.
POST
Response
200
400
Response status_code
Hide
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.
Show
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
Create store rule configuration
insertApplicationConfig
Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
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.
Show
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.
PUT
Response
200
400
Response status_code
Hide
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.
Show
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
Update store rules configuration
updateStoreRulesConfig
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
page_noquery
integer
The current page number for paginated results.
page_sizequery
integer
Determines the items to be displayed in a page
statusquery
string
Filter rules based on rule status
Enum
GET
Response
200
Successful Response
Hide
items
array of object (StoreRuleDataSchema)
List of store rule data.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
123
application_id:
"6524dac0e2e6dec99c1856da"
page_no:
1
page_size:
10
status:
"true"
Response
Get store rules
getStoreRules
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
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
Nullable
Denotes weather specific filters are applied to stores or all stores are considered.
Default Value : all
Enum
is_active
boolean
Denotes if the rule is active or not.
conditions
object (StoreRuleConditionSchema)
Show
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.
Show
sort
array of string
Criteria on which the selected stores should be sorted.
POST
Response
200
400
Response status_code
Hide
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
Nullable
Denotes weather specific filters are applied to stores or all stores are considered.
Default Value : all
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.
Show
sort
array of string
Criteria on which the selected stores should be sorted.
conditions
object (StoreRuleConditionSchema)
Show
is_active
boolean
Denotes if the rule is active or inactive.
Response
Create store rule
createStoreRules
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uidpath
string
Required
A `rule_uid` is a unique identifier for a particular rule object.
GET
Response
200
400
Successful Response
Hide
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
Nullable
Denotes weather specific filters are applied to stores or all stores are considered.
Default Value : all
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.
Show
sort
array of string
Criteria on which the selected stores should be sorted.
conditions
object (StoreRuleConditionSchema)
Show
is_active
boolean
Denotes whether the rule is active or inactive.
Response
Get store rule
getStoreRule
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
rule_uidpath
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
Nullable
Denotes weather specific filters are applied to stores or all stores are considered.
Default Value : all
Enum
is_active
boolean
Denotes if the rule is active or not.
conditions
object (StoreRuleConditionSchema)
Show
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.
Show
sort
array of string
Criteria on which the selected stores should be sorted.
PUT
Response
200
400
Response status_code
Hide
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
Nullable
Denotes weather specific filters are applied to stores or all stores are considered.
Default Value : all
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.
Show
sort
array of string
Criteria on which the selected stores should be sorted.
conditions
object (StoreRuleConditionSchema)
Show
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.
Response
Update store rule
updateStoreRules
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
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.
PUT
Response
200
400
Response status_code
Hide
success
boolean
Whether operation was successful.
Response
Update Store Rule priority
updateStoreRulePriority
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_idpath
integer
Required
Unique identifier of the company.
application_idpath
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
POST
Response
200
400
Success
Hide
success
boolean
Whether operation was successful.
status_code
integer
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.
Show
Response
Update pincode COD support
updatePincodeMopView
Updates the cash on delivery settings for multiple specified pin codes simultaneously.
Parameters
company_idpath
string
Required
Unique identifier of the company.
application_idpath
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.
POST
Response
200
400
Success
Hide
Represents the result of a bulk pincode view operation.
batch_id
string
A unique identifier for the performed batch operation.
s3_url
string
CDN URL for the uploaded file.
Response
Bulk update pincode COD support
updatePincodeBulkView
Retrieves a list of pincodes along with the count based on whether cash on delivery settings.
Parameters
company_idpath
string
Required
Unique identifier of the company.
application_idpath
string
Required
Unique Identifier of sales channel
page_numberquery
integer
Page number to be fetched.
Default Value : 1
page_sizequery
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
POST
Response
200
Success
Hide
country
string
Name of the country.
data
array of object (PincodeCodStatusItem)
List of pincode details.
Show
success
boolean
Whether operation was successful.
errors
array of object (Error)
List of error object in case of unsuccessful response.
Show
page
object (Page)
Show
summary
object (PincodeCodStatusListingSummary)
Show
Examples
Parameters
company_id:
"1"
application_id:
"0000000000000000000001"
page_number:
1
page_size:
10
body:
body
Response
Get COD enabled pincodes
updatePincodeCoDListing
Parameters
company_idpath
string
Required
Unique identifier of the company.
application_idpath
string
Required
Unique Identifier of sales channel
page_numberquery
integer
Page number to be fetched.
Default Value : 1
page_sizequery
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.
POST
Response
200
400
Success
Hide
Represents the data for pincode MOP update audit history.
entity_type
string
Type of the entity requested.
Enum
page
object (PincodeMopUpdateAuditHistoryPaging)
Show
data
array of object (PincodeMopUpdateAuditHistoryResult)
History records of the uploaded files.
Show
Response
Get audit trail
updatePincodeAuditHistory
Operations
POST
# Create polygon-based serviceability for stores
GET
# Get polygon-based serviceability for stores
PATCH
# Update polygon-based serviceability for stores
Creates polygon-based serviceability regions for one or more stores for quick commerce.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
data
object (StorePolygonServiceabilityRequestData)
Required
Show
POST
Response
200
400
Polygon serviceability has been created successfully.
Hide
Represents the result of processing polygon-based serviceability for one or more stores.
success
boolean
Indicates whether the polygon serviceability operation was successful.
data
array of object (StorePolygonServiceabilityStoreSummary)
List of stores for which polygon serviceability was successfully processed.
Show
errors
array of object (StorePolygonServiceabilityError)
List of errors encountered while processing individual entries, if any.
Show
identifier
string
Unique identifier for the polygon serviceability request.
failed_entries
array of object (StorePolygonServiceabilityError)
List of entries that failed during polygon serviceability processing.
Show
Examples
Parameters
company_id:
38474
application_id:
"66fe4b84985abb28a7b45570"
body:
body
Response
Create polygon-based serviceability for stores
createPolygon
Retrieves polygon-based serviceability configurations for stores for quick commerce.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
page_numberquery
integer
Page number to be fetched.
Default Value : 1
page_sizequery
integer
Determines the items to be displayed in a page
Default Value : 10
GET
Response
200
400
Polygon serviceability list has been fetched successfully.
Hide
Represents the result of fetching polygon-based store serviceability configurations.
success
boolean
Indicates whether the polygon serviceability fetch operation was successful.
data
array of object (StorePolygonServiceabilityStore)
List of stores with their polygon-based serviceability details.
Show
errors
array of object (StorePolygonServiceabilityError)
List of errors encountered while processing individual entries, if any.
Show
identifier
string
Unique identifier for the polygon serviceability request.
failed_entries
array of object (StorePolygonServiceabilityError)
List of entries that failed during polygon serviceability processing.
Show
pagination
object (StorePolygonServiceabilityPagination)
Pagination details for the polygon serviceability result set.
Show
Examples
Parameters
company_id:
38474
application_id:
"66fe4b84985abb28a7b45570"
page_number:
1
page_size:
10
Response
Get polygon-based serviceability for stores
getPolygon
Updates polygon-based serviceability regions for one or more stores for quick commerce.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
application_idpath
string
Required
A `application_id` is a unique identifier for a particular application channel.
Request body
data
object (StorePolygonServiceabilityRequestData)
Required
Show
PATCH
Response
200
400
Polygon serviceability has been updated successfully.
Hide
Represents the result of processing polygon-based serviceability for one or more stores.
success
boolean
Indicates whether the polygon serviceability operation was successful.
data
array of object (StorePolygonServiceabilityStoreSummary)
List of stores for which polygon serviceability was successfully processed.
Show
errors
array of object (StorePolygonServiceabilityError)
List of errors encountered while processing individual entries, if any.
Show
identifier
string
Unique identifier for the polygon serviceability request.
failed_entries
array of object (StorePolygonServiceabilityError)
List of entries that failed during polygon serviceability processing.
Show
Examples
Parameters
company_id:
38474
application_id:
"66fe4b84985abb28a7b45570"
body:
body
Response
Update polygon-based serviceability for stores
updatePolygon
Operations
POST
# Create and return shipments
Parameters
application_idpath
string
Required
Unique identifier of the sales channel.
company_idpath
string
Required
The ID of the company.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
Request body
journey
string
Required
The journey or route for the shipment.
Enum
location_articles
array of object (PlatformLocationArticles)
Required
A list of articles associated with the shipment location, grouped by fulfillment details.
Show
to_serviceability
object (PlatformShipmentsToServiceability)
Required
Show
payment_mode
string
Nullable
The payment mode for the shipment, nullable if not applicable.
Enum
POST
Response
200
400
Valid
Hide
Represents the response schema for a shipment request, including payment mode, journey, destination city, COD availability, and shipment details.
is_cod_available
boolean
Flag indicating whether Cash on Delivery (COD) is available for the shipment.
shipments
array of object (PlatformShipmentsSchema)
List of shipments generated for the courier partner.
Show
Response