XM
Powered By GitBook
Retrieve All Scheduled Orders
Path:
1
GET /data-subscription/orders/get-by-customer/{customer-reference-ID}
Copied!
This API helps retrive details of a subscribed order based on the specified order ID.

Headers

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

Parameters

Type : path
Name : The system-generated customer reference ID.
Required: true

Sample Path

1
https://{baseurl}/data-subscription/orders/get-by-customer/606efb7ec042330007b48447
Copied!

Sample Response

Response Code: 200
Message: OK
1
{
2
"success": true,
3
"responseStatus": "OK",
4
"message": "Request processed successfully.",
5
"data": {
6
"scheduledSubscriptions": [
7
{
8
"subscription": {
9
"shipTo": {
10
"name": {
11
"firstName": "Khizer",
12
"middleName": "",
13
"lastName": "Younas"
14
},
15
"streetAddress": {
16
"street1": "177 HUNTINGTON AVE STE 1703",
17
"street2": ""
18
},
19
"shipToId": "606f79b7a084a10008fc411f",
20
"city": "BOSTON",
21
"state": "MA",
22
"zipCode": "02115-3153",
23
"country": "US"
24
},
25
"billTo": {
26
"name": {
27
"firstName": "Khizer",
28
"middleName": "",
29
"lastName": "Younas"
30
},
31
"streetAddress": {
32
"street1": "177 HUNTINGTON AVE STE 1703",
33
"street2": ""
34
},
35
"city": "BOSTON",
36
"state": "MA",
37
"zipCode": "02115-3153",
38
"country": "US",
39
"billToId": "606f79d440b47300084ad850"
40
},
41
"paymentDetails": {
42
"processor": "stripe"
43
},
44
"isDeleted": false,
45
"deletedAt": null,
46
"_id": "606f79d8f94b4a00090fcad7",
47
"planID": "606ef36a93bc6e00084fd5ca",
48
"itemID": "1000000058",
49
"priceListID": "100034",
50
"quantity": 1,
51
"customerID": "606efdc83bf07b0009bb92e7",
52
"frequency": 2,
53
"frequencyType": "Monthly",
54
"merchantAccountId": "5827714929",
55
"merchantAccount": "5fc78dfc6135050007191290",
56
"status": "ACTIVE",
57
"lastOrderReferenceId": "2865-4716-86171",
58
"cancellationReason": "",
59
"discount": 0,
60
"tax": 0,
61
"shippingCost": 0,
62
"paymentMethod": "pi_1Ie5gUFbKq2PvwXbhEJlJQrv",
63
"lastPaymentDate": "2021-04-08T21:47:04.475Z",
64
"nextPaymentDate": "2021-06-08T21:47:04.468Z",
65
"createdAt": "2021-04-08T21:47:04.481Z",
66
"updatedAt": "2021-04-08T21:47:04.481Z",
67
"__v": 0
68
},
69
"scheduled": [
70
{
71
"deliveryDate": "2021-04-08T21:47:04.778Z",
72
"paymentStatus": "PAID"
73
},
74
{
75
"deliveryDate": "2021-06-08T21:47:04.475Z",
76
"paymentStatus": "SCHEDULE"
77
},
78
{
79
"deliveryDate": "2021-08-08T21:47:04.475Z",
80
"paymentStatus": "SCHEDULE"
81
},
82
{
83
"deliveryDate": "2021-10-08T21:47:04.475Z",
84
"paymentStatus": "SCHEDULE"
85
},
86
{
87
"deliveryDate": "2021-12-08T21:47:04.475Z",
88
"paymentStatus": "SCHEDULE"
89
},
90
{
91
"deliveryDate": "2022-02-08T21:47:04.475Z",
92
"paymentStatus": "SCHEDULE"
93
}
94
]
95
},
96
{
97
"subscription": {
98
"shipTo": {
99
"name": {
100
"firstName": "Khizer",
101
"middleName": "",
102
"lastName": "Younas"
103
},
104
"streetAddress": {
105
"street1": "177 HUNTINGTON AVE STE 1703",
106
"street2": ""
107
},
108
"phone": {
109
"number": ""
110
},
111
"shipToId": "606f822b2d77400008841d1e",
112
"city": "BOSTON",
113
"state": "MA",
114
"zipCode": "02115-3153",
115
"country": "US"
116
},
117
"billTo": {
118
"name": {
119
"firstName": "Khizer",
120
"middleName": "",
121
"lastName": "Younas"
122
},
123
"streetAddress": {
124
"street1": "177 HUNTINGTON AVE STE 1703",
125
"street2": ""
126
},
127
"phone": {
128
"number": ""
129
},
130
"city": "BOSTON",
131
"state": "MA",
132
"zipCode": "02115-3153",
133
"country": "US",
134
"billToId": "606f8240d10b8600089fa55b"
135
},
136
"paymentDetails": {
137
"processor": "stripe"
138
},
139
"isDeleted": false,
140
"deletedAt": null,
141
"_id": "606f8243feef6c0008971e64",
142
"planID": "606ef36a93bc6e00084fd5ca",
143
"itemID": "1000000058",
144
"priceListID": "100034",
145
"quantity": 1,
146
"customerID": "606efdc83bf07b0009bb92e7",
147
"frequency": 2,
148
"frequencyType": "Monthly",
149
"merchantAccountId": "5827714929",
150
"merchantAccount": "5fc78dfc6135050007191290",
151
"status": "ACTIVE",
152
"lastOrderReferenceId": "8520-6752-84361",
153
"cancellationReason": "",
154
"discount": 30,
155
"tax": 0,
156
"shippingCost": 0,
157
"paymentMethod": "pi_1Ie6FMFbKq2PvwXb82yBlcn9",
158
"lastPaymentDate": "2021-04-08T22:22:59.217Z",
159
"nextPaymentDate": "2021-06-08T22:22:59.217Z",
160
"createdAt": "2021-04-08T22:22:59.228Z",
161
"updatedAt": "2021-04-23T14:18:03.482Z",
162
"__v": 0
163
},
164
"scheduled": [
165
{
166
"deliveryDate": "2021-04-08T22:22:59.579Z",
167
"paymentStatus": "PAID"
168
},
169
{
170
"deliveryDate": "2021-06-08T22:22:59.217Z",
171
"paymentStatus": "SCHEDULE"
172
},
173
{
174
"deliveryDate": "2021-08-08T22:22:59.217Z",
175
"paymentStatus": "SCHEDULE"
176
},
177
{
178
"deliveryDate": "2021-10-08T22:22:59.217Z",
179
"paymentStatus": "SCHEDULE"
180
},
181
{
182
"deliveryDate": "2021-12-08T22:22:59.217Z",
183
"paymentStatus": "SCHEDULE"
184
},
185
{
186
"deliveryDate": "2022-02-08T22:22:59.217Z",
187
"paymentStatus": "SCHEDULE"
188
}
189
]
190
},
191
{
192
"subscription": {
193
"shipTo": {
194
"name": {
195
"firstName": "Khizer",
196
"middleName": "",
197
"lastName": "Younas"
198
},
199
"streetAddress": {
200
"street1": "177 HUNTINGTON AVE STE 1703",
201
"street2": ""
202
},
203
"shipToId": "606f8414484b1500094c53bd",
204
"city": "boston",
205
"state": "MA",
206
"zipCode": "02115-3153",
207
"country": "US"
208
},
209
"billTo": {
210
"name": {
211
"firstName": "Khizer",
212
"middleName": "",
213
"lastName": "Younas"
214
},
215
"streetAddress": {
216
"street1": "177 HUNTINGTON AVE STE 1703",
217
"street2": ""
218
},
219
"city": "boston",
220
"state": "MA",
221
"zipCode": "02115-3153",
222
"country": "US",
223
"billToId": "606f8431591d4d0008f3d24a"
224
},
225
"paymentDetails": {
226
"processor": "stripe"
227
},
228
"isDeleted": false,
229
"deletedAt": null,
230
"_id": "606f843592d236000885797f",
231
"planID": "606ef369c239960008ab3d77",
232
"itemID": "1000000058",
233
"priceListID": "100033",
234
"quantity": 1,
235
"customerID": "606efdc83bf07b0009bb92e7",
236
"frequency": 2,
237
"frequencyType": "Weekly",
238
"merchantAccountId": "5827714929",
239
"merchantAccount": "5fc78dfc6135050007191290",
240
"status": "ACTIVE",
241
"lastOrderReferenceId": "1953-2671-40456",
242
"cancellationReason": "",
243
"discount": 24,
244
"tax": 0,
245
"shippingCost": 0,
246
"paymentMethod": "pi_1Ie6NHFbKq2PvwXbn2hx2KEr",
247
"lastPaymentDate": "2021-04-08T22:31:17.000Z",
248
"nextPaymentDate": "2021-04-22T22:31:16.989Z",
249
"createdAt": "2021-04-08T22:31:17.006Z",
250
"updatedAt": "2021-04-08T22:31:17.006Z",
251
"__v": 0
252
},
253
"scheduled": [
254
{
255
"deliveryDate": "2021-04-08T22:31:18.677Z",
256
"paymentStatus": "PAID"
257
},
258
{
259
"deliveryDate": "2021-04-22T22:31:17.000Z",
260
"paymentStatus": "SCHEDULE"
261
},
262
{
263
"deliveryDate": "2021-05-06T22:31:17.000Z",
264
"paymentStatus": "SCHEDULE"
265
},
266
{
267
"deliveryDate": "2021-05-20T22:31:17.000Z",
268
"paymentStatus": "SCHEDULE"
269
},
270
{
271
"deliveryDate": "2021-06-03T22:31:17.000Z",
272
"paymentStatus": "SCHEDULE"
273
},
274
{
275
"deliveryDate": "2021-06-17T22:31:17.000Z",
276
"paymentStatus": "SCHEDULE"
277
}
278
]
279
},
280
{
281
"subscription": {
282
"shipTo": {
283
"name": {
284
"firstName": "test IQBAR",
285
"middleName": "",
286
"lastName": "test"
287
},
288
"streetAddress": {
289
"street1": "185-S QA Estate",
290
"street2": ""
291
},
292
"shipToId": "testShip",
293
"city": "Lahore",
294
"state": "Punjab",
295
"zipCode": "a1a1a1",
296
"country": "Pakistan"
297
},
298
"billTo": {
299
"name": {
300
"firstName": "test bill",
301
"middleName": "",
302
"lastName": "test"
303
},
304
"streetAddress": {
305
"street1": "185-S QA Estate bill",
306
"street2": ""
307
},
308
"billToId": "testBill",
309
"city": "Lahore",
310
"state": "Punjab",
311
"zipCode": "a1a1a1",
312
"country": "Pakistan"
313
},
314
"paymentDetails": {
315
"processor": "stripe"
316
},
317
"isDeleted": false,
318
"deletedAt": null,
319
"_id": "6089337f982e030009d7925e",
320
"planID": "6069ad22b68b21000ab1b046",
321
"itemID": "1000000058",
322
"priceListID": "100024",
323
"quantity": 3,
324
"customerID": "606efdc83bf07b0009bb92e7",
325
"frequency": 4,
326
"frequencyType": "Weekly",
327
"merchantAccount": "5fc78dfc6135050007191290",
328
"status": "ACTIVE",
329
"lastOrderReferenceId": "5082-5948-21691",
330
"cancellationReason": "",
331
"discount": 10,
332
"tax": 2,
333
"shippingCost": 2,
334
"paymentMethod": "pm_1ISekkETggmgrCy2b7osIpl8",
335
"lastPaymentDate": "2021-04-28T10:05:51.669Z",
336
"nextPaymentDate": "2021-05-26T10:05:51.667Z",
337
"createdAt": "2021-04-28T10:05:51.683Z",
338
"updatedAt": "2021-04-28T10:05:51.683Z",
339
"__v": 0
340
},
341
"scheduled": [
342
{
343
"deliveryDate": "2021-04-28T10:05:53.626Z",
344
"paymentStatus": "PAID"
345
},
346
{
347
"deliveryDate": "2021-05-26T10:05:51.669Z",
348
"paymentStatus": "SCHEDULE"
349
},
350
{
351
"deliveryDate": "2021-06-23T10:05:51.669Z",
352
"paymentStatus": "SCHEDULE"
353
},
354
{
355
"deliveryDate": "2021-07-21T10:05:51.669Z",
356
"paymentStatus": "SCHEDULE"
357
},
358
{
359
"deliveryDate": "2021-08-18T10:05:51.669Z",
360
"paymentStatus": "SCHEDULE"
361
},
362
{
363
"deliveryDate": "2021-09-15T10:05:51.669Z",
364
"paymentStatus": "SCHEDULE"
365
}
366
]
367
}
368
]
369
}
370
}
Copied!
Response Code: 400
Message: Client Error
Response Code: 500
Message: Server Error

Changelog

    April-2021
Last modified 3mo ago
Copy link
Contents
Changelog