Serviceability

Logistics Configuration API's allows you to configure zone, application logistics and many more useful features.

Country & Locality

The Country & Locality resource contains extensive data about countries and how they're structured. For instance, in India, it's organized as Country, State, City, and Pincode, while in Australia, it's simpler with State, City, and Zipcode. We've made this structure consistent globally, covering Country, State, City, Pincode, and Sector. Using this resource, you can easily access hierarchical information for each country. This resource helpful for retrieving detailed locality information, such as lists of states for a given country, cities for a given state and country, and more. Moreover, it's crucial for validating customer addresses, like verifying the validity of a pincode. Additionally, it provides in-depth locality data, such as offering city and country information for a specific sector in the UAE.

Operations
GET
/service/platform/logistics/v1.0/company/{company_id}/localities
# Get Localities by Name Prefix
GET
/service/platform/logistics/v1.0/company/{company_id}/localities/{locality_type}/{locality_value}
# Get Locality API
GET
/service/platform/logistics/v1.0/company/{company_id}/localities/{locality_type}
# Get Localities.
GET
/service/platform/logistics/v1.0/company/{company_id}/countries/{country_iso_code}
# Get single country and associated data.
GET
/service/platform/logistics/v2.0/company/{company_id}/countries
# Get all countries and associated data.
POST
/service/platform/logistics/v1.0/company/{company_id}/country/{country_iso_code}/address/templates/{template_name}/validate
# Validate given address wrt template
GET

Get Localities by Name Prefix

Get localities that start with a specified prefix.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
The unique identifier of the company.
page_no
integer
| value >= 1
Starting index of the items.
Default Value : 1
page_size
integer
| value >= 1
Number of items per page.
Default Value : 10
q
string
Localities starting with the specified prefix.
Response
200
400
Get Locality data
GetLocalities
items
array of object (Localities)
Array of Localities
id
string
name
string
display_name
string
parent_ids
array of string
Default Value :
meta
object
Default Value : [object Object]
type
string
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
coordinates
array of number
parent_uid
string
Nullable
code
string
localities
array of object (LocalityParent)
Array of LocalityParent
id
string
name
string
display_name
string
meta
object
Default Value : [object Object]
parent_ids
array of string
Nullable
Default Value :
type
string
serviceability
object
Default Value : [object Object]
code
string
parent_uid
string
Nullable
Default Value :
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
page_no:
1
page_size:
10
q:
"40000"
GET
/service/platform/logistics/v1.0/company/{company_id}/localities
Loading...
Response
Loading...
GET

Get Locality API

Get Locality data
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
locality_type
string
Required
A `locality_type` contains value geographical division.
Enum
locality_value
string
Required
A `locality_value` contains a specific name of the locality.
country
string
A `country` contains a specific value of the country iso2 code.
state
string
A `state` contains a specific value of the state, province.
city
string
A `city` contains a specific value of the city.
Response
200
400
Get Locality data
GetLocality
id
string
name
string
display_name
string
meta
object
Default Value : [object Object]
parent_ids
array of string
Nullable
Default Value :
parent_uid
string
Nullable
type
string
code
string
localities
array of object (LocalityParent)
Array of LocalityParent
id
string
name
string
display_name
string
meta
object
Default Value : [object Object]
parent_ids
array of string
Nullable
Default Value :
type
string
serviceability
object
Default Value : [object Object]
code
string
parent_uid
string
Nullable
Default Value :
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
Examples
Parameters
company_id:
123
locality_type:
"pincode"
locality_value:
"400001"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
GET
/service/platform/logistics/v1.0/company/{company_id}/localities/{locality_type}/{locality_value}
Loading...
Response
Loading...
GET

Get Localities.

Get Localities data.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
locality_type
string
Required
A `locality_type` contains unique geographical division.
Enum
country
string
A `country` contains a specific value of the country iso2 code.
state
string
A `state` contains a specific value of the state, province.
city
string
A `city` contains a specific value of the city.
page_no
integer
page number.
Default Value : 1
page_size
integer
| value <= 1000
page size.
Default Value : 12
q
string
search.
name
string
Search for localities. Either provide a full name or a search term.
Response
200
400
Get Localities data
GetLocalities
items
array of object (Localities)
Array of Localities
id
string
name
string
display_name
string
parent_ids
array of string
Default Value :
meta
object
Default Value : [object Object]
type
string
lat_long
object (PincodeLatLongData)
PincodeLatLongData
type
string
coordinates
array of number
parent_uid
string
Nullable
code
string
localities
array of object (LocalityParent)
Array of LocalityParent
id
string
name
string
display_name
string
meta
object
Default Value : [object Object]
parent_ids
array of string
Nullable
Default Value :
type
string
serviceability
object
Default Value : [object Object]
code
string
parent_uid
string
Nullable
Default Value :
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
iso2
string
ISO 3166-1 alpha-2 code for the country.
iso3
string
ISO 3166-1 alpha-3 code for the country.
currency
object
Currency information for the country.
phone_code
string
Country's international phone dialing code.
hierarchy
object
Hierarchical data of the country's location.
latitude
string
Latitude of the country's geographic center.
longitude
string
Longitude of the country's geographic center.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
locality_type:
"pincode"
country:
"IN"
state:
"MAHARASHTRA"
city:
"MUMBAI"
page_no:
1
page_size:
6
name:
"400001"
GET
/service/platform/logistics/v1.0/company/{company_id}/localities/{locality_type}
Loading...
Response
Loading...
GET

Get single country and associated data.

Retrieve data for a single country and address format.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
country_iso_code
string
Required
The `country_iso_code` is ISO-2 (alpha-2) code for the country.
Response
200
400
Get country data.
GetCountry
id
string
name
string
display_name
string
iso2
string
iso3
string
timezones
array of string
Nullable
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
display_name
string
slug
string
phone_code
string
latitude
string
longitude
string
currency
object (CurrencyObject)
CurrencyObject
code
string
name
string
symbol
string
type
string
fields
object (GetCountryFields)
GetCountryFields
address
array of object (GetCountryFieldsAddress)
Array of GetCountryFieldsAddress
display_name
string
slug
string
required
boolean
edit
boolean
input
string
validation
object (FieldValidation)
Nullable
FieldValidation
type
string
regex
object (FieldValidationRegex)
FieldValidationRegex
value
string
length
object (LengthValidation)
LengthValidation
min
integer
Nullable
max
integer
Nullable
values
object (GetCountryFieldsAddressValues)
Nullable
GetCountryFieldsAddressValues
get_one
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
value
string
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
state
string
Nullable
city
string
Nullable
sector
string
Nullable
get_all
object (GetOneOrAll)
Nullable
GetOneOrAll
operation_id
string
params
object (GetOneOrAllParams)
GetOneOrAllParams
path
object (GetOneOrAllPath)
GetOneOrAllPath
type
string
value
string
query
object (GetOneOrAllQuery)
GetOneOrAllQuery
country
string
Nullable
state
string
Nullable
city
string
Nullable
sector
string
Nullable
error_text
string
Nullable
serviceability_fields
array of string
address_template
object (GetCountryFieldsAddressTemplate)
GetCountryFieldsAddressTemplate
checkout_form
string
store_os_form
string
default_display
string
Examples
Parameters
company_id:
123
country_iso_code:
"IN"
GET
/service/platform/logistics/v1.0/company/{company_id}/countries/{country_iso_code}
Loading...
Response
Loading...
GET

Get all countries and associated data.

Retrieve a list of countries for logistical purposes.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
onboard
boolean
Only fetch countries which allowed for onboard on Platform.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
| value <= 300
The number of items to retrieve in each page. Default value is 12
Default Value : 12
q
string
The search string to search in the list of countries by name.
hierarchy
string
The search filter to filter countries based on their available hierarchy.
Response
200
400
Successfully retrieved all countries with associated data.
GetCountries
items
array of object (CountryObject)
Array of CountryObject
id
string
name
string
display_name
string
iso2
string
iso3
string
timezones
array of string
Nullable
hierarchy
array of object (CountryHierarchy)
Array of CountryHierarchy
display_name
string
slug
string
phone_code
string
latitude
string
longitude
string
currency
object (CurrencyObject)
CurrencyObject
code
string
name
string
symbol
string
type
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
onboard:
true
page_no:
1
page_size:
6
q:
"I"
hierarchy:
"pincode"
GET
/service/platform/logistics/v2.0/company/{company_id}/countries
Loading...
Response
Loading...
POST

Validate given address wrt template

Validate given address wrt template
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
country_iso_code
string
Required
The ISO code of the country.
template_name
string
Required
The type of address form.
Enum
Request body
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
A string containing the recipient's email address.
Response
200
400
Valid
ValidateAddressRequestSchema
address
string
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details.
address1
string
A string representing the first line of the address, typically containing street or building information.
address2
string
A string representing the second line of the address, which can be used for additional address details if needed.
area
string
A string specifying the locality or area associated with the address.
landmark
string
A string representing a prominent nearby landmark that aids in locating the address.
pincode
string
A string indicating the postal code or PIN code of the address area.
sector
string
A string specifying the sector or district of the address if applicable.
city
string
A string denoting the city or municipality of the address.
state
string
A string indicating the state or province of the address.
name
string
Nullable
A string representing the recipient's name or the organization name associated with the address.
phone
string
Nullable
An integer representing the recipient's contact phone number.
email
string
Nullable
A string containing the recipient's email address.
country_iso_code
string
A string containing the recipient's email address.
Examples
Parameters
company_id:
123
country_iso_code:
"IN"
template_name:
"default_display"
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/country/{country_iso_code}/address/templates/{template_name}/validate
Loading...
Response
Loading...

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
PATCH
/service/platform/logistics/v1.0/company/{company_id}/selfship
# Update Company Self Ship
GET
/service/platform/logistics/v1.0/company/{company_id}/selfship
# Update Company Self Ship
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# Create courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
# List courier accounts
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Update courier account
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
# Get courier account
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Update delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
# Get delivery configuration
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/list
# Fetching of Package Material Rules from database.
PATCH

Update Company Self Ship

Updates Self Ship at company level
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
is_active
boolean
Required
tat
number
Required
unit
string
Required
Enum
Response
200
400
Response status_code
CompanySelfShip
is_active
boolean
tat
number
unit
string
Enum
Examples
Parameters
company_id:
123
body:
body
PATCH
/service/platform/logistics/v1.0/company/{company_id}/selfship
Loading...
Response
Loading...
GET

Update Company Self Ship

Updates Self Ship at company level
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Response
200
400
Response status code
CompanySelfShip
is_active
boolean
tat
number
unit
string
Enum
Examples
Parameters
company_id:
123
GET
/service/platform/logistics/v1.0/company/{company_id}/selfship
Loading...
Response
Loading...
POST

Create courier account

Retrieves a list of courier partner accounts.
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
extension_id
string
Required
account_id
string
Required
scheme_id
string
Required
is_self_ship
boolean
Required
stage
string
Required
Enum
is_own_account
boolean
Required
company_id
integer
scheme_rules
object
Response
200
400
Response status_code
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
company_id
integer
scheme_rules
object
Examples
Parameters
company_id:
123
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
GET

List courier accounts

Retrieves a list of courier partner accounts.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale 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
stage
string
stage of the account. enabled/disabled
payment_mode
string
Filters dp accounts based on payment mode
transport_type
string
Filters dp accounts based on transport_type
account_ids
array of string
Filters dp accounts based on their ids
self_ship
boolean
To filter self ship/non self ship dp accounts
own_account
boolean
Filters seller owned or admin owned dp accounts
q
string
Filters dp accounts based on case sensitive partial account name
Response
200
Response status_code
CompanyCourierPartnerAccountListResponseSchema
items
array of object (CourierAccountResponseSchema)
Array of CourierAccountResponseSchema
company_id
integer
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierAccountSchemeResponseSchema)
CourierAccountSchemeResponseSchema
name
string
extension_id
string
scheme_id
string
weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account
Loading...
Response
Loading...
PUT

Update courier account

Updates an existing courier partner account.
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
account_id
string
Required
Unique ID of courier account
Request body
extension_id
string
Required
account_id
string
Required
scheme_id
string
Required
is_self_ship
boolean
Required
stage
string
Required
Enum
is_own_account
boolean
Required
company_id
integer
scheme_rules
object
Response
200
400
Response status_code
CourierAccount
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
company_id
integer
scheme_rules
object
Examples
Parameters
company_id:
123
account_id:
"23"
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
GET

Get courier account

Retrieves a single courier partner account.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
account_id
string
Required
Unique ID of courier account
Response
200
400
Response status_code
CourierAccountResponseSchema
company_id
integer
extension_id
string
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierAccountSchemeResponseSchema)
CourierAccountSchemeResponseSchema
name
string
extension_id
string
scheme_id
string
weight
object (ArithmeticOperations)
Nullable
ArithmeticOperations
lt
integer
Nullable
gt
integer
Nullable
lte
integer
Nullable
gte
integer
Nullable
transport_type
string
Enum
region
string
Enum
delivery_type
string
Enum
payment_mode
array of string
Enum
stage
string
Enum
feature
object (CourierPartnerSchemeFeatures)
CourierPartnerSchemeFeatures
doorstep_qc
boolean
qr
boolean
mps
boolean
ndr
boolean
ndr_attempts
integer
dangerous_goods
boolean
fragile_goods
boolean
restricted_goods
boolean
cold_storage_goods
boolean
doorstep_exchange
boolean
doorstep_return
boolean
product_installation
boolean
openbox_delivery
boolean
status_updates
string
multi_pick_single_drop
boolean
single_pick_multi_drop
boolean
multi_pick_multi_drop
boolean
ewaybill
boolean
Examples
Parameters
company_id:
123
account_id:
"23"
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}
Loading...
Response
Loading...
PUT

Update delivery configuration

Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences.
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
sort
array of string
Enum
Response
200
400
Response status_code
CompanyConfig
company_id
integer
sort
array of string
Enum
logistics_as_actual
string
Enum
Examples
Parameters
company_id:
123
body:
body
PUT
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
GET

Get delivery configuration

Retrieves information about the delivery setup for a company
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Response
200
400
Response status_code
CompanyConfig
company_id
integer
sort
array of string
Enum
logistics_as_actual
string
Enum
Examples
Parameters
company_id:
123
GET
/service/platform/logistics/v1.0/company/{company_id}/configuration
Loading...
Response
Loading...
GET

Fetching of Package Material Rules from database.

This API returns response of Package Materials Rules from mongo database.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale 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
is_installed
string
filter to get installed extensions only
Enum
Response
200
Response status_code
InstallCourierPartnerResponseSchema
items
array of object (InstallCourierPartnerItemsSchema)
Array of InstallCourierPartnerItemsSchema
base_url
string
callbacks
object
contact_email
string
created_at
string
| date-time
description
string
developed_by_name
string
ext_version
string
extention_type
string
is_coming_soon
boolean
is_hidden
boolean
is_installed
boolean
launch_type
string
logo
object
modified_at
string
| date-time
name
string
organization_id
string
partner
object
scope
array of string
whitelisted_urls
array of string
__v
integer
_id
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
123
page_no:
1
page_size:
10
is_installed:
true
GET
/service/platform/logistics/v1.0/company/{company_id}/courier-partner/list
Loading...
Response
Loading...

Shipment Packaging

Packaging material refers to the materials used to wrap and protect products during shipping or storage. Shipments are collections of products being transported together. The Custom packaging resource enables sellers to create rules based on brand, category, or department, which can be applied to this shipments. These rules are then linked to specific packaging materials, detailing weight and quantity capacities. Sellers can thus efficiently combine or split shipments, optimizing delivery partner costs and enhancing logistics flexibility.

Operations
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
# Create packaging material
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
# Get packaging materials
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
# Create packaging rule
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}/details
# Fetching of Package Material Rule from database.
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/details
# Fetching of Package Material Rules from database.
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
# Get packaging material rule
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
# Update packaging rule
DEL
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
# Delete packaging material rule
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
# Update packaging material
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
# Get packaging material
DEL
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
# Delete packaging material
POST

Create packaging material

Creates a packaging material
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
page_no
integer
index of the item to start returning with
Request body
company_id
number
item_id
number
id
string
name
string
Required
width
number
Required
height
number
Required
length
number
Required
weight
number
Required
auto_calculate
boolean
max_weight
number
package_vol_weight
number
error_rate
number
Required
channels
array of object (Channel)
Required
Array of Channel
type
string
id
string
package_type
string
Required
size
string
Required
track_inventory
boolean
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
company_id
integer
is_active
boolean
type
string
name
string
id
string
store_ids
array of integer
Required
mp_stores
array of object (PackageMpStores)
Array of PackageMpStores
app_name
string
app_id
string
store_ids
array of integer
store_data
object
media
array of string
status
string
Required
Enum
is_active
boolean
Response
201
400
Response status_code
PackageMaterialResponseSchema
company_id
integer
name
string
id
string
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
company_id
integer
is_active
boolean
type
string
name
string
id
string
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
channels
array of object (Channel)
Array of Channel
type
string
id
string
track_inventory
boolean
is_active
boolean
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
mp_stores
array of object (PackageMpStores)
Array of PackageMpStores
app_name
string
app_id
string
store_ids
array of integer
store_data
object
Examples
Parameters
company_id:
1
page_no:
1
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
Loading...
Response
Loading...
GET

Get packaging materials

Retrieves a list of packaging materials
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_no
integer
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
q
string
perform regex search on items matching name for given value
size
string
filters items based on given size
package_type
string
filters items based on given package_type
Response
200
400
Response status_code
PackageMaterialList
items
Undefined Type
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
Parameters are not required.
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-materials
Loading...
Response
Loading...
POST

Create packaging rule

Creates a packaging rule
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
Request body
name
string
Required
company_id
integer
Required
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
type
string
Required
is_active
boolean
Response
201
400
Response status_code
PackageRuleResult
is_active
boolean
company_id
integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
name
string
type
string
id
string
Examples
Parameters
company_id:
1
body:
body
POST
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules
Loading...
Response
Loading...
GET

Fetching of Package Material Rule from database.

This API returns details of package materials rule.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
page_no
integer
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
is_active
string
filters items based on given is_active
Response
200
404
Response status_code
PackageRuleResult
is_active
boolean
company_id
integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
name
string
type
string
id
string
Examples
Parameters
company_id:
100
rule_id:
"64b4337a0c607fbfbcd0156b"
page_no:
1
page_size:
10
is_active:
"true"
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}/details
Loading...
Response
Loading...
GET

Fetching of Package Material Rules from database.

This API returns response of Package Materials Rules from mongo database.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
page_no
integer
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
is_active
string
filters items based on given is_active
Response
200
400
Response status_code
PackageMaterialRuleList
items
array of object (PackageRuleResult)
Array of PackageRuleResult
is_active
boolean
company_id
integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
name
string
type
string
id
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/details
Loading...
Response
Loading...
GET

Get packaging material rule

Retrieve packaging rule details.
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Response
200
404
Response status_code
PackageRuleResult
is_active
boolean
company_id
integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
name
string
type
string
id
string
Examples
Parameters
company_id:
100
rule_id:
"64b4337a0c607fbfbcd0156b"
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
Loading...
Response
Loading...
PATCH

Update packaging rule

Update an existing packaging rule
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Request body
name
string
Required
company_id
integer
Required
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
type
string
Required
is_active
boolean
Response
200
400
Response status_code
PackageRuleResult
is_active
boolean
company_id
integer
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
department_id
object (PackageRuleDepartmentId)
PackageRuleDepartmentId
includes
array of integer
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_attributes
object (PackageRuleProductAttributes)
PackageRuleProductAttributes
includes
array of object
name
string
type
string
id
string
Examples
Parameters
company_id:
100
rule_id:
"64b4337a0c607fbfbcd0156b"
body:
body
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
Loading...
Response
Loading...
DEL

Delete packaging material rule

Delete a single packaging material rule
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Response
200
400
Response status_code
PackageMaterialDeleteResponseSchema
message
string
Examples
Parameters
company_id:
100
rule_id:
"64c50d2e7fa9a5f1c2e56789"
DEL
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}
Loading...
Response
Loading...
PATCH

Update packaging material

Update an existing packaging material
Requires company/logistics/write access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
package_material_id
string
Required
A `package_material_id` is a unique identifier for a Package Material
Request body
company_id
number
item_id
number
id
string
name
string
Required
width
number
Required
height
number
Required
length
number
Required
weight
number
Required
auto_calculate
boolean
max_weight
number
package_vol_weight
number
error_rate
number
Required
channels
array of object (Channel)
Required
Array of Channel
type
string
id
string
package_type
string
Required
size
string
Required
track_inventory
boolean
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
company_id
integer
is_active
boolean
type
string
name
string
id
string
store_ids
array of integer
Required
mp_stores
array of object (PackageMpStores)
Array of PackageMpStores
app_name
string
app_id
string
store_ids
array of integer
store_data
object
media
array of string
status
string
Required
Enum
is_active
boolean
Response
200
400
Response status_code
PackageMaterialResponseSchema
company_id
integer
name
string
id
string
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
company_id
integer
is_active
boolean
type
string
name
string
id
string
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
channels
array of object (Channel)
Array of Channel
type
string
id
string
track_inventory
boolean
is_active
boolean
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
mp_stores
array of object (PackageMpStores)
Array of PackageMpStores
app_name
string
app_id
string
store_ids
array of integer
store_data
object
Examples
Parameters
company_id:
100
package_material_id:
"656630b9cc661113138d994b"
body:
body
PATCH
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
Loading...
Response
Loading...
GET

Get packaging material

Retrieve a single packaging material
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
package_material_id
string
Required
A `package_material_id` is a unique identifier for a Package Material
Response
200
404
Response status_code
PackageMaterialResponseSchema
company_id
integer
name
string
id
string
width
number
height
number
length
number
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
company_id
integer
is_active
boolean
type
string
name
string
id
string
store_ids
array of integer
weight
number
error_rate
number
package_type
string
size
string
media
array of string
channels
array of object (Channel)
Array of Channel
type
string
id
string
track_inventory
boolean
is_active
boolean
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
mp_stores
array of object (PackageMpStores)
Array of PackageMpStores
app_name
string
app_id
string
store_ids
array of integer
store_data
object
Examples
Parameters
company_id:
100
package_material_id:
"656630b9cc661113138d994b"
GET
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
Loading...
Response
Loading...
DEL

Delete packaging material

Delete a single packaging material
Requires company/logistics/read access scope.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
package_material_id
string
Required
A `package_material_id` is a unique identifier for a Package Material
Response
200
400
Response status_code
PackageMaterialDeleteResponseSchema
message
string
Examples
Parameters
company_id:
100
package_material_id:
"64b39f4b89a4d2c4e8b45678"
DEL
/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}
Loading...
Response
Loading...