DispatchOne Solution

Order API

5min

Overview
This guide provides detailed information on how to use the Order API to create, retrieve, and manage orders. The API is designed to help you integrate order management functionalities into your applications seamlessly.
 The Order API allows you to:
Create new orders.
Retrieve details of existing orders.
Manage order-related operations such as updates, cancellations, and more.
You can leverage the pre-defined attributes provided by the LogisticsOrder API to quickly develop order management applications.

The ‘Orders’ in LogisticsOrder API are a set of instructions passed by the Client to the Tenant for execution. Orders can be for the physical movement of items (for example, moving items from the consignor to the consignee).
API configuration
When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.
﻿Authentication - Access OS1 with OAuth 2.0
﻿Building Apps -   Obtain credentails
﻿Object operations - Configure your requests
Object structure
Use the table below for information about the order objects.
Fields
Data Type
Description
Example Values
OrderEntity
object
Root object for Order API.
N/A
→ dropDetails
object
Drop location details.
N/A
→ orderSummary
object
Summary of the order.
N/A
→ clientDetails
object
Client-specific details.
N/A
→ productType
string
Type of product.
"parcel"
→ shipmentFlow
string
Type of shipment flow.
"forward"
→ pickupDetails
object
Pickup location details.
N/A
→ paymentInformation
object
Payment method details.
N/A
→ deliveryDetails
object
Delivery specifications.
N/A
→ returnDetails
object
Return logistics details.
N/A
→ priority
number
Priority level of the order.
1
→ maxAttempts
number
Maximum retry attempts.
3
→ teamId
string
Operating team managing the order.
"default"
→ seqNo
number
Order sequence for display.
100
→ routeTag
string
Routing details.
"route1"
→ containers
array
Packaging container details.
[{...}]
→ → containers[]
object
Container details.
N/A
→ → → containerType
string
Type of the container.
"box"
→ → → scannableId
string
Unique scannable identifier.
"CNT-001"
→ → → trackingId
string
Tracking ID of the container.
"TRK123"
→ → → attributes
object
Container attributes.
{...}
→ → → → dimensions
object
Physical dimensions of the container.
{...}
→ → → → → length
number
Length in cm.
50
→ → → → → breadth
number
Breadth in cm.
30
→ → → → → height
number
Height in cm.
20
→ → → → → weight
number
Weight in kg.
10
→ → → → → volume
number
Volume in cubic cm.
5000
Fields
Data Type
Descriptions
Example Values
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
Fields
Data Type
Description
Example Values
UpdateOrderEntity
object
Root object for updating an order.
N/A
→ dropDetails
object
Drop location details.
N/A
→ orderSummary
object
Summary of the order.
N/A
→ clientDetails
object
Client-specific details.
N/A
→ productType
string
Type of product.
"parcel"
→ shipmentFlow
string
Shipment flow type.
"forward"
→ pickupDetails
object
Pickup location details.
N/A
→ paymentInformation
object
Payment details.
N/A
→ deliveryDetails
object
Delivery specifications.
N/A
→ returnDetails
object
Return logistics details.
N/A
﻿
﻿
﻿

Fields	Data Type	Description	Example Values
OrderEntity	object	Root object for Order API.	N/A
→ dropDetails	object	Drop location details.	N/A
→ orderSummary	object	Summary of the order.	N/A
→ clientDetails	object	Client-specific details.	N/A
→ productType	string	Type of product.	"parcel"
→ shipmentFlow	string	Type of shipment flow.	"forward"
→ pickupDetails	object	Pickup location details.	N/A
→ paymentInformation	object	Payment method details.	N/A
→ deliveryDetails	object	Delivery specifications.	N/A
→ returnDetails	object	Return logistics details.	N/A
→ priority	number	Priority level of the order.	1
→ maxAttempts	number	Maximum retry attempts.	3
→ teamId	string	Operating team managing the order.	"default"
→ seqNo	number	Order sequence for display.	100
→ routeTag	string	Routing details.	"route1"
→ containers	array	Packaging container details.	[{...}]
→ → containers[]	object	Container details.	N/A
→ → → containerType	string	Type of the container.	"box"
→ → → scannableId	string	Unique scannable identifier.	"CNT-001"
→ → → trackingId	string	Tracking ID of the container.	"TRK123"
→ → → attributes	object	Container attributes.	{...}
→ → → → dimensions	object	Physical dimensions of the container.	{...}
→ → → → → length	number	Length in cm.	50
→ → → → → breadth	number	Breadth in cm.	30
→ → → → → height	number	Height in cm.	20
→ → → → → weight	number	Weight in kg.	10
→ → → → → volume	number	Volume in cubic cm.	5000

Fields	Data Type	Description	Example Values
UpdateOrderEntity	object	Root object for updating an order.	N/A
→ dropDetails	object	Drop location details.	N/A
→ orderSummary	object	Summary of the order.	N/A
→ clientDetails	object	Client-specific details.	N/A
→ productType	string	Type of product.	"parcel"
→ shipmentFlow	string	Shipment flow type.	"forward"
→ pickupDetails	object	Pickup location details.	N/A
→ paymentInformation	object	Payment details.	N/A
→ deliveryDetails	object	Delivery specifications.	N/A
→ returnDetails	object	Return logistics details.	N/A

Updated 19 Feb 2025

Did this page help you?

Console FAQ

Order API

Order API

Overview

API configuration

Object structure

OrderEntity

UpdateOrderEntity

CreateOrderEntityRequest