Serviceability

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

Courier Partner Setup & Rules

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

Operations

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}

# Update courier rule

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}

# Get courier rule

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules

# Create rourier rule

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules

# Get courier rules

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration

# Update delivery configuration

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration

# Get delivery configuration

PATCH

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship

# Update self ship configuration

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship

# Get self ship configuration

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority

# Update courier partner rule priority

PUT

Update courier rule

Updates an existing rule within the delivery configuration.

Parameters

company_id

integer

Required

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

name

string

Required

conditions

object (CourierPartnerRuleConditions)

Required

CourierPartnerRuleConditions

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

sort

array of string

Enum

created_by

object

Nullable

string

modified_by

object

Nullable

modified_on

string

Nullable

name

string

type

string

cp_list

array of object (CourierPartnerRuleCPListResponse)

Array of CourierPartnerRuleCPListResponse

Examples

Parameters

companyId:

applicationId:

"value"

ruleId:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}

Response

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

sort

array of string

Enum

created_by

object

Nullable

string

modified_by

object

Nullable

modified_on

string

Nullable

name

string

type

string

cp_list

array of object (CourierPartnerRuleCPListResponse)

Array of CourierPartnerRuleCPListResponse

Examples

Parameters

companyId:

applicationId:

"value"

ruleId:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}

Response

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

name

string

Required

conditions

object (CourierPartnerRuleConditions)

Required

CourierPartnerRuleConditions

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

sort

array of string

Enum

created_by

object

Nullable

string

modified_by

object

Nullable

modified_on

string

Nullable

name

string

type

string

cp_list

array of object (CourierPartnerRuleCPListResponse)

Array of CourierPartnerRuleCPListResponse

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules

Response

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

page

object (Page)

Page

Examples

Parameters

companyId:

applicationId:

"value"

pageNo:

pageSize:

status:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules

Response

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

Response

200

400

Response status_code

ApplicationConfig

rule_ids

array of string

sort

array of string

Enum

zones

object (ZoneConfig)

ZoneConfig

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration

Response

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

Examples

Parameters

companyId:

applicationId:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration

Response

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

data

object (ApplicationSelfShipConfig)

ApplicationSelfShipConfig

success

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

PATCH

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship

Response

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

data

object (ApplicationSelfShipConfig)

ApplicationSelfShipConfig

success

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship

Response

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

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority

Response

Order Routing Rules

Order routing rules determine how orders are directed to fulfillment centers. Order routing rules helps sellers to optimize fullfilment based on parameters like distance, inventory availability and depth, pricing, shipping cost, store processing efficiency, location type, and tag. For instance, a seller offering electronic goods can implement a rule directing heavy products like refrigerator to warehouses for fulfillment, while lighter items are fulfilled by other stores.

Operations

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

# Get store rule configuration

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

# Create store rule configuration

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

# Update store rules configuration

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules

# Get store rules

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules

# Create store rule

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}

# Get store rule

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}

# Update store rule

GET

Get store rule configuration

Retrieves information about the order routing setup for a single application

Parameters

company_id

integer

Required

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

sort

array of string

Examples

Parameters

companyId:

applicationId:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

Response

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

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

sort

array of string

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

Response

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

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

sort

array of string

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration

Response

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

page

object (Page)

Page

Examples

Parameters

companyId:

applicationId:

"value"

pageNo:

pageSize:

status:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules

Response

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

type_based_priority

array of string

tag_based_priority

array of string

store_priority

array of object (StorePrioritySchema)

Array of StorePrioritySchema

sort

array of string

Response

200

400

Response status_code

StoreRuleResponseSchema

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

sort

array of string

conditions

object (StoreRuleConditionSchema)

StoreRuleConditionSchema

is_active

boolean

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules

Response

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

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

sort

array of string

conditions

object (StoreRuleConditionSchema)

StoreRuleConditionSchema

is_active

boolean

Examples

Parameters

companyId:

applicationId:

"value"

ruleUid:

"value"

Was this section helpful?

GET

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}

Response

PUT

Update store rule

Updates an existing 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.

Request body

name

string

is_active

boolean

conditions

object (StoreRuleConditionSchema)

StoreRuleConditionSchema

type_based_priority

array of string

tag_based_priority

array of string

store_priority

array of object (StorePrioritySchema)

Array of StorePrioritySchema

sort

array of string

Response

200

400

Response status_code

StoreRuleUpdateResponseSchema

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

sort

array of string

conditions

object (StoreRuleConditionSchema)

StoreRuleConditionSchema

is_active

boolean

company_id

integer

application_id

string

Examples

Parameters

companyId:

applicationId:

"value"

ruleUid:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}

Response

Pincode-based Cash on Delivery

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

Operations

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-update

# Update pincode COD support

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-bulk-update

# Bulk update pincode COD support

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-data

# Get COD enabled pincodes

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history

# Get audit trail

POST

Update pincode COD support

Modify and update views related to pincode MOP (Mode of Payment).

Parameters

company_id

integer

Required

A `company_id` is a unique identifier for a particular seller account.

application_id

string

Required

A `application_id` is a unique identifier for a particular sale channel.

Request body

pincodes

array of integer

Required

country

string

Required

action

string

Required

Response

200

400

Response Data

PincodeMOPresponse

success

boolean

status_code

integer

batch_id

string

country

string

action

string

pincodes

array of integer

updated_pincodes

array of object (PincodeMopUpdateResponse)

Array of PincodeMopUpdateResponse

Examples

Parameters

companyId:

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-update

Response

POST

Bulk update pincode COD support

Updates the cash on delivery settings for multiple specified pin codes simultaneously.

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

batch_id

string

Required

s3_url

string

Required

Response

200

400

Response Data

PincodeBulkViewResponse

batch_id

string

s3_url

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-bulk-update

Response

POST

Get COD enabled pincodes

Retrieves a list of pincodes along with the count based on whether cash on delivery settings.

Parameters

company_id

string

Required

A `company_id` is a unique identifier for a particular seller account.

application_id

string

Required

A `application_id` is a unique identifier for a particular sale channel.

Request body

country

string

Default Value : INDIA

is_active

boolean

Default Value : true

pincode

integer

Nullable

current

integer

Default Value : 1

page_size

integer

Default Value : 100

Response

200

400

Response Data

PincodeCodStatusListingResponse

country

string

data

array of object (PincodeCodStatusListingResponse)

Array of PincodeCodStatusListingResponse

success

boolean

errors

array of object (Error)

Array of Error

page

object (PincodeCodStatusListingPage)

PincodeCodStatusListingPage

summary

object (PincodeCodStatusListingSummary)

PincodeCodStatusListingSummary

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-data

Response

POST

Get audit trail

Retrieves the history of changes made to cash on delivery settings for pincodes.

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

entity_type

string

Required

file_name

string

Response

200

400

Response Data

PincodeMopUpdateAuditHistoryResponseData

entity_type

string

page

object (PincodeMopUpdateAuditHistoryPaging)

PincodeMopUpdateAuditHistoryPaging

data

array of object (PincodeMopUpdateAuditHistoryResponse)

Array of PincodeMopUpdateAuditHistoryResponse

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history

Response

« Payment confirmation

Create short link »

Serviceability

Courier Partner Setup & Rules

Update courier rule

Update courier rule

updateCourierRule

Get courier rule

Get courier rule

getCourierPartnerRule

Create rourier rule

Create rourier rule

createCourierPartnerRule

Get courier rules

Get courier rules

getCourierPartnerRules

Update delivery configuration

Update delivery configuration

updateApplicationConfiguration

Get delivery configuration

Get delivery configuration

getApplicationConfiguration

Update self ship configuration

Update self ship configuration

patchApplicationServiceabilitySelfShipment

Get self ship configuration

Get self ship configuration

getApplicationServiceabilitySelfShipment

Update courier partner rule priority

Update courier partner rule priority

updateCourierPartnerRulePriority

Order Routing Rules

Get store rule configuration

Get store rule configuration

getApplicationConfig

Create store rule configuration

Create store rule configuration

insertApplicationConfig

Update store rules configuration

Update store rules configuration

updateStoreRulesConfig

Get store rules

Get store rules

getStoreRules

Create store rule

Create store rule

createStoreRules

Get store rule

Get store rule

getStoreRule

Update store rule

Update store rule

updateStoreRules

Pincode-based Cash on Delivery

Update pincode COD support

Update pincode COD support

updatePincodeMopView

Bulk update pincode COD support

Bulk update pincode COD support

updatePincodeBulkView

Get COD enabled pincodes

Get COD enabled pincodes

updatePincodeCoDListing

Get audit trail

Get audit trail

updatePincodeAuditHistory