GET api/Dispatch/GetDispatchDetailByOrderId?securityKey={securityKey}&orderId={orderId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| securityKey | string |
Required |
|
| orderId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Dispatch| Name | Description | Type | Additional information |
|---|---|---|---|
| SecurityKey | string |
None. |
|
| TranId | integer |
None. |
|
| UserId | integer |
None. |
|
| CourierVendor | string |
None. |
|
| DispatchDate | date |
None. |
|
| ExpectedDeliveryDate | string |
None. |
|
| ExtraInfo | string |
None. |
|
| TrackingInfo | string |
None. |
|
| CourierBy | string |
None. |
|
| ChallenNo | string |
None. |
|
| ReceivedDate | date |
None. |
|
| DispatchNo | integer |
None. |
|
| lstDispatchDetail | Collection of DispatchDetail |
None. |
|
| CourierReceiptImage | string |
None. |
|
| CourierReceiptImageData | Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"SecurityKey": "sample string 1",
"TranId": 2,
"UserId": 3,
"CourierVendor": "sample string 4",
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"ExpectedDeliveryDate": "sample string 6",
"ExtraInfo": "sample string 7",
"TrackingInfo": "sample string 8",
"CourierBy": "sample string 9",
"ChallenNo": "sample string 10",
"ReceivedDate": "2025-12-11T10:30:18.4196266-08:00",
"DispatchNo": 12,
"lstDispatchDetail": [
{
"SecurityKey": "sample string 1",
"DispatchId": 2,
"DispatchDetailId": 3,
"ProposedDispatchId": 4,
"OrderDetailId": 5,
"UserId": 6,
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"Qunatity": 8,
"ProductName": "sample string 9",
"Status": 1,
"ProductDispactStatus": 1
},
{
"SecurityKey": "sample string 1",
"DispatchId": 2,
"DispatchDetailId": 3,
"ProposedDispatchId": 4,
"OrderDetailId": 5,
"UserId": 6,
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"Qunatity": 8,
"ProductName": "sample string 9",
"Status": 1,
"ProductDispactStatus": 1
}
],
"CourierReceiptImage": "sample string 13",
"CourierReceiptImageData": "QEA="
},
{
"SecurityKey": "sample string 1",
"TranId": 2,
"UserId": 3,
"CourierVendor": "sample string 4",
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"ExpectedDeliveryDate": "sample string 6",
"ExtraInfo": "sample string 7",
"TrackingInfo": "sample string 8",
"CourierBy": "sample string 9",
"ChallenNo": "sample string 10",
"ReceivedDate": "2025-12-11T10:30:18.4196266-08:00",
"DispatchNo": 12,
"lstDispatchDetail": [
{
"SecurityKey": "sample string 1",
"DispatchId": 2,
"DispatchDetailId": 3,
"ProposedDispatchId": 4,
"OrderDetailId": 5,
"UserId": 6,
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"Qunatity": 8,
"ProductName": "sample string 9",
"Status": 1,
"ProductDispactStatus": 1
},
{
"SecurityKey": "sample string 1",
"DispatchId": 2,
"DispatchDetailId": 3,
"ProposedDispatchId": 4,
"OrderDetailId": 5,
"UserId": 6,
"DispatchDate": "2025-12-11T10:30:18.4196266-08:00",
"Qunatity": 8,
"ProductName": "sample string 9",
"Status": 1,
"ProductDispactStatus": 1
}
],
"CourierReceiptImage": "sample string 13",
"CourierReceiptImageData": "QEA="
}
]
text/html
Sample:
[{"SecurityKey":"sample string 1","TranId":2,"UserId":3,"CourierVendor":"sample string 4","DispatchDate":"2025-12-11T10:30:18.4196266-08:00","ExpectedDeliveryDate":"sample string 6","ExtraInfo":"sample string 7","TrackingInfo":"sample string 8","CourierBy":"sample string 9","ChallenNo":"sample string 10","ReceivedDate":"2025-12-11T10:30:18.4196266-08:00","DispatchNo":12,"lstDispatchDetail":[{"SecurityKey":"sample string 1","DispatchId":2,"DispatchDetailId":3,"ProposedDispatchId":4,"OrderDetailId":5,"UserId":6,"DispatchDate":"2025-12-11T10:30:18.4196266-08:00","Qunatity":8,"ProductName":"sample string 9","Status":1,"ProductDispactStatus":1},{"SecurityKey":"sample string 1","DispatchId":2,"DispatchDetailId":3,"ProposedDispatchId":4,"OrderDetailId":5,"UserId":6,"DispatchDate":"2025-12-11T10:30:18.4196266-08:00","Qunatity":8,"ProductName":"sample string 9","Status":1,"ProductDispactStatus":1}],"CourierReceiptImage":"sample string 13","CourierReceiptImageData":"QEA="},{"SecurityKey":"sample string 1","TranId":2,"UserId":3,"CourierVendor":"sample string 4","DispatchDate":"2025-12-11T10:30:18.4196266-08:00","ExpectedDeliveryDate":"sample string 6","ExtraInfo":"sample string 7","TrackingInfo":"sample string 8","CourierBy":"sample string 9","ChallenNo":"sample string 10","ReceivedDate":"2025-12-11T10:30:18.4196266-08:00","DispatchNo":12,"lstDispatchDetail":[{"SecurityKey":"sample string 1","DispatchId":2,"DispatchDetailId":3,"ProposedDispatchId":4,"OrderDetailId":5,"UserId":6,"DispatchDate":"2025-12-11T10:30:18.4196266-08:00","Qunatity":8,"ProductName":"sample string 9","Status":1,"ProductDispactStatus":1},{"SecurityKey":"sample string 1","DispatchId":2,"DispatchDetailId":3,"ProposedDispatchId":4,"OrderDetailId":5,"UserId":6,"DispatchDate":"2025-12-11T10:30:18.4196266-08:00","Qunatity":8,"ProductName":"sample string 9","Status":1,"ProductDispactStatus":1}],"CourierReceiptImage":"sample string 13","CourierReceiptImageData":"QEA="}]
application/xml, text/xml
Sample:
<ArrayOfDispatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dnyanved.Core.Model">
<Dispatch>
<ChallenNo>sample string 10</ChallenNo>
<CourierBy>sample string 9</CourierBy>
<CourierReceiptImage>sample string 13</CourierReceiptImage>
<CourierReceiptImageData>QEA=</CourierReceiptImageData>
<CourierVendor>sample string 4</CourierVendor>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchNo>12</DispatchNo>
<ExpectedDeliveryDate>sample string 6</ExpectedDeliveryDate>
<ExtraInfo>sample string 7</ExtraInfo>
<ReceivedDate>2025-12-11T10:30:18.4196266-08:00</ReceivedDate>
<SecurityKey>sample string 1</SecurityKey>
<TrackingInfo>sample string 8</TrackingInfo>
<TranId>2</TranId>
<UserId>3</UserId>
<lstDispatchDetail>
<DispatchDetail>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchDetailId>3</DispatchDetailId>
<DispatchId>2</DispatchId>
<OrderDetailId>5</OrderDetailId>
<ProductDispactStatus>New</ProductDispactStatus>
<ProductName>sample string 9</ProductName>
<ProposedDispatchId>4</ProposedDispatchId>
<Qunatity>8</Qunatity>
<SecurityKey>sample string 1</SecurityKey>
<Status>New</Status>
<UserId>6</UserId>
</DispatchDetail>
<DispatchDetail>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchDetailId>3</DispatchDetailId>
<DispatchId>2</DispatchId>
<OrderDetailId>5</OrderDetailId>
<ProductDispactStatus>New</ProductDispactStatus>
<ProductName>sample string 9</ProductName>
<ProposedDispatchId>4</ProposedDispatchId>
<Qunatity>8</Qunatity>
<SecurityKey>sample string 1</SecurityKey>
<Status>New</Status>
<UserId>6</UserId>
</DispatchDetail>
</lstDispatchDetail>
</Dispatch>
<Dispatch>
<ChallenNo>sample string 10</ChallenNo>
<CourierBy>sample string 9</CourierBy>
<CourierReceiptImage>sample string 13</CourierReceiptImage>
<CourierReceiptImageData>QEA=</CourierReceiptImageData>
<CourierVendor>sample string 4</CourierVendor>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchNo>12</DispatchNo>
<ExpectedDeliveryDate>sample string 6</ExpectedDeliveryDate>
<ExtraInfo>sample string 7</ExtraInfo>
<ReceivedDate>2025-12-11T10:30:18.4196266-08:00</ReceivedDate>
<SecurityKey>sample string 1</SecurityKey>
<TrackingInfo>sample string 8</TrackingInfo>
<TranId>2</TranId>
<UserId>3</UserId>
<lstDispatchDetail>
<DispatchDetail>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchDetailId>3</DispatchDetailId>
<DispatchId>2</DispatchId>
<OrderDetailId>5</OrderDetailId>
<ProductDispactStatus>New</ProductDispactStatus>
<ProductName>sample string 9</ProductName>
<ProposedDispatchId>4</ProposedDispatchId>
<Qunatity>8</Qunatity>
<SecurityKey>sample string 1</SecurityKey>
<Status>New</Status>
<UserId>6</UserId>
</DispatchDetail>
<DispatchDetail>
<DispatchDate>2025-12-11T10:30:18.4196266-08:00</DispatchDate>
<DispatchDetailId>3</DispatchDetailId>
<DispatchId>2</DispatchId>
<OrderDetailId>5</OrderDetailId>
<ProductDispactStatus>New</ProductDispactStatus>
<ProductName>sample string 9</ProductName>
<ProposedDispatchId>4</ProposedDispatchId>
<Qunatity>8</Qunatity>
<SecurityKey>sample string 1</SecurityKey>
<Status>New</Status>
<UserId>6</UserId>
</DispatchDetail>
</lstDispatchDetail>
</Dispatch>
</ArrayOfDispatch>