XM
Members
Retrieve Order by Order ID
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-order/orders/orderNumber/{orderId}
Copied!
This API faciliates retrieval of order details based on the order ID. This is secured by x-api-key. When the order ID is not available, the Get Order by Email API is recommended.

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
x-api-key : d41d8cd98f00b204e9800998ecf8427e

Parameters

Type : path
Name : The 15 character order ID (generated after successful cartcheckout).
Required: true

Sample Request

1
https://{baseurl}/api-order/orders/orderNumber/8677-7648-19307
Copied!

Sample Response

Response Code: 200
Message: OK
Description: You'll see this message when the order details are successfully retrieved. The response includes order details and a history of all the changes to the order.
1
{
2
"order": {
3
"_id": "60ca5d3dc0fac00008e64c91",
4
"tags": [],
5
"cartId": "60ca5b6ae3b5d900081ae44a",
6
"customerUserId": "60c128045a38bf0009ad6502",
7
"attributes": [],
8
"customerEmail": "[email protected]",
9
"orderCurrency": "USD",
10
"orderTotal": 90.5,
11
"taxTotal": 0.5,
12
"channel": 12,
13
"status": "ORDER_FULFILLED",
14
"statusLog": "Order has been fulfilled",
15
"orderReference": "1635-8532-92190",
16
"orderId": "8677-7648-19307",
17
"shipTo": [
18
{
19
"pickupPerson": {
20
"name": {
21
"first": "John",
22
"last": "Doe"
23
},
24
"phone": {
25
"number": "8087769338",
26
"kind": "Mobile"
27
},
28
"email": "[email protected]"
29
},
30
"altPickupPerson": {
31
"name": {
32
"first": "first",
33
"last": "last"
34
},
35
"phone": {
36
"number": "8087769338",
37
"kind": "Mobile"
38
},
39
"email": "[email protected]"
40
},
41
"promosApplied": [],
42
"_id": "60ca5c1c9f490e0008020b28",
43
"shipToType": "BOPIS",
44
"taxCode": "FR1000",
45
"shipToId": 390,
46
"price": 0,
47
"currency": "",
48
"shipmentMethodId": "",
49
"estimatedTax": 0.5,
50
"shipmentCarrier": "",
51
"shipmentMethod": "",
52
"total": 0.5,
53
"id": "60ca5c1c9f490e0008020b28"
54
}
55
],
56
"items": [
57
{
58
"group": [
59
"123123123123123213212222"
60
],
61
"promosApplied": [],
62
"_id": "60ca5b6ae3b5d900081ae44b",
63
"price": 90,
64
"weightUnit": "lb",
65
"isPickup": true,
66
"itemId": 89,
67
"quantity": 1,
68
"priceListId": 100000,
69
"sku": "GardenWoodSofa",
70
"taxCode": "tytuy",
71
"title": "Garden Wood Sofa",
72
"weight": 2345,
73
"lineItemId": 1,
74
"attributeTotalPrice": 0,
75
"attributes": [],
76
"warehouseId": "60bf9615e66d120008b37e5e",
77
"currency": "USD",
78
"shipToId": 390,
79
"discount": 0,
80
"estimatedTax": 0,
81
"total": 90,
82
"reservedLocation": [
83
{
84
"_id": "60ca5d3e06b91d0008427435",
85
"warehouseId": "60bf9615e66d120008b37e5e",
86
"quantity": 1,
87
"id": "60ca5d3e06b91d0008427435"
88
}
89
],
90
"id": "60ca5b6ae3b5d900081ae44b"
91
}
92
],
93
"shipments": [],
94
"payments": [
95
{
96
"billToAddress": {
97
"name": {
98
"first": "John",
99
"last": "Smith"
100
},
101
"phone": {
102
"number": "07780811973",
103
"kind": "mobile"
104
},
105
"email": "[email protected]",
106
"street1": "600 Congress Ave",
107
"street2": "suite 219",
108
"city": "Austin",
109
"state": "Tx",
110
"country": "US",
111
"zipCode": "10033"
112
},
113
"shipToId": [
114
390
115
],
116
"_id": "60ca5d3dc0fac00008e64c94",
117
"paymentStatus": "succeeded",
118
"amount": 90.5,
119
"currency": "USD",
120
"paymentIdentifier": {
121
"cardIdentifier": "4242"
122
},
123
"paymentMethod": "visa",
124
"paymentKind": "CARD_STRIPE",
125
"conversion": 1,
126
"paymentToken": {
127
"token": "pi_1J35DCJxr7zyIFb9axtM3OKv",
128
"type": "CARD_STRIPE"
129
},
130
"id": "60ca5d3dc0fac00008e64c94"
131
}
132
],
133
"revision": 1,
134
"totalQuantity": 1,
135
"statusDescriptions": [],
136
"events": [],
137
"pickups": [
138
{
139
"pickupPerson": {
140
"name": {
141
"first": "John",
142
"last": "Smith"
143
},
144
"phone": {
145
"number": "8087769338",
146
"kind": "Mobile"
147
},
148
"email": "[email protected]"
149
},
150
"_id": "60ca5e93344d5f00087725d9",
151
"lineItems": [
152
{
153
"_id": "60ca5e93344d5f00087725da",
154
"lineItemId": 1,
155
"quantity": 1,
156
"id": "60ca5e93344d5f00087725da"
157
}
158
],
159
"pickupStatus": "picked",
160
"shipToId": 390,
161
"id": "60ca5e93344d5f00087725d9"
162
}
163
],
164
"createdAt": "2021-06-16T20:21:17.038Z",
165
"updatedAt": "2021-06-16T20:26:59.689Z",
166
"__v": 0
167
},
168
"history": [
169
{
170
"_id": "60ca5e93344d5f00087725db",
171
"tags": [],
172
"cartId": "60ca5b6ae3b5d900081ae44a",
173
"customerUserId": "60c128045a38bf0009ad6502",
174
"customerEmail": "[email protected]",
175
"orderCurrency": "USD",
176
"orderTotal": 90.5,
177
"taxTotal": 0.5,
178
"channel": 12,
179
"status": "ORDER_FULFILLED",
180
"statusLog": "Order has been fulfilled",
181
"orderId": "8677-7648-19307",
182
"shipTo": [
183
{
184
"promosApplied": [],
185
"_id": "60ca5c1c9f490e0008020b28",
186
"shipToType": "BOPIS",
187
"taxCode": "FR1000",
188
"shipToId": 390,
189
"price": 0,
190
"currency": "",
191
"shipmentMethodId": "",
192
"estimatedTax": 0.5,
193
"shipmentCarrier": "",
194
"shipmentMethod": "",
195
"total": 0.5,
196
"id": "60ca5c1c9f490e0008020b28"
197
}
198
],
199
"items": [
200
{
201
"group": [
202
"123123123123123213212222"
203
],
204
"promosApplied": [],
205
"_id": "60ca5b6ae3b5d900081ae44b",
206
"price": 90,
207
"weightUnit": "lb",
208
"itemId": 89,
209
"quantity": 1,
210
"sku": "GardenWoodSofa",
211
"taxCode": "tytuy",
212
"title": "Garden Wood Sofa",
213
"weight": 2345,
214
"lineItemId": 1,
215
"currency": "USD",
216
"shipToId": 390,
217
"discount": 0,
218
"estimatedTax": 0,
219
"total": 90,
220
"id": "60ca5b6ae3b5d900081ae44b"
221
}
222
],
223
"shipments": [],
224
"payments": [
225
{
226
"billToAddress": {
227
"name": {
228
"first": "John",
229
"last": "Smith"
230
},
231
"phone": {
232
"number": "07780811973",
233
"kind": "mobile"
234
},
235
"email": "[email protected]",
236
"street1": "600 Congress Ave",
237
"street2": "suite 219",
238
"city": "Austin",
239
"state": "Tx",
240
"country": "US",
241
"zipCode": "10033"
242
},
243
"shipToId": [
244
390
245
],
246
"_id": "60ca5d3dc0fac00008e64c94",
247
"paymentStatus": "succeeded",
248
"amount": 90.5,
249
"currency": "USD",
250
"paymentIdentifier": {
251
"cardIdentifier": "4242"
252
},
253
"paymentMethod": "visa",
254
"paymentKind": "CARD_STRIPE",
255
"conversion": 1,
256
"paymentToken": {
257
"token": "pi_1J35DCJxr7zyIFb9axtM3OKv",
258
"type": "CARD_STRIPE"
259
},
260
"id": "60ca5d3dc0fac00008e64c94"
261
}
262
],
263
"revision": 1,
264
"totalQuantity": 1,
265
"statusDescriptions": [],
266
"events": [],
267
"__v": 0,
268
"createdAt": "2021-06-16T20:26:59.769Z",
269
"updatedAt": "2021-06-16T20:26:59.769Z"
270
},
271
{
272
"_id": "60ca5d3dc0fac00008e64c95",
273
"tags": [],
274
"cartId": "60ca5b6ae3b5d900081ae44a",
275
"customerUserId": "60c128045a38bf0009ad6502",
276
"customerEmail": "[email protected]",
277
"orderCurrency": "USD",
278
"orderTotal": 90.5,
279
"taxTotal": 0.5,
280
"channel": 12,
281
"status": "ORDER_CREATED",
282
"statusLog": "Order has been created",
283
"orderId": "8677-7648-19307",
284
"shipTo": [
285
{
286
"promosApplied": [],
287
"_id": "60ca5c1c9f490e0008020b28",
288
"shipToType": "BOPIS",
289
"taxCode": "FR1000",
290
"shipToId": 390,
291
"price": 0,
292
"currency": "",
293
"shipmentMethodId": "",
294
"estimatedTax": 0.5,
295
"shipmentCarrier": "",
296
"shipmentMethod": "",
297
"total": 0.5,
298
"id": "60ca5c1c9f490e0008020b28"
299
}
300
],
301
"items": [
302
{
303
"group": [
304
"123123123123123213212222"
305
],
306
"promosApplied": [],
307
"_id": "60ca5b6ae3b5d900081ae44b",
308
"price": 90,
309
"weightUnit": "lb",
310
"itemId": 89,
311
"quantity": 1,
312
"sku": "GardenWoodSofa",
313
"taxCode": "tytuy",
314
"title": "Garden Wood Sofa",
315
"weight": 2345,
316
"lineItemId": 1,
317
"currency": "USD",
318
"shipToId": 390,
319
"discount": 0,
320
"estimatedTax": 0,
321
"total": 90,
322
"id": "60ca5b6ae3b5d900081ae44b"
323
}
324
],
325
"shipments": [],
326
"payments": [
327
{
328
"billToAddress": {
329
"name": {
330
"first": "John",
331
"last": "Smith"
332
},
333
"phone": {
334
"number": "07780811973",
335
"kind": "mobile"
336
},
337
"email": "[email protected]",
338
"street1": "600 Congress Ave",
339
"street2": "suite 219",
340
"city": "Austin",
341
"state": "Tx",
342
"country": "US",
343
"zipCode": "10033"
344
},
345
"shipToId": [
346
390
347
],
348
"_id": "60ca5d3dc0fac00008e64c94",
349
"paymentStatus": "succeeded",
350
"amount": 90.5,
351
"currency": "USD",
352
"paymentIdentifier": {
353
"cardIdentifier": "4242"
354
},
355
"paymentMethod": "visa",
356
"paymentKind": "CARD_STRIPE",
357
"conversion": 1,
358
"paymentToken": {
359
"token": "pi_1J35DCJxr7zyIFb9axtM3OKv",
360
"type": "CARD_STRIPE"
361
},
362
"id": "60ca5d3dc0fac00008e64c94"
363
}
364
],
365
"revision": 0,
366
"totalQuantity": 1,
367
"statusDescriptions": [],
368
"events": [],
369
"createdAt": "2021-06-16T20:21:17.095Z",
370
"updatedAt": "2021-06-16T20:21:17.095Z",
371
"__v": 0
372
}
373
]
374
}
Copied!
Error Code: 404
Message: Not Found
Description: You will see this error when the order number doesn't exist in the system.
1
{
2
"code": "ORDER_NOT_FOUND",
3
"message": "Order Id Not Found"
4
}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the order number is incorrect.
1
{}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021
  • July - 2020 First updated
Last modified 1mo ago
Copy link
Contents
Change Log