XM
Members
Retrieve Orders by Email
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-order/orders/user/guest?orderEmail={email}
Copied!
This API facilitates retrieval of order details based on email address.

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 : query
Name : The email address of the customer.
Required: true

Sample Request

1
https://{baseurl}/api-order/orders/user/[email protected]
Copied!

Sample Response

Response Code: 200
Message: OK
Description: You'll see this message when the order details are successfully retrieved. When the email address is invalid, a blank array is returned in the success response.
1
[
2
{
3
"_id": "60ca3b299430450009679f90",
4
"tags": [],
5
"cartId": "60ca3ab52d5e41000881389e",
6
"attributes": [],
7
"customerEmail": "[email protected]",
8
"orderCurrency": "USD",
9
"orderTotal": 102.49,
10
"taxTotal": 0.5,
11
"channel": 12,
12
"status": "ORDER_SHIPPED",
13
"statusLog": "Order has been shipped",
14
"orderReference": "5778-5180-41779",
15
"orderId": "4284-4200-49489",
16
"shipTo": [
17
{
18
"address": {
19
"name": {
20
"first": "Friend",
21
"last": "Address"
22
},
23
"phone": {
24
"number": "123-992-1234",
25
"kind": "Mobile"
26
},
27
"street1": "888 Broadway",
28
"city": "New York",
29
"state": "NY",
30
"country": "United States",
31
"zipCode": "10003",
32
"kind": "shipping",
33
"email": "[email protected]"
34
},
35
"promosApplied": [],
36
"_id": "60ca3ac24ef53d0009395682",
37
"shipToType": "SHIP_TO_ADDRESS",
38
"taxCode": "FR1000",
39
"shipToId": 386,
40
"price": 11.99,
41
"shipmentMethodId": "10002",
42
"estimatedTax": 0.5,
43
"shipmentCarrier": "2 Day",
44
"total": 12.49,
45
"id": "60ca3ac24ef53d0009395682"
46
}
47
],
48
"items": [
49
{
50
"group": [
51
"123123123123123213212222"
52
],
53
"promosApplied": [],
54
"_id": "60ca3ab52d5e41000881389f",
55
"price": 90,
56
"weightUnit": "lb",
57
"isPickup": false,
58
"itemId": 89,
59
"quantity": 1,
60
"priceListId": 100000,
61
"sku": "GardenWoodSofa",
62
"taxCode": "tytuy",
63
"title": "Garden Wood Sofa",
64
"weight": 2345,
65
"lineItemId": 1,
66
"attributeTotalPrice": 0,
67
"attributes": [],
68
"currency": "USD",
69
"shipToId": 386,
70
"discount": 0,
71
"estimatedTax": 0,
72
"total": 90,
73
"reservedLocation": [
74
{
75
"_id": "60ca3b2e673a8100083c7835",
76
"warehouseId": "60bf9615e66d120008b37e5e",
77
"quantity": 1,
78
"id": "60ca3b2e673a8100083c7835"
79
}
80
],
81
"id": "60ca3ab52d5e41000881389f"
82
}
83
],
84
"shipments": [
85
{
86
"_id": "60ca3bdda6f3020008224e45",
87
"shipmentRef": "ref-100",
88
"shipmentCarrier": "Fedex",
89
"shipmentCarrierUrl": "https://fedex.com",
90
"trackingNumber": "2345367890876549",
91
"lineItems": [
92
{
93
"_id": "60ca3bdda6f3020008224e46",
94
"lineItemId": 1,
95
"quantity": 1,
96
"id": "60ca3bdda6f3020008224e46"
97
}
98
],
99
"shipmentStatus": "awaiting",
100
"estimatedDeliveryDate": "2019-03-01T00:00:00.000Z",
101
"shippedDate": "2020-04-05T00:00:00.000Z",
102
"shipToId": 386,
103
"id": "60ca3bdda6f3020008224e45"
104
}
105
],
106
"payments": [
107
{
108
"billToAddress": {
109
"name": {
110
"first": "John",
111
"last": "Smith"
112
},
113
"phone": {
114
"number": "07780811973",
115
"kind": "mobile"
116
},
117
"email": "[email protected]",
118
"street1": "600 Congress Ave",
119
"street2": "suite 219",
120
"city": "Austin",
121
"state": "Tx",
122
"country": "US",
123
"zipCode": "10033"
124
},
125
"shipToId": [
126
386
127
],
128
"_id": "60ca3b299430450009679f93",
129
"paymentStatus": "succeeded",
130
"amount": 102.49,
131
"currency": "USD",
132
"paymentIdentifier": {
133
"cardIdentifier": "4242"
134
},
135
"paymentMethod": "visa",
136
"paymentKind": "CARD_STRIPE",
137
"conversion": 1,
138
"paymentToken": {
139
"token": "pi_1J32xZJxr7zyIFb9Yc82PMcm",
140
"type": "CARD_STRIPE"
141
},
142
"id": "60ca3b299430450009679f93"
143
}
144
],
145
"revision": 1,
146
"totalQuantity": 1,
147
"statusDescriptions": [],
148
"events": [],
149
"pickups": [],
150
"createdAt": "2021-06-16T17:55:53.231Z",
151
"updatedAt": "2021-06-16T17:58:53.711Z",
152
"__v": 0
153
}
154
]
Copied!
Error Code: 400
Message: Bad Request
Description: You will see this error when the format of the email addres is incorrect.
1
{
2
"code": "REQUEST_VALIDATION",
3
"message": "Invalid data in query: /orderEmail should match format \"email\""
4
}
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