Order
Manages orders, including processing, tracking, and updating order status.
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
GET
# List bag cancellation reasons
GET
# List sales channel shipments
GET
# Track shipment
GET
# List shipment cancellation reasons
GET
List bag cancellation reasons
Get reasons to perform full or partial cancellation of a shipment
Parameters
company_id
integer
Required
Id of company
application_id
string
Required
Application ID of company
shipment_id
string
Required
ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
line_number
integer
Required
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)
Array of BagReasons
success
boolean
Examples
Parameters
companyId:
1
applicationId:
"value"
shipmentId:
"value"
lineNumber:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List bag cancellation reasons
getShipmentBagReasons
GET
List sales channel shipments
Get shipments of a particular sales channel based on the filters provided
Parameters
company_id
integer
Required
application_id
string
Required
lane
string
search_type
string
search_id
string
from_date
string
to_date
string
dp_ids
string
ordering_company_id
string
stores
string
sales_channel
string
request_by_ext
string
page_no
integer
page_size
integer
customer_id
string
is_priority_sort
boolean
Default Value : true
exclude_locked_shipments
boolean
Default Value : true
Response
200
4XX
We are processing the report!
ShipmentInternalPlatformViewResponse
total_count
integer
Nullable
message
string
Nullable
success
boolean
Nullable
items
array of object (ShipmentItem)
Array of ShipmentItem
lane
string
Nullable
page
object (Page)
Page
Examples
Parameters
companyId:
1
applicationId:
"value"
lane:
"value"
searchType:
"value"
searchId:
"value"
fromDate:
"value"
toDate:
"value"
dpIds:
"value"
orderingCompanyId:
"value"
stores:
"value"
salesChannel:
"value"
requestByExt:
"value"
pageNo:
1
pageSize:
1
customerId:
"value"
isPrioritySort:
false
excludeLockedShipments:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel shipments
getApplicationShipments
GET
Track shipment
Track shipment by shipment Id for an application
Parameters
company_id
string
Required
Id of company
application_id
string
Required
Id of application
shipment_id
string
Required
Shipment Id
Response
200
4XX
5XX
Success. Check the example shown below or refer `PlatformShipmentTrack` for more details.
PlatformShipmentTrack
meta
object
results
array of object (PlatformTrack)
Array of PlatformTrack
Examples
Parameters
companyId:
"value"
applicationId:
"value"
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Track shipment
trackShipmentPlatform
GET
List shipment cancellation reasons
Get reasons to perform full or partial cancellation of a shipment
Parameters
company_id
integer
Required
application_id
string
Required
action
string
Required
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
companyId:
1
applicationId:
"value"
action:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...