Order Service
Order
Get Order Details
1min
GET
Get Order Details
Path Parameters
orderId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
Entity event mapped response
OrderGetResponse
error
Error
*
request
Request
*
data
OrderResponse
400
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
401
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
404
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
1curl --location --globoff 'https://{base_url}/core/api/v1/orders/{orderId}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
400
401
404
1// Entity event mapped response
2{
3 "error": {
4 "code": "",
5 "description": "",
6 "additionalInfo": {}
7 },
8 "request": {
9 "uri": "",
10 "method": "",
11 "queryString": "",
12 "body": {}
13 },
14 "data": {
15 "orderId": "",
16 "cancellation": {
17 "cancellationRequested": false,
18 "cancellationRequestAt": 0,
19 "cancellationRequestedBy": "",
20 "cancellationStatus": "",
21 "cancellationFailedReasonCode": "",
22 "cancelledAt": 0
23 },
24 "shipmentFlow": "",
25 "workOrderFlowType": "",
26 "dropDetails": {
27 "contact": {},
28 "location": {}
29 },
30 "clientDetails": {
31 "clientName": "",
32 "clientId": "",
33 "clientOrderId": ""
34 },
35 "orderSummary": {
36 "invoiceNumber": "",
37 "orderDescription": "",
38 "totalWeight": {
39 "value": 0,
40 "unit": ""
41 },
42 "totalItems": 0,
43 "totalOrderCost": {
44 "cost": 0,
45 "currencyCode": "",
46 "minorUnit": 0
47 }
48 },
49 "attributes": {},
50 "workOrder": [
51 {
52 "workOrderId": "",
53 "serviceTemplateId": "",
54 "serviceTemplateName": "",
55 "workOrderStatus": "",
56 "cancellationStatus": "",
57 "pickupDetails": {
58 "contact": {
59 "": ""
60 },
61 "location": {
62 "": ""
63 },
64 "pickUpSlot": {
65 "": ""
66 },
67 "serviceTime": 0
68 },
69 "returnDetails": {
70 "contact": {
71 "": ""
72 },
73 "location": {
74 "": ""
75 },
76 "returnSlot": {
77 "": ""
78 },
79 "serviceTime": 0
80 },
81 "deliveryDetails": {
82 "promisedDeliveryDate": "",
83 "deliverySlot": {
84 "": ""
85 },
86 "deliveryServiceTime": 0
87 },
88 "attributes": {},
89 "description": "",
90 "containers": [
91 {}
92 ],
93 "workOrderType": ""
94 }
95 ],
96 "schemaVersion": 0,
97 "currentState": "",
98 "currentSubState": "",
99 "createdAt": 0,
100 "updatedAt": 0,
101 "createdBy": {
102 "id": "",
103 "name": "",
104 "appId": ""
105 },
106 "updatedBy": {
107 "id": "",
108 "name": "",
109 "appId": ""
110 }
111 }
112}
Updated 03 Aug 2023
Did this page help you?