Skip to main content

Order

Manages orders, including processing, tracking, and updating order status.

Announcements

Announcements are a way to communicate important information to your platform users, which can be sellers. They could be about upcoming promotions, system maintenance downtime, policy changes, or new features on the platform

Operations
GET
/service/platform/order-manage/v1.0/company/{company_id}/announcements
# List announcements
GET

List announcements

Retrieve announcements related to orders fulfilment configured by platform or company admin
Parameters
date
string
Optional
Date On which the announcement is Active (Date should in ISO Datetime format IST Time)
Response
200
4XX
Announcements retrieved successfully
AnnouncementsResponse
announcements
array of object (AnnouncementResponse)
Optional
Array of AnnouncementResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
date:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/announcements
Loading...
Response
Loading...

Bag

Bag represents a virtual entity to group same items which contains single or multi quantity. Bags are part of a shipment. An order will have one or more than one shipments. A shipment can contain zero or more bags.

Operations
GET
/service/platform/order/v1.0/company/{company_id}/shipments/{shipment_id}/bags/{bag_id}/state/{state}/reasons
# List bag cancellation reasons
GET
/service/platform/order/v1.0/company/{company_id}/bag-details/
# Get bag
GET
/service/platform/order/v1.0/company/{company_id}/bags
# List bags
GET

List bag cancellation reasons

Get reasons to perform full or partial cancellation of a bag
Parameters
shipmentId
string
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
bagId
string
ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
state
string
State for which reasons are required.
Response
200
4XX
5XX
Success. Check the example shown below or refer `PlatformShipmentReasonsResponse` for more details.
PlatformShipmentReasonsResponse
reasons
array of object (Reason)
Optional
Array of Reason
success
boolean
Optional
Examples
Parameters
shipmentId:
"value"
bagId:
"value"
state:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/shipments/{shipment_id}/bags/{bag_id}/state/{state}/reasons
Loading...
Response
Loading...
GET

Get bag

Retrieve detailed information about a specific bag
Parameters
bagId
string
Optional
Id of bag
channelBagId
string
Optional
Id of application bag
channelId
string
Optional
Id of application
Response
200
4XX
5XX
Successfully retrived shipment details!
BagDetailsPlatformResponse
status_code
integer
Optional
data
object (BagDetails)
Optional
BagDetails
Examples
Parameters
bagId:
"value"
channelBagId:
"value"
channelId:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/bag-details/
Loading...
Response
Loading...
GET

List bags

Get paginated list of bags based on provided filters
Parameters
bagIds
string
Optional
Comma separated values of bag ids
shipmentIds
string
Optional
Comma separated values of shipment ids
orderIds
string
Optional
Comma separated values of order ids
channelBagIds
string
Optional
Comma separated values of app bag ids
channelShipmentIds
string
Optional
Comma separated values of app shipment ids
channelOrderIds
string
Optional
Comma separated values of app order ids
channelId
string
Optional
Comma separated values of app ids
pageNo
integer
Optional
Page number for paginated data
Default Value : 1
pageSize
integer
Optional
Page size of data received per page
Default Value : 20
Response
200
4XX
5XX
Successfully retrived all the given shipments details!
GetBagsPlatformResponse
status_code
integer
Optional
data
object (BagData)
Nullable
Optional
BagData
Examples
Parameters
bagIds:
"value"
shipmentIds:
"value"
orderIds:
"value"
channelBagIds:
"value"
channelShipmentIds:
"value"
channelOrderIds:
"value"
channelId:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/bags
Loading...
Response
Loading...

Bulk Operations

Bulk operations allow you to perform actions on a large number of orders. This can save significant time compared to managing them individually. For example, bulk order fulfillment, bulk invoice download etc.

Operations
POST
/service/platform/order-manage/v1.0/company/{company_id}/jobs/state-transition
# Upload bulk state transitions file
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs
# Lists bulk operations
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}
# Get bulk operation details
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}/file
# Download file used for Bulk operation
GET
/service/platform/order/v1.0/company/{company_id}/bulk-action/get-seller-templates
# List supported templates
GET
/service/platform/order/v1.0/company/{company_id}/bulk-action/download-seller-templates
# Download bulk template
GET
/service/platform/order/v1.0/company/{company_id}/jobs/templates
# List bulk operation templates
GET
/service/platform/order/v1.0/company/{company_id}/jobs/templates/{template_name}
# Download bulk operation templates
POST

Upload bulk state transitions file

Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV.
Parameters
body
object (BulkStateTransistionRequest)
BulkStateTransistionRequest
url
string
Optional
file_name
string
Optional
Response
200
4XX
Bulk State Transistion Sucessfully Initiated Response.
BulkStateTransistionResponse
status
boolean
Optional
message
string
Optional
batch_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/jobs/state-transition
Loading...
Response
Loading...
GET

Lists bulk operations

Get list of bulk operation that is initiated and completed as per the filters provided
Parameters
pageSize
integer
page size
pageNo
integer
page number
startDate
string
| date-time
UTC start date in ISO format
endDate
string
| date-time
UTC end date in ISO format
status
string
Optional
status for which to fetch the jobs.
bulkActionType
string
Optional
job type.
searchKey
string
Optional
search_key.
Response
200
4XX
Fetches Bulk Action Listing
BulkListingResponse
success
boolean
Optional
data
array of object (BulkActionListingData)
Optional
Array of BulkActionListingData
page
object (BulkListinPage)
Optional
BulkListinPage
total_count
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs
Loading...
Response
Loading...
GET

Get bulk operation details

Fetches details of the job for the provided batch Id
Parameters
batchId
string
Response
200
4XX
Job details.
JobDetailsResponse
success
boolean
Optional
data
array of object (JobDetailsData)
Optional
Array of JobDetailsData
file_url
string
Optional
message
string
Optional
failed_records
array of object
Optional
uploaded_by
string
Optional
user_id
string
Optional
created_ts
string
| date-time
Optional
uploaded_on
string
Optional
status
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}
Loading...
Response
Loading...
GET

Download file used for Bulk operation

Get the file download URL used for performing bulk operation
Parameters
batchId
string
status
string
fileType
string
Default Value : xlsx
Enum
reportType
string
Optional
Default Value : generation_report
Enum
Response
200
4XX
Job details.
JobFailedResponse
file_name
string
Optional
url
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}/file
Loading...
Response
Loading...
GET

List supported templates

Get list of templates so that users can download the required template
Parameters
No Parameters
Response
200
4XX
Slug names
BulkActionTemplateResponse
template_x_slug
array of object (BulkActionTemplate)
Optional
Allowed bulk action template slugs
Array of BulkActionTemplate
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/bulk-action/get-seller-templates
Loading...
Response
Loading...
GET

Download bulk template

Download bulk seller templates which can be used to perform operations in bulk
Parameters
templateSlug
string
Optional
Slug name of template to be downloaded
Response
200
4XX
We are processing the file!
FileResponse
file_name
string
Optional
Name of the file
cdn
object (URL)
Optional
URL
Examples
Parameters
templateSlug:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/bulk-action/download-seller-templates
Loading...
Response
Loading...
GET

List bulk operation templates

Gets all the allowed templates to perform bulk operations.
Parameters
No Parameters
Response
200
4XX
Successfully Found the templates.
AllowedTemplatesResponse
template_x_slug
array of object (Templates)
Optional
Array of Templates
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/jobs/templates
Loading...
Response
Loading...
GET

Download bulk operation templates

Get the excel or CSV file URL for the template.
Parameters
templateName
string
Response
200
4XX
Sucessfully Created the Template Url.
TemplateDownloadResponse
file_name
string
Optional
url
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/jobs/templates/{template_name}
Loading...
Response
Loading...

Manifest

Manifest

Operations
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests/shipments
# List manifest shipments
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests
# List manifests
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifests
# Generate manifest
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests/{manifest_id}
# Get a manifest
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/dispatch
# Dispatch manifest
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/upload-consent
# Upload consent
GET
/service/platform/order-manage/v1.0/company/{company_id}/filter/listing
# List filters
GET

List manifest shipments

Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number
Parameters
dpIds
integer
stores
string
toDate
string
fromDate
string
dpName
string
Optional
salesChannels
string
Optional
searchType
string
Optional
searchValue
string
Optional
pageNo
string
Optional
pageSize
string
Optional
Response
200
4XX
Successful Manifest upload!
ManifestShipmentListing
total_count
integer
| int32
lane
string
Optional
page
object (ManifestPageInfo)
ManifestPageInfo
success
boolean
status
integer
| int32
items
array of object (ManifestItemDetails)
Optional
Array of ManifestItemDetails
message
string
Optional
Examples
Parameters
dpIds:
0
stores:
"value"
toDate:
"value"
fromDate:
"value"
dpName:
"value"
salesChannels:
"value"
searchType:
"value"
searchValue:
"value"
pageNo:
"value"
pageSize:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests/shipments
Loading...
Response
Loading...
GET

List manifests

Get a list of manifest as per the filter provided
Parameters
status
string
Optional
Possible Status [ active, closed ]
Default Value : active
Enum
startDate
string
Optional
UTC Start Date in ISO format
endDate
string
Optional
UTC End Date in ISO format
searchType
string
Optional
Search type options [ fynd_order_id, shipment_id, manifest_id, dp_name, awb_no ]
Enum
storeId
integer
Optional
Fetch manifests for a Store.
searchValue
string
Optional
Search value for selected search type
dpIds
string
Optional
DP Ids separated by ',' (comma)
pageNo
integer
Optional
pageSize
integer
Optional
Response
200
4XX
5XX
Successful Manifest upload!
ManifestList
items
array of object (Manifest)
Optional
Array of Manifest
page
object (ManifestPageInfo)
Optional
ManifestPageInfo
Examples
Parameters
status:
"value"
startDate:
"value"
endDate:
"value"
searchType:
"value"
storeId:
0
searchValue:
"value"
dpIds:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests
Loading...
Response
Loading...
POST

Generate manifest

Generate manifest Id and PDF and tags the shipments with that manifest Id
Parameters
body
object (ProcessManifest)
ProcessManifest
filters
object (FiltersRequest)
FiltersRequest
action
string
unique_id
string
manifest_id
string
Optional
Response
200
4XX
5XX
Manifest will be processed!
ProcessManifestItemResponse
items
object (ProcessManifestResponse)
Optional
ProcessManifestResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifests
Loading...
Response
Loading...
GET

Get a manifest

Get details regarding a manifest which can be used to perform further actions on it
Parameters
manifestId
string
Response
200
4XX
5XX
Successful Manifest upload!
ManifestDetails
items
array of object (ManifestItemDetails)
Optional
Array of ManifestItemDetails
page
object (ManifestPageInfo)
Optional
ManifestPageInfo
additional_shipment_count
integer
| int32
Optional
manifest_details
array of object (Manifest)
Optional
Array of Manifest
Examples
Parameters
manifestId:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/manifests/{manifest_id}
Loading...
Response
Loading...
POST

Dispatch manifest

Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status
Parameters
manifestId
string
body
object (DispatchManifest)
DispatchManifest
manifest_id
string
Response
200
4XX
Shipment Dispatched mapped with manifest!
SuccessResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
manifestId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/dispatch
Loading...
Response
Loading...
POST

Upload consent

Uploads the consent signed by courier partner and seller to keep records
Parameters
manifestId
string
body
object (UploadConsent)
UploadConsent
consent_url
string
manifest_id
string
Response
200
4XX
Successful Manifest upload!
SuccessResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
manifestId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/upload-consent
Loading...
Response
Loading...
GET

List filters

Get supported filter for listing manifests
Parameters
view
string
Name of View
Default Value : manifest
Enum
Response
200
4XX
List of filters
ManifestFiltersResponse
advance_filter
array of object (FiltersInfo)
Optional
Array of FiltersInfo
global_filter
array of object (FiltersInfo)
Optional
Array of FiltersInfo
Examples
Parameters
view:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/filter/listing
Loading...
Response
Loading...

Order

Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method.

Operations
GET
/service/platform/order-manage/v1.0/company/{company_id}/roles
# Get role-based actions
POST
/service/platform/order-manage/v1.0/company/{company_id}/create-order
# Create order
GET
/service/platform/order-manage/v1.0/company/{company_id}/order-config
# Get channel configuration
POST
/service/platform/order-manage/v1.0/company/{company_id}/order-config
# Create channel configuration
PUT
/service/platform/order-manage/v1.0/company/{company_id}/order/validation
# Update an order
POST
/service/platform/order-manage/v1.0/company/{company_id}/debug/order_status
# Debug order
POST
/service/platform/order-manage/v1.0/company/{company_id}/customer-credit-balance
# Get credit balance detail
POST
/service/platform/order-manage/v1.0/company/{company_id}/refund-mode-config
# List refund modes
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/attach
# Attach order to a user
GET
/service/platform/order-manage/v1.0/company/{company_id}/orders/failed
# List failed order logs
GET
/service/platform/order-manage/v1.0/company/{company_id}/orders/failed/logs/{log_id}
# Get failed order log
GET
/service/platform/order/v1.0/company/{company_id}/order-details
# Get order
GET
/service/platform/order/v1.0/company/{company_id}/orders-listing
# List orders
GET
/service/platform/order/v1.0/company/{company_id}/filter-listing
# List filters
GET
/service/platform/order/v1.0/company/{company_id}/orders/{order_id}/generate/pos-receipt
# Generate POS receipt by order Id
GET

Get role-based actions

Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only.
Parameters
No Parameters
Response
200
4XX
5XX
You will get an array of actions allowed for that particular user based on their role
GetActionsResponse
permissions
array of object (ActionInfo)
Optional
Array of ActionInfo
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/roles
Loading...
Response
Loading...
POST

Create order

Creates an order
Parameters
body
object (CreateOrderAPI)
CreateOrderAPI
shipments
array of object (Shipment)
Array of Shipment
shipping_info
object (ShippingInfo)
ShippingInfo
billing_info
object (BillingInfo)
BillingInfo
currency_info
object
Optional
external_order_id
string
Optional
charges
array of object (Charge)
Optional
Array of Charge
external_creation_date
string
Optional
meta
object
Optional
tax_info
object (TaxInfo)
Optional
TaxInfo
config
object
Optional
payment_info
object (PaymentInfo)
PaymentInfo
user_info
object (UserInfo)
Optional
UserInfo
ordering_store_id
integer
| int32
Optional
order_platform
string
Optional
Response
200
4XX
5XX
Successfully created an order!
CreateOrderResponse
fynd_order_id
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/create-order
Loading...
Response
Loading...
GET

Get channel configuration

Retrieve configuration settings specific to orders for a channel
Parameters
No Parameters
Response
200
4XX
5XX
Successfully created the config data
CreateChannelConfigData
config_data
object (CreateChannelConfig)
Optional
CreateChannelConfig
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/order-config
Loading...
Response
Loading...
POST

Create channel configuration

Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel
Parameters
body
object (CreateChannelConfigData)
CreateChannelConfigData
config_data
object (CreateChannelConfig)
Optional
CreateChannelConfig
Response
200
4XX
5XX
Successfully updateShipmentStatus!
CreateChannelConfigResponse
is_inserted
boolean
Optional
is_upserted
boolean
Optional
acknowledged
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/order-config
Loading...
Response
Loading...
PUT

Update an order

Used to update an order's meta information. These meta information can be accessed via order or shipment details API.
Parameters
body
object (PlatformOrderUpdate)
PlatformOrderUpdate
order_id
string
Response
200
4XX
5XX
We are processing the order!
ResponseDetail
success
boolean
Optional
message
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/order-manage/v1.0/company/{company_id}/order/validation
Loading...
Response
Loading...
POST

Debug order

Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc.
Parameters
body
object (OrderStatus)
OrderStatus
order_details
array of object (FyndOrderIdList)
Optional
Array of FyndOrderIdList
start_date
string
end_date
string
mobile
integer
| int32
Response
200
Order Status retrieved successfully
OrderStatusResult
success
string
result
array of object (OrderStatusData)
Optional
Array of OrderStatusData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/debug/order_status
Loading...
Response
Loading...
POST

Get credit balance detail

Retrieve details about credit balance on the basis of customer mobile number
Parameters
body
object (FetchCreditBalanceRequestPayload)
FetchCreditBalanceRequestPayload
affiliate_id
string
seller_id
string
customer_mobile_number
string
Response
200
4XX
Credit Balance will be fetched
FetchCreditBalanceResponsePayload
success
boolean
data
object (CreditBalanceInfo)
CreditBalanceInfo
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/customer-credit-balance
Loading...
Response
Loading...
POST

List refund modes

Get list of refund modes to trigger refunds
Parameters
body
object (RefundModeConfigRequestPayload)
RefundModeConfigRequestPayload
fynd_order_id
string
seller_id
integer
| int32
affiliate_id
string
customer_mobile_number
string
Optional
Response
200
4XX
Refund mode config is returned based on input parameter
RefundModeConfigResponsePayload
success
boolean
data
array of object (RefundModeInfo)
Array of RefundModeInfo
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/refund-mode-config
Loading...
Response
Loading...
POST

Attach order to a user

Attach an anonymous order to a customer based on OTP verification
Parameters
body
object (AttachOrderUser)
AttachOrderUser
otp_data
object (AttachUserOtpData)
AttachUserOtpData
fynd_order_id
string
user_info
object (AttachUserInfo)
AttachUserInfo
Response
200
4XX
Attach user to order
AttachOrderUserResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/attach
Loading...
Response
Loading...
GET

List failed order logs

Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id.
Parameters
pageNo
integer
Optional
Page Number
pageSize
integer
Optional
Page Size
searchType
string
Optional
Search type for filter
searchValue
string
Optional
Search value for filter
Response
200
4XX
5XX
Order Logs listing fetched successfully
FailedOrderLogs
items
object (FailedOrdersItem)
FailedOrdersItem
page
object (PageDetails)
PageDetails
Examples
Parameters
pageNo:
0
pageSize:
0
searchType:
"value"
searchValue:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/orders/failed
Loading...
Response
Loading...
GET

Get failed order log

Get the exact error trace from the log Id provided in the failed order list API response
Parameters
logId
string
Log Error ID
Response
200
4XX
5XX
Order Logs listing fetched successfully
FailedOrderLogDetails
error_trace
string
Nullable
exception
string
Nullable
Examples
Parameters
logId:
"value"
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/orders/failed/logs/{log_id}
Loading...
Response
Loading...
GET

Get order

Get detailed information about a specific order
Parameters
orderId
string
Default Value : FY6299E19701B4EAEFC2
myOrders
boolean
Optional
allowInactive
boolean
Optional
Flag to allow inactive shipments
Default Value : false
Response
200
4XX
We are processing the report!
OrderDetailsResponse
order
object (OrderData)
Optional
OrderData
success
boolean
shipments
array of object (PlatformShipment)
Optional
Array of PlatformShipment
Examples
Parameters
orderId:
"value"
myOrders:
false
allowInactive:
false
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/order-details
Loading...
Response
Loading...
GET

List orders

Get a list of orders based on the filters provided
Parameters
lane
string
Optional
lane refers to a section where orders are assigned, indicating its grouping
Default Value : new
searchType
string
Optional
search_type refers to the field that will be used as the target for the search operation
Default Value : shipment_id
bagStatus
string
Optional
bag_status refers to status of the entity. Filters orders based on the status.
timeToDispatch
integer
Optional
time_to_dispatch refers to estimated SLA time.
Enum
paymentMethods
string
Optional
tags
string
Optional
tags refers to additional descriptive labels associated with the order
searchValue
string
Optional
search_value is matched against the field specified by the search_type
Default Value : 16854460524441037000
fromDate
string
Optional
toDate
string
Optional
startDate
string
Optional
endDate
string
Optional
dpIds
string
Optional
Delivery Partner IDs to which shipments are assigned.
stores
string
Optional
salesChannels
string
Optional
pageNo
integer
Optional
pageSize
integer
Optional
isPrioritySort
boolean
Optional
Default Value : true
customMeta
string
Optional
Default Value : 6388422a5ebd6a6cf4a8ede6
myOrders
boolean
Optional
showCrossCompanyData
boolean
Optional
Flag to view cross & non-cross company order
Default Value : false
customerId
string
Optional
orderType
string
Optional
allowInactive
boolean
Optional
Flag indicating whether inactive shipments are allowed
Default Value : false
Response
200
4XX
We are processing the report!
OrderListingResponse
total_count
integer
Nullable
Optional
message
string
Nullable
Optional
success
boolean
Nullable
Optional
items
array of object (PlatformOrderItems)
Optional
Array of PlatformOrderItems
lane
string
Nullable
Optional
page
object (Page)
Optional
Page
Examples
Parameters
lane:
"value"
searchType:
"value"
bagStatus:
"value"
timeToDispatch:
0
paymentMethods:
"value"
tags:
"value"
searchValue:
"value"
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
dpIds:
"value"
stores:
"value"
salesChannels:
"value"
pageNo:
0
pageSize:
0
isPrioritySort:
false
customMeta:
"value"
myOrders:
false
showCrossCompanyData:
false
customerId:
"value"
orderType:
"value"
allowInactive:
false
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/orders-listing
Loading...
Response
Loading...
GET

List filters

Get supported filters for various listing operations
Parameters
view
string
Name of view
Default Value : manifest
Enum
groupEntity
string
Optional
Name of group entity
Default Value : orders
Enum
Response
200
4XX
List of filters
FiltersResponse
advance_filter
object (AdvanceFilterInfo)
Optional
AdvanceFilterInfo
global_filter
array of object (FiltersInfo)
Optional
Array of FiltersInfo
Examples
Parameters
view:
"value"
groupEntity:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/filter-listing
Loading...
Response
Loading...
GET

Generate POS receipt by order Id

Create a point-of-sale (POS) receipt for a specific order by order Id.
Parameters
orderId
string
shipmentId
string
Optional
documentType
string
Optional
Default Value : invoice_receipt
Response
200
4XX
We are processing the request!
GeneratePosOrderReceiptResponse
customer_cn_receipt
string
Optional
success
boolean
Optional
order_id
string
Optional
invoice_receipt
string
Optional
payment_receipt
string
Optional
merchant_cn_receipt
string
Optional
payment_receipt_template
string
Optional
customer_cn_receipt_template
string
Optional
invoice_receipt_template
string
Optional
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
documentType:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/orders/{order_id}/generate/pos-receipt
Loading...
Response
Loading...

Reports

Reports are summaries of various data points related to your orders. These can include order reports for example - New, Confirmed, To be packed, Return Delivered, etc, Lane download, etc. Use this to download shipment's data on the basis of status, download shipments on the basis of type of lane selected.

Operations
POST
/service/platform/order-manage/v1.0/company/{company_id}/reports/lanes/download
# Download Lane report
GET
/service/platform/order/v1.0/company/{company_id}/generate/file
# Generate the report
POST

Download Lane report

Downloads shipments/orders present in the provided lane
Parameters
body
object (BulkReportsDownloadRequest)
BulkReportsDownloadRequest
store_ids
array of string
Optional
Download for specific store ids.
lane_type
string
Optional
custom_headers
string
Optional
Download report with specific headers
report_type
string
Optional
Type of report
start_date
string
| date-time
Optional
UTC start date in ISO format
end_date
string
| date-time
Optional
UTC end date in ISO format
entities
array of string
Optional
Download for specific enitites, entities can be bag, shipment or order_id, etc.
filter_type
string
Optional
is_cross_company_enabled
boolean
Optional
Download lanes for cross company.
custom_filters_for_lane
object
Optional
Response
200
4XX
Bulk Report creation initiated.
BulkReportsDownloadResponse
success
boolean
Optional
batch_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/reports/lanes/download
Loading...
Response
Loading...
GET

Generate the report

Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided
Parameters
salesChannels
string
Optional
Comma separated values of sales channel ids
dpIds
string
Optional
Comma separated values of delivery partner ids
startDate
string
| date-time
Optional
UTC start date in ISO format
endDate
string
| date-time
Optional
UTC end date in ISO format
stores
string
Optional
Comma separated values of store ids
tags
string
Optional
Comma separated values of tags
bagStatus
string
Optional
Comma separated values of bag statuses
paymentMethods
string
Optional
Comma separated values of payment methods
fileType
string
Optional
File type to be downloaded
timeToDispatch
integer
Optional
Sla breached or not breached
Enum
pageNo
integer
Optional
Default Value : 1
pageSize
integer
Optional
Default Value : 10
Response
200
4XX
We are processing the file!
FileResponse
file_name
string
Optional
Name of the file
cdn
object (URL)
Optional
URL
Examples
Parameters
salesChannels:
"value"
dpIds:
"value"
startDate:
"value"
endDate:
"value"
stores:
"value"
tags:
"value"
bagStatus:
"value"
paymentMethods:
"value"
fileType:
"value"
timeToDispatch:
0
pageNo:
0
pageSize:
0
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/generate/file
Loading...
Response
Loading...

Shipment

Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.

Operations
PUT
/service/platform/order-manage/v1.0/company/{company_id}/update-cache
# Invalidate shipment cache
POST
/service/platform/order-manage/v1.0/company/{company_id}/store/reassign-internal
# Reassign location
POST
/service/platform/order-manage/v1.0/company/{company_id}/entity/lock-manager
# Update a shipment lock
POST
/service/platform/order-manage/v1.0/company/{company_id}/delight/update-address
# Update shipment address
PUT
/service/platform/order-manage/v1.0/company/{company_id}/shipment/status-internal
# Update a shipment's status
GET
/service/platform/order-manage/v1.0/company/{company_id}/shipment/history
# Get a shipment's history
POST
/service/platform/order-manage/v1.0/company/{company_id}/shipment/history
# Create shipment history
POST
/service/platform/order-manage/v1.0/company/{company_id}/ninja/send-sms
# Send SMS
POST
/service/platform/order-manage/v1.0/company/{company_id}/update-packaging-dimension
# Update packaging dimensions
GET
/service/platform/order-manage/v1.0/company/{company_id}/bag/state/transition
# Get state transition map
GET
/service/platform/order-manage/v1.0/company/{company_id}/allowed/state/transition
# Get allowed state transition
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/send/otp/mobile
# Send user mobile OTP
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/verify/otp
# Verify mobile OTP
POST
/service/platform/order-manage/v1.0/company/{company_id}/einvoice/retry/irn
# Retry E-invoice
GET
/service/platform/order-manage/v1.0/company/{company_id}/tracking
# Track shipment
POST
/service/platform/order-manage/v1.0/company/{company_id}/tracking
# Update shipment tracking
POST
/service/platform/order-manage/v1.0/company/{company_id}/{invoice_type}/id/generate
# Generate and attach invoice Id
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/line_number/{line_number}/reasons
# List bag cancellation reasons
GET
/service/platform/order/v1.0/company/{company_id}/shipments-listing
# List shipments
GET
/service/platform/order/v1.0/company/{company_id}/shipment-details
# Get shipment
GET
/service/platform/order/v1.0/company/{company_id}/lane-config/
# Get lane configuration
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/shipments/
# List sales channel shipments
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/track
# Track shipment
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/reasons/{action}
# List shipment cancellation reasons
PUT

Invalidate shipment cache

Deprecated
Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use.
Parameters
body
object (InvalidateShipmentCachePayload)
Shipment Ids to clear cache!. NOTE Must pass one of the three Field, which then clear the shipment cached data. This api will use only one of the fields passed even if you pass all. Priority Order (shipment_ids > affiliate_bag_ids > bag_ids)
InvalidateShipmentCachePayload
shipment_ids
array of string
Optional
Shipment Ids to clear cache
affiliate_bag_ids
array of string
Optional
Affiliate Bag Ids to clear cache of shipment Ids mapped to it
bag_ids
array of string
Optional
Bag Ids to clear cache of shipment Ids mapped to it
Response
200
4XX
5XX
Successfully updated shipment cache!
InvalidateShipmentCacheResponse
response
array of object (InvalidateShipmentCacheNestedResponse)
Optional
Array of InvalidateShipmentCacheNestedResponse
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/order-manage/v1.0/company/{company_id}/update-cache
Loading...
Response
Loading...
POST

Reassign location

Reassign the shipment to a another location and update its status to 'Store Reassigned.'
Parameters
body
object (StoreReassign)
StoreReassign
store_id
integer
| int32
bag_id
integer
| int32
Nullable
Optional
affiliate_order_id
string
Nullable
Optional
affiliate_id
string
Nullable
Optional
item_id
string
Nullable
Optional
fynd_order_id
string
Nullable
Optional
set_id
string
Nullable
Optional
affiliate_bag_id
string
Nullable
Optional
reason_ids
array of integer
Nullable
Optional
mongo_article_id
string
Nullable
Optional
Response
200
4XX
Successfully reassigned location!
StoreReassignResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/store/reassign-internal
Loading...
Response
Loading...
POST

Update a shipment lock

Modify shipment/bag lock and check status.
Parameters
body
object (UpdateShipmentLockPayload)
UpdateShipmentLockPayload
entity_type
string
Expected entity_type: [bags, shipments]
Enum
action
string
Expected Actions: [lock, unlock, check]
Enum
action_type
string
Expected action_type: [complete, operational, financial]
Enum
entities
array of object (Entities)
Shipment/Entity
Array of Entities
resume_tasks_after_unlock
boolean
Nullable
Optional
lock_after_transition
boolean
Optional
Lock Shipment After Transition
unlock_before_transition
boolean
Optional
Unlock Shipment After Transition
Response
200
4XX
Successfully update the Lock and get check status of the shipment/Bag
UpdateShipmentLockResponse
success
boolean
Optional
message
string
Optional
check_response
array of object (CheckResponse)
Optional
Entity Lock Status, If the action input as 'check'
Array of CheckResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/entity/lock-manager
Loading...
Response
Loading...
POST

Update shipment address

Modify the address details of an existing shipment
Parameters
shipmentId
string
name
string
Optional
address
string
Optional
addressType
string
Optional
pincode
string
Optional
phone
string
Optional
email
string
Optional
landmark
string
Optional
addressCategory
string
city
string
Optional
state
string
Optional
country
string
Optional
Response
200
4XX
Update Address will be processed!
BaseResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
shipmentId:
"value"
name:
"value"
address:
"value"
addressType:
"value"
pincode:
"value"
phone:
"value"
email:
"value"
landmark:
"value"
addressCategory:
"value"
city:
"value"
state:
"value"
country:
"value"
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/delight/update-address
Loading...
Response
Loading...
PUT

Update a shipment's status

Used for updating a shipment and its status. Can also be used for updating bags present in that shipment.
Parameters
body
object (UpdateShipmentStatusRequest)
UpdateShipmentStatusRequest
force_transition
boolean
Optional
Force Transition
statuses
array of object (StatuesRequest)
Optional
Array of StatuesRequest
lock_after_transition
boolean
Optional
Lock Shipment After Transition
unlock_before_transition
boolean
Optional
Unlock Shipment After Transition
task
boolean
Optional
To Run Status Update as a background Task
Response
200
4XX
NOTE success response can contains success and failed result as well
UpdateShipmentStatusResponseBody
statuses
array of object (StatuesResponse)
Optional
Array of StatuesResponse
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/order-manage/v1.0/company/{company_id}/shipment/status-internal
Loading...
Response
Loading...
GET

Get a shipment's history

Get the history of the shipment
Parameters
shipmentId
string
Optional
Shipment Id
bagId
integer
Optional
Bag/Product Id
Response
200
4XX
5XX
It shows the journey of the shipment!
ShipmentHistoryResponse
success
boolean
Optional
activity_history
array of object (HistoryDict)
Array of HistoryDict
Examples
Parameters
shipmentId:
"value"
bagId:
0
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/shipment/history
Loading...
Response
Loading...
POST

Create shipment history

Used to add logs in history for a bag for the provided Shipment ID
Parameters
body
object (PostShipmentHistory)
PostShipmentHistory
activity_history
array of object (PostHistoryDict)
Optional
Array of PostHistoryDict
Response
200
4XX
5XX
It shows the journey of the shipment!
ShipmentHistoryResponse
success
boolean
Optional
activity_history
array of object (HistoryDict)
Array of HistoryDict
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/shipment/history
Loading...
Response
Loading...
POST

Send SMS

Send SMS to customer based on the template that is selected
Parameters
body
object (SendSmsPayload)
SendSmsPayload
bag_id
integer
| int32
bag_id for the activity history track
data
object (SmsDataPayload)
Optional
SMS Data
SmsDataPayload
slug
string
slug name for the template mapped in pointblank
Response
200
4XX
5XX
Sms Sent successfully
OrderStatusResult
success
string
result
array of object (OrderStatusData)
Optional
Array of OrderStatusData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/ninja/send-sms
Loading...
Response
Loading...
POST

Update packaging dimensions

Used to modify the packaging dimension of a shipment
Parameters
body
object (UpdatePackagingDimensionsPayload)
UpdatePackagingDimensionsPayload
shipment_id
string
current_status
string
dimension
array of object (Dimension)
Array of Dimension
Response
200
4XX
Manifest will be processed!
UpdatePackagingDimensionsResponse
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/update-packaging-dimension
Loading...
Response
Loading...
GET

Get state transition map

Retrieve a map of state transitions for orders
Parameters
No Parameters
Response
200
4XX
State Transition Mapping, for next possible state
BagStateTransitionMap
fynd
object
Optional
affiliate
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/bag/state/transition
Loading...
Response
Loading...
GET

Get allowed state transition

Retrieve next possible states based on logged in user's role
Parameters
orderingChannel
string
Ordering channel
status
string
current status of a shipment
Response
200
4XX
Role wise state transition mapping, for next possible state
RoleBaseStateTransitionMapping
success
boolean
Optional
next_statuses
array of string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/allowed/state/transition
Loading...
Response
Loading...
POST

Send user mobile OTP

Send a one-time OTP to a customer mobile number
Parameters
body
object (SendUserMobileOTP)
SendUserMobileOTP
mobile
string
country_code
string
Optional
Response
200
4XX
Send OTP to user mobile
SendUserMobileOtpResponse
success
boolean
Optional
message
string
Optional
data
object (PointBlankOtpData)
Optional
PointBlankOtpData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/send/otp/mobile
Loading...
Response
Loading...
POST

Verify mobile OTP

Perform OTP verification to link a user to an anonymous order
Parameters
body
object (VerifyMobileOTP)
VerifyMobileOTP
otp_data
object (VerifyOtpData)
VerifyOtpData
fynd_order_id
string
Response
200
4XX
Verify OTP
VerifyOtpResponse
status
integer
| int32
Optional
success
boolean
Optional
message
string
Optional
data
object (VerifyOtpResponseData)
Optional
VerifyOtpResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/user/verify/otp
Loading...
Response
Loading...
POST

Retry E-invoice

Reattempt the generation of an E-invoice
Parameters
body
object (EInvoiceRetry)
EInvoiceRetry
shipments_data
array of object (EInvoiceRetryShipmentData)
Optional
Array of EInvoiceRetryShipmentData
Response
200
400
500
E-invoice generated successfully for all/few shipments from given list of shipments.
EInvoiceRetryResponse
response_data
array of object (EInvoiceResponseData)
Array of EInvoiceResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/einvoice/retry/irn
Loading...
Response
Loading...
GET

Track shipment

Retrieve courier partner tracking details for a given shipment Id or AWB number
Parameters
shipmentId
string
Optional
Shipment ID
awb
string
Optional
AWB number
pageNo
integer
Optional
Page number
pageSize
integer
Optional
Page size
Response
200
4XX
Shipment Tracking fetched successfully
CourierPartnerTrackingResponse
items
array of object (CourierPartnerTrackingDetails)
Optional
Array of CourierPartnerTrackingDetails
page
object (PageDetails)
Optional
PageDetails
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/order-manage/v1.0/company/{company_id}/tracking
Loading...
Response
Loading...
POST

Update shipment tracking

Modify courier partner tracking details for a given shipment Id or AWB number
Parameters
body
object (CourierPartnerTrackingDetails)
CourierPartnerTrackingDetails
awb
string
AWB Number
dp_location
string
Nullable
Optional
Current location of Courier partner
dp_name
string
Courier Partner name
dp_status
string
Status at Courier partner end
dp_status_updated_at
string
| date-time
Date Time at which status was updated at Courier partner
estimated_delivery_date
string
| date-time
Nullable
Optional
Estimated delivery date received from Courier partner
id
integer
| int32
Optional
Id of Tracking history
journey
string
Journey type of the shipment
Enum
meta
object
Optional
Meta field to store Courier partner's meta data
operational_status
string
Operational status of OMS
promised_delivery_date
string
| date-time
Nullable
Optional
Promised delivery date received from Courier partner
remark
string
Nullable
Optional
Remark from courier partner
shipment_id
string
Shipment ID
Response
200
4XX
Shipment Tracking updated successfully
CourierPartnerTrackingDetails
awb
string
AWB Number
dp_location
string
Nullable
Optional
Current location of Courier partner
dp_name
string
Courier Partner name
dp_status
string
Status at Courier partner end
dp_status_updated_at
string
| date-time
Date Time at which status was updated at Courier partner
estimated_delivery_date
string
| date-time
Nullable
Optional
Estimated delivery date received from Courier partner
id
integer
| int32
Optional
Id of Tracking history
journey
string
Journey type of the shipment
Enum
meta
object
Optional
Meta field to store Courier partner's meta data
operational_status
string
Operational status of OMS
promised_delivery_date
string
| date-time
Nullable
Optional
Promised delivery date received from Courier partner
remark
string
Nullable
Optional
Remark from courier partner
shipment_id
string
Shipment ID
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/tracking
Loading...
Response
Loading...
POST

Generate and attach invoice Id

Generate and attach Invoice Ids against shipments.
Parameters
invoiceType
string
mention the type of invoice id to generate
body
object (GenerateInvoiceIDRequest)
GenerateInvoiceIDRequest
shipment_ids
array of string
Response
200
4XX
NOTE success response can contains success and failed result as well
GenerateInvoiceIDResponse
items
array of object (GenerateInvoiceIDResponseData)
Optional
Array of GenerateInvoiceIDResponseData
Examples
Parameters
invoiceType:
"value"
body:
body
Was this section helpful?
POST
/service/platform/order-manage/v1.0/company/{company_id}/{invoice_type}/id/generate
Loading...
Response
Loading...
GET

List bag cancellation reasons

Get reasons to perform full or partial cancellation of a shipment
Parameters
shipmentId
string
ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
lineNumber
integer
line number of bag.
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
ShipmentBagReasons
reasons
array of object (BagReasons)
Optional
Array of BagReasons
success
boolean
Optional
Examples
Parameters
shipmentId:
"value"
lineNumber:
0
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/line_number/{line_number}/reasons
Loading...
Response
Loading...
GET

List shipments

Get a list of shipments based on the filters provided
Parameters
lane
string
Optional
Name of lane for which data is to be fetched
Enum
bagStatus
string
Optional
Comma separated values of bag statuses
statusOverrideLane
boolean
Optional
Use this flag to fetch by bag_status and override lane
Default Value : false
timeToDispatch
integer
Optional
Enum
searchType
string
Optional
Search type key
searchValue
string
Optional
Search type value
fromDate
string
| date
Optional
Start Date in DD-MM-YYYY format
toDate
string
| date
Optional
End Date in DD-MM-YYYY format
startDate
string
| date-time
Optional
UTC Start Date in ISO format
endDate
string
| date-time
Optional
UTC End Date in ISO format
dpIds
string
Optional
Comma separated values of delivery partner ids
stores
string
Optional
Comma separated values of store ids
salesChannels
string
Optional
Comma separated values of sales channel ids
pageNo
integer
Optional
Page number for paginated data
Default Value : 1
pageSize
integer
Optional
Page size of data received per page
Default Value : 10
fetchActiveShipment
boolean
Optional
flag to fetch active shipments
Default Value : true
allowInactive
boolean
Optional
Flag to allow inactive shipments
Default Value : false
excludeLockedShipments
boolean
Optional
flag to fetch locked shipments
Default Value : true
paymentMethods
string
Optional
Comma separated values of payment methods
channelShipmentId
string
Optional
App Shipment Id
channelOrderId
string
Optional
App Order Id
customMeta
string
Optional
orderingChannel
string
Optional
companyAffiliateTag
string
Optional
myOrders
boolean
Optional
platformUserId
string
Optional
sortType
string
Optional
Sort the result data on basis of input
Default Value : sla_asc
Enum
showCrossCompanyData
boolean
Optional
Flag to view cross & non-cross company order
Default Value : false
tags
string
Optional
Comma separated values of tags
customerId
string
Optional
orderType
string
Optional
Response
200
4XX
We are processing the report!
ShipmentInternalPlatformViewResponse
total_count
integer
Nullable
Optional
message
string
Nullable
Optional
success
boolean
Nullable
Optional
items
array of object (ShipmentItem)
Optional
Array of ShipmentItem
lane
string
Nullable
Optional
page
object (Page)
Optional
Page
Examples
Parameters
lane:
"value"
bagStatus:
"value"
statusOverrideLane:
false
timeToDispatch:
0
searchType:
"value"
searchValue:
"value"
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
dpIds:
"value"
stores:
"value"
salesChannels:
"value"
pageNo:
0
pageSize:
0
fetchActiveShipment:
false
allowInactive:
false
excludeLockedShipments:
false
paymentMethods:
"value"
channelShipmentId:
"value"
channelOrderId:
"value"
customMeta:
"value"
orderingChannel:
"value"
companyAffiliateTag:
"value"
myOrders:
false
platformUserId:
"value"
sortType:
"value"
showCrossCompanyData:
false
tags:
"value"
customerId:
"value"
orderType:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/shipments-listing
Loading...
Response
Loading...
GET

Get shipment

Get detailed information about a specific shipment
Parameters
channelShipmentId
string
Optional
App Shipment Id
shipmentId
string
Optional
Shipment Id
fetchActiveShipment
boolean
Optional
flag to fetch active or deactivated shipments
allowInactive
boolean
Optional
Flag indicating whether inactive shipments are allowed
Default Value : false
Response
200
4XX
We are processing the report!
ShipmentInfoResponse
message
string
Nullable
Optional
success
boolean
shipments
array of object (PlatformShipment)
Optional
Array of PlatformShipment
Examples
Parameters
channelShipmentId:
"value"
shipmentId:
"value"
fetchActiveShipment:
false
allowInactive:
false
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/shipment-details
Loading...
Response
Loading...
GET

Get lane configuration

Get configuration settings for lanes
Parameters
superLane
string
Optional
Name of lane for which data is to be fetched
Default Value : unfulfilled
Enum
groupEntity
string
Optional
Name of group entity
Default Value : shipments
Enum
fromDate
string
Optional
Start Date in DD-MM-YYYY format
toDate
string
Optional
End Date in DD-MM-YYYY format
startDate
string
Optional
UTC Start Date in ISO format
endDate
string
Optional
UTC End Date in ISO format
dpIds
string
Optional
Comma separated values of delivery partner ids
stores
string
Optional
Comma separated values of store ids
salesChannels
string
Optional
paymentMode
string
Optional
Comma separated values of payment modes
bagStatus
string
Optional
Comma separated values of bag statuses
searchType
string
Optional
searchValue
string
Optional
tags
string
Optional
timeToDispatch
integer
Optional
Enum
paymentMethods
string
Optional
myOrders
boolean
Optional
showCrossCompanyData
boolean
Optional
Flag to view cross & non-cross company order
Default Value : false
orderType
string
Optional
Response
200
4XX
Response containing count of shipments of the given status
LaneConfigResponse
super_lanes
array of object (SuperLane)
Optional
Array of SuperLane
Examples
Parameters
superLane:
"value"
groupEntity:
"value"
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
dpIds:
"value"
stores:
"value"
salesChannels:
"value"
paymentMode:
"value"
bagStatus:
"value"
searchType:
"value"
searchValue:
"value"
tags:
"value"
timeToDispatch:
0
paymentMethods:
"value"
myOrders:
false
showCrossCompanyData:
false
orderType:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/lane-config/
Loading...
Response
Loading...
GET

List sales channel shipments

Get shipments of a particular sales channel based on the filters provided
Parameters
lane
string
Optional
searchType
string
Optional
searchId
string
Optional
fromDate
string
Optional
toDate
string
Optional
dpIds
string
Optional
orderingCompanyId
string
Optional
stores
string
Optional
salesChannel
string
Optional
requestByExt
string
Optional
pageNo
integer
Optional
pageSize
integer
Optional
customerId
string
Optional
isPrioritySort
boolean
Optional
Default Value : true
excludeLockedShipments
boolean
Optional
Default Value : true
Response
200
4XX
We are processing the report!
ShipmentInternalPlatformViewResponse
total_count
integer
Nullable
Optional
message
string
Nullable
Optional
success
boolean
Nullable
Optional
items
array of object (ShipmentItem)
Optional
Array of ShipmentItem
lane
string
Nullable
Optional
page
object (Page)
Optional
Page
Examples
Parameters
lane:
"value"
searchType:
"value"
searchId:
"value"
fromDate:
"value"
toDate:
"value"
dpIds:
"value"
orderingCompanyId:
"value"
stores:
"value"
salesChannel:
"value"
requestByExt:
"value"
pageNo:
0
pageSize:
0
customerId:
"value"
isPrioritySort:
false
excludeLockedShipments:
false
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/shipments/
Loading...
Response
Loading...
GET

Track shipment

Track shipment by shipment Id for an application
Parameters
shipmentId
string
Shipment Id
Response
200
4XX
5XX
Success. Check the example shown below or refer `PlatformShipmentTrack` for more details.
PlatformShipmentTrack
meta
object
Optional
results
array of object (PlatformTrack)
Optional
Array of PlatformTrack
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/track
Loading...
Response
Loading...
GET

List shipment cancellation reasons

Get reasons to perform full or partial cancellation of a shipment
Parameters
action
string
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentReasonsResponse` for more details.
ShipmentReasonsResponse
reasons
array of object (ShipmentResponseReasons)
Array of ShipmentResponseReasons
message
string
success
boolean
Examples
Parameters
action:
"value"
Was this section helpful?
GET
/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/reasons/{action}
Loading...
Response
Loading...