VC Orders Despatched v1
Introduction
The purpose of this service is to retrieve information about the orders processed when it has been confirm picked (EDI VW) or delivery despatched (VC).
Request
API GET : https://<pathtoapi>/OrdersDespatched
This API needs to be authenticated ( pass header parameter Authorization : "Bearer "+AccessToken )
Input parameters
Parameter (Query Param) | Details | Required | Example |
|---|---|---|---|
response_type | JSON OR XML are permitted, default response is 'JSON'. | Optional | JSON |
order_date | Data to be retrieved for a specific date and if no date value provided, data corresponding to the current date will be returned. | Optional | '2025-06-01' |
Response
Field Name | Type | Length | Unique | Comments |
|---|---|---|---|---|
Customer | AN | 8 | Y | Unique Customer Account Code |
OrderNumber | AN | 11 | Y | Unique Sales Order Number |
WebOrderID | AN | 16 |
| Order Ref |
DespatchedDateTime | DateTime |
|
| dd/MM/yyyy HH:mm:ss When this order is despatched on. |
ConsignmentNo | AN | 40 |
| Consignment No |
Carrier | AN | 50 |
| The carrier to which the tracking number applies to |
JSON Response sample
[
{
"Customer": "R1",
"OrderNumber": "811",
"WebOrderID": "1130",
"DespatchedDateTime": "29/05/2025 14:30:45",
"ConsignmentNo": "11229863578",
"Carrier": "APC"
}
]XML Response sample
<Orders>
<Order>
<Customer>R1</Customer>
<OrderNumber>811</OrderNumber>
<WebOrderID>1130</WebOrderID>
<DespatchedDateTime>2025-05-29T14:30:45</DespatchedDateTime>
<ConsignmentNo>11229863578</ConsignmentNo>
<Carrier>APC<Carrier>
</Order
</Orders>Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.