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
POST
# Create courier account
GET
# List courier accounts
PUT
# Update courier account
GET
# Get courier account
PUT
# Update delivery configuration
GET
# Get delivery configuration
POST
# Locality TAT import or export
GET
# Locality TAT change history
POST
# Bulk update serviceability of localities
GET
# Bulk update history
GET
# Get serviceability of a locality
PUT
# Update Serviceability of a locality
POST
Create courier account
Creates a courier partner account.
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
scheme_id
string
Required
is_self_ship
boolean
Required
stage
string
Required
Enum
is_own_account
boolean
Required
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
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create courier account
createCourierPartnerAccount
GET
List courier accounts
Retrieves a list of courier partner accounts.
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
Response
200
400
Response status_code
CompanyCourierPartnerAccountListResponse
items
array of object (CourierAccountResponse)
Array of CourierAccountResponse
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
scheme_id
string
weight
object (ArithmeticOperations)
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.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
1
stage:
"value"
payment_mode:
"value"
transport_type:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List courier accounts
getCourierPartnerAccounts
PUT
Update courier account
Updates an existing courier partner account.
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
Response
200
400
Response status_code
CourierAccountResponse
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
scheme_id
string
weight
object (ArithmeticOperations)
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:
1
account_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update courier account
updateCourierPartnerAccount
GET
Get courier account
Retrieves a single courier partner account.
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
CourierAccountResponse
account_id
string
scheme_id
string
is_self_ship
boolean
stage
string
Enum
is_own_account
boolean
scheme_rules
object (CourierPartnerSchemeModel)
CourierPartnerSchemeModel
extension_id
string
scheme_id
string
weight
object (ArithmeticOperations)
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:
1
account_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get courier account
getCourierPartnerAccount
PUT
Update delivery configuration
Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
rule_ids
array of string
Required
sort
array of string
Required
Enum
logistics_as_actual
boolean
Response
200
400
Response status_code
CompanyConfig
rule_ids
array of string
sort
array of string
Enum
logistics_as_actual
boolean
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update delivery configuration
updateCompanyConfiguration
GET
Get delivery configuration
Retrieves information about the delivery setup for a company
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Response
200
400
Response status_code
CompanyConfig
rule_ids
array of string
sort
array of string
Enum
logistics_as_actual
boolean
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get delivery configuration
getCompanyConfiguration
POST
Locality TAT import or export
Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
Export locality wise CSV files.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
file_path
string
country
string
Required
action
string
Required
Enum
region
string
Required
Response
200
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Locality TAT import or export
bulkTat
GET
Locality TAT change history
Retrieves the history of changes made to TAT(Turn Around Time) for scheme.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
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 : 12
batch_id
string
Unique identifier of bulk job
action
string
import or export bulk type
status
string
Status of the bulk actions
country
string
Country for which bulk job is initiated
region
string
Region for which bulk job is initiated
start_date
string
Fetch job history after a particule date
end_date
string
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponse
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
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.
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
page_no:
1
page_size:
1
batch_id:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
start_date:
"value"
end_date:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Locality TAT change history
getBulkTat
POST
Bulk update serviceability of localities
Bulk operations involve either new serviceability settings or updating existing ones in large quantities.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
Request body
file_path
string
country
string
Required
action
string
Required
Enum
region
string
Required
Response
200
400
Response status_code
BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
string
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Bulk update serviceability of localities
bulkServiceability
GET
Bulk update history
Retrieves the history of changes made to serviceability settings for a scheme.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
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 : 12
batch_id
string
Unique identifier of bulk job
action
string
import or export bulk type
status
string
Status of the bulk actions
country
string
Country for which bulk job is initiated
region
string
Region for which bulk job is initiated
start_date
string
Fetch job history after a particule date
end_date
string
Fetch job history before a particule date
Response
200
Response status_code
BulkRegionResponse
items
array of object (BulkRegionResponseItemData)
Array of BulkRegionResponseItemData
file_path
string
failed
integer
failed_records
array of object
action
string
batch_id
string
country
string
success
integer
region
string
status
string
total
integer
error_file_path
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.
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
page_no:
1
page_size:
1
batch_id:
"value"
action:
"value"
status:
"value"
country:
"value"
region:
"value"
start_date:
"value"
end_date:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Bulk update history
getBulkServiceability
GET
Get serviceability of a locality
Rerieves serviceability settings of a single courier scheme for a given locality
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
region_id
string
Required
Unique identifier of a region
Response
200
400
Response status_code
ServiceabilityModel
lm_cod_limit
integer
is_qc
boolean
pickup_cutoff
string
Nullable
route_code
string
Nullable
is_first_mile
boolean
is_return
boolean
is_installation
boolean
is_last_mile
boolean
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
region_id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get serviceability of a locality
getServiceability
PUT
Update Serviceability of a locality
Updates serviceability settings of a single courier scheme for a given locality
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
extension_id
string
Required
Unique Identifier of CP Extension
scheme_id
string
Required
Unique identifier of a scheme
region_id
string
Required
Unique identifier of a region
Request body
lm_cod_limit
integer
Required
is_qc
boolean
Required
pickup_cutoff
string
Nullable
Required
route_code
string
Nullable
Required
is_first_mile
boolean
Required
is_return
boolean
Required
is_installation
boolean
Required
is_last_mile
boolean
Required
Response
200
400
Response status_code
ServiceabilityModel
lm_cod_limit
integer
is_qc
boolean
pickup_cutoff
string
Nullable
route_code
string
Nullable
is_first_mile
boolean
is_return
boolean
is_installation
boolean
is_last_mile
boolean
Examples
Parameters
company_id:
1
extension_id:
"value"
scheme_id:
"value"
region_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update Serviceability of a locality
updateServiceability
Delivery Zone
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
GET
# Get zones
POST
# Create zone
PUT
# Update a zone
GET
# Get zone details
GET
Get zones
Retrieves a list of delivery zones.
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_active
boolean
Status of Zone (either active or inactive)
channel_id
string
Zones filtered by an application
q
string
search with name as a free text
country_iso_code
string
ISO2 code of the country
state
string
State name
city
string
City name
pincode
string
Pincode value to search zones
sector
string
Sector value to search zones
Response
200
400
Zone List of application in descending order of their last modified date.
ListViewResponse
page
object (ZoneDataItem)
ZoneDataItem
has_next
boolean
item_total
integer
size
integer
current
integer
type
string
items
array of object (ListViewItems)
Array of ListViewItems
zone_id
string
The unique identifier for the zone.
name
string
The name of the zone.
slug
string
A human-readable and unique identifier for the zone, derived from the name.
stores_count
integer
The number of stores within the zone.
is_active
boolean
A flag indicating whether the zone is active.
regions_count
integer
The number of regions within the zone.
company_id
integer
The unique identifier for the company to which the zone belongs.
store_ids
array of integer
A list of store identifiers associated with the zone.
channels
array of object (ListViewChannels)
The name of the zone.
Array of ListViewChannels
channel_id
string
channel_type
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get zones
getZones
POST
Create zone
Creates a delivery zone.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Request body
name
string
Required
slug
string
Required
company_id
integer
Required
is_active
boolean
Required
channels
array of object (GetZoneDataViewChannels)
Required
Array of GetZoneDataViewChannels
channel_id
string
Required
channel_type
string
Required
store_ids
array of integer
Required
region_type
string
Required
Enum
mapping
array of object (ZoneMappingType)
Required
Array of ZoneMappingType
country
string
Required
pincode
array of string
state
array of string
assignment_preference
string
Default Value : optimal
Enum
Response
200
400
Response status_code
ZoneResponse
status_code
integer
zone_id
string
success
boolean
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create zone
createZone
PUT
Update a zone
Update an existing delivery zone .
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
zone_id
string
Required
A `zone_id` is a unique identifier for a particular zone.
Request body
zone_id
string
Required
name
string
Required
slug
string
Required
company_id
integer
Required
is_active
boolean
Required
channels
array of object (GetZoneDataViewChannels)
Required
Array of GetZoneDataViewChannels
channel_id
string
Required
channel_type
string
Required
product
object (ZoneProductTypes)
Required
ZoneProductTypes
type
string
Required
Enum
tags
array of string
Required
store_ids
array of integer
Required
region_type
string
Required
Enum
mapping
array of object (ZoneMappingType)
Required
Array of ZoneMappingType
country
string
Required
pincode
array of string
state
array of string
assignment_preference
string
Default Value : optimal
Enum
Response
200
400
Response status_code
ZoneSuccessResponse
status_code
integer
success
boolean
Examples
Parameters
company_id:
1
zone_id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a zone
updateZoneById
GET
Get zone details
Retrieves a single delivery zone.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
zone_id
string
Required
A `zone_id` is a unique identifier for a particular zone.
Response
200
400
Get details of the Zone
GetZoneByIdSchema
zone_id
string
name
string
slug
string
company_id
integer
is_active
boolean
channels
array of object (GetZoneDataViewChannels)
Array of GetZoneDataViewChannels
channel_id
string
channel_type
string
product
object (ZoneProductTypes)
ZoneProductTypes
type
string
Enum
tags
array of string
store_ids
array of integer
region_type
string
Enum
mapping
array of object (ZoneMappingType)
Array of ZoneMappingType
country
string
pincode
array of string
state
array of string
assignment_preference
string
Default Value : optimal
Enum
stores_count
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get zone details
getZoneById
Selling Location
A selling location is nothing but a geographical location where your stores and warehouses exists. The Selling location resource efficiently matches customer orders with the nearest store, reducing delivery time for sellers and ensuring customers receive products quickly at the best price, enhancing overall satisfaction.
Operations
GET
# Get all stores
GET
Get all stores
Deprecated
Retrieves a list of locations.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
Response
200
Response status_code
GetStoresViewResponse
page
object (ServiceabilityPageResponse)
ServiceabilityPageResponse
type
string
has_next
boolean
item_total
integer
size
integer
current
integer
items
array of object (ItemResponse)
Array of ItemResponse
created_on
string
manager
object (ManagerResponse)
ManagerResponse
email
string
mobile_no
object (MobileNo)
MobileNo
number
string
country_code
integer
name
string
modified_by
object (ModifiedByResponse)
ModifiedByResponse
username
string
user_id
string
integration_type
object (IntegrationTypeResponse)
IntegrationTypeResponse
inventory
string
order
string
verified_on
string
product_return_config
object (ProductReturnConfigResponse)
ProductReturnConfigResponse
on_same_store
boolean
contact_numbers
array of object (ContactNumberResponse)
Array of ContactNumberResponse
number
string
country_code
integer
verified_by
object (ModifiedByResponse)
ModifiedByResponse
username
string
user_id
string
stage
string
address
object (AddressResponse)
AddressResponse
city
string
address1
string
pincode
integer
address2
string
landmark
string
state
string
country
string
latitude
number
longitude
number
modified_on
string
created_by
object (CreatedByResponse)
CreatedByResponse
username
string
user_id
string
gst_credentials
object (GstCredentialsResponse)
GstCredentialsResponse
e_waybill
object (EwayBillResponse)
EwayBillResponse
enabled
boolean
e_invoice
object (EinvoiceResponse)
EinvoiceResponse
enabled
boolean
display_name
string
company_id
integer
uid
integer
_custom_json
object
code
string
warnings
object (WarningsResponse)
WarningsResponse
store_address
string
name
string
timing
array of object (TimmingResponse)
Array of TimmingResponse
open
boolean
weekday
string
closing
object (OpeningClosing)
OpeningClosing
minute
integer
hour
integer
opening
object (OpeningClosing)
OpeningClosing
minute
integer
hour
integer
documents
array of object (DocumentsResponse)
Array of DocumentsResponse
legal_name
string
value
string
type
string
verified
boolean
store_type
string
sub_type
string
company
integer
_cls
string
logistics
object (LogisticsResponse)
LogisticsResponse
override
boolean
dp
object (Dp)
Dp
fm_priority
integer
rvp_priority
integer
lm_priority
integer
internal_account_id
string
area_code
integer
Nullable
payment_mode
string
operations
array of string
external_account_id
string
Nullable
transport_mode
string
assign_dp_from_sb
boolean
notification_emails
array of string
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get all stores
getAllStores
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
# Create packaging material
GET
# Get packaging materials
POST
# Create packaging rule
GET
# Get packaging rules
PATCH
# Update packaging rule
GET
# Get packaging material rule
PATCH
# Update packaging material
GET
# Get packaging material
POST
Create packaging material
Creates a packaging material
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller.
Request body
name
string
Required
width
number
Required
height
number
Required
length
number
Required
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
store_ids
array of integer
Required
weight
number
Required
error_rate
number
Required
package_type
string
Required
size
string
Required
media
array of string
channels
array of object (Channel)
Required
Array of Channel
type
string
id
string
track_inventory
boolean
status
string
Required
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
Response
201
400
Response status_code
PackageMaterialResponse
name
string
id
string
item_id
integer
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
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
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example not available.
Create packaging material
createPackageMaterial
GET
Get packaging materials
Retrieves a list of packaging materials
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
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
object (PackageMaterialResponse)
PackageMaterialResponse
name
string
id
string
item_id
integer
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
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
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get packaging materials
getPackageMaterialList
POST
Create packaging rule
Creates a packaging rule
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
type
string
Required
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
Response
201
400
Response status_code
PackageRuleResponse
id
string
name
string
company_id
integer
type
string
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example not available.
Create packaging rule
createPackageMaterialRule
GET
Get packaging rules
Retrieve packaging rules
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_active
string
filters items based on given is_active
Response
200
400
Response status_code
PackageMaterialRuleList
items
object (PackageRuleResponse)
PackageRuleResponse
id
string
name
string
company_id
integer
type
string
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get packaging rules
getPackageMaterialRules
PATCH
Update packaging rule
Update an existing packaging rule
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
type
string
Required
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
Response
200
400
Response status_code
PackageRuleResponse
id
string
name
string
company_id
integer
type
string
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response
Example not available.
Update packaging rule
updatePackageMaterialRule
GET
Get packaging material rule
Retrieve packaging rule details.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular sale channel.
rule_id
string
Required
A `package_material_rule_id` is a unique identifier for a Package Material Rule
Response
200
400
Response status_code
PackageRuleResponse
id
string
name
string
company_id
integer
type
string
is_active
boolean
product_tag
object (PackageRuleProductTag)
PackageRuleProductTag
includes
array of string
product_id
object (PackageRuleProduct)
PackageRuleProduct
includes
array of integer
category_id
object (PackageRuleCategory)
PackageRuleCategory
includes
array of integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get packaging material rule
getPackageMaterialRule
PATCH
Update packaging material
Update an existing packaging material
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
name
string
Required
width
number
Required
height
number
Required
length
number
Required
rules
array of object (PackageMaterialRule)
Array of PackageMaterialRule
rule_id
string
quantity
object (PackageMaterialRuleQuantity)
PackageMaterialRuleQuantity
min
integer
max
integer
weight
integer
store_ids
array of integer
Required
weight
number
Required
error_rate
number
Required
package_type
string
Required
size
string
Required
media
array of string
channels
array of object (Channel)
Required
Array of Channel
type
string
id
string
track_inventory
boolean
status
string
Required
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
Response
200
400
Response status_code
PackageMaterialResponse
name
string
id
string
item_id
integer
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
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
status
string
Enum
max_weight
number
package_vol_weight
number
auto_calculate
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response