/ClientOrderIn/orderTrackingDetails

Retrieves order tracking details based on the shipment ID.

Responses

🟢200OK

application/json

Successful response with order tracking details.

Body

success

boolean

optional

Indicates if the request was successful.

Example:

true

data

object

optional

events

array [object {4}]

optional

List of events related to the shipment.

cancellationFlag

boolean

optional

Flag indicating whether the shipment was cancelled.

Example:

false

clientRefId

string

optional

Reference ID of the client.

Example:

c2e55c72f2fc4849befbd20392e169f2

courierCode

string

optional

Code of the courier partner.

Example:

ECOM

cancellationStatus

integer

optional

Status of the cancellation.

Example:

direction

string

optional

Direction of the shipment (e.g., forward, reverse).

Example:

forward

orderTrackingId

string

optional

Tracking ID of the order.

Example:

715430528

originAddress

object

optional

The shipment origination address. Provide full location address or location code

originContactDetails

object

optional

Contact details of the origin.

shippingAddress

object

optional

Address details of the shipping destination.

shippingContactDetails

object

optional

Contact details of the shipping destination.

amount

number

optional

Total amount of the order.

Example:

3291.8

quantity

integer

optional

Quantity of items in the order.

Example:

sellerName

string

optional

Name of the seller.

Example:

Lucknow-1

sellerCode

string

optional

Code of the seller.

Example:

CN-LKO001

Example

{
    "success": true,
    "data": {
        "events": [
            {
                "eventType": "shipmentRegistered",
                "eventTime": 1725505913387,
                "orderStatus": 100,
                "orderDescription": "Order Placed"
            }
        ],
        "cancellationFlag": false,
        "clientRefId": "c2e55c72f2fc4849befbd20392e169f2",
        "courierCode": "ECOM",
        "cancellationStatus": 2,
        "direction": "forward",
        "orderTrackingId": "715430528",
        "originAddress": {
            "addressLine1": "Uttam Nagar",
            "addressLine2": "Prayagraj",
            "latitude": "26.84171543636974",
            "longitude": "80.94229612376603",
            "state": "Uttar Pradesh",
            "city": "Lucknow",
            "pincode": "226001",
            "addressType": "HOME",
            "addressConfidenceScore": null,
            "_id": "66d921543accef30881d8e0a"
        },
        "originContactDetails": {
            "contactPersonName": "Tanya Agrawal",
            "primaryContactNumber": "9871253640",
            "secondaryContactNumber": "",
            "email": "toroboc280@comsb.com",
            "_id": "66d921543accef30881d8e0b"
        },
        "shippingAddress": {
            "addressLine1": "Street No 345",
            "addressLine2": "Near church",
            "state": "Uttar Pradesh",
            "city": "Lucknow",
            "pincode": "226001",
            "addressType": "HOME",
            "_id": "66d921543accef30881d8e04"
        },
        "shippingContactDetails": {
            "contactPersonName": "Tarun Dharmashya",
            "primaryContactNumber": "9929657898",
            "secondaryContactNumber": "",
            "email": "tarundharmashya@gmail.com",
            "_id": "66d921543accef30881d8e05"
        },
        "amount": 3291.8,
        "quantity": 2,
        "sellerName": "Lucknow-1",
        "sellerCode": "CN-LKO001"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

/ClientOrderIn/orderTrackingDetails

Request

Request samples

Responses