@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. package/README.md +51 -2
  2. package/index.d.ts +7 -4
  3. package/index.js +22 -7
  4. package/package.json +23 -14
  5. package/partner.d.ts +4 -0
  6. package/partner.js +7 -0
  7. package/sdk/application/ApplicationAPIClient.js +2 -4
  8. package/sdk/application/Cart/CartApplicationClient.js +29 -28
  9. package/sdk/application/Cart/CartApplicationModel.js +3 -1
  10. package/sdk/application/Catalog/CatalogApplicationClient.js +43 -42
  11. package/sdk/application/Catalog/CatalogApplicationModel.js +5 -3
  12. package/sdk/application/Common/CommonApplicationClient.js +5 -4
  13. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -5
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +21 -20
  15. package/sdk/application/Content/ContentApplicationClient.js +26 -25
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -5
  17. package/sdk/application/Lead/LeadApplicationClient.js +10 -9
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -3
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -12
  20. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -1
  21. package/sdk/application/Order/OrderApplicationClient.js +15 -14
  22. package/sdk/application/Order/OrderApplicationModel.js +9 -0
  23. package/sdk/application/Payment/PaymentApplicationClient.js +42 -41
  24. package/sdk/application/PosCart/PosCartApplicationClient.js +30 -29
  25. package/sdk/application/PosCart/PosCartApplicationModel.js +3 -1
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +11 -10
  27. package/sdk/application/Share/ShareApplicationClient.js +10 -9
  28. package/sdk/application/Theme/ThemeApplicationClient.js +7 -6
  29. package/sdk/application/User/UserApplicationClient.js +38 -37
  30. package/sdk/common/AxiosHelper.js +17 -6
  31. package/sdk/common/BaseOAuthClient.d.ts +17 -0
  32. package/sdk/common/BaseOAuthClient.js +67 -0
  33. package/sdk/common/RequestSigner.js +0 -5
  34. package/sdk/partner/OAuthClient.d.ts +14 -0
  35. package/sdk/partner/OAuthClient.js +112 -0
  36. package/sdk/partner/PartnerAPIClient.d.ts +12 -0
  37. package/sdk/partner/PartnerAPIClient.js +42 -0
  38. package/sdk/partner/PartnerClient.d.ts +6 -0
  39. package/sdk/partner/PartnerClient.js +17 -0
  40. package/sdk/partner/PartnerConfig.d.ts +30 -0
  41. package/sdk/partner/PartnerConfig.js +39 -0
  42. package/sdk/partner/index.d.ts +3 -0
  43. package/sdk/partner/index.js +5 -0
  44. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -1
  45. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  46. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  47. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  48. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -2
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +1 -0
  50. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -0
  51. package/sdk/platform/Billing/BillingPlatformClient.js +137 -2
  52. package/sdk/platform/Billing/BillingPlatformModel.d.ts +4 -0
  53. package/sdk/platform/Billing/BillingPlatformModel.js +44 -0
  54. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +2 -0
  55. package/sdk/platform/Billing/BillingPlatformValidator.js +15 -0
  56. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +27 -0
  57. package/sdk/platform/Cart/CartPlatformApplicationClient.js +177 -1
  58. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +3 -0
  59. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +17 -1
  60. package/sdk/platform/Cart/CartPlatformModel.js +7 -3
  61. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +3 -1
  62. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -1
  63. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  64. package/sdk/platform/Catalog/CatalogPlatformClient.js +6 -9
  65. package/sdk/platform/Catalog/CatalogPlatformModel.js +9 -9
  66. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -1
  67. package/sdk/platform/Common/CommonPlatformClient.js +7 -18
  68. package/sdk/platform/Common/CommonPlatformValidator.js +1 -0
  69. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3 -1
  70. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -1
  71. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  72. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  73. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +5 -4
  74. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +1 -0
  75. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
  77. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +9 -8
  78. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +1 -0
  79. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3 -1
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +1 -1
  81. package/sdk/platform/Discount/DiscountPlatformClient.js +3 -2
  82. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -0
  83. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -3
  84. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +27 -5
  85. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  86. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -3
  87. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -6
  88. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +1 -0
  89. package/sdk/platform/Inventory/InventoryPlatformClient.js +3 -2
  90. package/sdk/platform/Inventory/InventoryPlatformValidator.js +1 -0
  91. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +3 -1
  92. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +1 -1
  93. package/sdk/platform/Lead/LeadPlatformClient.js +4 -3
  94. package/sdk/platform/Lead/LeadPlatformValidator.js +1 -0
  95. package/sdk/platform/OAuthClient.js +3 -9
  96. package/sdk/platform/Order/OrderPlatformApplicationClient.js +3 -1
  97. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -1
  98. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  99. package/sdk/platform/Order/OrderPlatformClient.js +16 -3
  100. package/sdk/platform/Order/OrderPlatformModel.js +1 -0
  101. package/sdk/platform/Order/OrderPlatformValidator.js +1 -0
  102. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  103. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  104. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +14 -14
  106. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +1 -1
  107. package/sdk/platform/Payment/PaymentPlatformClient.js +3 -2
  108. package/sdk/platform/Payment/PaymentPlatformValidator.js +1 -0
  109. package/sdk/platform/PlatformApplicationClient.d.ts +5 -1
  110. package/sdk/platform/PlatformApplicationClient.js +4 -0
  111. package/sdk/platform/PlatformClient.d.ts +51 -12
  112. package/sdk/platform/PlatformClient.js +54 -11
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +17 -19
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +88 -83
  115. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  116. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +8 -9
  117. package/sdk/platform/Share/SharePlatformApplicationClient.js +3 -1
  118. package/sdk/platform/Share/SharePlatformApplicationValidator.js +1 -1
  119. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +3 -1
  120. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +1 -1
  121. package/sdk/platform/User/UserPlatformApplicationClient.js +3 -1
  122. package/sdk/platform/User/UserPlatformApplicationValidator.js +1 -1
  123. package/sdk/platform/Webhook/WebhookPlatformClient.js +3 -2
  124. package/sdk/platform/Webhook/WebhookPlatformValidator.js +1 -0
  125. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -0
  126. package/sdk/public/Inventory/InventoryPublicClient.js +2 -0
  127. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  128. package/.github/workflows/on_create_release.yml +0 -23
  129. package/.github/workflows/on_merge_main.yml +0 -38
  130. package/.github/workflows/on_pull_request.yml +0 -35
  131. package/.prettierrc +0 -5
  132. package/documentation/application/CART.md +0 -8771
  133. package/documentation/application/CATALOG.md +0 -8690
  134. package/documentation/application/COMMON.md +0 -325
  135. package/documentation/application/COMMUNICATION.md +0 -387
  136. package/documentation/application/CONFIGURATION.md +0 -2212
  137. package/documentation/application/CONTENT.md +0 -2629
  138. package/documentation/application/FILESTORAGE.md +0 -442
  139. package/documentation/application/LEAD.md +0 -1549
  140. package/documentation/application/LOGISTIC.md +0 -689
  141. package/documentation/application/ORDER.md +0 -2937
  142. package/documentation/application/PAYMENT.md +0 -4475
  143. package/documentation/application/POSCART.md +0 -9375
  144. package/documentation/application/README.md +0 -21
  145. package/documentation/application/REWARDS.md +0 -554
  146. package/documentation/application/SHARE.md +0 -635
  147. package/documentation/application/THEME.md +0 -5517
  148. package/documentation/application/USER.md +0 -3798
  149. package/documentation/platform/ANALYTICS.md +0 -1012
  150. package/documentation/platform/AUDITTRAIL.md +0 -493
  151. package/documentation/platform/BILLING.md +0 -1889
  152. package/documentation/platform/CART.md +0 -4711
  153. package/documentation/platform/CATALOG.md +0 -20522
  154. package/documentation/platform/COMMON.md +0 -325
  155. package/documentation/platform/COMMUNICATION.md +0 -4970
  156. package/documentation/platform/COMPANYPROFILE.md +0 -1646
  157. package/documentation/platform/CONFIGURATION.md +0 -6316
  158. package/documentation/platform/CONTENT.md +0 -8364
  159. package/documentation/platform/DISCOUNT.md +0 -767
  160. package/documentation/platform/FILESTORAGE.md +0 -945
  161. package/documentation/platform/INVENTORY.md +0 -1136
  162. package/documentation/platform/LEAD.md +0 -4394
  163. package/documentation/platform/ORDER.md +0 -6525
  164. package/documentation/platform/PARTNER.md +0 -193
  165. package/documentation/platform/PAYMENT.md +0 -3138
  166. package/documentation/platform/README.md +0 -27
  167. package/documentation/platform/REWARDS.md +0 -919
  168. package/documentation/platform/SHARE.md +0 -513
  169. package/documentation/platform/THEME.md +0 -35446
  170. package/documentation/platform/USER.md +0 -2174
  171. package/documentation/platform/WEBHOOK.md +0 -485
  172. package/documentation/public/CONFIGURATION.md +0 -325
  173. package/documentation/public/INVENTORY.md +0 -508
  174. package/documentation/public/WEBHOOK.md +0 -246
  175. package/jest.config.d.ts +0 -4
  176. package/jest.config.js +0 -6
  177. package/tests/application/catalog.spec.js +0 -54
  178. package/tests/common/action-url.spec.js +0 -35
  179. package/tests/common/schema/action-url.json +0 -178
  180. package/tests/common/schema/url-action.json +0 -683
  181. package/tests/common/url-action.spec.js +0 -48
  182. package/tests/helpers/cookie.helper.js +0 -31
  183. package/tests/helpers/oauth.helper.js +0 -43
  184. package/tests/platform/catalog.spec.js +0 -49
  185. package/tests/public/location.spec.js +0 -39
@@ -1,2937 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Application docs](./README.md)
7
-
8
- ## Order Methods
9
- Handles all Application order and shipment api(s)
10
-
11
- * [getCustomerDetailsByShipmentId](#getcustomerdetailsbyshipmentid)
12
- * [getInvoiceByShipmentId](#getinvoicebyshipmentid)
13
- * [getOrderById](#getorderbyid)
14
- * [getOrders](#getorders)
15
- * [getPosOrderById](#getposorderbyid)
16
- * [getShipmentBagReasons](#getshipmentbagreasons)
17
- * [getShipmentById](#getshipmentbyid)
18
- * [getShipmentReasons](#getshipmentreasons)
19
- * [sendOtpToShipmentCustomer](#sendotptoshipmentcustomer)
20
- * [trackShipment](#trackshipment)
21
- * [updateShipmentStatus](#updateshipmentstatus)
22
- * [verifyOtpShipmentCustomer](#verifyotpshipmentcustomer)
23
-
24
-
25
-
26
- ## Methods with example and description
27
-
28
-
29
-
30
-
31
- ### getCustomerDetailsByShipmentId
32
- Get Customer Details by Shipment Id
33
-
34
-
35
-
36
- ```javascript
37
- // Promise
38
- const promise = order.getCustomerDetailsByShipmentId({ orderId : value,
39
- shipmentId : value });
40
-
41
- // Async/Await
42
- const data = await order.getCustomerDetailsByShipmentId({ orderId : value,
43
- shipmentId : value });
44
- ```
45
-
46
-
47
-
48
-
49
-
50
- | Argument | Type | Required | Description |
51
- | --------- | ----- | -------- | ----------- |
52
- | orderId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
53
- | shipmentId | string | yes | A unique number used for identifying and tracking your orders. |
54
-
55
-
56
-
57
- Use this API to retrieve customer details such as mobileno using Shipment ID.
58
-
59
- *Returned Response:*
60
-
61
-
62
-
63
-
64
- [CustomerDetailsResponse](#CustomerDetailsResponse)
65
-
66
- Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
67
-
68
-
69
-
70
-
71
- <details>
72
- <summary><i>&nbsp; Example:</i></summary>
73
-
74
- ```json
75
- {
76
- "order_id": "FYMP629D972D01B6BD76",
77
- "shipment_id": "16544950215681060915J",
78
- "name": "sagar Kulkarni",
79
- "phone": "XXX-XXX-6780",
80
- "country": "India"
81
- }
82
- ```
83
- </details>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
- ---
94
-
95
-
96
- ### getInvoiceByShipmentId
97
- Get Invoice of a shipment
98
-
99
-
100
-
101
- ```javascript
102
- // Promise
103
- const promise = order.getInvoiceByShipmentId({ shipmentId : value });
104
-
105
- // Async/Await
106
- const data = await order.getInvoiceByShipmentId({ shipmentId : value });
107
- ```
108
-
109
-
110
-
111
-
112
-
113
- | Argument | Type | Required | Description |
114
- | --------- | ----- | -------- | ----------- |
115
- | shipmentId | string | yes | ID of the shipment. |
116
-
117
-
118
-
119
- Use this API to retrieve shipment invoice.
120
-
121
- *Returned Response:*
122
-
123
-
124
-
125
-
126
- [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
127
-
128
- Success. Check the example shown below or refer `ShipmentById` for more details.
129
-
130
-
131
-
132
-
133
- <details>
134
- <summary><i>&nbsp; Example:</i></summary>
135
-
136
- ```json
137
-
138
- ```
139
- </details>
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
- ---
150
-
151
-
152
- ### getOrderById
153
- Get details of an order
154
-
155
-
156
-
157
- ```javascript
158
- // Promise
159
- const promise = order.getOrderById({ orderId : value });
160
-
161
- // Async/Await
162
- const data = await order.getOrderById({ orderId : value });
163
- ```
164
-
165
-
166
-
167
-
168
-
169
- | Argument | Type | Required | Description |
170
- | --------- | ----- | -------- | ----------- |
171
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
172
-
173
-
174
-
175
- Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID.
176
-
177
- *Returned Response:*
178
-
179
-
180
-
181
-
182
- [OrderById](#OrderById)
183
-
184
- Success. Check the example shown below or refer `OrderById` for more details.
185
-
186
-
187
-
188
-
189
- <details>
190
- <summary><i>&nbsp; Example:</i></summary>
191
-
192
- ```json
193
- {
194
- "order": {
195
- "bags_for_reorder": [
196
- {
197
- "item_id": 7500429,
198
- "item_size": "OS",
199
- "store_id": 50,
200
- "seller_id": 33,
201
- "article_assignment": {
202
- "level": "multi-companies",
203
- "strategy": "low-price"
204
- },
205
- "quantity": 3
206
- }
207
- ],
208
- "user_info": {
209
- "mobile": "9892133001",
210
- "first_name": "User",
211
- "last_name": "-",
212
- "gender": "male"
213
- },
214
- "order_created_time": "2022-09-23T12:07:20.000Z",
215
- "total_shipments_in_order": 2,
216
- "order_id": "FY632D541F01152493D0",
217
- "breakup_values": [
218
- {
219
- "name": "mrp_total",
220
- "display": "MRP Total",
221
- "value": 3000
222
- },
223
- {
224
- "name": "sub_total",
225
- "display": "Sub Total",
226
- "value": 1797
227
- },
228
- {
229
- "name": "coupon",
230
- "display": "Coupon",
231
- "value": 0
232
- },
233
- {
234
- "name": "discount",
235
- "display": "Discount",
236
- "value": -1203
237
- },
238
- {
239
- "name": "promotion",
240
- "display": "Promotion",
241
- "value": 0
242
- },
243
- {
244
- "name": "reward_points",
245
- "display": "Reward Points",
246
- "value": 0
247
- },
248
- {
249
- "name": "cashback_applied",
250
- "display": "Cashback Applied",
251
- "value": 0
252
- },
253
- {
254
- "name": "delivery_charges",
255
- "display": "Delivery Charges",
256
- "value": 0
257
- },
258
- {
259
- "name": "cod_charges",
260
- "display": "COD Charges",
261
- "value": 0
262
- },
263
- {
264
- "name": "total",
265
- "display": "Total",
266
- "value": 1797
267
- }
268
- ],
269
- "shipments": [
270
- {
271
- "order_id": "FY632D541F01152493D0",
272
- "breakup_values": [
273
- {
274
- "name": "mrp_total",
275
- "display": "MRP Total",
276
- "value": 2000
277
- },
278
- {
279
- "name": "sub_total",
280
- "display": "Sub Total",
281
- "value": 1198
282
- },
283
- {
284
- "name": "coupon",
285
- "display": "Coupon",
286
- "value": 0
287
- },
288
- {
289
- "name": "discount",
290
- "display": "Discount",
291
- "value": -802
292
- },
293
- {
294
- "name": "promotion",
295
- "display": "Promotion",
296
- "value": 0
297
- },
298
- {
299
- "name": "reward_points",
300
- "display": "Reward Points",
301
- "value": 0
302
- },
303
- {
304
- "name": "cashback_applied",
305
- "display": "Cashback Applied",
306
- "value": 0
307
- },
308
- {
309
- "name": "delivery_charges",
310
- "display": "Delivery Charges",
311
- "value": 0
312
- },
313
- {
314
- "name": "cod_charges",
315
- "display": "COD Charges",
316
- "value": 0
317
- },
318
- {
319
- "name": "total",
320
- "display": "Total",
321
- "value": 1198
322
- }
323
- ],
324
- "beneficiary_details": false,
325
- "shipment_created_at": "2022-09-23T12:07:35.000Z",
326
- "shipment_id": "16639150404761166748K",
327
- "shipment_status": {
328
- "title": "Placed",
329
- "value": "processing",
330
- "hex_code": "#02D1CB"
331
- },
332
- "track_url": "",
333
- "traking_no": "",
334
- "awb_no": "",
335
- "dp_name": "",
336
- "tracking_details": [
337
- {
338
- "status": "Order Placed",
339
- "time": "2022-09-23T12:07:35.000Z",
340
- "is_passed": true,
341
- "value": "processing"
342
- },
343
- {
344
- "status": "Order Confirmed",
345
- "time": "",
346
- "is_passed": false,
347
- "value": "confirmed"
348
- },
349
- {
350
- "status": "Delivery Partner Assigned",
351
- "time": "",
352
- "is_passed": false,
353
- "value": "dp_assigned"
354
- },
355
- {
356
- "status": "In Transit",
357
- "time": "",
358
- "is_passed": false,
359
- "value": "in_transit"
360
- },
361
- {
362
- "status": "Out For Delivery",
363
- "time": "",
364
- "is_passed": false,
365
- "value": "out_for_delivery"
366
- },
367
- {
368
- "status": "Delivered",
369
- "time": "",
370
- "is_passed": false,
371
- "value": "delivered"
372
- }
373
- ],
374
- "total_bags": 1,
375
- "order_type": null,
376
- "promise": {
377
- "show_promise": true,
378
- "timestamp": {
379
- "dp_promise": null,
380
- "min": "2022-09-26T06:37:17+00:00",
381
- "max": "2022-09-27T06:37:17+00:00"
382
- }
383
- },
384
- "bags": [
385
- {
386
- "id": 67631,
387
- "current_status": {
388
- "status": "placed",
389
- "updated_at": "2022-09-23T12:07:35+00:00",
390
- "name": "Placed",
391
- "journey_type": "forward"
392
- },
393
- "prices": {
394
- "price_effective": 599,
395
- "discount": 401,
396
- "amount_paid": 599,
397
- "coupon_effective_discount": 0,
398
- "delivery_charge": 0,
399
- "fynd_credits": 0,
400
- "cod_charges": 0,
401
- "refund_credit": 0,
402
- "cashback": 0,
403
- "refund_amount": 599,
404
- "added_to_fynd_cash": false,
405
- "cashback_applied": 0,
406
- "gst_tax_percentage": 5,
407
- "value_of_good": 570.48,
408
- "price_marked": 1000,
409
- "transfer_price": 0,
410
- "brand_calculated_amount": 599,
411
- "promotion_effective_discount": 0,
412
- "coupon_value": 0,
413
- "pm_price_split": {
414
- "": 599
415
- }
416
- },
417
- "item": {
418
- "name": "FYND Black T-Shirt 03",
419
- "brand": {
420
- "name": "lacoste",
421
- "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
422
- },
423
- "image": [
424
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
425
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
426
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
427
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
428
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
429
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
430
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
431
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
432
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
433
- ],
434
- "slug_key": "fynd-black-cotton-mens-t-shirt",
435
- "size": "OS",
436
- "code": "SHIRT-01",
437
- "id": 7500429,
438
- "category": {
439
- "l1": [
440
- {
441
- "uid": 124,
442
- "name": "Apparel",
443
- "level": 1,
444
- "departments": [
445
- {
446
- "uid": 24,
447
- "name": "Crafts Of India"
448
- },
449
- {
450
- "uid": 8,
451
- "name": "Fashion"
452
- }
453
- ],
454
- "gated_category_types": {}
455
- }
456
- ],
457
- "l2": [
458
- {
459
- "uid": 50,
460
- "name": "Western Wear",
461
- "level": 2,
462
- "departments": [
463
- {
464
- "uid": 8,
465
- "name": "Fashion"
466
- }
467
- ],
468
- "gated_category_types": {}
469
- }
470
- ],
471
- "l3": [
472
- {
473
- "uid": 25,
474
- "name": "T-Shirts",
475
- "level": 3,
476
- "departments": [
477
- {
478
- "uid": 1,
479
- "name": "Men's Fashionjhjh"
480
- },
481
- {
482
- "uid": 8,
483
- "name": "Fashion"
484
- }
485
- ],
486
- "gated_category_types": {
487
- "food": false
488
- }
489
- }
490
- ]
491
- },
492
- "seller_identifier": "SHIRT-01"
493
- },
494
- "financial_breakup": [
495
- {
496
- "price_effective": 599,
497
- "discount": 401,
498
- "amount_paid": 599,
499
- "coupon_effective_discount": 0,
500
- "delivery_charge": 0,
501
- "fynd_credits": 0,
502
- "cod_charges": 0,
503
- "refund_credit": 0,
504
- "cashback": 0,
505
- "refund_amount": 599,
506
- "added_to_fynd_cash": false,
507
- "cashback_applied": 0,
508
- "gst_tax_percentage": 5,
509
- "value_of_good": 570.48,
510
- "price_marked": 1000,
511
- "transfer_price": 0,
512
- "brand_calculated_amount": 599,
513
- "promotion_effective_discount": 0,
514
- "coupon_value": 0,
515
- "pm_price_split": {
516
- "": 599
517
- },
518
- "size": "OS",
519
- "total_units": 1,
520
- "hsn_code": "62063000",
521
- "identifiers": {
522
- "sku_code": "SHIRT-01"
523
- },
524
- "item_name": "FYND Black T-Shirt 03",
525
- "gst_fee": "28.52",
526
- "gst_tag": "SGST"
527
- }
528
- ],
529
- "quantity": 2,
530
- "can_cancel": true,
531
- "can_return": false,
532
- "delivery_date": null,
533
- "returnable_date": null
534
- }
535
- ],
536
- "size_info": {
537
- "SHIRT-01": {
538
- "quantity": 2,
539
- "price_effective": 599,
540
- "amount_paid": 599,
541
- "price_marked": 1000,
542
- "margin": 40.1
543
- }
544
- },
545
- "total_details": {
546
- "sizes": 1,
547
- "total_price": 599,
548
- "pieces": 2
549
- },
550
- "fulfilling_store": {
551
- "name": "Jio-market-store4",
552
- "company_id": 33,
553
- "id": 50,
554
- "code": "store3"
555
- },
556
- "fulfilling_company": {
557
- "id": 33,
558
- "name": "RELIANCE JIO INFOCOMM LIMITED"
559
- },
560
- "delivery_date": null,
561
- "delivery_address": {
562
- "id": "62dfe1d112b842b2959de99e",
563
- "uid": 660,
564
- "area": "asd",
565
- "city": "Mumbai",
566
- "name": "Vaishakh Shetty",
567
- "email": null,
568
- "phone": "9892133001",
569
- "state": "Maharashtra",
570
- "address": "dsa",
571
- "country": "India",
572
- "pincode": "400059",
573
- "version": "1.0",
574
- "address1": " asd",
575
- "address2": "",
576
- "landmark": "tr",
577
- "latitude": 19.1157486,
578
- "address_1": " asd",
579
- "area_code": "400059",
580
- "longitude": 72.8773159,
581
- "created_at": "2022-09-22T18:19:29+00:00",
582
- "updated_at": "2022-09-22T18:19:29+00:00",
583
- "address_type": "home",
584
- "country_code": "91",
585
- "geo_location": {
586
- "latitude": 19.1157486,
587
- "longitude": 72.8773159
588
- },
589
- "area_code_slug": "pincode",
590
- "delivery_address_id": 660,
591
- "addressee_name": "Vaishakh Shetty",
592
- "delivery_code_required": 1
593
- },
594
- "can_cancel": true,
595
- "can_return": false,
596
- "returnable_date": null,
597
- "show_download_invoice": false,
598
- "show_track_link": false,
599
- "prices": {
600
- "amount_paid": 1198,
601
- "refund_amount": 1198,
602
- "price_marked": 2000,
603
- "cod_charges": 0,
604
- "coupon_value": 0,
605
- "discount": 802,
606
- "cashback_applied": 0,
607
- "delivery_charge": 0,
608
- "fynd_credits": 0,
609
- "cashback": 0,
610
- "price_effective": 1198,
611
- "refund_credit": 0,
612
- "value_of_good": 1140.96,
613
- "discount_percent": 40
614
- },
615
- "can_break": {
616
- "bag_repriced": {
617
- "can_break_entity": false
618
- },
619
- "cancelled_seller": {
620
- "can_break_entity": false
621
- },
622
- "bag_not_verified": {
623
- "can_break_entity": false
624
- },
625
- "product_not_available": {
626
- "can_break_entity": false
627
- },
628
- "bag_invoiced": {
629
- "can_break_entity": false
630
- },
631
- "store_reassigned": {
632
- "can_break_entity": false
633
- },
634
- "cancelled_fynd": {
635
- "can_break_entity": false
636
- },
637
- "cancelled_operations": {
638
- "can_break_entity": true
639
- },
640
- "cancelled_customer": {
641
- "can_break_entity": true
642
- },
643
- "bag_not_confirmed": {
644
- "can_break_entity": true
645
- },
646
- "delivery_sla_breached": {
647
- "can_break_entity": false
648
- },
649
- "bag_confirmed": {
650
- "can_break_entity": true
651
- }
652
- },
653
- "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
654
- "payment": {
655
- "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
656
- "mode": "Jio Partner Pay",
657
- "mop": "PREPAID",
658
- "status": "Paid"
659
- },
660
- "user_info": {
661
- "email": "paymentsdummy@gofynd.com",
662
- "gender": "male",
663
- "mobile": "9892133001",
664
- "name": "User -"
665
- },
666
- "comment": "",
667
- "invoice": {
668
- "updated_date": "1970-01-01T00:00:00.000Z",
669
- "store_invoice_id": null,
670
- "invoice_url": "",
671
- "label_url": ""
672
- },
673
- "refund_details": {
674
- "rrn": null
675
- }
676
- },
677
- {
678
- "order_id": "FY632D541F01152493D0",
679
- "breakup_values": [
680
- {
681
- "name": "mrp_total",
682
- "display": "MRP Total",
683
- "value": 1000
684
- },
685
- {
686
- "name": "sub_total",
687
- "display": "Sub Total",
688
- "value": 599
689
- },
690
- {
691
- "name": "coupon",
692
- "display": "Coupon",
693
- "value": 0
694
- },
695
- {
696
- "name": "discount",
697
- "display": "Discount",
698
- "value": -401
699
- },
700
- {
701
- "name": "promotion",
702
- "display": "Promotion",
703
- "value": 0
704
- },
705
- {
706
- "name": "reward_points",
707
- "display": "Reward Points",
708
- "value": 0
709
- },
710
- {
711
- "name": "cashback_applied",
712
- "display": "Cashback Applied",
713
- "value": 0
714
- },
715
- {
716
- "name": "delivery_charges",
717
- "display": "Delivery Charges",
718
- "value": 0
719
- },
720
- {
721
- "name": "cod_charges",
722
- "display": "COD Charges",
723
- "value": 0
724
- },
725
- {
726
- "name": "total",
727
- "display": "Total",
728
- "value": 599
729
- }
730
- ],
731
- "beneficiary_details": false,
732
- "shipment_created_at": "2022-09-23T12:07:58.000Z",
733
- "shipment_id": "16639150772951172388K",
734
- "shipment_status": {
735
- "title": "Refund Initiated",
736
- "value": "refund_initiated",
737
- "hex_code": "#FE8F46"
738
- },
739
- "track_url": "",
740
- "traking_no": "",
741
- "awb_no": "",
742
- "dp_name": "",
743
- "tracking_details": [
744
- {
745
- "status": "Order Placed",
746
- "time": "2022-09-23T12:07:35.000Z",
747
- "is_passed": true,
748
- "value": "processing"
749
- },
750
- {
751
- "status": "Cancelled",
752
- "time": "2022-09-23T12:07:57.000Z",
753
- "is_passed": true,
754
- "value": "cancelled"
755
- },
756
- {
757
- "status": "Refund Processing",
758
- "time": "2022-09-23T12:07:58.000Z",
759
- "is_passed": true,
760
- "value": "refund_initiated",
761
- "tracking_details": [
762
- {
763
- "status": "Refund Initiated",
764
- "time": "2022-09-23T12:07:58.000Z",
765
- "is_passed": true,
766
- "value": "refund_initiated"
767
- },
768
- {
769
- "status": "Refund Completed",
770
- "time": "",
771
- "is_passed": false,
772
- "value": "refund_done"
773
- }
774
- ]
775
- }
776
- ],
777
- "total_bags": 1,
778
- "order_type": null,
779
- "promise": {
780
- "show_promise": false,
781
- "timestamp": {
782
- "dp_promise": null,
783
- "min": "2022-09-26T06:37:17+00:00",
784
- "max": "2022-09-27T06:37:17+00:00"
785
- }
786
- },
787
- "bags": [
788
- {
789
- "id": 67632,
790
- "current_status": {
791
- "status": "refund_acknowledged",
792
- "updated_at": "2022-09-23T12:07:58+00:00",
793
- "name": "Refund Acknowledged",
794
- "journey_type": null
795
- },
796
- "prices": {
797
- "price_effective": 599,
798
- "discount": 401,
799
- "amount_paid": 599,
800
- "coupon_effective_discount": 0,
801
- "delivery_charge": 0,
802
- "fynd_credits": 0,
803
- "cod_charges": 0,
804
- "refund_credit": 0,
805
- "cashback": 0,
806
- "refund_amount": 599,
807
- "added_to_fynd_cash": false,
808
- "cashback_applied": 0,
809
- "gst_tax_percentage": 5,
810
- "value_of_good": 570.48,
811
- "price_marked": 1000,
812
- "transfer_price": 0,
813
- "brand_calculated_amount": 599,
814
- "promotion_effective_discount": 0,
815
- "coupon_value": 0,
816
- "pm_price_split": {
817
- "": 599
818
- }
819
- },
820
- "item": {
821
- "name": "FYND Black T-Shirt 03",
822
- "brand": {
823
- "name": "lacoste",
824
- "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
825
- },
826
- "image": [
827
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
828
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
829
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
830
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
831
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
832
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
833
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
834
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
835
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
836
- ],
837
- "slug_key": "fynd-black-cotton-mens-t-shirt",
838
- "size": "OS",
839
- "code": "SHIRT-01",
840
- "id": 7500429,
841
- "category": {
842
- "l1": [
843
- {
844
- "uid": 124,
845
- "name": "Apparel",
846
- "level": 1,
847
- "departments": [
848
- {
849
- "uid": 24,
850
- "name": "Crafts Of India"
851
- },
852
- {
853
- "uid": 8,
854
- "name": "Fashion"
855
- }
856
- ],
857
- "gated_category_types": {}
858
- }
859
- ],
860
- "l2": [
861
- {
862
- "uid": 50,
863
- "name": "Western Wear",
864
- "level": 2,
865
- "departments": [
866
- {
867
- "uid": 8,
868
- "name": "Fashion"
869
- }
870
- ],
871
- "gated_category_types": {}
872
- }
873
- ],
874
- "l3": [
875
- {
876
- "uid": 25,
877
- "name": "T-Shirts",
878
- "level": 3,
879
- "departments": [
880
- {
881
- "uid": 1,
882
- "name": "Men's Fashionjhjh"
883
- },
884
- {
885
- "uid": 8,
886
- "name": "Fashion"
887
- }
888
- ],
889
- "gated_category_types": {
890
- "food": false
891
- }
892
- }
893
- ]
894
- },
895
- "seller_identifier": "SHIRT-01"
896
- },
897
- "financial_breakup": [
898
- {
899
- "price_effective": 599,
900
- "discount": 401,
901
- "amount_paid": 599,
902
- "coupon_effective_discount": 0,
903
- "delivery_charge": 0,
904
- "fynd_credits": 0,
905
- "cod_charges": 0,
906
- "refund_credit": 0,
907
- "cashback": 0,
908
- "refund_amount": 599,
909
- "added_to_fynd_cash": false,
910
- "cashback_applied": 0,
911
- "gst_tax_percentage": 5,
912
- "value_of_good": 570.48,
913
- "price_marked": 1000,
914
- "transfer_price": 0,
915
- "brand_calculated_amount": 599,
916
- "promotion_effective_discount": 0,
917
- "coupon_value": 0,
918
- "pm_price_split": {
919
- "": 599
920
- },
921
- "size": "OS",
922
- "total_units": 1,
923
- "hsn_code": "62063000",
924
- "identifiers": {
925
- "sku_code": "SHIRT-01"
926
- },
927
- "item_name": "FYND Black T-Shirt 03",
928
- "gst_fee": "28.52",
929
- "gst_tag": "SGST"
930
- }
931
- ],
932
- "quantity": 1,
933
- "can_cancel": false,
934
- "can_return": false,
935
- "delivery_date": null,
936
- "returnable_date": null
937
- }
938
- ],
939
- "size_info": {
940
- "SHIRT-01": {
941
- "quantity": 1,
942
- "price_effective": 599,
943
- "amount_paid": 599,
944
- "price_marked": 1000,
945
- "margin": 40.1
946
- }
947
- },
948
- "total_details": {
949
- "sizes": 1,
950
- "total_price": 599,
951
- "pieces": 1
952
- },
953
- "fulfilling_store": {
954
- "name": "Jio-market-store4",
955
- "company_id": 33,
956
- "id": 50,
957
- "code": "store3"
958
- },
959
- "fulfilling_company": {
960
- "id": 33,
961
- "name": "RELIANCE JIO INFOCOMM LIMITED"
962
- },
963
- "delivery_date": null,
964
- "delivery_address": {
965
- "id": "62dfe1d112b842b2959de99e",
966
- "uid": 660,
967
- "area": "asd",
968
- "city": "Mumbai",
969
- "name": "Vaishakh Shetty",
970
- "email": null,
971
- "phone": "9892133001",
972
- "state": "Maharashtra",
973
- "address": "dsa",
974
- "country": "India",
975
- "pincode": "400059",
976
- "version": "1.0",
977
- "address1": " asd",
978
- "address2": "",
979
- "landmark": "tr",
980
- "latitude": 19.1157486,
981
- "address_1": " asd",
982
- "area_code": "400059",
983
- "longitude": 72.8773159,
984
- "created_at": "2022-09-22T18:19:29+00:00",
985
- "updated_at": "2022-09-22T18:19:29+00:00",
986
- "address_type": "home",
987
- "country_code": "91",
988
- "geo_location": {
989
- "latitude": 19.1157486,
990
- "longitude": 72.8773159
991
- },
992
- "area_code_slug": "pincode",
993
- "delivery_address_id": 660,
994
- "addressee_name": "Vaishakh Shetty",
995
- "delivery_code_required": 1
996
- },
997
- "can_cancel": false,
998
- "can_return": false,
999
- "returnable_date": null,
1000
- "show_download_invoice": false,
1001
- "show_track_link": false,
1002
- "prices": {
1003
- "amount_paid": 599,
1004
- "refund_amount": 599,
1005
- "price_marked": 1000,
1006
- "cod_charges": 0,
1007
- "coupon_value": 0,
1008
- "discount": 401,
1009
- "cashback_applied": 0,
1010
- "delivery_charge": 0,
1011
- "fynd_credits": 0,
1012
- "cashback": 0,
1013
- "price_effective": 599,
1014
- "refund_credit": 0,
1015
- "value_of_good": 570.48,
1016
- "discount_percent": 40
1017
- },
1018
- "can_break": {
1019
- "refund_completed": {
1020
- "can_break_entity": false
1021
- },
1022
- "rto_delivery_attempt_failed": {
1023
- "can_break_entity": false
1024
- },
1025
- "return_rejected_by_dp": {
1026
- "can_break_entity": false
1027
- },
1028
- "return_to_origin": {
1029
- "can_break_entity": false
1030
- },
1031
- "rto_initiated": {
1032
- "can_break_entity": false
1033
- },
1034
- "refund_failed": {
1035
- "can_break_entity": false
1036
- },
1037
- "bag_picked": {
1038
- "can_break_entity": false
1039
- },
1040
- "rto_bag_delivered": {
1041
- "can_break_entity": false
1042
- },
1043
- "return_dp_assigned": {
1044
- "can_break_entity": false
1045
- },
1046
- "return_bag_in_transit": {
1047
- "can_break_entity": false
1048
- },
1049
- "return_bag_out_for_delivery": {
1050
- "can_break_entity": false
1051
- },
1052
- "return_initiated": {
1053
- "can_break_entity": true
1054
- },
1055
- "return_rejected_by_store": {
1056
- "can_break_entity": false
1057
- },
1058
- "rto_bag_out_for_delivery": {
1059
- "can_break_entity": false
1060
- },
1061
- "deadstock": {
1062
- "can_break_entity": false
1063
- },
1064
- "bag_lost": {
1065
- "can_break_entity": false
1066
- },
1067
- "return_bag_delivered": {
1068
- "can_break_entity": false
1069
- },
1070
- "return_completed": {
1071
- "can_break_entity": false
1072
- },
1073
- "return_bag_picked": {
1074
- "can_break_entity": false
1075
- },
1076
- "rto_bag_accepted": {
1077
- "can_break_entity": false
1078
- },
1079
- "deadstock_defective": {
1080
- "can_break_entity": false
1081
- },
1082
- "rto_in_transit": {
1083
- "can_break_entity": false
1084
- },
1085
- "return_accepted": {
1086
- "can_break_entity": false
1087
- },
1088
- "out_for_pickup": {
1089
- "can_break_entity": false
1090
- },
1091
- "return_bag_not_delivered": {
1092
- "can_break_entity": false
1093
- },
1094
- "cancelled_customer": {
1095
- "can_break_entity": true
1096
- },
1097
- "return_bag_lost": {
1098
- "can_break_entity": false
1099
- }
1100
- },
1101
- "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
1102
- "payment": {
1103
- "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1104
- "mode": "Jio Partner Pay",
1105
- "mop": "PREPAID",
1106
- "status": "Paid"
1107
- },
1108
- "user_info": {
1109
- "email": "paymentsdummy@gofynd.com",
1110
- "gender": "male",
1111
- "mobile": "9892133001",
1112
- "name": "User -"
1113
- },
1114
- "comment": "",
1115
- "invoice": {
1116
- "updated_date": "1970-01-01T00:00:00.000Z",
1117
- "store_invoice_id": null,
1118
- "invoice_url": "",
1119
- "label_url": ""
1120
- },
1121
- "refund_details": {
1122
- "rrn": ""
1123
- }
1124
- }
1125
- ],
1126
- "is_validated": false
1127
- }
1128
- }
1129
- ```
1130
- </details>
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
- ---
1141
-
1142
-
1143
- ### getOrders
1144
- Get all orders
1145
-
1146
-
1147
-
1148
- ```javascript
1149
- // Promise
1150
- const promise = order.getOrders({ status : value,
1151
- pageNo : value,
1152
- pageSize : value,
1153
- fromDate : value,
1154
- toDate : value,
1155
- customMeta : value });
1156
-
1157
- // Async/Await
1158
- const data = await order.getOrders({ status : value,
1159
- pageNo : value,
1160
- pageSize : value,
1161
- fromDate : value,
1162
- toDate : value,
1163
- customMeta : value });
1164
- ```
1165
-
1166
-
1167
-
1168
-
1169
-
1170
- | Argument | Type | Required | Description |
1171
- | --------- | ----- | -------- | ----------- |
1172
- | status | number | no | A filter to retrieve orders by their current status such as _placed_, _delivered_, etc. |
1173
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
1174
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
1175
- | fromDate | string | no | The date from which the orders should be retrieved. |
1176
- | toDate | string | no | The date till which the orders should be retrieved. |
1177
- | customMeta | string | no | A filter and retrieve data using special fields included for special use-cases |
1178
-
1179
-
1180
-
1181
- Use this API to retrieve all the orders.
1182
-
1183
- *Returned Response:*
1184
-
1185
-
1186
-
1187
-
1188
- [OrderList](#OrderList)
1189
-
1190
- Success. Returns all the orders. Check the example shown below or refer `OrderList` for more details.
1191
-
1192
-
1193
-
1194
-
1195
- <details>
1196
- <summary><i>&nbsp; Example:</i></summary>
1197
-
1198
- ```json
1199
-
1200
- ```
1201
- </details>
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
- ---
1212
-
1213
-
1214
- ### getPosOrderById
1215
- Get POS Order
1216
-
1217
-
1218
-
1219
- ```javascript
1220
- // Promise
1221
- const promise = order.getPosOrderById({ orderId : value });
1222
-
1223
- // Async/Await
1224
- const data = await order.getPosOrderById({ orderId : value });
1225
- ```
1226
-
1227
-
1228
-
1229
-
1230
-
1231
- | Argument | Type | Required | Description |
1232
- | --------- | ----- | -------- | ----------- |
1233
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
1234
-
1235
-
1236
-
1237
- Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
1238
-
1239
- *Returned Response:*
1240
-
1241
-
1242
-
1243
-
1244
- [OrderList](#OrderList)
1245
-
1246
- Success. Check the example shown below or refer `PosOrderById` for more details.
1247
-
1248
-
1249
-
1250
-
1251
- <details>
1252
- <summary><i>&nbsp; Example:</i></summary>
1253
-
1254
- ```json
1255
- {
1256
- "order": {
1257
- "order_created_time": "2022-08-11T16:09:17.000Z",
1258
- "total_shipments_in_order": 1,
1259
- "order_id": "FY62F4CE260113EFCC64",
1260
- "breakup_values": [
1261
- {
1262
- "name": "mrp_total",
1263
- "display": "MRP Total",
1264
- "value": 1000
1265
- },
1266
- {
1267
- "name": "sub_total",
1268
- "display": "Sub Total",
1269
- "value": 999
1270
- },
1271
- {
1272
- "name": "coupon",
1273
- "display": "Coupon",
1274
- "value": 0
1275
- },
1276
- {
1277
- "name": "discount",
1278
- "display": "Discount",
1279
- "value": -1
1280
- },
1281
- {
1282
- "name": "promotion",
1283
- "display": "Promotion",
1284
- "value": 0
1285
- },
1286
- {
1287
- "name": "reward_points",
1288
- "display": "Reward Points",
1289
- "value": 0
1290
- },
1291
- {
1292
- "name": "cashback_applied",
1293
- "display": "Cashback Applied",
1294
- "value": 0
1295
- },
1296
- {
1297
- "name": "delivery_charges",
1298
- "display": "Delivery Charges",
1299
- "value": 0
1300
- },
1301
- {
1302
- "name": "cod_charges",
1303
- "display": "COD Charges",
1304
- "value": 0
1305
- },
1306
- {
1307
- "name": "total",
1308
- "display": "Total",
1309
- "value": 999
1310
- }
1311
- ],
1312
- "shipments": [
1313
- {
1314
- "order_id": "FY62F4CE260113EFCC64",
1315
- "breakup_values": [
1316
- {
1317
- "name": "mrp_total",
1318
- "display": "MRP Total",
1319
- "value": 1000
1320
- },
1321
- {
1322
- "name": "sub_total",
1323
- "display": "Sub Total",
1324
- "value": 999
1325
- },
1326
- {
1327
- "name": "coupon",
1328
- "display": "Coupon",
1329
- "value": 0
1330
- },
1331
- {
1332
- "name": "discount",
1333
- "display": "Discount",
1334
- "value": -1
1335
- },
1336
- {
1337
- "name": "promotion",
1338
- "display": "Promotion",
1339
- "value": 0
1340
- },
1341
- {
1342
- "name": "reward_points",
1343
- "display": "Reward Points",
1344
- "value": 0
1345
- },
1346
- {
1347
- "name": "cashback_applied",
1348
- "display": "Cashback Applied",
1349
- "value": 0
1350
- },
1351
- {
1352
- "name": "delivery_charges",
1353
- "display": "Delivery Charges",
1354
- "value": 0
1355
- },
1356
- {
1357
- "name": "cod_charges",
1358
- "display": "COD Charges",
1359
- "value": 0
1360
- },
1361
- {
1362
- "name": "total",
1363
- "display": "Total",
1364
- "value": 999
1365
- }
1366
- ],
1367
- "beneficiary_details": false,
1368
- "shipment_created_at": "2022-08-22T21:33:33.000Z",
1369
- "shipment_id": "16602143565551542371K",
1370
- "shipment_status": {
1371
- "title": "DP Assigned",
1372
- "value": "dp_assigned",
1373
- "hex_code": "#FE8F46"
1374
- },
1375
- "track_url": "",
1376
- "traking_no": "Tracking No.: 118022046",
1377
- "awb_no": "118022046",
1378
- "dp_name": "ecom_jio",
1379
- "tracking_details": [
1380
- {
1381
- "status": "Order Placed",
1382
- "time": "2022-08-11T16:09:17.000Z",
1383
- "is_passed": true,
1384
- "value": "processing"
1385
- },
1386
- {
1387
- "status": "Order Confirmed",
1388
- "time": "2022-08-22T17:14:02.000Z",
1389
- "is_passed": true,
1390
- "value": "confirmed"
1391
- },
1392
- {
1393
- "status": "Delivery Partner Assigned",
1394
- "time": "2022-08-22T17:14:13.000Z",
1395
- "is_passed": true,
1396
- "value": "dp_assigned"
1397
- },
1398
- {
1399
- "status": "In Transit",
1400
- "time": "",
1401
- "is_passed": false,
1402
- "value": "in_transit"
1403
- },
1404
- {
1405
- "status": "Out For Delivery",
1406
- "time": "",
1407
- "is_passed": false,
1408
- "value": "out_for_delivery"
1409
- },
1410
- {
1411
- "status": "Delivered",
1412
- "time": "",
1413
- "is_passed": false,
1414
- "value": "delivered"
1415
- }
1416
- ],
1417
- "total_bags": 1,
1418
- "order_type": null,
1419
- "promise": {
1420
- "show_promise": false,
1421
- "timestamp": {
1422
- "dp_promise": null,
1423
- "min": "2022-08-15T09:38:44+00:00",
1424
- "max": "2022-08-18T09:38:44+00:00"
1425
- }
1426
- },
1427
- "bags": [
1428
- {
1429
- "id": 59987,
1430
- "current_status": {
1431
- "status": "bag_not_picked",
1432
- "updated_at": "2022-08-22T21:33:33+00:00",
1433
- "name": "Bag Not Picked",
1434
- "journey_type": "forward"
1435
- },
1436
- "prices": {
1437
- "price_effective": 999,
1438
- "discount": 1,
1439
- "amount_paid": 999,
1440
- "coupon_effective_discount": 0,
1441
- "delivery_charge": 0,
1442
- "fynd_credits": 0,
1443
- "cod_charges": 0,
1444
- "refund_credit": 0,
1445
- "cashback": 0,
1446
- "refund_amount": 999,
1447
- "added_to_fynd_cash": false,
1448
- "cashback_applied": 0,
1449
- "gst_tax_percentage": 18,
1450
- "value_of_good": 846.61,
1451
- "price_marked": 1000,
1452
- "transfer_price": 0,
1453
- "brand_calculated_amount": 999,
1454
- "promotion_effective_discount": 0,
1455
- "coupon_value": 0,
1456
- "pm_price_split": {
1457
- "Net Banking": 999
1458
- }
1459
- },
1460
- "item": {
1461
- "name": "Puma Men Tshirt",
1462
- "brand": {
1463
- "name": "Dabur",
1464
- "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/kv5DZy0J8-Logo.jpeg"
1465
- },
1466
- "image": [
1467
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/e6qJ_Bihn-61x838nYQUL._UL1440_.jpg"
1468
- ],
1469
- "slug_key": "puma-men-tshirt",
1470
- "size": "OS",
1471
- "code": "PUMATSHIRT",
1472
- "id": 7507572,
1473
- "category": [],
1474
- "seller_identifier": "PUMATSHIRT"
1475
- },
1476
- "financial_breakup": [
1477
- {
1478
- "price_effective": 999,
1479
- "discount": 1,
1480
- "amount_paid": 999,
1481
- "coupon_effective_discount": 0,
1482
- "delivery_charge": 0,
1483
- "fynd_credits": 0,
1484
- "cod_charges": 0,
1485
- "refund_credit": 0,
1486
- "cashback": 0,
1487
- "refund_amount": 999,
1488
- "added_to_fynd_cash": false,
1489
- "cashback_applied": 0,
1490
- "gst_tax_percentage": 18,
1491
- "value_of_good": 846.61,
1492
- "price_marked": 1000,
1493
- "transfer_price": 0,
1494
- "brand_calculated_amount": 999,
1495
- "promotion_effective_discount": 0,
1496
- "coupon_value": 0,
1497
- "pm_price_split": {
1498
- "Net Banking": 999
1499
- },
1500
- "size": "OS",
1501
- "total_units": 1,
1502
- "hsn_code": "99972900",
1503
- "identifiers": {
1504
- "sku_code": "PUMATSHIRT"
1505
- },
1506
- "item_name": "Puma Men Tshirt",
1507
- "gst_fee": "152.38",
1508
- "gst_tag": "IGST"
1509
- }
1510
- ],
1511
- "quantity": 1
1512
- }
1513
- ],
1514
- "size_info": {
1515
- "PUMATSHIRT": {
1516
- "quantity": 1,
1517
- "price_effective": 999,
1518
- "amount_paid": 999,
1519
- "price_marked": 1000,
1520
- "margin": 0.1
1521
- }
1522
- },
1523
- "total_details": {
1524
- "sizes": 1,
1525
- "total_price": 999,
1526
- "pieces": 1
1527
- },
1528
- "fulfilling_store": {
1529
- "name": "jio-location",
1530
- "company_id": 41,
1531
- "id": 8,
1532
- "code": "jio-location"
1533
- },
1534
- "fulfilling_company": {
1535
- "id": 41,
1536
- "name": "Jio"
1537
- }
1538
- }
1539
- ],
1540
- "is_validated": false
1541
- }
1542
- }
1543
- ```
1544
- </details>
1545
-
1546
-
1547
-
1548
-
1549
-
1550
-
1551
-
1552
-
1553
-
1554
- ---
1555
-
1556
-
1557
- ### getShipmentBagReasons
1558
- Get reasons behind full or partial cancellation of a shipment
1559
-
1560
-
1561
-
1562
- ```javascript
1563
- // Promise
1564
- const promise = order.getShipmentBagReasons({ shipmentId : value,
1565
- bagId : value });
1566
-
1567
- // Async/Await
1568
- const data = await order.getShipmentBagReasons({ shipmentId : value,
1569
- bagId : value });
1570
- ```
1571
-
1572
-
1573
-
1574
-
1575
-
1576
- | Argument | Type | Required | Description |
1577
- | --------- | ----- | -------- | ----------- |
1578
- | shipmentId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1579
- | bagId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1580
-
1581
-
1582
-
1583
- Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
1584
-
1585
- *Returned Response:*
1586
-
1587
-
1588
-
1589
-
1590
- [ShipmentBagReasons](#ShipmentBagReasons)
1591
-
1592
- Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
1593
-
1594
-
1595
-
1596
-
1597
- <details>
1598
- <summary><i>&nbsp; Example:</i></summary>
1599
-
1600
- ```json
1601
- {
1602
- "success": true,
1603
- "reasons": [
1604
- {
1605
- "id": 1,
1606
- "display_name": "Not available",
1607
- "qc_type": [],
1608
- "question_set": []
1609
- },
1610
- {
1611
- "reasons": [
1612
- {
1613
- "id": 2,
1614
- "display_name": "Processing other orders",
1615
- "qc_type": [],
1616
- "question_set": []
1617
- },
1618
- {
1619
- "id": 3,
1620
- "display_name": "Printer not working",
1621
- "qc_type": [],
1622
- "question_set": []
1623
- },
1624
- {
1625
- "reasons": [
1626
- {
1627
- "id": 4,
1628
- "display_name": "Card issues",
1629
- "qc_type": [],
1630
- "question_set": []
1631
- }
1632
- ]
1633
- }
1634
- ]
1635
- },
1636
- {
1637
- "id": 4,
1638
- "display_name": "Card issues",
1639
- "qc_type": [],
1640
- "question_set": []
1641
- }
1642
- ]
1643
- }
1644
- ```
1645
- </details>
1646
-
1647
-
1648
-
1649
-
1650
-
1651
-
1652
-
1653
-
1654
-
1655
- ---
1656
-
1657
-
1658
- ### getShipmentById
1659
- Get details of a shipment
1660
-
1661
-
1662
-
1663
- ```javascript
1664
- // Promise
1665
- const promise = order.getShipmentById({ shipmentId : value });
1666
-
1667
- // Async/Await
1668
- const data = await order.getShipmentById({ shipmentId : value });
1669
- ```
1670
-
1671
-
1672
-
1673
-
1674
-
1675
- | Argument | Type | Required | Description |
1676
- | --------- | ----- | -------- | ----------- |
1677
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1678
-
1679
-
1680
-
1681
- Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
1682
-
1683
- *Returned Response:*
1684
-
1685
-
1686
-
1687
-
1688
- [ShipmentById](#ShipmentById)
1689
-
1690
- Success. Check the example shown below or refer `ShipmentById` for more details.
1691
-
1692
-
1693
-
1694
-
1695
- <details>
1696
- <summary><i>&nbsp; Example:</i></summary>
1697
-
1698
- ```json
1699
- {
1700
- "shipment": {
1701
- "order_id": "FY62F3B8290150D13E36",
1702
- "breakup_values": [
1703
- {
1704
- "name": "mrp_total",
1705
- "display": "MRP Total",
1706
- "value": 50
1707
- },
1708
- {
1709
- "name": "sub_total",
1710
- "display": "Sub Total",
1711
- "value": 50
1712
- },
1713
- {
1714
- "name": "coupon",
1715
- "display": "Coupon",
1716
- "value": 0
1717
- },
1718
- {
1719
- "name": "discount",
1720
- "display": "Discount",
1721
- "value": 0
1722
- },
1723
- {
1724
- "name": "promotion",
1725
- "display": "Promotion",
1726
- "value": 0
1727
- },
1728
- {
1729
- "name": "reward_points",
1730
- "display": "Reward Points",
1731
- "value": 0
1732
- },
1733
- {
1734
- "name": "cashback_applied",
1735
- "display": "Cashback Applied",
1736
- "value": 0
1737
- },
1738
- {
1739
- "name": "delivery_charges",
1740
- "display": "Delivery Charges",
1741
- "value": 0
1742
- },
1743
- {
1744
- "name": "cod_charges",
1745
- "display": "COD Charges",
1746
- "value": 0
1747
- },
1748
- {
1749
- "name": "total",
1750
- "display": "Total",
1751
- "value": 50
1752
- }
1753
- ],
1754
- "beneficiary_details": false,
1755
- "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
1756
- "shipment_created_at": "2022-08-10T19:22:42.000Z",
1757
- "shipment_id": "16601395620321798247K",
1758
- "shipment_status": {
1759
- "title": "DP Assigned",
1760
- "value": "dp_assigned",
1761
- "hex_code": "#FE8F46"
1762
- },
1763
- "track_url": "",
1764
- "traking_no": "Tracking No.: 5923410031146",
1765
- "awb_no": "5923410031146",
1766
- "dp_name": "delhivery_jio_surface",
1767
- "tracking_details": [
1768
- {
1769
- "status": "Order Placed",
1770
- "time": "2022-08-10T19:22:55.000Z",
1771
- "is_passed": true,
1772
- "value": "processing"
1773
- },
1774
- {
1775
- "status": "Order Confirmed",
1776
- "time": "2022-08-18T19:11:02.000Z",
1777
- "is_passed": true,
1778
- "value": "confirmed"
1779
- },
1780
- {
1781
- "status": "Delivery Partner Assigned",
1782
- "time": "2022-08-18T19:11:38.000Z",
1783
- "is_passed": true,
1784
- "value": "dp_assigned"
1785
- },
1786
- {
1787
- "status": "In Transit",
1788
- "time": "",
1789
- "is_passed": false,
1790
- "value": "in_transit"
1791
- },
1792
- {
1793
- "status": "Out For Delivery",
1794
- "time": "",
1795
- "is_passed": false,
1796
- "value": "out_for_delivery"
1797
- },
1798
- {
1799
- "status": "Delivered",
1800
- "time": "",
1801
- "is_passed": false,
1802
- "value": "delivered"
1803
- }
1804
- ],
1805
- "total_bags": 1,
1806
- "promise": {
1807
- "show_promise": false,
1808
- "timestamp": {
1809
- "min": "2022-08-14T13:52:37+00:00",
1810
- "max": "2022-08-17T13:52:37+00:00",
1811
- "dp_promise": null
1812
- }
1813
- },
1814
- "bags": [
1815
- {
1816
- "id": 59624,
1817
- "current_status": {
1818
- "status": "bag_not_picked",
1819
- "updated_at": "2022-08-18T23:46:11+00:00",
1820
- "name": "Bag Not Picked",
1821
- "journey_type": "forward"
1822
- },
1823
- "prices": {
1824
- "price_effective": 50,
1825
- "discount": 0,
1826
- "amount_paid": 50,
1827
- "coupon_effective_discount": 0,
1828
- "delivery_charge": 0,
1829
- "fynd_credits": 0,
1830
- "cod_charges": 0,
1831
- "refund_credit": 0,
1832
- "cashback": 0,
1833
- "refund_amount": 50,
1834
- "added_to_fynd_cash": false,
1835
- "cashback_applied": 0,
1836
- "gst_tax_percentage": 18,
1837
- "value_of_good": 42.37,
1838
- "price_marked": 50,
1839
- "transfer_price": 0,
1840
- "brand_calculated_amount": 50,
1841
- "promotion_effective_discount": 0,
1842
- "coupon_value": 0,
1843
- "pm_price_split": {
1844
- "COD": 50
1845
- }
1846
- },
1847
- "item": {
1848
- "name": "Tissues",
1849
- "brand": {
1850
- "name": "Zepto",
1851
- "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/5XLRHXC5H-Logo.png"
1852
- },
1853
- "image": [
1854
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/hGov80Pbv-411yLXtNYNL._SL1000_.jpg",
1855
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1856
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1857
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1858
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1859
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1860
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1861
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1862
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1863
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
1864
- "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg"
1865
- ],
1866
- "slug_key": "tissues",
1867
- "size": "OS",
1868
- "code": "TIS-102",
1869
- "id": 7500474,
1870
- "seller_identifier": "987432134"
1871
- },
1872
- "financial_breakup": [
1873
- {
1874
- "price_effective": 50,
1875
- "discount": 0,
1876
- "amount_paid": 50,
1877
- "coupon_effective_discount": 0,
1878
- "delivery_charge": 0,
1879
- "fynd_credits": 0,
1880
- "cod_charges": 0,
1881
- "refund_credit": 0,
1882
- "cashback": 0,
1883
- "refund_amount": 50,
1884
- "added_to_fynd_cash": false,
1885
- "cashback_applied": 0,
1886
- "gst_tax_percentage": 18,
1887
- "value_of_good": 42.37,
1888
- "price_marked": 50,
1889
- "transfer_price": 0,
1890
- "brand_calculated_amount": 50,
1891
- "promotion_effective_discount": 0,
1892
- "coupon_value": 0,
1893
- "pm_price_split": {
1894
- "COD": 50
1895
- },
1896
- "size": "OS",
1897
- "total_units": 1,
1898
- "hsn_code": "70099200",
1899
- "identifiers": {
1900
- "sku_code": "987432134"
1901
- },
1902
- "item_name": "Tissues",
1903
- "gst_fee": "7.62",
1904
- "gst_tag": "SGST"
1905
- }
1906
- ],
1907
- "quantity": 1,
1908
- "departments": [
1909
- 31
1910
- ],
1911
- "can_cancel": false,
1912
- "can_return": false
1913
- }
1914
- ],
1915
- "size_info": {
1916
- "TIS-102": {
1917
- "quantity": 1,
1918
- "price_effective": 50,
1919
- "amount_paid": 50,
1920
- "price_marked": 50,
1921
- "margin": 0
1922
- }
1923
- },
1924
- "total_details": {
1925
- "sizes": 1,
1926
- "total_price": 50,
1927
- "pieces": 1
1928
- },
1929
- "fulfilling_store": {
1930
- "name": "Jio-market-store3",
1931
- "company_id": 33,
1932
- "id": 50,
1933
- "code": "store3"
1934
- },
1935
- "fulfilling_company": {
1936
- "id": 33,
1937
- "name": "RELIANCE JIO INFOCOMM LIMITED"
1938
- },
1939
- "delivery_address": {
1940
- "id": "62e8fc91c1700b808fe528bd",
1941
- "uid": 745,
1942
- "area": "test",
1943
- "city": "Mumbai",
1944
- "name": "abc",
1945
- "email": "abc@gofynd.com",
1946
- "phone": "1234567890",
1947
- "state": "Maharashtra",
1948
- "address": "1234",
1949
- "country": "India",
1950
- "pincode": "400074",
1951
- "version": "1.0",
1952
- "address1": " test",
1953
- "address2": "",
1954
- "landmark": "test",
1955
- "latitude": 19.0653252,
1956
- "address_1": " test",
1957
- "area_code": "400074",
1958
- "longitude": 72.8423802,
1959
- "created_at": "2022-08-10T18:52:38+00:00",
1960
- "updated_at": "2022-08-10T18:52:38+00:00",
1961
- "address_type": "home",
1962
- "country_code": "91",
1963
- "geo_location": {
1964
- "latitude": 19.0653252,
1965
- "longitude": 72.8423802
1966
- },
1967
- "area_code_slug": "pincode",
1968
- "delivery_address_id": 745,
1969
- "addressee_name": "abc",
1970
- "delivery_code_required": 1
1971
- },
1972
- "can_cancel": false,
1973
- "can_return": false,
1974
- "delivery_date": null,
1975
- "returnable_date": null,
1976
- "show_download_invoice": true,
1977
- "show_track_link": true,
1978
- "prices": {
1979
- "amount_paid": 50,
1980
- "refund_amount": 50,
1981
- "price_marked": 50,
1982
- "cod_charges": 0,
1983
- "coupon_value": 0,
1984
- "discount": 0,
1985
- "cashback_applied": 0,
1986
- "delivery_charge": 0,
1987
- "fynd_credits": 0,
1988
- "cashback": 0,
1989
- "price_effective": 50,
1990
- "refund_credit": 0,
1991
- "value_of_good": 42.37
1992
- },
1993
- "can_break": {
1994
- "bag_not_picked": {
1995
- "can_break_entity": false
1996
- },
1997
- "cancelled_customer": {
1998
- "can_break_entity": true
1999
- },
2000
- "bag_picked": {
2001
- "can_break_entity": false
2002
- },
2003
- "cancelled_fynd": {
2004
- "can_break_entity": true
2005
- },
2006
- "bag_rescheduled": {
2007
- "can_break_entity": false
2008
- },
2009
- "cancelled_at_dp": {
2010
- "can_break_entity": false
2011
- },
2012
- "handed_over_to_dg": {
2013
- "can_break_entity": false
2014
- },
2015
- "dp_assigned": {
2016
- "can_break_entity": false
2017
- },
2018
- "cancelled_operations": {
2019
- "can_break_entity": false
2020
- },
2021
- "cancelled_seller": {
2022
- "can_break_entity": false
2023
- },
2024
- "out_for_pickup": {
2025
- "can_break_entity": false
2026
- },
2027
- "bag_pick_failed": {
2028
- "can_break_entity": false
2029
- },
2030
- "update_qr_code": {
2031
- "can_break_entity": false
2032
- }
2033
- },
2034
- "payment": {
2035
- "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
2036
- "mode": "Jio Partner Pay",
2037
- "mop": "COD",
2038
- "display_name": "COD",
2039
- "payment_mode": "COD",
2040
- "status": "Unpaid"
2041
- },
2042
- "user_info": {
2043
- "email": "paymentsdummy@gofynd.com",
2044
- "gender": "male",
2045
- "mobile": "1234567890",
2046
- "name": "User -"
2047
- },
2048
- "comment": "",
2049
- "invoice": {
2050
- "updated_date": "2022-08-18T19:11:02.000Z",
2051
- "store_invoice_id": "00000050AA000147",
2052
- "invoice_url": "",
2053
- "label_url": ""
2054
- },
2055
- "refund_details": {
2056
- "rrn": ""
2057
- }
2058
- }
2059
- }
2060
- ```
2061
- </details>
2062
-
2063
-
2064
-
2065
-
2066
-
2067
-
2068
-
2069
-
2070
-
2071
- ---
2072
-
2073
-
2074
- ### getShipmentReasons
2075
- Get reasons behind full or partial cancellation of a shipment
2076
-
2077
-
2078
-
2079
- ```javascript
2080
- // Promise
2081
- const promise = order.getShipmentReasons({ shipmentId : value });
2082
-
2083
- // Async/Await
2084
- const data = await order.getShipmentReasons({ shipmentId : value });
2085
- ```
2086
-
2087
-
2088
-
2089
-
2090
-
2091
- | Argument | Type | Required | Description |
2092
- | --------- | ----- | -------- | ----------- |
2093
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2094
-
2095
-
2096
-
2097
- Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
2098
-
2099
- *Returned Response:*
2100
-
2101
-
2102
-
2103
-
2104
- [ShipmentReasons](#ShipmentReasons)
2105
-
2106
- Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
2107
-
2108
-
2109
-
2110
-
2111
- <details>
2112
- <summary><i>&nbsp; Example:</i></summary>
2113
-
2114
- ```json
2115
- {
2116
- "reasons": [
2117
- {
2118
- "reason_id": 115,
2119
- "priority": 9,
2120
- "reason_text": "Wrong size/colour delivered",
2121
- "show_text_area": false,
2122
- "feedback_type": "bag",
2123
- "flow": "return"
2124
- },
2125
- {
2126
- "reason_id": 116,
2127
- "priority": 10,
2128
- "reason_text": "Product does not fit me",
2129
- "show_text_area": false,
2130
- "feedback_type": "bag",
2131
- "flow": "return"
2132
- },
2133
- {
2134
- "reason_id": 117,
2135
- "priority": 11,
2136
- "reason_text": "Quality of product is not good",
2137
- "show_text_area": false,
2138
- "feedback_type": "bag",
2139
- "flow": "return"
2140
- },
2141
- {
2142
- "reason_id": 118,
2143
- "priority": 12,
2144
- "reason_text": "Wrong product delivered",
2145
- "show_text_area": true,
2146
- "feedback_type": "bag",
2147
- "flow": "return"
2148
- },
2149
- {
2150
- "reason_id": 119,
2151
- "priority": 13,
2152
- "reason_text": "Damaged product delivered",
2153
- "show_text_area": true,
2154
- "feedback_type": "bag",
2155
- "flow": "return"
2156
- },
2157
- {
2158
- "reason_id": 120,
2159
- "priority": 14,
2160
- "reason_text": "Used product delivered",
2161
- "show_text_area": true,
2162
- "feedback_type": "bag",
2163
- "flow": "return"
2164
- },
2165
- {
2166
- "reason_id": 124,
2167
- "priority": 15,
2168
- "reason_text": "Missing Items/Partially Received",
2169
- "show_text_area": true,
2170
- "feedback_type": "bag",
2171
- "flow": "return"
2172
- },
2173
- {
2174
- "reason_id": 121,
2175
- "priority": 16,
2176
- "reason_text": "Found better price elsewhere",
2177
- "show_text_area": true,
2178
- "feedback_type": "bag",
2179
- "flow": "return"
2180
- },
2181
- {
2182
- "reason_id": 122,
2183
- "priority": 17,
2184
- "reason_text": "Product looks different from image",
2185
- "show_text_area": true,
2186
- "feedback_type": "bag",
2187
- "flow": "return"
2188
- },
2189
- {
2190
- "reason_id": 123,
2191
- "priority": 18,
2192
- "reason_text": "Other issue",
2193
- "show_text_area": true,
2194
- "feedback_type": "bag",
2195
- "flow": "return"
2196
- }
2197
- ]
2198
- }
2199
- ```
2200
- </details>
2201
-
2202
-
2203
-
2204
-
2205
-
2206
-
2207
-
2208
-
2209
-
2210
- ---
2211
-
2212
-
2213
- ### sendOtpToShipmentCustomer
2214
- Send and Resend Otp code to Order-Shipment customer
2215
-
2216
-
2217
-
2218
- ```javascript
2219
- // Promise
2220
- const promise = order.sendOtpToShipmentCustomer({ orderId : value,
2221
- shipmentId : value });
2222
-
2223
- // Async/Await
2224
- const data = await order.sendOtpToShipmentCustomer({ orderId : value,
2225
- shipmentId : value });
2226
- ```
2227
-
2228
-
2229
-
2230
-
2231
-
2232
- | Argument | Type | Required | Description |
2233
- | --------- | ----- | -------- | ----------- |
2234
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2235
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2236
-
2237
-
2238
-
2239
- Use this API to send OTP to the customer of the mapped Shipment.
2240
-
2241
- *Returned Response:*
2242
-
2243
-
2244
-
2245
-
2246
- [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
2247
-
2248
- Success to acknowledge the service was notified
2249
-
2250
-
2251
-
2252
-
2253
- <details>
2254
- <summary><i>&nbsp; Example:</i></summary>
2255
-
2256
- ```json
2257
- {
2258
- "success": true,
2259
- "request_id": "0fe0d6e16205ddc57d212e947ee31896",
2260
- "message": "OTP sent",
2261
- "resend_timer": 30
2262
- }
2263
- ```
2264
- </details>
2265
-
2266
-
2267
-
2268
-
2269
-
2270
-
2271
-
2272
-
2273
-
2274
- ---
2275
-
2276
-
2277
- ### trackShipment
2278
- Track shipment
2279
-
2280
-
2281
-
2282
- ```javascript
2283
- // Promise
2284
- const promise = order.trackShipment({ shipmentId : value });
2285
-
2286
- // Async/Await
2287
- const data = await order.trackShipment({ shipmentId : value });
2288
- ```
2289
-
2290
-
2291
-
2292
-
2293
-
2294
- | Argument | Type | Required | Description |
2295
- | --------- | ----- | -------- | ----------- |
2296
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2297
-
2298
-
2299
-
2300
- Track Shipment by shipment id, for application based on application Id
2301
-
2302
- *Returned Response:*
2303
-
2304
-
2305
-
2306
-
2307
- [ShipmentTrack](#ShipmentTrack)
2308
-
2309
- Success. Check the example shown below or refer `ShipmentTrack` for more details.
2310
-
2311
-
2312
-
2313
-
2314
- <details>
2315
- <summary><i>&nbsp; Example:</i></summary>
2316
-
2317
- ```json
2318
- {
2319
- "results": [
2320
- {
2321
- "awb": "string",
2322
- "updated_at": "string",
2323
- "last_location_recieved_at": "string",
2324
- "reason": "string",
2325
- "shipment_type": "string",
2326
- "status": "string",
2327
- "updated_time": "string",
2328
- "account_name": "string"
2329
- }
2330
- ]
2331
- }
2332
- ```
2333
- </details>
2334
-
2335
-
2336
-
2337
-
2338
-
2339
-
2340
-
2341
-
2342
-
2343
- ---
2344
-
2345
-
2346
- ### updateShipmentStatus
2347
- Update the shipment status
2348
-
2349
-
2350
-
2351
- ```javascript
2352
- // Promise
2353
- const promise = order.updateShipmentStatus({ shipmentId : value,
2354
- body : value });
2355
-
2356
- // Async/Await
2357
- const data = await order.updateShipmentStatus({ shipmentId : value,
2358
- body : value });
2359
- ```
2360
-
2361
-
2362
-
2363
-
2364
-
2365
- | Argument | Type | Required | Description |
2366
- | --------- | ----- | -------- | ----------- |
2367
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2368
- | body | [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest) | yes | Request body |
2369
-
2370
-
2371
- Use this API to update the status of a shipment using its shipment ID.
2372
-
2373
- *Returned Response:*
2374
-
2375
-
2376
-
2377
-
2378
- [ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
2379
-
2380
- Successfully updateShipmentStatus!
2381
-
2382
-
2383
-
2384
-
2385
- <details>
2386
- <summary><i>&nbsp; Example:</i></summary>
2387
-
2388
- ```json
2389
- {
2390
- "statuses": [
2391
- {
2392
- "shipments": {
2393
- "16291129095851065963": {
2394
- "status": 400,
2395
- "message": {
2396
- "16291129095851065963": "Invalid State Transition bag_invoiced detected for given entity"
2397
- },
2398
- "code": null,
2399
- "exception": "ValidationError",
2400
- "stack_trace": null
2401
- }
2402
- }
2403
- }
2404
- ]
2405
- }
2406
- ```
2407
- </details>
2408
-
2409
-
2410
-
2411
-
2412
-
2413
-
2414
-
2415
-
2416
-
2417
- ---
2418
-
2419
-
2420
- ### verifyOtpShipmentCustomer
2421
- Verify Otp code
2422
-
2423
-
2424
-
2425
- ```javascript
2426
- // Promise
2427
- const promise = order.verifyOtpShipmentCustomer({ orderId : value,
2428
- shipmentId : value,
2429
- body : value });
2430
-
2431
- // Async/Await
2432
- const data = await order.verifyOtpShipmentCustomer({ orderId : value,
2433
- shipmentId : value,
2434
- body : value });
2435
- ```
2436
-
2437
-
2438
-
2439
-
2440
-
2441
- | Argument | Type | Required | Description |
2442
- | --------- | ----- | -------- | ----------- |
2443
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2444
- | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2445
- | body | [VerifyOtp](#VerifyOtp) | yes | Request body |
2446
-
2447
-
2448
- Use this API to verify OTP and create a session token with custom payload.
2449
-
2450
- *Returned Response:*
2451
-
2452
-
2453
-
2454
-
2455
- [VerifyOtpResponse](#VerifyOtpResponse)
2456
-
2457
- Success, the code is valid and returns a session token
2458
-
2459
-
2460
-
2461
-
2462
- <details>
2463
- <summary><i>&nbsp; Example:</i></summary>
2464
-
2465
- ```json
2466
- {
2467
- "success": true
2468
- }
2469
- ```
2470
- </details>
2471
-
2472
-
2473
-
2474
-
2475
-
2476
-
2477
-
2478
-
2479
-
2480
- ---
2481
-
2482
-
2483
-
2484
- ### Schemas
2485
-
2486
-
2487
- #### [ApefaceApiError](#ApefaceApiError)
2488
-
2489
- | Properties | Type | Nullable | Description |
2490
- | ---------- | ---- | -------- | ----------- || message | string | no | || success | boolean | no | |
2491
-
2492
- ---
2493
-
2494
- #### [AppliedFreeArticles](#AppliedFreeArticles)
2495
-
2496
- | Properties | Type | Nullable | Description |
2497
- | ---------- | ---- | -------- | ----------- || article_id | string | no | || free_gift_item_details | string | no | || parent_item_identifier | string | no | || quantity | number | no | |
2498
-
2499
- ---
2500
-
2501
- #### [AppliedPromos](#AppliedPromos)
2502
-
2503
- | Properties | Type | Nullable | Description |
2504
- | ---------- | ---- | -------- | ----------- || amount | number | no | || applied_free_articles | [[AppliedFreeArticles](#AppliedFreeArticles)] | no | || article_quantity | number | no | || mrp_promotion | boolean | no | || promo_id | string | no | || promotion_name | string | no | || promotion_type | string | no | |
2505
-
2506
- ---
2507
-
2508
- #### [BagReasonMeta](#BagReasonMeta)
2509
-
2510
- | Properties | Type | Nullable | Description |
2511
- | ---------- | ---- | -------- | ----------- || show_text_area | boolean | no | |
2512
-
2513
- ---
2514
-
2515
- #### [BagReasons](#BagReasons)
2516
-
2517
- | Properties | Type | Nullable | Description |
2518
- | ---------- | ---- | -------- | ----------- || display_name | string | no | || id | number | no | || meta | [BagReasonMeta](#BagReasonMeta) | no | || qc_type | [string] | no | || question_set | [[QuestionSet](#QuestionSet)] | no | || reasons | [[BagReasons](#BagReasons)] | no | |
2519
-
2520
- ---
2521
-
2522
- #### [Bags](#Bags)
2523
-
2524
- | Properties | Type | Nullable | Description |
2525
- | ---------- | ---- | -------- | ----------- || applied_promos | [[AppliedPromos](#AppliedPromos)] | no | || can_cancel | boolean | no | || can_return | boolean | no | || current_status | [CurrentStatus](#CurrentStatus) | no | || delivery_date | string | no | || financial_breakup | [[FinancialBreakup](#FinancialBreakup)] | no | || id | number | no | || item | [Item](#Item) | no | || line_number | number | no | || parent_promo_bags | string | no | || prices | [Prices](#Prices) | no | || quantity | number | no | || returnable_date | string | no | || seller_identifier | string | no | |
2526
-
2527
- ---
2528
-
2529
- #### [BagsForReorder](#BagsForReorder)
2530
-
2531
- | Properties | Type | Nullable | Description |
2532
- | ---------- | ---- | -------- | ----------- || article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) | no | || item_id | number | no | || item_size | string | no | || quantity | number | no | || seller_id | number | no | || store_id | number | no | |
2533
-
2534
- ---
2535
-
2536
- #### [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment)
2537
-
2538
- | Properties | Type | Nullable | Description |
2539
- | ---------- | ---- | -------- | ----------- || level | string | no | || strategy | string | no | |
2540
-
2541
- ---
2542
-
2543
- #### [BreakupValues](#BreakupValues)
2544
-
2545
- | Properties | Type | Nullable | Description |
2546
- | ---------- | ---- | -------- | ----------- || display | string | no | || name | string | no | || value | number | no | |
2547
-
2548
- ---
2549
-
2550
- #### [CurrentStatus](#CurrentStatus)
2551
-
2552
- | Properties | Type | Nullable | Description |
2553
- | ---------- | ---- | -------- | ----------- || journey_type | string | no | || name | string | no | || status | string | no | || updated_at | string | no | |
2554
-
2555
- ---
2556
-
2557
- #### [CustomerDetailsResponse](#CustomerDetailsResponse)
2558
-
2559
- | Properties | Type | Nullable | Description |
2560
- | ---------- | ---- | -------- | ----------- || country | string | no | || name | string | no | || order_id | string | no | || phone | string | no | || shipment_id | string | no | |
2561
-
2562
- ---
2563
-
2564
- #### [DataUpdates](#DataUpdates)
2565
-
2566
- | Properties | Type | Nullable | Description |
2567
- | ---------- | ---- | -------- | ----------- || entities | [[EntitiesDataUpdates](#EntitiesDataUpdates)] | no | || products | [[ProductsDataUpdates](#ProductsDataUpdates)] | no | |
2568
-
2569
- ---
2570
-
2571
- #### [DeliveryAddress](#DeliveryAddress)
2572
-
2573
- | Properties | Type | Nullable | Description |
2574
- | ---------- | ---- | -------- | ----------- || address | string | no | || address1 | string | no | || address2 | string | no | || address_category | string | no | || address_type | string | no | || area | string | no | || city | string | no | || contact_person | string | no | || country | string | no | || created_at | string | no | || email | string | no | || landmark | string | no | || latitude | number | no | || longitude | number | no | || name | string | no | || phone | string | no | || pincode | string | no | || state | string | no | || updated_at | string | no | || version | string | no | |
2575
-
2576
- ---
2577
-
2578
- #### [EntitiesDataUpdates](#EntitiesDataUpdates)
2579
-
2580
- | Properties | Type | Nullable | Description |
2581
- | ---------- | ---- | -------- | ----------- || data | string | no | || filters | [string] | no | |
2582
-
2583
- ---
2584
-
2585
- #### [EntitiesReasons](#EntitiesReasons)
2586
-
2587
- | Properties | Type | Nullable | Description |
2588
- | ---------- | ---- | -------- | ----------- || data | [EntityReasonData](#EntityReasonData) | no | || filters | [string] | no | |
2589
-
2590
- ---
2591
-
2592
- #### [EntityReasonData](#EntityReasonData)
2593
-
2594
- | Properties | Type | Nullable | Description |
2595
- | ---------- | ---- | -------- | ----------- || reason_id | number | no | || reason_text | string | no | |
2596
-
2597
- ---
2598
-
2599
- #### [ErrorResponse](#ErrorResponse)
2600
-
2601
- | Properties | Type | Nullable | Description |
2602
- | ---------- | ---- | -------- | ----------- || code | string | no | || exception | string | no | || message | string | no | || stack_trace | string | no | || status | number | no | |
2603
-
2604
- ---
2605
-
2606
- #### [FinancialBreakup](#FinancialBreakup)
2607
-
2608
- | Properties | Type | Nullable | Description |
2609
- | ---------- | ---- | -------- | ----------- || added_to_fynd_cash | boolean | no | || amount_paid | number | no | || amount_paid_roundoff | number | no | || brand_calculated_amount | number | no | || cashback | number | no | || cashback_applied | number | no | || cod_charges | number | no | || coupon_effective_discount | number | no | || coupon_value | number | no | || delivery_charge | number | no | || discount | number | no | || fynd_credits | number | no | || gst_fee | number | no | || gst_tag | string | no | || gst_tax_percentage | number | no | || hsn_code | string | no | || identifiers | [Identifiers](#Identifiers) | no | || item_name | string | no | || price_effective | number | no | || price_marked | number | no | || promotion_effective_discount | number | no | || refund_amount | number | no | || refund_credit | number | no | || size | string | no | || total_units | number | no | || transfer_price | number | no | || value_of_good | number | no | |
2610
-
2611
- ---
2612
-
2613
- #### [FulfillingCompany](#FulfillingCompany)
2614
-
2615
- | Properties | Type | Nullable | Description |
2616
- | ---------- | ---- | -------- | ----------- || id | number | no | || name | string | no | |
2617
-
2618
- ---
2619
-
2620
- #### [FulfillingStore](#FulfillingStore)
2621
-
2622
- | Properties | Type | Nullable | Description |
2623
- | ---------- | ---- | -------- | ----------- || code | string | no | || company_id | number | no | || company_name | string | no | || id | number | no | || name | string | no | |
2624
-
2625
- ---
2626
-
2627
- #### [Identifiers](#Identifiers)
2628
-
2629
- | Properties | Type | Nullable | Description |
2630
- | ---------- | ---- | -------- | ----------- || ean | string | no | || sku_code | string | no | |
2631
-
2632
- ---
2633
-
2634
- #### [Invoice](#Invoice)
2635
-
2636
- | Properties | Type | Nullable | Description |
2637
- | ---------- | ---- | -------- | ----------- || invoice_url | string | no | || label_url | string | no | || updated_date | string | no | |
2638
-
2639
- ---
2640
-
2641
- #### [Item](#Item)
2642
-
2643
- | Properties | Type | Nullable | Description |
2644
- | ---------- | ---- | -------- | ----------- || brand | [ItemBrand](#ItemBrand) | no | || code | string | no | || id | number | no | || image | [string] | no | || name | string | no | || seller_identifier | string | no | || size | string | no | || slug_key | string | no | |
2645
-
2646
- ---
2647
-
2648
- #### [ItemBrand](#ItemBrand)
2649
-
2650
- | Properties | Type | Nullable | Description |
2651
- | ---------- | ---- | -------- | ----------- || logo | string | no | || name | string | no | |
2652
-
2653
- ---
2654
-
2655
- #### [NestedTrackingDetails](#NestedTrackingDetails)
2656
-
2657
- | Properties | Type | Nullable | Description |
2658
- | ---------- | ---- | -------- | ----------- || is_current | boolean | no | || is_passed | boolean | no | || status | string | no | || time | string | no | |
2659
-
2660
- ---
2661
-
2662
- #### [OrderById](#OrderById)
2663
-
2664
- | Properties | Type | Nullable | Description |
2665
- | ---------- | ---- | -------- | ----------- || order | [OrderSchema](#OrderSchema) | no | |
2666
-
2667
- ---
2668
-
2669
- #### [OrderFilters](#OrderFilters)
2670
-
2671
- | Properties | Type | Nullable | Description |
2672
- | ---------- | ---- | -------- | ----------- || statuses | [[OrderStatuses](#OrderStatuses)] | no | |
2673
-
2674
- ---
2675
-
2676
- #### [OrderList](#OrderList)
2677
-
2678
- | Properties | Type | Nullable | Description |
2679
- | ---------- | ---- | -------- | ----------- || filters | [OrderFilters](#OrderFilters) | no | || items | [[OrderSchema](#OrderSchema)] | no | || page | [OrderPage](#OrderPage) | no | |
2680
-
2681
- ---
2682
-
2683
- #### [OrderPage](#OrderPage)
2684
-
2685
- | Properties | Type | Nullable | Description |
2686
- | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || item_total | number | no | || size | number | no | || type | string | no | |
2687
-
2688
- ---
2689
-
2690
- #### [OrderSchema](#OrderSchema)
2691
-
2692
- | Properties | Type | Nullable | Description |
2693
- | ---------- | ---- | -------- | ----------- || bags_for_reorder | [[BagsForReorder](#BagsForReorder)] | no | || breakup_values | [[BreakupValues](#BreakupValues)] | no | || order_created_time | string | no | || order_id | string | no | || shipments | [[Shipments](#Shipments)] | no | || total_shipments_in_order | number | no | || user_info | [UserInfo](#UserInfo) | no | |
2694
-
2695
- ---
2696
-
2697
- #### [OrderStatuses](#OrderStatuses)
2698
-
2699
- | Properties | Type | Nullable | Description |
2700
- | ---------- | ---- | -------- | ----------- || display | string | no | || is_selected | boolean | no | || value | number | no | |
2701
-
2702
- ---
2703
-
2704
- #### [Prices](#Prices)
2705
-
2706
- | Properties | Type | Nullable | Description |
2707
- | ---------- | ---- | -------- | ----------- || added_to_fynd_cash | boolean | no | || amount_paid | number | no | || amount_paid_roundoff | number | no | || brand_calculated_amount | number | no | || cashback | number | no | || cashback_applied | number | no | || cod_charges | number | no | || coupon_effective_discount | number | no | || coupon_value | number | no | || delivery_charge | number | no | || discount | number | no | || fynd_credits | number | no | || gst_tax_percentage | number | no | || price_effective | number | no | || price_marked | number | no | || promotion_effective_discount | number | no | || refund_amount | number | no | || refund_credit | number | no | || transfer_price | number | no | || value_of_good | number | no | |
2708
-
2709
- ---
2710
-
2711
- #### [Products](#Products)
2712
-
2713
- | Properties | Type | Nullable | Description |
2714
- | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | || quantity | number | no | |
2715
-
2716
- ---
2717
-
2718
- #### [ProductsDataUpdates](#ProductsDataUpdates)
2719
-
2720
- | Properties | Type | Nullable | Description |
2721
- | ---------- | ---- | -------- | ----------- || data | string | no | || filters | [[ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)] | no | |
2722
-
2723
- ---
2724
-
2725
- #### [ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)
2726
-
2727
- | Properties | Type | Nullable | Description |
2728
- | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | |
2729
-
2730
- ---
2731
-
2732
- #### [ProductsReasons](#ProductsReasons)
2733
-
2734
- | Properties | Type | Nullable | Description |
2735
- | ---------- | ---- | -------- | ----------- || data | [ProductsReasonsData](#ProductsReasonsData) | no | || filters | [[ProductsReasonsFilters](#ProductsReasonsFilters)] | no | |
2736
-
2737
- ---
2738
-
2739
- #### [ProductsReasonsData](#ProductsReasonsData)
2740
-
2741
- | Properties | Type | Nullable | Description |
2742
- | ---------- | ---- | -------- | ----------- || reason_id | number | no | || reason_text | string | no | |
2743
-
2744
- ---
2745
-
2746
- #### [ProductsReasonsFilters](#ProductsReasonsFilters)
2747
-
2748
- | Properties | Type | Nullable | Description |
2749
- | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | || quantity | number | no | |
2750
-
2751
- ---
2752
-
2753
- #### [Promise](#Promise)
2754
-
2755
- | Properties | Type | Nullable | Description |
2756
- | ---------- | ---- | -------- | ----------- || show_promise | boolean | no | || timestamp | [TimeStampData](#TimeStampData) | no | |
2757
-
2758
- ---
2759
-
2760
- #### [QuestionSet](#QuestionSet)
2761
-
2762
- | Properties | Type | Nullable | Description |
2763
- | ---------- | ---- | -------- | ----------- || display_name | string | no | || id | number | no | |
2764
-
2765
- ---
2766
-
2767
- #### [ReasonsData](#ReasonsData)
2768
-
2769
- | Properties | Type | Nullable | Description |
2770
- | ---------- | ---- | -------- | ----------- || entities | [[EntitiesReasons](#EntitiesReasons)] | no | || products | [[ProductsReasons](#ProductsReasons)] | no | |
2771
-
2772
- ---
2773
-
2774
- #### [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
2775
-
2776
- | Properties | Type | Nullable | Description |
2777
- | ---------- | ---- | -------- | ----------- || presigned_type | string | yes | || presigned_url | string | yes | || shipment_id | string | yes | || success | boolean | yes | |
2778
-
2779
- ---
2780
-
2781
- #### [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
2782
-
2783
- | Properties | Type | Nullable | Description |
2784
- | ---------- | ---- | -------- | ----------- || message | string | no | || request_id | string | no | || resend_timer | number | no | || success | boolean | no | |
2785
-
2786
- ---
2787
-
2788
- #### [ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
2789
-
2790
- | Properties | Type | Nullable | Description |
2791
- | ---------- | ---- | -------- | ----------- || statuses | [[StatusesBodyResponse](#StatusesBodyResponse)] | no | |
2792
-
2793
- ---
2794
-
2795
- #### [ShipmentBagReasons](#ShipmentBagReasons)
2796
-
2797
- | Properties | Type | Nullable | Description |
2798
- | ---------- | ---- | -------- | ----------- || reasons | [[BagReasons](#BagReasons)] | no | || success | boolean | no | |
2799
-
2800
- ---
2801
-
2802
- #### [ShipmentById](#ShipmentById)
2803
-
2804
- | Properties | Type | Nullable | Description |
2805
- | ---------- | ---- | -------- | ----------- || shipment | [Shipments](#Shipments) | no | |
2806
-
2807
- ---
2808
-
2809
- #### [ShipmentPayment](#ShipmentPayment)
2810
-
2811
- | Properties | Type | Nullable | Description |
2812
- | ---------- | ---- | -------- | ----------- || display_name | string | no | || logo | string | no | || mode | string | no | || mop | string | no | || payment_mode | string | no | || status | string | no | |
2813
-
2814
- ---
2815
-
2816
- #### [ShipmentReason](#ShipmentReason)
2817
-
2818
- | Properties | Type | Nullable | Description |
2819
- | ---------- | ---- | -------- | ----------- || feedback_type | string | no | || flow | string | no | || priority | number | no | || reason_id | number | no | || reason_text | string | no | || show_text_area | boolean | no | |
2820
-
2821
- ---
2822
-
2823
- #### [ShipmentReasons](#ShipmentReasons)
2824
-
2825
- | Properties | Type | Nullable | Description |
2826
- | ---------- | ---- | -------- | ----------- || reasons | [[ShipmentReason](#ShipmentReason)] | no | |
2827
-
2828
- ---
2829
-
2830
- #### [Shipments](#Shipments)
2831
-
2832
- | Properties | Type | Nullable | Description |
2833
- | ---------- | ---- | -------- | ----------- || awb_no | string | no | || bags | [[Bags](#Bags)] | no | || beneficiary_details | boolean | no | || breakup_values | [[BreakupValues](#BreakupValues)] | no | || can_break | string | no | || can_cancel | boolean | no | || can_return | boolean | no | || comment | string | no | || custom_meta | [string] | no | || delivery_address | [DeliveryAddress](#DeliveryAddress) | no | || delivery_date | string | no | || dp_name | string | no | || fulfilling_company | [FulfillingCompany](#FulfillingCompany) | no | || fulfilling_store | [FulfillingStore](#FulfillingStore) | no | || invoice | [Invoice](#Invoice) | no | || need_help_url | string | no | || order_id | string | no | || order_type | string | no | || payment | [ShipmentPayment](#ShipmentPayment) | no | || prices | [Prices](#Prices) | no | || promise | [Promise](#Promise) | no | || refund_details | string | no | || returnable_date | string | no | || shipment_created_at | string | no | || shipment_id | string | no | || shipment_status | [ShipmentStatus](#ShipmentStatus) | no | || show_download_invoice | boolean | no | || show_track_link | boolean | no | || size_info | string | no | || total_bags | number | no | || total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) | no | || track_url | string | no | || tracking_details | [[TrackingDetails](#TrackingDetails)] | no | || traking_no | string | no | || user_info | [ShipmentUserInfo](#ShipmentUserInfo) | no | |
2834
-
2835
- ---
2836
-
2837
- #### [ShipmentsRequest](#ShipmentsRequest)
2838
-
2839
- | Properties | Type | Nullable | Description |
2840
- | ---------- | ---- | -------- | ----------- || data_updates | [DataUpdates](#DataUpdates) | no | || identifier | string | yes | || products | [[Products](#Products)] | no | || reasons | [ReasonsData](#ReasonsData) | no | |
2841
-
2842
- ---
2843
-
2844
- #### [ShipmentStatus](#ShipmentStatus)
2845
-
2846
- | Properties | Type | Nullable | Description |
2847
- | ---------- | ---- | -------- | ----------- || hex_code | string | no | || title | string | no | |
2848
-
2849
- ---
2850
-
2851
- #### [ShipmentTotalDetails](#ShipmentTotalDetails)
2852
-
2853
- | Properties | Type | Nullable | Description |
2854
- | ---------- | ---- | -------- | ----------- || pieces | number | no | || sizes | number | no | || total_price | number | no | |
2855
-
2856
- ---
2857
-
2858
- #### [ShipmentTrack](#ShipmentTrack)
2859
-
2860
- | Properties | Type | Nullable | Description |
2861
- | ---------- | ---- | -------- | ----------- || results | [[Track](#Track)] | no | |
2862
-
2863
- ---
2864
-
2865
- #### [ShipmentUserInfo](#ShipmentUserInfo)
2866
-
2867
- | Properties | Type | Nullable | Description |
2868
- | ---------- | ---- | -------- | ----------- || first_name | string | no | || gender | string | no | || last_name | string | no | || mobile | string | no | |
2869
-
2870
- ---
2871
-
2872
- #### [StatuesRequest](#StatuesRequest)
2873
-
2874
- | Properties | Type | Nullable | Description |
2875
- | ---------- | ---- | -------- | ----------- || exclude_bags_next_state | string | no | || shipments | [[ShipmentsRequest](#ShipmentsRequest)] | no | || status | string | no | |
2876
-
2877
- ---
2878
-
2879
- #### [StatusesBodyResponse](#StatusesBodyResponse)
2880
-
2881
- | Properties | Type | Nullable | Description |
2882
- | ---------- | ---- | -------- | ----------- || shipments | [string] | no | |
2883
-
2884
- ---
2885
-
2886
- #### [TimeStampData](#TimeStampData)
2887
-
2888
- | Properties | Type | Nullable | Description |
2889
- | ---------- | ---- | -------- | ----------- || max | string | no | || min | string | no | |
2890
-
2891
- ---
2892
-
2893
- #### [Track](#Track)
2894
-
2895
- | Properties | Type | Nullable | Description |
2896
- | ---------- | ---- | -------- | ----------- || account_name | string | no | || awb | string | no | || last_location_recieved_at | string | no | || reason | string | no | || shipment_type | string | no | || status | string | no | || updated_at | string | no | || updated_time | string | no | |
2897
-
2898
- ---
2899
-
2900
- #### [TrackingDetails](#TrackingDetails)
2901
-
2902
- | Properties | Type | Nullable | Description |
2903
- | ---------- | ---- | -------- | ----------- || is_current | boolean | no | || is_passed | boolean | no | || status | string | no | || time | string | no | || tracking_details | [[NestedTrackingDetails](#NestedTrackingDetails)] | no | |
2904
-
2905
- ---
2906
-
2907
- #### [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest)
2908
-
2909
- | Properties | Type | Nullable | Description |
2910
- | ---------- | ---- | -------- | ----------- || force_transition | boolean | no | || lock_after_transition | boolean | no | || statuses | [[StatuesRequest](#StatuesRequest)] | no | || task | boolean | no | || unlock_before_transition | boolean | no | |
2911
-
2912
- ---
2913
-
2914
- #### [UserInfo](#UserInfo)
2915
-
2916
- | Properties | Type | Nullable | Description |
2917
- | ---------- | ---- | -------- | ----------- || email | string | no | || gender | string | no | || mobile | string | no | || name | string | no | |
2918
-
2919
- ---
2920
-
2921
- #### [VerifyOtp](#VerifyOtp)
2922
-
2923
- | Properties | Type | Nullable | Description |
2924
- | ---------- | ---- | -------- | ----------- || otp_code | string | no | || request_id | string | no | |
2925
-
2926
- ---
2927
-
2928
- #### [VerifyOtpResponse](#VerifyOtpResponse)
2929
-
2930
- | Properties | Type | Nullable | Description |
2931
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
2932
-
2933
- ---
2934
-
2935
-
2936
-
2937
-