/orderProcessing/searchOrders

The API allows search orders

Request

Body Params application/json

dateFrom

integer

optional

The start timestamp of the date range.

Example:

1724956200000

dateTo

integer

optional

The end timestamp of the date range.

Example:

1725647399999

status

number

optional

The status of the order.

Example:

100

identificationParameter

string

optional

Parameter used for identifying the order.

Example:

consignorGroupCode

string

optional

Code for the consignor group.

Example:

CN-LKO001

consignorLocationCode

string

optional

Code for the consignor location.

Example:

direction

string

optional

The direction of the shipment (e.g., forward, reverse).

Example:

forward

pageNo

integer

optional

The page number for pagination.

Example:

rowCount

integer

optional

The number of rows to return.

Example:

Example

{
    "dateFrom": 1724956200000,
    "dateTo": 1725647399999,
    "status": 100,
    "identificationParameter": "",
    "consignorGroupCode": "CN-LKO001",
    "consignorLocationCode": "",
    "direction": "forward",
    "pageNo": 1,
    "rowCount": 50
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Message indicating the result of the order search.

Body

msg

string

optional

Example:

Order Data Received!!

status

number

optional

Example:

200

data

array [object {16}]

optional

Array of order details.

clientRefId

string

optional

The client reference identifier.

Example:

c2e55c72f2fc4849befbd20392e169f2

orderID

string

optional

Comma-separated list of order IDs.

Example:

2024090508965958, 2024090508757007

orderChannel

string

optional

Channel through which the order was placed.

Example:

Manual

courierPartner

string

optional

The courier partner handling the shipment.

Example:

ECOM

createdDate

integer

optional

Timestamp when the order was created.

Example:

1725505875991

orderStatus

integer

optional

Current status of the order.

Example:

1000

pickupReferenceNumber

string

optional

Reference number for the pickup.

Example:

240905-a0e0-15b7

courierAWBNumber

string

optional

The Air Waybill number of the courier.

Example:

715430528

shipmentValue

number

optional

The value of the shipment.

Example:

3291.8

rtsDate

integer

optional

Timestamp when the shipment is marked RTS.

Example:

null

estimatednextPickupAttemptDate

integer

optional

Estimated date for the next pickup attempt.

Example:

null

cancellationStatus

integer

optional

Status of the cancellation process.

Example:

consignorLocation

string

optional

Location of the consignor.

Example:

CN-LKO001-1

paymentMode

string

optional

Payment mode for the order (e.g., COD, PREPAID).

Example:

COD

serviceType

string

optional

Type of service for the shipment (e.g., ECONOMY).

Example:

ECONOMY

pickupAddress

string

optional

Address where the pickup will occur.

Example:

Uttam Nagar, Prayagraj, Lucknow, Uttar Pradesh, 226001

Example

{
    "msg": "Order Data Received!!",
    "status": 200,
    "data": [
        {
            "clientRefId": "c2e55c72f2fc4849befbd20392e169f2",
            "orderID": "2024090508965958, 2024090508757007",
            "orderChannel": "Manual",
            "courierPartner": "ECOM",
            "createdDate": 1725505875991,
            "orderStatus": 1000,
            "pickupReferenceNumber": "240905-a0e0-15b7",
            "courierAWBNumber": "715430528",
            "shipmentValue": 3291.8,
            "rtsDate": null,
            "estimatednextPickupAttemptDate": null,
            "cancellationStatus": 2,
            "consignorLocation": "CN-LKO001-1",
            "paymentMode": "COD",
            "serviceType": "ECONOMY",
            "pickupAddress": "Uttam Nagar, Prayagraj, Lucknow, Uttar Pradesh, 226001"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error