@gofynd/fdk-client-javascript 0.1.35

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 (277) hide show
  1. package/.github/workflows/on_create_release.yml +23 -0
  2. package/.github/workflows/on_merge_main.yml +38 -0
  3. package/.github/workflows/on_pull_request.yml +35 -0
  4. package/.prettierrc +5 -0
  5. package/LICENSE +21 -0
  6. package/README.md +118 -0
  7. package/application.d.ts +3 -0
  8. package/application.js +6 -0
  9. package/common.d.ts +4 -0
  10. package/common.js +9 -0
  11. package/documentation/application/CART.md +7290 -0
  12. package/documentation/application/CATALOG.md +9570 -0
  13. package/documentation/application/COMMON.md +448 -0
  14. package/documentation/application/COMMUNICATION.md +463 -0
  15. package/documentation/application/CONFIGURATION.md +2902 -0
  16. package/documentation/application/CONTENT.md +3350 -0
  17. package/documentation/application/FILESTORAGE.md +491 -0
  18. package/documentation/application/LEAD.md +1891 -0
  19. package/documentation/application/LOGISTIC.md +439 -0
  20. package/documentation/application/ORDER.md +3428 -0
  21. package/documentation/application/PAYMENT.md +5035 -0
  22. package/documentation/application/POSCART.md +7889 -0
  23. package/documentation/application/README.md +21 -0
  24. package/documentation/application/REWARDS.md +714 -0
  25. package/documentation/application/SHARE.md +729 -0
  26. package/documentation/application/THEME.md +5796 -0
  27. package/documentation/application/USER.md +4326 -0
  28. package/documentation/platform/ANALYTICS.md +1150 -0
  29. package/documentation/platform/AUDITTRAIL.md +572 -0
  30. package/documentation/platform/BILLING.md +2396 -0
  31. package/documentation/platform/CART.md +5539 -0
  32. package/documentation/platform/CATALOG.md +21624 -0
  33. package/documentation/platform/COMMON.md +448 -0
  34. package/documentation/platform/COMMUNICATION.md +5714 -0
  35. package/documentation/platform/COMPANYPROFILE.md +2141 -0
  36. package/documentation/platform/CONFIGURATION.md +7335 -0
  37. package/documentation/platform/CONTENT.md +8989 -0
  38. package/documentation/platform/DISCOUNT.md +773 -0
  39. package/documentation/platform/FILESTORAGE.md +994 -0
  40. package/documentation/platform/INVENTORY.md +1775 -0
  41. package/documentation/platform/LEAD.md +4736 -0
  42. package/documentation/platform/ORDER.md +3764 -0
  43. package/documentation/platform/PARTNER.md +216 -0
  44. package/documentation/platform/PAYMENT.md +3444 -0
  45. package/documentation/platform/README.md +27 -0
  46. package/documentation/platform/REWARDS.md +871 -0
  47. package/documentation/platform/SHARE.md +602 -0
  48. package/documentation/platform/THEME.md +35725 -0
  49. package/documentation/platform/USER.md +2305 -0
  50. package/documentation/platform/WEBHOOK.md +587 -0
  51. package/documentation/public/CONFIGURATION.md +448 -0
  52. package/documentation/public/INVENTORY.md +686 -0
  53. package/documentation/public/WEBHOOK.md +348 -0
  54. package/index.d.ts +10 -0
  55. package/index.js +18 -0
  56. package/jest.config.d.ts +4 -0
  57. package/jest.config.js +6 -0
  58. package/package.json +35 -0
  59. package/platform.d.ts +3 -0
  60. package/platform.js +6 -0
  61. package/public.d.ts +3 -0
  62. package/public.js +6 -0
  63. package/sdk/application/ApplicationAPIClient.d.ts +11 -0
  64. package/sdk/application/ApplicationAPIClient.js +44 -0
  65. package/sdk/application/ApplicationClient.d.ts +40 -0
  66. package/sdk/application/ApplicationClient.js +84 -0
  67. package/sdk/application/ApplicationConfig.d.ts +19 -0
  68. package/sdk/application/ApplicationConfig.js +55 -0
  69. package/sdk/application/ApplicationModels.d.ts +826 -0
  70. package/sdk/application/ApplicationModels.js +10474 -0
  71. package/sdk/application/client/CartApplicationClient.d.ts +432 -0
  72. package/sdk/application/client/CartApplicationClient.js +1066 -0
  73. package/sdk/application/client/CatalogApplicationClient.d.ts +694 -0
  74. package/sdk/application/client/CatalogApplicationClient.js +1629 -0
  75. package/sdk/application/client/CommonApplicationClient.d.ts +38 -0
  76. package/sdk/application/client/CommonApplicationClient.js +105 -0
  77. package/sdk/application/client/CommunicationApplicationClient.d.ts +39 -0
  78. package/sdk/application/client/CommunicationApplicationClient.js +131 -0
  79. package/sdk/application/client/ConfigurationApplicationClient.d.ts +210 -0
  80. package/sdk/application/client/ConfigurationApplicationClient.js +649 -0
  81. package/sdk/application/client/ContentApplicationClient.d.ts +256 -0
  82. package/sdk/application/client/ContentApplicationClient.js +785 -0
  83. package/sdk/application/client/FileStorageApplicationClient.d.ts +88 -0
  84. package/sdk/application/client/FileStorageApplicationClient.js +214 -0
  85. package/sdk/application/client/LeadApplicationClient.d.ts +90 -0
  86. package/sdk/application/client/LeadApplicationClient.js +264 -0
  87. package/sdk/application/client/LogisticApplicationClient.d.ts +42 -0
  88. package/sdk/application/client/LogisticApplicationClient.js +128 -0
  89. package/sdk/application/client/OrderApplicationClient.d.ts +190 -0
  90. package/sdk/application/client/OrderApplicationClient.js +479 -0
  91. package/sdk/application/client/PaymentApplicationClient.d.ts +454 -0
  92. package/sdk/application/client/PaymentApplicationClient.js +1378 -0
  93. package/sdk/application/client/PosCartApplicationClient.d.ts +449 -0
  94. package/sdk/application/client/PosCartApplicationClient.js +1123 -0
  95. package/sdk/application/client/RewardsApplicationClient.d.ts +93 -0
  96. package/sdk/application/client/RewardsApplicationClient.js +293 -0
  97. package/sdk/application/client/ShareApplicationClient.d.ts +87 -0
  98. package/sdk/application/client/ShareApplicationClient.js +268 -0
  99. package/sdk/application/client/ThemeApplicationClient.d.ts +52 -0
  100. package/sdk/application/client/ThemeApplicationClient.js +161 -0
  101. package/sdk/application/client/UserApplicationClient.d.ts +446 -0
  102. package/sdk/application/client/UserApplicationClient.js +1275 -0
  103. package/sdk/application/constructUrl.d.ts +5 -0
  104. package/sdk/application/constructUrl.js +13 -0
  105. package/sdk/application/index.d.ts +2 -0
  106. package/sdk/application/index.js +4 -0
  107. package/sdk/application/models/CartValidator.d.ts +29 -0
  108. package/sdk/application/models/CartValidator.js +223 -0
  109. package/sdk/application/models/CatalogValidator.d.ts +33 -0
  110. package/sdk/application/models/CatalogValidator.js +233 -0
  111. package/sdk/application/models/CommonValidator.d.ts +5 -0
  112. package/sdk/application/models/CommonValidator.js +18 -0
  113. package/sdk/application/models/CommunicationValidator.d.ts +6 -0
  114. package/sdk/application/models/CommunicationValidator.js +20 -0
  115. package/sdk/application/models/ConfigurationValidator.d.ts +19 -0
  116. package/sdk/application/models/ConfigurationValidator.js +88 -0
  117. package/sdk/application/models/ContentValidator.d.ts +22 -0
  118. package/sdk/application/models/ContentValidator.js +106 -0
  119. package/sdk/application/models/FileStorageValidator.d.ts +6 -0
  120. package/sdk/application/models/FileStorageValidator.js +24 -0
  121. package/sdk/application/models/LeadValidator.d.ts +10 -0
  122. package/sdk/application/models/LeadValidator.js +48 -0
  123. package/sdk/application/models/LogisticValidator.d.ts +6 -0
  124. package/sdk/application/models/LogisticValidator.js +22 -0
  125. package/sdk/application/models/OrderValidator.d.ts +15 -0
  126. package/sdk/application/models/OrderValidator.js +87 -0
  127. package/sdk/application/models/PaymentValidator.d.ts +40 -0
  128. package/sdk/application/models/PaymentValidator.js +235 -0
  129. package/sdk/application/models/PosCartValidator.d.ts +30 -0
  130. package/sdk/application/models/PosCartValidator.js +232 -0
  131. package/sdk/application/models/RewardsValidator.d.ts +10 -0
  132. package/sdk/application/models/RewardsValidator.js +43 -0
  133. package/sdk/application/models/ShareValidator.d.ts +10 -0
  134. package/sdk/application/models/ShareValidator.js +44 -0
  135. package/sdk/application/models/ThemeValidator.d.ts +7 -0
  136. package/sdk/application/models/ThemeValidator.js +27 -0
  137. package/sdk/application/models/UserValidator.d.ts +38 -0
  138. package/sdk/application/models/UserValidator.js +233 -0
  139. package/sdk/common/AxiosHelper.d.ts +1 -0
  140. package/sdk/common/AxiosHelper.js +141 -0
  141. package/sdk/common/Constant.d.ts +294 -0
  142. package/sdk/common/Constant.js +332 -0
  143. package/sdk/common/FDKError.d.ts +26 -0
  144. package/sdk/common/FDKError.js +51 -0
  145. package/sdk/common/Logger.d.ts +2 -0
  146. package/sdk/common/Logger.js +85 -0
  147. package/sdk/common/Paginator.d.ts +16 -0
  148. package/sdk/common/Paginator.js +26 -0
  149. package/sdk/common/RequestSigner.d.ts +1 -0
  150. package/sdk/common/RequestSigner.js +306 -0
  151. package/sdk/common/Utility.d.ts +9 -0
  152. package/sdk/common/Utility.js +86 -0
  153. package/sdk/common/utils.d.ts +14 -0
  154. package/sdk/common/utils.js +165 -0
  155. package/sdk/platform/OAuthClient.d.ts +26 -0
  156. package/sdk/platform/OAuthClient.js +221 -0
  157. package/sdk/platform/PlatformAPIClient.d.ts +12 -0
  158. package/sdk/platform/PlatformAPIClient.js +43 -0
  159. package/sdk/platform/PlatformApplicationClient.d.ts +24398 -0
  160. package/sdk/platform/PlatformApplicationClient.js +23185 -0
  161. package/sdk/platform/PlatformApplicationModels.d.ts +333 -0
  162. package/sdk/platform/PlatformApplicationModels.js +21262 -0
  163. package/sdk/platform/PlatformClient.d.ts +9535 -0
  164. package/sdk/platform/PlatformClient.js +12336 -0
  165. package/sdk/platform/PlatformConfig.d.ts +29 -0
  166. package/sdk/platform/PlatformConfig.js +36 -0
  167. package/sdk/platform/PlatformModels.d.ts +1396 -0
  168. package/sdk/platform/PlatformModels.js +19222 -0
  169. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +84 -0
  170. package/sdk/platform/client/AnalyticsPlatformClient.js +215 -0
  171. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +38 -0
  172. package/sdk/platform/client/AuditTrailPlatformClient.js +133 -0
  173. package/sdk/platform/client/BillingPlatformClient.d.ts +109 -0
  174. package/sdk/platform/client/BillingPlatformClient.js +381 -0
  175. package/sdk/platform/client/CatalogPlatformClient.d.ts +806 -0
  176. package/sdk/platform/client/CatalogPlatformClient.js +2462 -0
  177. package/sdk/platform/client/CommonPlatformClient.d.ts +30 -0
  178. package/sdk/platform/client/CommonPlatformClient.js +84 -0
  179. package/sdk/platform/client/CommunicationPlatformClient.d.ts +26 -0
  180. package/sdk/platform/client/CommunicationPlatformClient.js +72 -0
  181. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +182 -0
  182. package/sdk/platform/client/CompanyProfilePlatformClient.js +540 -0
  183. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +277 -0
  184. package/sdk/platform/client/ConfigurationPlatformClient.js +806 -0
  185. package/sdk/platform/client/DiscountPlatformClient.d.ts +118 -0
  186. package/sdk/platform/client/DiscountPlatformClient.js +364 -0
  187. package/sdk/platform/client/FileStoragePlatformClient.d.ts +111 -0
  188. package/sdk/platform/client/FileStoragePlatformClient.js +268 -0
  189. package/sdk/platform/client/InventoryPlatformClient.d.ts +125 -0
  190. package/sdk/platform/client/InventoryPlatformClient.js +409 -0
  191. package/sdk/platform/client/LeadPlatformClient.d.ts +150 -0
  192. package/sdk/platform/client/LeadPlatformClient.js +439 -0
  193. package/sdk/platform/client/OrderPlatformClient.d.ts +190 -0
  194. package/sdk/platform/client/OrderPlatformClient.js +521 -0
  195. package/sdk/platform/client/PaymentPlatformClient.d.ts +98 -0
  196. package/sdk/platform/client/PaymentPlatformClient.js +331 -0
  197. package/sdk/platform/client/WebhookPlatformClient.d.ts +64 -0
  198. package/sdk/platform/client/WebhookPlatformClient.js +207 -0
  199. package/sdk/platform/index.d.ts +2 -0
  200. package/sdk/platform/index.js +4 -0
  201. package/sdk/platform/models/AnalyticsValidator.d.ts +7 -0
  202. package/sdk/platform/models/AnalyticsValidator.js +36 -0
  203. package/sdk/platform/models/AuditTrailValidator.d.ts +7 -0
  204. package/sdk/platform/models/AuditTrailValidator.js +26 -0
  205. package/sdk/platform/models/BillingValidator.d.ts +15 -0
  206. package/sdk/platform/models/BillingValidator.js +72 -0
  207. package/sdk/platform/models/CartValidator.d.ts +0 -0
  208. package/sdk/platform/models/CartValidator.js +0 -0
  209. package/sdk/platform/models/CatalogValidator.d.ts +74 -0
  210. package/sdk/platform/models/CatalogValidator.js +484 -0
  211. package/sdk/platform/models/CommonValidator.d.ts +5 -0
  212. package/sdk/platform/models/CommonValidator.js +18 -0
  213. package/sdk/platform/models/CommunicationValidator.d.ts +4 -0
  214. package/sdk/platform/models/CommunicationValidator.js +11 -0
  215. package/sdk/platform/models/CompanyProfileValidator.d.ts +17 -0
  216. package/sdk/platform/models/CompanyProfileValidator.js +93 -0
  217. package/sdk/platform/models/ConfigurationValidator.d.ts +21 -0
  218. package/sdk/platform/models/ConfigurationValidator.js +134 -0
  219. package/sdk/platform/models/ContentValidator.d.ts +0 -0
  220. package/sdk/platform/models/ContentValidator.js +0 -0
  221. package/sdk/platform/models/DiscountValidator.d.ts +13 -0
  222. package/sdk/platform/models/DiscountValidator.js +75 -0
  223. package/sdk/platform/models/FileStorageValidator.d.ts +9 -0
  224. package/sdk/platform/models/FileStorageValidator.js +44 -0
  225. package/sdk/platform/models/InventoryValidator.d.ts +15 -0
  226. package/sdk/platform/models/InventoryValidator.js +81 -0
  227. package/sdk/platform/models/LeadValidator.d.ts +14 -0
  228. package/sdk/platform/models/LeadValidator.js +78 -0
  229. package/sdk/platform/models/OrderValidator.d.ts +14 -0
  230. package/sdk/platform/models/OrderValidator.js +110 -0
  231. package/sdk/platform/models/PartnerValidator.d.ts +0 -0
  232. package/sdk/platform/models/PartnerValidator.js +0 -0
  233. package/sdk/platform/models/PaymentValidator.d.ts +13 -0
  234. package/sdk/platform/models/PaymentValidator.js +65 -0
  235. package/sdk/platform/models/RewardsValidator.d.ts +0 -0
  236. package/sdk/platform/models/RewardsValidator.js +0 -0
  237. package/sdk/platform/models/ShareValidator.d.ts +0 -0
  238. package/sdk/platform/models/ShareValidator.js +0 -0
  239. package/sdk/platform/models/ThemeValidator.d.ts +0 -0
  240. package/sdk/platform/models/ThemeValidator.js +0 -0
  241. package/sdk/platform/models/UserValidator.d.ts +0 -0
  242. package/sdk/platform/models/UserValidator.js +0 -0
  243. package/sdk/platform/models/WebhookValidator.d.ts +9 -0
  244. package/sdk/platform/models/WebhookValidator.js +42 -0
  245. package/sdk/public/PublicAPIClient.d.ts +11 -0
  246. package/sdk/public/PublicAPIClient.js +38 -0
  247. package/sdk/public/PublicClient.d.ts +12 -0
  248. package/sdk/public/PublicClient.js +24 -0
  249. package/sdk/public/PublicConfig.d.ts +10 -0
  250. package/sdk/public/PublicConfig.js +12 -0
  251. package/sdk/public/PublicModels.d.ts +50 -0
  252. package/sdk/public/PublicModels.js +712 -0
  253. package/sdk/public/client/ConfigurationPublicClient.d.ts +38 -0
  254. package/sdk/public/client/ConfigurationPublicClient.js +102 -0
  255. package/sdk/public/client/InventoryPublicClient.d.ts +81 -0
  256. package/sdk/public/client/InventoryPublicClient.js +239 -0
  257. package/sdk/public/client/WebhookPublicClient.d.ts +28 -0
  258. package/sdk/public/client/WebhookPublicClient.js +92 -0
  259. package/sdk/public/constructUrl.d.ts +5 -0
  260. package/sdk/public/constructUrl.js +13 -0
  261. package/sdk/public/index.d.ts +2 -0
  262. package/sdk/public/index.js +4 -0
  263. package/sdk/public/models/ConfigurationValidator.d.ts +5 -0
  264. package/sdk/public/models/ConfigurationValidator.js +18 -0
  265. package/sdk/public/models/InventoryValidator.d.ts +9 -0
  266. package/sdk/public/models/InventoryValidator.js +43 -0
  267. package/sdk/public/models/WebhookValidator.d.ts +5 -0
  268. package/sdk/public/models/WebhookValidator.js +14 -0
  269. package/tests/application/catalog.spec.js +47 -0
  270. package/tests/common/action-url.spec.js +35 -0
  271. package/tests/common/schema/action-url.json +163 -0
  272. package/tests/common/schema/url-action.json +667 -0
  273. package/tests/common/url-action.spec.js +48 -0
  274. package/tests/helpers/cookie.helper.js +31 -0
  275. package/tests/helpers/oauth.helper.js +43 -0
  276. package/tests/platform/catalog.spec.js +49 -0
  277. package/tests/public/location.spec.js +39 -0
@@ -0,0 +1,3764 @@
1
+
2
+
3
+
4
+
5
+ ##### [Back to Platform docs](./README.md)
6
+
7
+ ## Order Methods
8
+ Handles Platform websites OMS
9
+ * [shipmentStatusUpdate](#shipmentstatusupdate)
10
+ * [activityStatus](#activitystatus)
11
+ * [storeProcessShipmentUpdate](#storeprocessshipmentupdate)
12
+ * [checkRefund](#checkrefund)
13
+ * [shipmentBagsCanBreak](#shipmentbagscanbreak)
14
+ * [getOrdersByCompanyId](#getordersbycompanyid)
15
+ * [getOrderLanesCountByCompanyId](#getorderlanescountbycompanyid)
16
+ * [getOrderDetails](#getorderdetails)
17
+ * [getApplicationOrderDetails](#getapplicationorderdetails)
18
+ * [getPicklistOrdersByCompanyId](#getpicklistordersbycompanyid)
19
+ * [trackShipmentPlatform](#trackshipmentplatform)
20
+ * [trackOrder](#trackorder)
21
+ * [failedOrders](#failedorders)
22
+ * [reprocessOrder](#reprocessorder)
23
+ * [updateShipment](#updateshipment)
24
+ * [getPlatformShipmentReasons](#getplatformshipmentreasons)
25
+ * [getShipmentTrackDetails](#getshipmenttrackdetails)
26
+ * [getShipmentAddress](#getshipmentaddress)
27
+ * [updateShipmentAddress](#updateshipmentaddress)
28
+ * [getOrdersByApplicationId](#getordersbyapplicationid)
29
+
30
+
31
+
32
+ ## Methods with example and description
33
+
34
+
35
+ ### shipmentStatusUpdate
36
+ Update status of Shipment
37
+
38
+
39
+
40
+ ```javascript
41
+ // Promise
42
+ const promise = client.order.shipmentStatusUpdate({ body : value });
43
+
44
+ // Async/Await
45
+ const data = await client.order.shipmentStatusUpdate({ body : value });
46
+ ```
47
+
48
+
49
+
50
+
51
+
52
+ | Argument | Type | Required | Description |
53
+ | --------- | ----- | -------- | ----------- |
54
+ | body | [UpdateShipmentStatusBody](#UpdateShipmentStatusBody) | yes | Request body |
55
+
56
+
57
+ Update Shipment Status
58
+
59
+ *Returned Response:*
60
+
61
+
62
+
63
+
64
+ [UpdateShipmentStatusResponse](#UpdateShipmentStatusResponse)
65
+
66
+ Success
67
+
68
+
69
+
70
+
71
+ <details>
72
+ <summary><i>&nbsp; Example:</i></summary>
73
+
74
+ ```json
75
+
76
+ ```
77
+ </details>
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+ ---
88
+
89
+
90
+ ### activityStatus
91
+ Get Activity Status
92
+
93
+
94
+
95
+ ```javascript
96
+ // Promise
97
+ const promise = client.order.activityStatus({ bagId : value });
98
+
99
+ // Async/Await
100
+ const data = await client.order.activityStatus({ bagId : value });
101
+ ```
102
+
103
+
104
+
105
+
106
+
107
+ | Argument | Type | Required | Description |
108
+ | --------- | ----- | -------- | ----------- |
109
+ | bagId | string | yes | Bag Id |
110
+
111
+
112
+
113
+ Get Activity Status
114
+
115
+ *Returned Response:*
116
+
117
+
118
+
119
+
120
+ [GetActivityStatus](#GetActivityStatus)
121
+
122
+ Success
123
+
124
+
125
+
126
+
127
+ <details>
128
+ <summary><i>&nbsp; Example:</i></summary>
129
+
130
+ ```json
131
+
132
+ ```
133
+ </details>
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ ---
144
+
145
+
146
+ ### storeProcessShipmentUpdate
147
+ Update Store Process-Shipment
148
+
149
+
150
+
151
+ ```javascript
152
+ // Promise
153
+ const promise = client.order.storeProcessShipmentUpdate({ body : value });
154
+
155
+ // Async/Await
156
+ const data = await client.order.storeProcessShipmentUpdate({ body : value });
157
+ ```
158
+
159
+
160
+
161
+
162
+
163
+ | Argument | Type | Required | Description |
164
+ | --------- | ----- | -------- | ----------- |
165
+ | body | [UpdateProcessShipmenstRequestBody](#UpdateProcessShipmenstRequestBody) | yes | Request body |
166
+
167
+
168
+ Update Store Process-Shipment
169
+
170
+ *Returned Response:*
171
+
172
+
173
+
174
+
175
+ [UpdateProcessShipmenstRequestResponse](#UpdateProcessShipmenstRequestResponse)
176
+
177
+ Success
178
+
179
+
180
+
181
+
182
+ <details>
183
+ <summary><i>&nbsp; Example:</i></summary>
184
+
185
+ ```json
186
+
187
+ ```
188
+ </details>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ ---
199
+
200
+
201
+ ### checkRefund
202
+ Check Refund is available or not
203
+
204
+
205
+
206
+ ```javascript
207
+ // Promise
208
+ const promise = client.order.checkRefund({ shipmentId : value });
209
+
210
+ // Async/Await
211
+ const data = await client.order.checkRefund({ shipmentId : value });
212
+ ```
213
+
214
+
215
+
216
+
217
+
218
+ | Argument | Type | Required | Description |
219
+ | --------- | ----- | -------- | ----------- |
220
+ | shipmentId | string | yes | Shipment Id |
221
+
222
+
223
+
224
+ Check Refund is available or not
225
+
226
+ *Returned Response:*
227
+
228
+
229
+
230
+
231
+ [Object](#Object)
232
+
233
+ Success
234
+
235
+
236
+
237
+
238
+ <details>
239
+ <summary><i>&nbsp; Example:</i></summary>
240
+
241
+ ```json
242
+
243
+ ```
244
+ </details>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ ---
255
+
256
+
257
+ ### shipmentBagsCanBreak
258
+ Decides if Shipment bags can break
259
+
260
+
261
+
262
+ ```javascript
263
+ // Promise
264
+ const promise = client.order.shipmentBagsCanBreak({ body : value });
265
+
266
+ // Async/Await
267
+ const data = await client.order.shipmentBagsCanBreak({ body : value });
268
+ ```
269
+
270
+
271
+
272
+
273
+
274
+ | Argument | Type | Required | Description |
275
+ | --------- | ----- | -------- | ----------- |
276
+ | body | [CanBreakRequestBody](#CanBreakRequestBody) | yes | Request body |
277
+
278
+
279
+ Decides if Shipment bags can break
280
+
281
+ *Returned Response:*
282
+
283
+
284
+
285
+
286
+ [CanBreakResponse](#CanBreakResponse)
287
+
288
+ Success
289
+
290
+
291
+
292
+
293
+ <details>
294
+ <summary><i>&nbsp; Example:</i></summary>
295
+
296
+ ```json
297
+
298
+ ```
299
+ </details>
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+ ---
310
+
311
+
312
+ ### getOrdersByCompanyId
313
+ Get Orders for company based on Company Id
314
+
315
+
316
+
317
+ ```javascript
318
+ // Promise
319
+ const promise = client.order.getOrdersByCompanyId({ pageNo : value,
320
+ pageSize : value,
321
+ fromDate : value,
322
+ toDate : value,
323
+ isPrioritySort : value,
324
+ lockStatus : value,
325
+ userId : value,
326
+ q : value,
327
+ stage : value,
328
+ salesChannels : value,
329
+ orderId : value,
330
+ stores : value,
331
+ deploymentStores : value,
332
+ status : value,
333
+ dp : value,
334
+ filterType : value });
335
+
336
+ // Async/Await
337
+ const data = await client.order.getOrdersByCompanyId({ pageNo : value,
338
+ pageSize : value,
339
+ fromDate : value,
340
+ toDate : value,
341
+ isPrioritySort : value,
342
+ lockStatus : value,
343
+ userId : value,
344
+ q : value,
345
+ stage : value,
346
+ salesChannels : value,
347
+ orderId : value,
348
+ stores : value,
349
+ deploymentStores : value,
350
+ status : value,
351
+ dp : value,
352
+ filterType : value });
353
+ ```
354
+
355
+
356
+
357
+
358
+
359
+ | Argument | Type | Required | Description |
360
+ | --------- | ----- | -------- | ----------- |
361
+ | pageNo | string | no | Current page number |
362
+ | pageSize | string | no | Page limit |
363
+ | fromDate | string | no | From Date |
364
+ | toDate | string | no | To Date |
365
+ | isPrioritySort | boolean | no | Sorting Order |
366
+ | lockStatus | boolean | no | Hide Lock Status |
367
+ | userId | string | no | User Id |
368
+ | q | string | no | Keyword for Search |
369
+ | stage | string | no | Specefic Order Stage |
370
+ | salesChannels | string | no | Selected Sales Channel |
371
+ | orderId | string | no | Order Id |
372
+ | stores | string | no | Selected Stores |
373
+ | deploymentStores | string | no | Selected Deployment Stores |
374
+ | status | string | no | Status of order |
375
+ | dp | string | no | Delivery Partners |
376
+ | filterType | string | no | Filters |
377
+
378
+
379
+
380
+ Get Orders
381
+
382
+ *Returned Response:*
383
+
384
+
385
+
386
+
387
+ [OrderListing](#OrderListing)
388
+
389
+ Success
390
+
391
+
392
+
393
+
394
+ <details>
395
+ <summary><i>&nbsp; Example:</i></summary>
396
+
397
+ ```json
398
+
399
+ ```
400
+ </details>
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+ ---
411
+
412
+
413
+ ### getOrderLanesCountByCompanyId
414
+ Get Order Lanes Count for company based on Company Id
415
+
416
+
417
+
418
+ ```javascript
419
+ // Promise
420
+ const promise = client.order.getOrderLanesCountByCompanyId({ pageNo : value,
421
+ pageSize : value,
422
+ fromDate : value,
423
+ toDate : value,
424
+ q : value,
425
+ stage : value,
426
+ salesChannels : value,
427
+ orderId : value,
428
+ stores : value,
429
+ status : value,
430
+ filterType : value });
431
+
432
+ // Async/Await
433
+ const data = await client.order.getOrderLanesCountByCompanyId({ pageNo : value,
434
+ pageSize : value,
435
+ fromDate : value,
436
+ toDate : value,
437
+ q : value,
438
+ stage : value,
439
+ salesChannels : value,
440
+ orderId : value,
441
+ stores : value,
442
+ status : value,
443
+ filterType : value });
444
+ ```
445
+
446
+
447
+
448
+
449
+
450
+ | Argument | Type | Required | Description |
451
+ | --------- | ----- | -------- | ----------- |
452
+ | pageNo | string | no | Current page number |
453
+ | pageSize | string | no | Page limit |
454
+ | fromDate | string | no | From Date |
455
+ | toDate | string | no | To Date |
456
+ | q | string | no | Keyword for Search |
457
+ | stage | string | no | Specefic Order Stage |
458
+ | salesChannels | string | no | Selected Sales Channel |
459
+ | orderId | string | no | Order Id |
460
+ | stores | string | no | Selected Stores |
461
+ | status | string | no | Status of order |
462
+ | filterType | string | no | Filters |
463
+
464
+
465
+
466
+ Get Orders Seperate Lane Count
467
+
468
+ *Returned Response:*
469
+
470
+
471
+
472
+
473
+ [OrderLanesCount](#OrderLanesCount)
474
+
475
+ Success
476
+
477
+
478
+
479
+
480
+ <details>
481
+ <summary><i>&nbsp; Example:</i></summary>
482
+
483
+ ```json
484
+
485
+ ```
486
+ </details>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+ ---
497
+
498
+
499
+ ### getOrderDetails
500
+ Get Order Details for company based on Company Id and Order Id
501
+
502
+
503
+
504
+ ```javascript
505
+ // Promise
506
+ const promise = client.order.getOrderDetails({ orderId : value,
507
+ next : value,
508
+ previous : value });
509
+
510
+ // Async/Await
511
+ const data = await client.order.getOrderDetails({ orderId : value,
512
+ next : value,
513
+ previous : value });
514
+ ```
515
+
516
+
517
+
518
+
519
+
520
+ | Argument | Type | Required | Description |
521
+ | --------- | ----- | -------- | ----------- |
522
+ | orderId | string | no | Order Id |
523
+ | next | string | no | Next |
524
+ | previous | string | no | Previous |
525
+
526
+
527
+
528
+ Get Orders
529
+
530
+ *Returned Response:*
531
+
532
+
533
+
534
+
535
+ [OrderDetails](#OrderDetails)
536
+
537
+ Success
538
+
539
+
540
+
541
+
542
+ <details>
543
+ <summary><i>&nbsp; Example:</i></summary>
544
+
545
+ ```json
546
+
547
+ ```
548
+ </details>
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+ ---
559
+
560
+
561
+ ### getApplicationOrderDetails
562
+ Get Order Details for company based on Company Id and Order Id
563
+
564
+
565
+
566
+ ```javascript
567
+ // Promise
568
+ const promise = client.application("<APPLICATION_ID>").order.getApplicationOrderDetails({ orderId : value,
569
+ next : value,
570
+ previous : value });
571
+
572
+ // Async/Await
573
+ const data = await client.application("<APPLICATION_ID>").order.getApplicationOrderDetails({ orderId : value,
574
+ next : value,
575
+ previous : value });
576
+ ```
577
+
578
+
579
+
580
+
581
+
582
+ | Argument | Type | Required | Description |
583
+ | --------- | ----- | -------- | ----------- |
584
+ | orderId | string | no | Order Id |
585
+ | next | string | no | Next |
586
+ | previous | string | no | Previous |
587
+
588
+
589
+
590
+ Get Orders
591
+
592
+ *Returned Response:*
593
+
594
+
595
+
596
+
597
+ [OrderDetails](#OrderDetails)
598
+
599
+ Success
600
+
601
+
602
+
603
+
604
+ <details>
605
+ <summary><i>&nbsp; Example:</i></summary>
606
+
607
+ ```json
608
+
609
+ ```
610
+ </details>
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+ ---
621
+
622
+
623
+ ### getPicklistOrdersByCompanyId
624
+ Get Orders for company based on Company Id
625
+
626
+
627
+
628
+ ```javascript
629
+ // Promise
630
+ const promise = client.order.getPicklistOrdersByCompanyId({ pageNo : value,
631
+ pageSize : value,
632
+ fromDate : value,
633
+ toDate : value,
634
+ q : value,
635
+ stage : value,
636
+ salesChannels : value,
637
+ orderId : value,
638
+ stores : value,
639
+ status : value,
640
+ filterType : value });
641
+
642
+ // Async/Await
643
+ const data = await client.order.getPicklistOrdersByCompanyId({ pageNo : value,
644
+ pageSize : value,
645
+ fromDate : value,
646
+ toDate : value,
647
+ q : value,
648
+ stage : value,
649
+ salesChannels : value,
650
+ orderId : value,
651
+ stores : value,
652
+ status : value,
653
+ filterType : value });
654
+ ```
655
+
656
+
657
+
658
+
659
+
660
+ | Argument | Type | Required | Description |
661
+ | --------- | ----- | -------- | ----------- |
662
+ | pageNo | string | no | Current page number |
663
+ | pageSize | string | no | Page limit |
664
+ | fromDate | string | no | From Date |
665
+ | toDate | string | no | To Date |
666
+ | q | string | no | Keyword for Search |
667
+ | stage | string | no | Specefic Order Stage |
668
+ | salesChannels | string | no | Selected Sales Channel |
669
+ | orderId | string | no | Order Id |
670
+ | stores | string | no | Selected Stores |
671
+ | status | string | no | Status of order |
672
+ | filterType | string | no | Filters |
673
+
674
+
675
+
676
+ Get Orders
677
+
678
+ *Returned Response:*
679
+
680
+
681
+
682
+
683
+ [OrderPicklistListing](#OrderPicklistListing)
684
+
685
+ Success
686
+
687
+
688
+
689
+
690
+ <details>
691
+ <summary><i>&nbsp; Example:</i></summary>
692
+
693
+ ```json
694
+
695
+ ```
696
+ </details>
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+ ---
707
+
708
+
709
+ ### trackShipmentPlatform
710
+ Track Shipment by shipment id, for application based on application Id
711
+
712
+
713
+
714
+ ```javascript
715
+ // Promise
716
+ const promise = client.application("<APPLICATION_ID>").order.trackShipmentPlatform({ shipmentId : value });
717
+
718
+ // Async/Await
719
+ const data = await client.application("<APPLICATION_ID>").order.trackShipmentPlatform({ shipmentId : value });
720
+ ```
721
+
722
+
723
+
724
+
725
+
726
+ | Argument | Type | Required | Description |
727
+ | --------- | ----- | -------- | ----------- |
728
+ | shipmentId | string | yes | Shipment Id |
729
+
730
+
731
+
732
+ Shipment Track
733
+
734
+ *Returned Response:*
735
+
736
+
737
+
738
+
739
+ [PlatformShipmentTrack](#PlatformShipmentTrack)
740
+
741
+ Success
742
+
743
+
744
+
745
+
746
+ <details>
747
+ <summary><i>&nbsp; Example:</i></summary>
748
+
749
+ ```json
750
+
751
+ ```
752
+ </details>
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+ ---
763
+
764
+
765
+ ### trackOrder
766
+ Track Order by order id, for application based on application Id
767
+
768
+
769
+
770
+ ```javascript
771
+ // Promise
772
+ const promise = client.application("<APPLICATION_ID>").order.trackOrder({ orderId : value });
773
+
774
+ // Async/Await
775
+ const data = await client.application("<APPLICATION_ID>").order.trackOrder({ orderId : value });
776
+ ```
777
+
778
+
779
+
780
+
781
+
782
+ | Argument | Type | Required | Description |
783
+ | --------- | ----- | -------- | ----------- |
784
+ | orderId | string | yes | Order Id |
785
+
786
+
787
+
788
+ Order Track
789
+
790
+ *Returned Response:*
791
+
792
+
793
+
794
+
795
+ [PlatformOrderTrack](#PlatformOrderTrack)
796
+
797
+ Success
798
+
799
+
800
+
801
+
802
+ <details>
803
+ <summary><i>&nbsp; Example:</i></summary>
804
+
805
+ ```json
806
+
807
+ ```
808
+ </details>
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+ ---
819
+
820
+
821
+ ### failedOrders
822
+ Get all failed orders application wise
823
+
824
+
825
+
826
+ ```javascript
827
+ // Promise
828
+ const promise = client.application("<APPLICATION_ID>").order.failedOrders();
829
+
830
+ // Async/Await
831
+ const data = await client.application("<APPLICATION_ID>").order.failedOrders();
832
+ ```
833
+
834
+
835
+
836
+
837
+
838
+
839
+ Failed Orders
840
+
841
+ *Returned Response:*
842
+
843
+
844
+
845
+
846
+ [FailedOrders](#FailedOrders)
847
+
848
+ Success
849
+
850
+
851
+
852
+
853
+ <details>
854
+ <summary><i>&nbsp; Example:</i></summary>
855
+
856
+ ```json
857
+
858
+ ```
859
+ </details>
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+ ---
870
+
871
+
872
+ ### reprocessOrder
873
+ Reprocess order by order id
874
+
875
+
876
+
877
+ ```javascript
878
+ // Promise
879
+ const promise = client.application("<APPLICATION_ID>").order.reprocessOrder({ orderId : value });
880
+
881
+ // Async/Await
882
+ const data = await client.application("<APPLICATION_ID>").order.reprocessOrder({ orderId : value });
883
+ ```
884
+
885
+
886
+
887
+
888
+
889
+ | Argument | Type | Required | Description |
890
+ | --------- | ----- | -------- | ----------- |
891
+ | orderId | string | yes | Order Id |
892
+
893
+
894
+
895
+ Order Reprocess
896
+
897
+ *Returned Response:*
898
+
899
+
900
+
901
+
902
+ [UpdateOrderReprocessResponse](#UpdateOrderReprocessResponse)
903
+
904
+ Success
905
+
906
+
907
+
908
+
909
+ <details>
910
+ <summary><i>&nbsp; Example:</i></summary>
911
+
912
+ ```json
913
+
914
+ ```
915
+ </details>
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+ ---
926
+
927
+
928
+ ### updateShipment
929
+ Use this API to update the shipment using its shipment ID.
930
+
931
+
932
+
933
+ ```javascript
934
+ // Promise
935
+ const promise = client.application("<APPLICATION_ID>").order.updateShipment({ shipmentId : value,
936
+ body : value });
937
+
938
+ // Async/Await
939
+ const data = await client.application("<APPLICATION_ID>").order.updateShipment({ shipmentId : value,
940
+ body : value });
941
+ ```
942
+
943
+
944
+
945
+
946
+
947
+ | Argument | Type | Required | Description |
948
+ | --------- | ----- | -------- | ----------- |
949
+ | 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. |
950
+ | body | [ShipmentUpdateRequest](#ShipmentUpdateRequest) | yes | Request body |
951
+
952
+
953
+ Update the shipment
954
+
955
+ *Returned Response:*
956
+
957
+
958
+
959
+
960
+ [ShipmentUpdateResponse](#ShipmentUpdateResponse)
961
+
962
+ Success. Check the example shown below or refer `ShipmentUpdateRequest` for more details.
963
+
964
+
965
+
966
+
967
+ <details>
968
+ <summary><i>&nbsp; Example:</i></summary>
969
+
970
+ ```json
971
+
972
+ ```
973
+ </details>
974
+
975
+
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+ ---
984
+
985
+
986
+ ### getPlatformShipmentReasons
987
+ Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
988
+
989
+
990
+
991
+ ```javascript
992
+ // Promise
993
+ const promise = client.application("<APPLICATION_ID>").order.getPlatformShipmentReasons({ action : value });
994
+
995
+ // Async/Await
996
+ const data = await client.application("<APPLICATION_ID>").order.getPlatformShipmentReasons({ action : value });
997
+ ```
998
+
999
+
1000
+
1001
+
1002
+
1003
+ | Argument | Type | Required | Description |
1004
+ | --------- | ----- | -------- | ----------- |
1005
+ | action | string | yes | Action |
1006
+
1007
+
1008
+
1009
+ Get reasons behind full or partial cancellation of a shipment
1010
+
1011
+ *Returned Response:*
1012
+
1013
+
1014
+
1015
+
1016
+ [ShipmentReasonsResponse](#ShipmentReasonsResponse)
1017
+
1018
+ Success. Check the example shown below or refer `ShipmentReasonsResponse` for more details.
1019
+
1020
+
1021
+
1022
+
1023
+ <details>
1024
+ <summary><i>&nbsp; Example:</i></summary>
1025
+
1026
+ ```json
1027
+
1028
+ ```
1029
+ </details>
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+ ---
1040
+
1041
+
1042
+ ### getShipmentTrackDetails
1043
+ Use this API to track a shipment using its shipment ID.
1044
+
1045
+
1046
+
1047
+ ```javascript
1048
+ // Promise
1049
+ const promise = client.application("<APPLICATION_ID>").order.getShipmentTrackDetails({ orderId : value,
1050
+ shipmentId : value });
1051
+
1052
+ // Async/Await
1053
+ const data = await client.application("<APPLICATION_ID>").order.getShipmentTrackDetails({ orderId : value,
1054
+ shipmentId : value });
1055
+ ```
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+ | Argument | Type | Required | Description |
1062
+ | --------- | ----- | -------- | ----------- |
1063
+ | orderId | string | yes | ID of the order. |
1064
+ | 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. |
1065
+
1066
+
1067
+
1068
+ Track shipment
1069
+
1070
+ *Returned Response:*
1071
+
1072
+
1073
+
1074
+
1075
+ [ShipmentTrackResponse](#ShipmentTrackResponse)
1076
+
1077
+ Success. Check the example shown below or refer `ShipmentTrackResponse` for more details.
1078
+
1079
+
1080
+
1081
+
1082
+ <details>
1083
+ <summary><i>&nbsp; Example:</i></summary>
1084
+
1085
+ ```json
1086
+
1087
+ ```
1088
+ </details>
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+ ---
1099
+
1100
+
1101
+ ### getShipmentAddress
1102
+ Use this API to get address of a shipment using its shipment ID and Address Category.
1103
+
1104
+
1105
+
1106
+ ```javascript
1107
+ // Promise
1108
+ const promise = client.order.getShipmentAddress({ shipmentId : value,
1109
+ addressCategory : value });
1110
+
1111
+ // Async/Await
1112
+ const data = await client.order.getShipmentAddress({ shipmentId : value,
1113
+ addressCategory : value });
1114
+ ```
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+ | Argument | Type | Required | Description |
1121
+ | --------- | ----- | -------- | ----------- |
1122
+ | 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. |
1123
+ | addressCategory | string | yes | Category of the address it falls into(billing or delivery). |
1124
+
1125
+
1126
+
1127
+ Get Shipment Address
1128
+
1129
+ *Returned Response:*
1130
+
1131
+
1132
+
1133
+
1134
+ [GetShipmentAddressResponse](#GetShipmentAddressResponse)
1135
+
1136
+ Success. Check the example shown below or refer `GetShipmentAddressResponse` for more details.
1137
+
1138
+
1139
+
1140
+
1141
+ <details>
1142
+ <summary><i>&nbsp; Example:</i></summary>
1143
+
1144
+ ```json
1145
+
1146
+ ```
1147
+ </details>
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+ ---
1158
+
1159
+
1160
+ ### updateShipmentAddress
1161
+ Use this API to update address of a shipment using its shipment ID and Address Category.
1162
+
1163
+
1164
+
1165
+ ```javascript
1166
+ // Promise
1167
+ const promise = client.order.updateShipmentAddress({ shipmentId : value,
1168
+ addressCategory : value,
1169
+ body : value });
1170
+
1171
+ // Async/Await
1172
+ const data = await client.order.updateShipmentAddress({ shipmentId : value,
1173
+ addressCategory : value,
1174
+ body : value });
1175
+ ```
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+ | Argument | Type | Required | Description |
1182
+ | --------- | ----- | -------- | ----------- |
1183
+ | 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. |
1184
+ | addressCategory | string | yes | Category of the address it falls into(billing or delivery). |
1185
+ | body | [UpdateShipmentAddressRequest](#UpdateShipmentAddressRequest) | yes | Request body |
1186
+
1187
+
1188
+ Update Shipment Address
1189
+
1190
+ *Returned Response:*
1191
+
1192
+
1193
+
1194
+
1195
+ [UpdateShipmentAddressResponse](#UpdateShipmentAddressResponse)
1196
+
1197
+ Success. Check the example shown below or refer `UpdateShipmentAddressResponse` for more details.
1198
+
1199
+
1200
+
1201
+
1202
+ <details>
1203
+ <summary><i>&nbsp; Example:</i></summary>
1204
+
1205
+ ```json
1206
+
1207
+ ```
1208
+ </details>
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+ ---
1219
+
1220
+
1221
+ ### getOrdersByApplicationId
1222
+ Get Orders for company based on Company Id
1223
+
1224
+
1225
+
1226
+ ```javascript
1227
+ // Promise
1228
+ const promise = client.application("<APPLICATION_ID>").order.getOrdersByApplicationId({ pageNo : value,
1229
+ pageSize : value,
1230
+ fromDate : value,
1231
+ toDate : value,
1232
+ q : value,
1233
+ stage : value,
1234
+ salesChannels : value,
1235
+ orderId : value,
1236
+ stores : value,
1237
+ status : value,
1238
+ dp : value,
1239
+ userId : value,
1240
+ filterType : value });
1241
+
1242
+ // Async/Await
1243
+ const data = await client.application("<APPLICATION_ID>").order.getOrdersByApplicationId({ pageNo : value,
1244
+ pageSize : value,
1245
+ fromDate : value,
1246
+ toDate : value,
1247
+ q : value,
1248
+ stage : value,
1249
+ salesChannels : value,
1250
+ orderId : value,
1251
+ stores : value,
1252
+ status : value,
1253
+ dp : value,
1254
+ userId : value,
1255
+ filterType : value });
1256
+ ```
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+ | Argument | Type | Required | Description |
1263
+ | --------- | ----- | -------- | ----------- |
1264
+ | pageNo | string | no | Current page number |
1265
+ | pageSize | string | no | Page limit |
1266
+ | fromDate | string | no | From Date |
1267
+ | toDate | string | no | To Date |
1268
+ | q | string | no | Keyword for Search |
1269
+ | stage | string | no | Specefic Order Stage |
1270
+ | salesChannels | string | no | Selected Sales Channel |
1271
+ | orderId | string | no | Order Id |
1272
+ | stores | string | no | Selected Stores |
1273
+ | status | string | no | Status of order |
1274
+ | dp | string | no | Delivery Partners |
1275
+ | userId | string | no | User Id |
1276
+ | filterType | string | no | Filters |
1277
+
1278
+
1279
+
1280
+ Get Orders at Application Level
1281
+
1282
+ *Returned Response:*
1283
+
1284
+
1285
+
1286
+
1287
+ [OrderListing](#OrderListing)
1288
+
1289
+ Success
1290
+
1291
+
1292
+
1293
+
1294
+ <details>
1295
+ <summary><i>&nbsp; Example:</i></summary>
1296
+
1297
+ ```json
1298
+
1299
+ ```
1300
+ </details>
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+ ---
1311
+
1312
+
1313
+
1314
+ ### Schemas
1315
+
1316
+
1317
+
1318
+ #### [GetActivityStatus](#GetActivityStatus)
1319
+
1320
+ | Properties | Type | Nullable | Description |
1321
+ | ---------- | ---- | -------- | ----------- |
1322
+ | activity_history | [ActivityHistory](#ActivityHistory) | yes | |
1323
+
1324
+ ---
1325
+
1326
+
1327
+
1328
+
1329
+ #### [ActivityHistory](#ActivityHistory)
1330
+
1331
+ | Properties | Type | Nullable | Description |
1332
+ | ---------- | ---- | -------- | ----------- |
1333
+ | createdat | string | no | |
1334
+ | message | string | no | |
1335
+ | type | string | no | |
1336
+ | user | string | no | |
1337
+
1338
+ ---
1339
+
1340
+
1341
+
1342
+
1343
+ #### [CanBreakRequestBody](#CanBreakRequestBody)
1344
+
1345
+ | Properties | Type | Nullable | Description |
1346
+ | ---------- | ---- | -------- | ----------- |
1347
+ | shipment_ids | [string] | yes | |
1348
+
1349
+ ---
1350
+
1351
+
1352
+
1353
+
1354
+ #### [CanBreakResponse](#CanBreakResponse)
1355
+
1356
+ | Properties | Type | Nullable | Description |
1357
+ | ---------- | ---- | -------- | ----------- |
1358
+ | status | boolean | yes | |
1359
+ | valid_actions | string | yes | |
1360
+
1361
+ ---
1362
+
1363
+
1364
+
1365
+
1366
+ #### [FailedOrders](#FailedOrders)
1367
+
1368
+ | Properties | Type | Nullable | Description |
1369
+ | ---------- | ---- | -------- | ----------- |
1370
+ | orders | [FailOrder](#FailOrder) | yes | |
1371
+
1372
+ ---
1373
+
1374
+
1375
+
1376
+
1377
+ #### [FailOrder](#FailOrder)
1378
+
1379
+ | Properties | Type | Nullable | Description |
1380
+ | ---------- | ---- | -------- | ----------- |
1381
+ | updated_at | string | no | |
1382
+ | _id | string | no | |
1383
+ | reason | string | no | |
1384
+ | marketplace_order | [MarketplaceOrder](#MarketplaceOrder) | no | |
1385
+ | marketplace_order_id | string | no | |
1386
+ | created_at | string | no | |
1387
+ | app_id | string | no | |
1388
+ | marketplace | string | no | |
1389
+ | company_id | number | no | |
1390
+
1391
+ ---
1392
+
1393
+
1394
+
1395
+
1396
+ #### [MarketplaceOrder](#MarketplaceOrder)
1397
+
1398
+ | Properties | Type | Nullable | Description |
1399
+ | ---------- | ---- | -------- | ----------- |
1400
+ | order_status_url | string | no | |
1401
+ | admin_graphql_api_id | string | no | |
1402
+ | email | string | no | |
1403
+ | test | boolean | no | |
1404
+ | note | string | no | |
1405
+ | total_price | string | no | |
1406
+ | app_id | number | no | |
1407
+ | total_discounts_set | [TotalDiscountsSet](#TotalDiscountsSet) | no | |
1408
+ | total_price_set | [TotalPriceSet](#TotalPriceSet) | no | |
1409
+ | total_tax_set | [TotalTaxSet](#TotalTaxSet) | no | |
1410
+ | gateway | string | no | |
1411
+ | name | string | no | |
1412
+ | subtotal_price_set | [SubtotalPriceSet](#SubtotalPriceSet) | no | |
1413
+ | number | number | no | |
1414
+ | buyer_accepts_marketing | boolean | no | |
1415
+ | contact_email | string | no | |
1416
+ | token | string | no | |
1417
+ | source_name | string | no | |
1418
+ | payment_gateway_names | [any] | no | |
1419
+ | presentment_currency | string | no | |
1420
+ | subtotal_price | string | no | |
1421
+ | processed_at | string | no | |
1422
+ | order_number | number | no | |
1423
+ | total_tip_received | string | no | |
1424
+ | id | number | no | |
1425
+ | confirmed | boolean | no | |
1426
+ | currency | string | no | |
1427
+ | total_line_items_price | string | no | |
1428
+ | line_items | [LineItems](#LineItems) | no | |
1429
+ | created_at | string | no | |
1430
+ | updated_at | string | no | |
1431
+ | total_weight | number | no | |
1432
+ | billing_address | [BillingAddress](#BillingAddress) | no | |
1433
+ | total_shipping_price_set | [TotalShippingPriceSet](#TotalShippingPriceSet) | no | |
1434
+ | customer | [Customer](#Customer) | no | |
1435
+ | total_discounts | string | no | |
1436
+ | total_line_items_price_set | [TotalLineItemsPriceSet](#TotalLineItemsPriceSet) | no | |
1437
+ | tags | string | no | |
1438
+ | total_price_usd | string | no | |
1439
+ | user_id | number | no | |
1440
+ | total_tax | string | no | |
1441
+ | processing_method | string | no | |
1442
+ | shipping_address | [OrderShippingAddress](#OrderShippingAddress) | no | |
1443
+ | taxes_included | boolean | no | |
1444
+ | financial_status | string | no | |
1445
+
1446
+ ---
1447
+
1448
+
1449
+
1450
+
1451
+ #### [TotalDiscountsSet](#TotalDiscountsSet)
1452
+
1453
+ | Properties | Type | Nullable | Description |
1454
+ | ---------- | ---- | -------- | ----------- |
1455
+ | presentment_money | [PresentmentMoney](#PresentmentMoney) | no | |
1456
+ | shop_money | [ShopMoney](#ShopMoney) | no | |
1457
+
1458
+ ---
1459
+
1460
+
1461
+
1462
+
1463
+ #### [PresentmentMoney](#PresentmentMoney)
1464
+
1465
+ | Properties | Type | Nullable | Description |
1466
+ | ---------- | ---- | -------- | ----------- |
1467
+ | amount | string | no | |
1468
+ | currency_code | string | no | |
1469
+
1470
+ ---
1471
+
1472
+
1473
+
1474
+
1475
+ #### [ShopMoney](#ShopMoney)
1476
+
1477
+ | Properties | Type | Nullable | Description |
1478
+ | ---------- | ---- | -------- | ----------- |
1479
+ | amount | string | no | |
1480
+ | currency_code | string | no | |
1481
+
1482
+ ---
1483
+
1484
+
1485
+
1486
+
1487
+ #### [TotalPriceSet](#TotalPriceSet)
1488
+
1489
+ | Properties | Type | Nullable | Description |
1490
+ | ---------- | ---- | -------- | ----------- |
1491
+ | shop_money | [TotalPriceSetShopMoney](#TotalPriceSetShopMoney) | no | |
1492
+ | presentment_money | [TotalPriceSetPresentmentMoney](#TotalPriceSetPresentmentMoney) | no | |
1493
+
1494
+ ---
1495
+
1496
+
1497
+
1498
+
1499
+ #### [TotalPriceSetShopMoney](#TotalPriceSetShopMoney)
1500
+
1501
+ | Properties | Type | Nullable | Description |
1502
+ | ---------- | ---- | -------- | ----------- |
1503
+ | amount | string | no | |
1504
+ | currency_code | string | no | |
1505
+
1506
+ ---
1507
+
1508
+
1509
+
1510
+
1511
+ #### [TotalPriceSetPresentmentMoney](#TotalPriceSetPresentmentMoney)
1512
+
1513
+ | Properties | Type | Nullable | Description |
1514
+ | ---------- | ---- | -------- | ----------- |
1515
+ | amount | string | no | |
1516
+ | currency_code | string | no | |
1517
+
1518
+ ---
1519
+
1520
+
1521
+
1522
+
1523
+ #### [TotalTaxSet](#TotalTaxSet)
1524
+
1525
+ | Properties | Type | Nullable | Description |
1526
+ | ---------- | ---- | -------- | ----------- |
1527
+ | shop_money | [TotalTaxSetShopMoney](#TotalTaxSetShopMoney) | no | |
1528
+ | presentment_money | [TotalTaxSetPresentmentMoney](#TotalTaxSetPresentmentMoney) | no | |
1529
+
1530
+ ---
1531
+
1532
+
1533
+
1534
+
1535
+ #### [TotalTaxSetShopMoney](#TotalTaxSetShopMoney)
1536
+
1537
+ | Properties | Type | Nullable | Description |
1538
+ | ---------- | ---- | -------- | ----------- |
1539
+ | amount | string | no | |
1540
+ | currency_code | string | no | |
1541
+
1542
+ ---
1543
+
1544
+
1545
+
1546
+
1547
+ #### [TotalTaxSetPresentmentMoney](#TotalTaxSetPresentmentMoney)
1548
+
1549
+ | Properties | Type | Nullable | Description |
1550
+ | ---------- | ---- | -------- | ----------- |
1551
+ | amount | string | no | |
1552
+ | currency_code | string | no | |
1553
+
1554
+ ---
1555
+
1556
+
1557
+
1558
+
1559
+ #### [SubtotalPriceSet](#SubtotalPriceSet)
1560
+
1561
+ | Properties | Type | Nullable | Description |
1562
+ | ---------- | ---- | -------- | ----------- |
1563
+ | shop_money | [SubtotalPriceSetShopMoney](#SubtotalPriceSetShopMoney) | no | |
1564
+ | presentment_money | [SubtotalPriceSetPresentmentMoney](#SubtotalPriceSetPresentmentMoney) | no | |
1565
+
1566
+ ---
1567
+
1568
+
1569
+
1570
+
1571
+ #### [SubtotalPriceSetShopMoney](#SubtotalPriceSetShopMoney)
1572
+
1573
+ | Properties | Type | Nullable | Description |
1574
+ | ---------- | ---- | -------- | ----------- |
1575
+ | amount | string | no | |
1576
+ | currency_code | string | no | |
1577
+
1578
+ ---
1579
+
1580
+
1581
+
1582
+
1583
+ #### [SubtotalPriceSetPresentmentMoney](#SubtotalPriceSetPresentmentMoney)
1584
+
1585
+ | Properties | Type | Nullable | Description |
1586
+ | ---------- | ---- | -------- | ----------- |
1587
+ | amount | string | no | |
1588
+ | currency_code | string | no | |
1589
+
1590
+ ---
1591
+
1592
+
1593
+
1594
+
1595
+ #### [LineItems](#LineItems)
1596
+
1597
+ | Properties | Type | Nullable | Description |
1598
+ | ---------- | ---- | -------- | ----------- |
1599
+ | sku | string | no | |
1600
+ | fulfillable_quantity | number | no | |
1601
+ | grams | number | no | |
1602
+ | total_discount | string | no | |
1603
+ | article | [LineItemsArticle](#LineItemsArticle) | no | |
1604
+ | title | string | no | |
1605
+ | variant_inventory_management | string | no | |
1606
+ | id | number | no | |
1607
+ | variant_id | number | no | |
1608
+ | variant_title | string | no | |
1609
+ | product_exists | boolean | no | |
1610
+ | price | string | no | |
1611
+ | admin_graphql_api_id | string | no | |
1612
+ | quantity | number | no | |
1613
+ | vendor | string | no | |
1614
+ | fulfillment_service | string | no | |
1615
+ | taxable | boolean | no | |
1616
+ | name | string | no | |
1617
+ | product_id | number | no | |
1618
+ | price_set | [PriceSet](#PriceSet) | no | |
1619
+ | tax_lines | [TaxLines](#TaxLines) | no | |
1620
+ | requires_shipping | boolean | no | |
1621
+ | gift_card | boolean | no | |
1622
+ | total_discount_set | [TotalDiscountSet](#TotalDiscountSet) | no | |
1623
+
1624
+ ---
1625
+
1626
+
1627
+
1628
+
1629
+ #### [LineItemsArticle](#LineItemsArticle)
1630
+
1631
+ | Properties | Type | Nullable | Description |
1632
+ | ---------- | ---- | -------- | ----------- |
1633
+ | quantities | [Quantities](#Quantities) | no | |
1634
+ | old_article_uid | string | no | |
1635
+ | total_quantity | number | no | |
1636
+ | manufacturer | [Manufacturer](#Manufacturer) | no | |
1637
+ | price | [ArticlePrice](#ArticlePrice) | no | |
1638
+ | track_inventory | boolean | no | |
1639
+ | company | [Company](#Company) | no | |
1640
+ | is_active | boolean | no | |
1641
+ | date_meta | [FailOrderDateMeta](#FailOrderDateMeta) | no | |
1642
+ | fragile | boolean | no | |
1643
+ | marketplace_identifiers | [MarketplaceIdentifiers](#MarketplaceIdentifiers) | no | |
1644
+ | size | string | no | |
1645
+ | is_set | boolean | no | |
1646
+ | dimension | [Dimension](#Dimension) | no | |
1647
+ | weight | [Weight](#Weight) | no | |
1648
+ | store | [Store](#Store) | no | |
1649
+ | meta | [ArticleMeta](#ArticleMeta) | no | |
1650
+ | uid | string | no | |
1651
+ | brand | [ArticleBrand](#ArticleBrand) | no | |
1652
+ | item_id | number | no | |
1653
+ | fynd_article_code | string | no | |
1654
+ | _id | string | no | |
1655
+ | identifier | [LineItemsArticleIdentifier](#LineItemsArticleIdentifier) | no | |
1656
+ | seller_identifier | string | no | |
1657
+ | fynd_item_code | string | no | |
1658
+ | country_of_origin | string | no | |
1659
+
1660
+ ---
1661
+
1662
+
1663
+
1664
+
1665
+ #### [Quantities](#Quantities)
1666
+
1667
+ | Properties | Type | Nullable | Description |
1668
+ | ---------- | ---- | -------- | ----------- |
1669
+ | not_available | [NotAvailable](#NotAvailable) | no | |
1670
+ | sellable | [Sellable](#Sellable) | no | |
1671
+ | order_committed | [OrderCommitted](#OrderCommitted) | no | |
1672
+ | damaged | [Damaged](#Damaged) | no | |
1673
+
1674
+ ---
1675
+
1676
+
1677
+
1678
+
1679
+ #### [NotAvailable](#NotAvailable)
1680
+
1681
+ | Properties | Type | Nullable | Description |
1682
+ | ---------- | ---- | -------- | ----------- |
1683
+ | count | number | no | |
1684
+ | updated_at | string | no | |
1685
+
1686
+ ---
1687
+
1688
+
1689
+
1690
+
1691
+ #### [Sellable](#Sellable)
1692
+
1693
+ | Properties | Type | Nullable | Description |
1694
+ | ---------- | ---- | -------- | ----------- |
1695
+ | count | number | no | |
1696
+ | updated_at | string | no | |
1697
+
1698
+ ---
1699
+
1700
+
1701
+
1702
+
1703
+ #### [OrderCommitted](#OrderCommitted)
1704
+
1705
+ | Properties | Type | Nullable | Description |
1706
+ | ---------- | ---- | -------- | ----------- |
1707
+ | count | number | no | |
1708
+ | updated_at | string | no | |
1709
+
1710
+ ---
1711
+
1712
+
1713
+
1714
+
1715
+ #### [Damaged](#Damaged)
1716
+
1717
+ | Properties | Type | Nullable | Description |
1718
+ | ---------- | ---- | -------- | ----------- |
1719
+ | updated_at | string | no | |
1720
+ | count | number | no | |
1721
+
1722
+ ---
1723
+
1724
+
1725
+
1726
+
1727
+ #### [Manufacturer](#Manufacturer)
1728
+
1729
+ | Properties | Type | Nullable | Description |
1730
+ | ---------- | ---- | -------- | ----------- |
1731
+ | is_default | boolean | no | |
1732
+ | address | string | no | |
1733
+ | name | string | no | |
1734
+
1735
+ ---
1736
+
1737
+
1738
+
1739
+
1740
+ #### [ArticlePrice](#ArticlePrice)
1741
+
1742
+ | Properties | Type | Nullable | Description |
1743
+ | ---------- | ---- | -------- | ----------- |
1744
+ | marked | number | no | |
1745
+ | currency | string | no | |
1746
+ | effective | number | no | |
1747
+ | transfer | number | no | |
1748
+
1749
+ ---
1750
+
1751
+
1752
+
1753
+
1754
+ #### [Company](#Company)
1755
+
1756
+ | Properties | Type | Nullable | Description |
1757
+ | ---------- | ---- | -------- | ----------- |
1758
+ | id | number | no | |
1759
+ | company_type | string | no | |
1760
+ | business_type | string | no | |
1761
+ | company_name | string | no | |
1762
+ | created_on | string | no | |
1763
+ | pan_no | string | no | |
1764
+ | return_allowed | boolean | no | |
1765
+ | meta | string | no | |
1766
+ | exchange_allowed | boolean | no | |
1767
+ | agreement_start_date | string | no | |
1768
+ | exchange_within_days | number | no | |
1769
+ | payment_procesing_charge | number | no | |
1770
+ | fynd_a_fit_available | boolean | no | |
1771
+ | modified_on | string | no | |
1772
+ | return_within_days | number | no | |
1773
+
1774
+ ---
1775
+
1776
+
1777
+
1778
+
1779
+ #### [FailOrderDateMeta](#FailOrderDateMeta)
1780
+
1781
+ | Properties | Type | Nullable | Description |
1782
+ | ---------- | ---- | -------- | ----------- |
1783
+ | added_on_store | string | no | |
1784
+ | inventory_updated_on | string | no | |
1785
+ | created_on | string | no | |
1786
+ | modified_on | string | no | |
1787
+
1788
+ ---
1789
+
1790
+
1791
+
1792
+
1793
+ #### [MarketplaceIdentifiers](#MarketplaceIdentifiers)
1794
+
1795
+ | Properties | Type | Nullable | Description |
1796
+ | ---------- | ---- | -------- | ----------- |
1797
+ | tatacliq_luxury | [TatacliqLuxury](#TatacliqLuxury) | no | |
1798
+
1799
+ ---
1800
+
1801
+
1802
+
1803
+
1804
+ #### [TatacliqLuxury](#TatacliqLuxury)
1805
+
1806
+ | Properties | Type | Nullable | Description |
1807
+ | ---------- | ---- | -------- | ----------- |
1808
+ | sku | string | no | |
1809
+
1810
+ ---
1811
+
1812
+
1813
+
1814
+
1815
+ #### [Dimension](#Dimension)
1816
+
1817
+ | Properties | Type | Nullable | Description |
1818
+ | ---------- | ---- | -------- | ----------- |
1819
+ | height | number | no | |
1820
+ | width | number | no | |
1821
+ | unit | string | no | |
1822
+ | length | number | no | |
1823
+ | is_default | boolean | no | |
1824
+
1825
+ ---
1826
+
1827
+
1828
+
1829
+
1830
+ #### [Weight](#Weight)
1831
+
1832
+ | Properties | Type | Nullable | Description |
1833
+ | ---------- | ---- | -------- | ----------- |
1834
+ | is_default | boolean | no | |
1835
+ | unit | string | no | |
1836
+ | shipping | number | no | |
1837
+
1838
+ ---
1839
+
1840
+
1841
+
1842
+
1843
+ #### [Store](#Store)
1844
+
1845
+ | Properties | Type | Nullable | Description |
1846
+ | ---------- | ---- | -------- | ----------- |
1847
+ | id | number | no | |
1848
+
1849
+ ---
1850
+
1851
+
1852
+
1853
+
1854
+ #### [ArticleMeta](#ArticleMeta)
1855
+
1856
+ | Properties | Type | Nullable | Description |
1857
+ | ---------- | ---- | -------- | ----------- |
1858
+ | service | string | no | |
1859
+
1860
+ ---
1861
+
1862
+
1863
+
1864
+
1865
+ #### [ArticleBrand](#ArticleBrand)
1866
+
1867
+ | Properties | Type | Nullable | Description |
1868
+ | ---------- | ---- | -------- | ----------- |
1869
+ | name | string | no | |
1870
+ | id | number | no | |
1871
+
1872
+ ---
1873
+
1874
+
1875
+
1876
+
1877
+ #### [LineItemsArticleIdentifier](#LineItemsArticleIdentifier)
1878
+
1879
+ | Properties | Type | Nullable | Description |
1880
+ | ---------- | ---- | -------- | ----------- |
1881
+ | sku_code | string | no | |
1882
+
1883
+ ---
1884
+
1885
+
1886
+
1887
+
1888
+ #### [PriceSet](#PriceSet)
1889
+
1890
+ | Properties | Type | Nullable | Description |
1891
+ | ---------- | ---- | -------- | ----------- |
1892
+ | shop_money | [PriceSetShopMoney](#PriceSetShopMoney) | no | |
1893
+ | presentment_money | [PriceSetPresentmentMoney](#PriceSetPresentmentMoney) | no | |
1894
+
1895
+ ---
1896
+
1897
+
1898
+
1899
+
1900
+ #### [PriceSetShopMoney](#PriceSetShopMoney)
1901
+
1902
+ | Properties | Type | Nullable | Description |
1903
+ | ---------- | ---- | -------- | ----------- |
1904
+ | amount | string | no | |
1905
+ | currency_code | string | no | |
1906
+
1907
+ ---
1908
+
1909
+
1910
+
1911
+
1912
+ #### [PriceSetPresentmentMoney](#PriceSetPresentmentMoney)
1913
+
1914
+ | Properties | Type | Nullable | Description |
1915
+ | ---------- | ---- | -------- | ----------- |
1916
+ | amount | string | no | |
1917
+ | currency_code | string | no | |
1918
+
1919
+ ---
1920
+
1921
+
1922
+
1923
+
1924
+ #### [TaxLines](#TaxLines)
1925
+
1926
+ | Properties | Type | Nullable | Description |
1927
+ | ---------- | ---- | -------- | ----------- |
1928
+ | title | string | no | |
1929
+ | price | string | no | |
1930
+ | rate | number | no | |
1931
+ | price_set | [TaxLinesPriceSet](#TaxLinesPriceSet) | no | |
1932
+
1933
+ ---
1934
+
1935
+
1936
+
1937
+
1938
+ #### [TaxLinesPriceSet](#TaxLinesPriceSet)
1939
+
1940
+ | Properties | Type | Nullable | Description |
1941
+ | ---------- | ---- | -------- | ----------- |
1942
+ | shop_money | [TaxLinesPriceSetShopMoney](#TaxLinesPriceSetShopMoney) | no | |
1943
+ | presentment_money | [TaxLinesPriceSetPresentmentMoney](#TaxLinesPriceSetPresentmentMoney) | no | |
1944
+
1945
+ ---
1946
+
1947
+
1948
+
1949
+
1950
+ #### [TaxLinesPriceSetShopMoney](#TaxLinesPriceSetShopMoney)
1951
+
1952
+ | Properties | Type | Nullable | Description |
1953
+ | ---------- | ---- | -------- | ----------- |
1954
+ | amount | string | no | |
1955
+ | currency_code | string | no | |
1956
+
1957
+ ---
1958
+
1959
+
1960
+
1961
+
1962
+ #### [TaxLinesPriceSetPresentmentMoney](#TaxLinesPriceSetPresentmentMoney)
1963
+
1964
+ | Properties | Type | Nullable | Description |
1965
+ | ---------- | ---- | -------- | ----------- |
1966
+ | currency_code | string | no | |
1967
+ | amount | string | no | |
1968
+
1969
+ ---
1970
+
1971
+
1972
+
1973
+
1974
+ #### [TotalDiscountSet](#TotalDiscountSet)
1975
+
1976
+ | Properties | Type | Nullable | Description |
1977
+ | ---------- | ---- | -------- | ----------- |
1978
+ | presentment_money | [TotalDiscountSetPresentmentMoney](#TotalDiscountSetPresentmentMoney) | no | |
1979
+ | shop_money | [TotalDiscountSetShopMoney](#TotalDiscountSetShopMoney) | no | |
1980
+
1981
+ ---
1982
+
1983
+
1984
+
1985
+
1986
+ #### [TotalDiscountSetPresentmentMoney](#TotalDiscountSetPresentmentMoney)
1987
+
1988
+ | Properties | Type | Nullable | Description |
1989
+ | ---------- | ---- | -------- | ----------- |
1990
+ | amount | string | no | |
1991
+ | currency_code | string | no | |
1992
+
1993
+ ---
1994
+
1995
+
1996
+
1997
+
1998
+ #### [TotalDiscountSetShopMoney](#TotalDiscountSetShopMoney)
1999
+
2000
+ | Properties | Type | Nullable | Description |
2001
+ | ---------- | ---- | -------- | ----------- |
2002
+ | amount | string | no | |
2003
+ | currency_code | string | no | |
2004
+
2005
+ ---
2006
+
2007
+
2008
+
2009
+
2010
+ #### [BillingAddress](#BillingAddress)
2011
+
2012
+ | Properties | Type | Nullable | Description |
2013
+ | ---------- | ---- | -------- | ----------- |
2014
+ | address1 | string | no | |
2015
+ | city | string | no | |
2016
+ | zip | string | no | |
2017
+ | last_name | string | no | |
2018
+ | address2 | string | no | |
2019
+ | latitude | number | no | |
2020
+ | longitude | number | no | |
2021
+ | province_code | string | no | |
2022
+ | phone | string | no | |
2023
+ | company | string | no | |
2024
+ | name | string | no | |
2025
+ | country | string | no | |
2026
+ | country_code | string | no | |
2027
+ | first_name | string | no | |
2028
+ | province | string | no | |
2029
+
2030
+ ---
2031
+
2032
+
2033
+
2034
+
2035
+ #### [TotalShippingPriceSet](#TotalShippingPriceSet)
2036
+
2037
+ | Properties | Type | Nullable | Description |
2038
+ | ---------- | ---- | -------- | ----------- |
2039
+ | shop_money | [TotalShippingPriceSetShopMoney](#TotalShippingPriceSetShopMoney) | no | |
2040
+ | presentment_money | [TotalShippingPriceSetPresentmentMoney](#TotalShippingPriceSetPresentmentMoney) | no | |
2041
+
2042
+ ---
2043
+
2044
+
2045
+
2046
+
2047
+ #### [TotalShippingPriceSetShopMoney](#TotalShippingPriceSetShopMoney)
2048
+
2049
+ | Properties | Type | Nullable | Description |
2050
+ | ---------- | ---- | -------- | ----------- |
2051
+ | amount | string | no | |
2052
+ | currency_code | string | no | |
2053
+
2054
+ ---
2055
+
2056
+
2057
+
2058
+
2059
+ #### [TotalShippingPriceSetPresentmentMoney](#TotalShippingPriceSetPresentmentMoney)
2060
+
2061
+ | Properties | Type | Nullable | Description |
2062
+ | ---------- | ---- | -------- | ----------- |
2063
+ | amount | string | no | |
2064
+ | currency_code | string | no | |
2065
+
2066
+ ---
2067
+
2068
+
2069
+
2070
+
2071
+ #### [Customer](#Customer)
2072
+
2073
+ | Properties | Type | Nullable | Description |
2074
+ | ---------- | ---- | -------- | ----------- |
2075
+ | created_at | string | no | |
2076
+ | id | number | no | |
2077
+ | last_name | string | no | |
2078
+ | state | string | no | |
2079
+ | last_order_id | number | no | |
2080
+ | note | string | no | |
2081
+ | verified_email | boolean | no | |
2082
+ | phone | string | no | |
2083
+ | accepts_marketing | boolean | no | |
2084
+ | first_name | string | no | |
2085
+ | tags | string | no | |
2086
+ | last_order_name | string | no | |
2087
+ | orders_count | number | no | |
2088
+ | total_spent | string | no | |
2089
+ | tax_exempt | boolean | no | |
2090
+ | currency | string | no | |
2091
+ | accepts_marketing_updated_at | string | no | |
2092
+ | email | string | no | |
2093
+ | updated_at | string | no | |
2094
+ | admin_graphql_api_id | string | no | |
2095
+ | default_address | [DefaultAddress](#DefaultAddress) | no | |
2096
+
2097
+ ---
2098
+
2099
+
2100
+
2101
+
2102
+ #### [DefaultAddress](#DefaultAddress)
2103
+
2104
+ | Properties | Type | Nullable | Description |
2105
+ | ---------- | ---- | -------- | ----------- |
2106
+ | last_name | string | no | |
2107
+ | name | string | no | |
2108
+ | province_code | string | no | |
2109
+ | country_code | string | no | |
2110
+ | is_default | boolean | no | |
2111
+ | id | number | no | |
2112
+ | customer_id | number | no | |
2113
+ | first_name | string | no | |
2114
+ | address1 | string | no | |
2115
+ | phone | string | no | |
2116
+ | country_name | string | no | |
2117
+ | company | string | no | |
2118
+ | address2 | string | no | |
2119
+ | city | string | no | |
2120
+ | province | string | no | |
2121
+ | country | string | no | |
2122
+ | zip | string | no | |
2123
+
2124
+ ---
2125
+
2126
+
2127
+
2128
+
2129
+ #### [TotalLineItemsPriceSet](#TotalLineItemsPriceSet)
2130
+
2131
+ | Properties | Type | Nullable | Description |
2132
+ | ---------- | ---- | -------- | ----------- |
2133
+ | shop_money | [TotalLineItemsPriceSetShopMoney](#TotalLineItemsPriceSetShopMoney) | no | |
2134
+ | presentment_money | [TotalLineItemsPriceSetPresentmentMoney](#TotalLineItemsPriceSetPresentmentMoney) | no | |
2135
+
2136
+ ---
2137
+
2138
+
2139
+
2140
+
2141
+ #### [TotalLineItemsPriceSetShopMoney](#TotalLineItemsPriceSetShopMoney)
2142
+
2143
+ | Properties | Type | Nullable | Description |
2144
+ | ---------- | ---- | -------- | ----------- |
2145
+ | amount | string | no | |
2146
+ | currency_code | string | no | |
2147
+
2148
+ ---
2149
+
2150
+
2151
+
2152
+
2153
+ #### [TotalLineItemsPriceSetPresentmentMoney](#TotalLineItemsPriceSetPresentmentMoney)
2154
+
2155
+ | Properties | Type | Nullable | Description |
2156
+ | ---------- | ---- | -------- | ----------- |
2157
+ | amount | string | no | |
2158
+ | currency_code | string | no | |
2159
+
2160
+ ---
2161
+
2162
+
2163
+
2164
+
2165
+ #### [OrderShippingAddress](#OrderShippingAddress)
2166
+
2167
+ | Properties | Type | Nullable | Description |
2168
+ | ---------- | ---- | -------- | ----------- |
2169
+ | address1 | string | no | |
2170
+ | zip | string | no | |
2171
+ | address2 | string | no | |
2172
+ | country_code | string | no | |
2173
+ | country | string | no | |
2174
+ | last_name | string | no | |
2175
+ | province_code | string | no | |
2176
+ | first_name | string | no | |
2177
+ | phone | string | no | |
2178
+ | province | string | no | |
2179
+ | latitude | number | no | |
2180
+ | longitude | number | no | |
2181
+ | city | string | no | |
2182
+ | company | string | no | |
2183
+ | name | string | no | |
2184
+
2185
+ ---
2186
+
2187
+
2188
+
2189
+
2190
+ #### [OrderListing](#OrderListing)
2191
+
2192
+ | Properties | Type | Nullable | Description |
2193
+ | ---------- | ---- | -------- | ----------- |
2194
+ | items | [[OrderItems](#OrderItems)] | yes | |
2195
+ | filters | [Filters](#Filters) | yes | |
2196
+ | next_order_status | string | yes | |
2197
+ | page | [PlatformOrderPage](#PlatformOrderPage) | yes | |
2198
+ | applied_filters | [AppliedFilters](#AppliedFilters) | yes | |
2199
+
2200
+ ---
2201
+
2202
+
2203
+
2204
+
2205
+ #### [OrderItems](#OrderItems)
2206
+
2207
+ | Properties | Type | Nullable | Description |
2208
+ | ---------- | ---- | -------- | ----------- |
2209
+ | user | [PlatformOrderUserInfo](#PlatformOrderUserInfo) | no | |
2210
+ | delivery_address | [PlatformDeliveryAddress](#PlatformDeliveryAddress) | no | |
2211
+ | channel | [Channel](#Channel) | no | |
2212
+ | id | string | no | |
2213
+ | application | [PlatformApplication](#PlatformApplication) | no | |
2214
+ | shipments | [PlatformShipment](#PlatformShipment) | no | |
2215
+ | created_at | string | no | |
2216
+ | total_shipments_in_order | number | no | |
2217
+
2218
+ ---
2219
+
2220
+
2221
+
2222
+
2223
+ #### [PlatformOrderUserInfo](#PlatformOrderUserInfo)
2224
+
2225
+ | Properties | Type | Nullable | Description |
2226
+ | ---------- | ---- | -------- | ----------- |
2227
+ | mobile | string | no | |
2228
+ | first_name | string | no | |
2229
+ | gender | string | no | |
2230
+ | email | string | no | |
2231
+ | last_name | string | no | |
2232
+ | is_anonymous_user | boolean | no | |
2233
+ | uid | number | no | |
2234
+ | avis_user_id | string | no | |
2235
+
2236
+ ---
2237
+
2238
+
2239
+
2240
+
2241
+ #### [PlatformDeliveryAddress](#PlatformDeliveryAddress)
2242
+
2243
+ | Properties | Type | Nullable | Description |
2244
+ | ---------- | ---- | -------- | ----------- |
2245
+ | area | string | no | |
2246
+ | state | string | no | |
2247
+ | country | string | no | |
2248
+ | version | string | no | |
2249
+ | address1 | string | no | |
2250
+ | updated_at | string | no | |
2251
+ | city | string | no | |
2252
+ | landmark | string | no | |
2253
+ | created_at | string | no | |
2254
+ | name | string | no | |
2255
+ | address | string | no | |
2256
+ | phone | string | no | |
2257
+ | latitude | number | no | |
2258
+ | longitude | number | no | |
2259
+ | address_type | string | no | |
2260
+ | email | string | no | |
2261
+ | pincode | string | no | |
2262
+ | address2 | string | no | |
2263
+ | contact_person | string | no | |
2264
+ | address_category | string | no | |
2265
+
2266
+ ---
2267
+
2268
+
2269
+
2270
+
2271
+ #### [Channel](#Channel)
2272
+
2273
+ | Properties | Type | Nullable | Description |
2274
+ | ---------- | ---- | -------- | ----------- |
2275
+ | name | string | no | |
2276
+ | logo | string | no | |
2277
+
2278
+ ---
2279
+
2280
+
2281
+
2282
+
2283
+ #### [PlatformApplication](#PlatformApplication)
2284
+
2285
+ | Properties | Type | Nullable | Description |
2286
+ | ---------- | ---- | -------- | ----------- |
2287
+ | id | string | no | |
2288
+
2289
+ ---
2290
+
2291
+
2292
+
2293
+
2294
+ #### [PlatformShipment](#PlatformShipment)
2295
+
2296
+ | Properties | Type | Nullable | Description |
2297
+ | ---------- | ---- | -------- | ----------- |
2298
+ | status | [PlatformShipmentStatus](#PlatformShipmentStatus) | no | |
2299
+ | bags | [Bags](#Bags) | no | |
2300
+ | prices | [ShipmentPrices](#ShipmentPrices) | no | |
2301
+ | id | string | no | |
2302
+ | gst | [ShipmentGst](#ShipmentGst) | no | |
2303
+ | priority | number | no | |
2304
+ | priority_text | string | no | |
2305
+ | lock_status | boolean | no | |
2306
+ | ordering_channel | string | no | |
2307
+ | total_shipment_bags | number | no | |
2308
+
2309
+ ---
2310
+
2311
+
2312
+
2313
+
2314
+ #### [PlatformShipmentStatus](#PlatformShipmentStatus)
2315
+
2316
+ | Properties | Type | Nullable | Description |
2317
+ | ---------- | ---- | -------- | ----------- |
2318
+ | id | number | no | |
2319
+ | bag_list | [number] | no | |
2320
+ | created_at | string | no | |
2321
+ | status | string | no | |
2322
+ | name | string | no | |
2323
+ | progress | number | no | |
2324
+ | shipment_id | string | no | |
2325
+ | current_shipment_status | string | no | |
2326
+ | color_code | string | no | |
2327
+
2328
+ ---
2329
+
2330
+
2331
+
2332
+
2333
+ #### [Bags](#Bags)
2334
+
2335
+ | Properties | Type | Nullable | Description |
2336
+ | ---------- | ---- | -------- | ----------- |
2337
+ | item | [BagItem](#BagItem) | no | |
2338
+ | id | number | no | |
2339
+
2340
+ ---
2341
+
2342
+
2343
+
2344
+
2345
+ #### [BagItem](#BagItem)
2346
+
2347
+ | Properties | Type | Nullable | Description |
2348
+ | ---------- | ---- | -------- | ----------- |
2349
+ | id | number | no | |
2350
+ | size | string | no | |
2351
+ | slug_key | string | no | |
2352
+ | can_return | boolean | no | |
2353
+ | brand_id | number | no | |
2354
+ | l2_category | [string] | no | |
2355
+ | name | string | no | |
2356
+ | code | string | no | |
2357
+ | can_cancel | boolean | no | |
2358
+ | attributes | [BagItemAttributes](#BagItemAttributes) | no | |
2359
+ | l3_category_name | string | no | |
2360
+ | l3_category | number | no | |
2361
+ | l1_category | [string] | no | |
2362
+ | image | [string] | no | |
2363
+ | brand | string | no | |
2364
+ | last_updated_at | string | no | |
2365
+
2366
+ ---
2367
+
2368
+
2369
+
2370
+
2371
+ #### [BagItemAttributes](#BagItemAttributes)
2372
+
2373
+ | Properties | Type | Nullable | Description |
2374
+ | ---------- | ---- | -------- | ----------- |
2375
+ | item_code | string | no | |
2376
+ | brand_name | string | no | |
2377
+ | country_of_origin | string | no | |
2378
+
2379
+ ---
2380
+
2381
+
2382
+
2383
+
2384
+ #### [ShipmentPrices](#ShipmentPrices)
2385
+
2386
+ | Properties | Type | Nullable | Description |
2387
+ | ---------- | ---- | -------- | ----------- |
2388
+ | refund_amount | number | no | |
2389
+ | cashback_applied | number | no | |
2390
+ | transfer_price | number | no | |
2391
+ | coupon_value | number | no | |
2392
+ | amount_paid | number | no | |
2393
+ | delivery_charge | number | no | |
2394
+ | coupon_effective_discount | number | no | |
2395
+ | cod_charges | number | no | |
2396
+ | refund_credit | number | no | |
2397
+ | added_to_fynd_cash | boolean | no | |
2398
+ | gst_tax_percentage | number | no | |
2399
+ | price_marked | number | no | |
2400
+ | price_effective | number | no | |
2401
+ | discount | number | no | |
2402
+ | promotion_effective_discount | number | no | |
2403
+ | amount_paid_roundoff | number | no | |
2404
+ | fynd_credits | number | no | |
2405
+ | brand_calculated_amount | number | no | |
2406
+ | cashback | number | no | |
2407
+ | value_of_good | number | no | |
2408
+
2409
+ ---
2410
+
2411
+
2412
+
2413
+
2414
+ #### [Payments](#Payments)
2415
+
2416
+ | Properties | Type | Nullable | Description |
2417
+ | ---------- | ---- | -------- | ----------- |
2418
+ | is_active | boolean | no | |
2419
+ | display_name | string | no | |
2420
+ | logo | string | no | |
2421
+ | source | string | no | |
2422
+ | source_nickname | string | no | |
2423
+ | display_priority | number | no | |
2424
+ | id | number | no | |
2425
+ | mode | string | no | |
2426
+ | payment_identifier | string | no | |
2427
+
2428
+ ---
2429
+
2430
+
2431
+
2432
+
2433
+ #### [Filters](#Filters)
2434
+
2435
+ | Properties | Type | Nullable | Description |
2436
+ | ---------- | ---- | -------- | ----------- |
2437
+ | stage | [Stage](#Stage) | no | |
2438
+ | stages | [Stages](#Stages) | no | |
2439
+
2440
+ ---
2441
+
2442
+
2443
+
2444
+
2445
+ #### [Stage](#Stage)
2446
+
2447
+ | Properties | Type | Nullable | Description |
2448
+ | ---------- | ---- | -------- | ----------- |
2449
+ | text | string | no | |
2450
+ | value | string | no | |
2451
+ | is_default | boolean | no | |
2452
+ | filters | [StagesFilters](#StagesFilters) | no | |
2453
+
2454
+ ---
2455
+
2456
+
2457
+
2458
+
2459
+ #### [StagesFilters](#StagesFilters)
2460
+
2461
+ | Properties | Type | Nullable | Description |
2462
+ | ---------- | ---- | -------- | ----------- |
2463
+ | text | string | no | |
2464
+ | value | string | no | |
2465
+ | type | string | no | |
2466
+ | options | [Options](#Options) | no | |
2467
+
2468
+ ---
2469
+
2470
+
2471
+
2472
+
2473
+ #### [Options](#Options)
2474
+
2475
+ | Properties | Type | Nullable | Description |
2476
+ | ---------- | ---- | -------- | ----------- |
2477
+ | text | string | no | |
2478
+ | value | string | no | |
2479
+
2480
+ ---
2481
+
2482
+
2483
+
2484
+
2485
+ #### [PlatformOrderPage](#PlatformOrderPage)
2486
+
2487
+ | Properties | Type | Nullable | Description |
2488
+ | ---------- | ---- | -------- | ----------- |
2489
+ | next | string | no | |
2490
+ | previous | string | no | |
2491
+ | type | string | no | |
2492
+ | size | number | no | |
2493
+ | current | number | no | |
2494
+ | has_next | boolean | no | |
2495
+ | total | number | no | |
2496
+ | item_total | [ItemTotal](#ItemTotal) | no | |
2497
+
2498
+ ---
2499
+
2500
+
2501
+
2502
+
2503
+ #### [AppliedFilters](#AppliedFilters)
2504
+
2505
+ | Properties | Type | Nullable | Description |
2506
+ | ---------- | ---- | -------- | ----------- |
2507
+ | stage | string | no | |
2508
+ | stores | [string] | no | |
2509
+ | deployment_stores | [string] | no | |
2510
+ | dp | [number] | no | |
2511
+ | from_date | string | no | |
2512
+ | to_date | string | no | |
2513
+
2514
+ ---
2515
+
2516
+
2517
+
2518
+
2519
+ #### [OrderDetails](#OrderDetails)
2520
+
2521
+ | Properties | Type | Nullable | Description |
2522
+ | ---------- | ---- | -------- | ----------- |
2523
+ | items | [[OrderPicklistListing](#OrderPicklistListing)] | yes | |
2524
+ | page | [PlatformOrderPage](#PlatformOrderPage) | yes | |
2525
+ | filters | [Filters](#Filters) | yes | |
2526
+ | next_order_status | string | yes | |
2527
+ | applied_filters | [AppliedFilters](#AppliedFilters) | yes | |
2528
+
2529
+ ---
2530
+
2531
+
2532
+
2533
+
2534
+ #### [OrderDetailsItem](#OrderDetailsItem)
2535
+
2536
+ | Properties | Type | Nullable | Description |
2537
+ | ---------- | ---- | -------- | ----------- |
2538
+ | user | [PlatformOrderUserInfo](#PlatformOrderUserInfo) | no | |
2539
+ | delivery_address | [PlatformDeliveryAddress](#PlatformDeliveryAddress) | no | |
2540
+ | channel | [Channel](#Channel) | no | |
2541
+ | fyndstore_emp | string | no | |
2542
+ | ordering_store | string | no | |
2543
+ | breakup_values | [[PlatformBreakupValues](#PlatformBreakupValues)] | no | |
2544
+ | id | string | no | |
2545
+ | application | [PlatformApplication](#PlatformApplication) | no | |
2546
+ | shipments | [PlatformShipmentDetails](#PlatformShipmentDetails) | no | |
2547
+ | created_at | string | no | |
2548
+ | total_shipments_in_order | number | no | |
2549
+ | payments | [ItemsPayments](#ItemsPayments) | no | |
2550
+ | payment_methods | string | no | |
2551
+
2552
+ ---
2553
+
2554
+
2555
+
2556
+
2557
+ #### [PlatformBreakupValues](#PlatformBreakupValues)
2558
+
2559
+ | Properties | Type | Nullable | Description |
2560
+ | ---------- | ---- | -------- | ----------- |
2561
+ | display | string | no | |
2562
+ | value | number | no | |
2563
+ | name | string | no | |
2564
+
2565
+ ---
2566
+
2567
+
2568
+
2569
+
2570
+ #### [ArticleAssignment](#ArticleAssignment)
2571
+
2572
+ | Properties | Type | Nullable | Description |
2573
+ | ---------- | ---- | -------- | ----------- |
2574
+ | strategy | string | no | |
2575
+ | level | string | no | |
2576
+
2577
+ ---
2578
+
2579
+
2580
+
2581
+
2582
+ #### [PlatformShipmentDetails](#PlatformShipmentDetails)
2583
+
2584
+ | Properties | Type | Nullable | Description |
2585
+ | ---------- | ---- | -------- | ----------- |
2586
+ | status | [PlatformShipmentDetailsStatus](#PlatformShipmentDetailsStatus) | no | |
2587
+ | bags | [[BagsDetails](#BagsDetails)] | no | |
2588
+ | prices | [ShipmentPrices](#ShipmentPrices) | no | |
2589
+ | breakup_values | [[ShipmentBreakupValues](#ShipmentBreakupValues)] | no | |
2590
+ | id | string | no | |
2591
+ | dp_details | [DpDetails](#DpDetails) | no | |
2592
+ | payment_methods | string | no | |
2593
+ | invoice | [ShipmentInvoice](#ShipmentInvoice) | no | |
2594
+ | fulfilling_store | [PlatformFulfillingStore](#PlatformFulfillingStore) | no | |
2595
+ | payments | [Payments](#Payments) | no | |
2596
+ | gst | [ShipmentGst](#ShipmentGst) | no | |
2597
+ | company | [Company](#Company) | no | |
2598
+ | brand | [PlatformShipmentDetailsBrand](#PlatformShipmentDetailsBrand) | no | |
2599
+ | coupon | string | no | |
2600
+ | order_source | string | no | |
2601
+ | is_not_fynd_source | boolean | no | |
2602
+ | can_break | string | no | |
2603
+ | comment | string | no | |
2604
+ | promise | [Promise](#Promise) | no | |
2605
+ | tracking_details | [[ShipmentTrackingDetails](#ShipmentTrackingDetails)] | no | |
2606
+ | is_fynd_coupon | boolean | no | |
2607
+ | order_type | string | no | |
2608
+ | total_shipment_bags | number | no | |
2609
+ | pod | string | no | |
2610
+ | lock_status | boolean | no | |
2611
+ | priority | number | no | |
2612
+ | priority_text | string | no | |
2613
+ | ordering_channel | string | no | |
2614
+ | credit_note_id | string | no | |
2615
+ | auto_trigger_dp_assignment | boolean | no | |
2616
+ | packaging_type | string | no | |
2617
+ | dates | [ShipmentDates](#ShipmentDates) | no | |
2618
+
2619
+ ---
2620
+
2621
+
2622
+
2623
+
2624
+ #### [PlatformShipmentDetailsStatus](#PlatformShipmentDetailsStatus)
2625
+
2626
+ | Properties | Type | Nullable | Description |
2627
+ | ---------- | ---- | -------- | ----------- |
2628
+ | id | number | no | |
2629
+ | bag_list | [number] | no | |
2630
+ | created_at | string | no | |
2631
+ | status | string | no | |
2632
+ | name | string | no | |
2633
+ | progress | number | no | |
2634
+ | shipment_id | string | no | |
2635
+ | current_shipment_status | string | no | |
2636
+ | color_code | string | no | |
2637
+
2638
+ ---
2639
+
2640
+
2641
+
2642
+
2643
+ #### [BagsDetails](#BagsDetails)
2644
+
2645
+ | Properties | Type | Nullable | Description |
2646
+ | ---------- | ---- | -------- | ----------- |
2647
+ | financial_breakup | [[BagFinancialBreakup](#BagFinancialBreakup)] | no | |
2648
+ | status | [BagCurrStatus](#BagCurrStatus) | no | |
2649
+ | item | [BagItem](#BagItem) | no | |
2650
+ | article | [BagArticle](#BagArticle) | no | |
2651
+ | id | number | no | |
2652
+ | prices | [BagPrices](#BagPrices) | no | |
2653
+ | gst_details | [GstDetails](#GstDetails) | no | |
2654
+ | breakup_values | [[BagBreakupValues](#BagBreakupValues)] | no | |
2655
+ | update_time | number | no | |
2656
+ | current_status | [BagCurrentStatus](#BagCurrentStatus) | no | |
2657
+ | bag_status | [BagStatus](#BagStatus) | no | |
2658
+ | can_cancel | boolean | no | |
2659
+ | can_return | boolean | no | |
2660
+ | payment_methods | string | no | |
2661
+
2662
+ ---
2663
+
2664
+
2665
+
2666
+
2667
+ #### [BagFinancialBreakup](#BagFinancialBreakup)
2668
+
2669
+ | Properties | Type | Nullable | Description |
2670
+ | ---------- | ---- | -------- | ----------- |
2671
+ | value_of_good | number | no | |
2672
+ | hsn_code | string | no | |
2673
+ | price_effective | number | no | |
2674
+ | cod_charges | number | no | |
2675
+ | gst_fee | number | no | |
2676
+ | fynd_credits | number | no | |
2677
+ | refund_amount | number | no | |
2678
+ | cashback_applied | number | no | |
2679
+ | transfer_price | number | no | |
2680
+ | amount_paid_roundoff | number | no | |
2681
+ | coupon_value | number | no | |
2682
+ | amount_paid | number | no | |
2683
+ | gst_tax_percentage | number | no | |
2684
+ | size | string | no | |
2685
+ | total_units | number | no | |
2686
+ | discount | number | no | |
2687
+ | coupon_effective_discount | number | no | |
2688
+ | cashback | number | no | |
2689
+ | promotion_effective_discount | number | no | |
2690
+ | gst_tag | string | no | |
2691
+ | delivery_charge | number | no | |
2692
+ | refund_credit | number | no | |
2693
+ | price_marked | number | no | |
2694
+ | identifiers | [Identifiers](#Identifiers) | no | |
2695
+ | item_name | string | no | |
2696
+ | added_to_fynd_cash | boolean | no | |
2697
+ | brand_calculated_amount | number | no | |
2698
+
2699
+ ---
2700
+
2701
+
2702
+
2703
+
2704
+ #### [Identifiers](#Identifiers)
2705
+
2706
+ | Properties | Type | Nullable | Description |
2707
+ | ---------- | ---- | -------- | ----------- |
2708
+ | ean | string | no | |
2709
+
2710
+ ---
2711
+
2712
+
2713
+
2714
+
2715
+ #### [BagCurrStatus](#BagCurrStatus)
2716
+
2717
+ | Properties | Type | Nullable | Description |
2718
+ | ---------- | ---- | -------- | ----------- |
2719
+ | enable_tracking | boolean | no | |
2720
+ | is_customer_return_allowed | boolean | no | |
2721
+ | is_active | boolean | no | |
2722
+ | is_returnable | boolean | no | |
2723
+ | can_be_cancelled | boolean | no | |
2724
+
2725
+ ---
2726
+
2727
+
2728
+
2729
+
2730
+ #### [BagArticle](#BagArticle)
2731
+
2732
+ | Properties | Type | Nullable | Description |
2733
+ | ---------- | ---- | -------- | ----------- |
2734
+ | identifiers | [ArticleIdentifiers](#ArticleIdentifiers) | no | |
2735
+ | esp_modified | boolean | no | |
2736
+ | is_set | boolean | no | |
2737
+ | size | string | no | |
2738
+ | code | string | no | |
2739
+ | set | [Set](#Set) | no | |
2740
+ | seller_identifier | string | no | |
2741
+ | return_config | [BagArticleReturnConfig](#BagArticleReturnConfig) | no | |
2742
+ | _id | string | no | |
2743
+ | uid | string | no | |
2744
+ | child_details | string | no | |
2745
+
2746
+ ---
2747
+
2748
+
2749
+
2750
+
2751
+ #### [ArticleIdentifiers](#ArticleIdentifiers)
2752
+
2753
+ | Properties | Type | Nullable | Description |
2754
+ | ---------- | ---- | -------- | ----------- |
2755
+ | ean | string | no | |
2756
+
2757
+ ---
2758
+
2759
+
2760
+
2761
+
2762
+ #### [Set](#Set)
2763
+
2764
+ | Properties | Type | Nullable | Description |
2765
+ | ---------- | ---- | -------- | ----------- |
2766
+ | quantity | number | no | |
2767
+ | size_distribution | [SetSizeDistribution](#SetSizeDistribution) | no | |
2768
+
2769
+ ---
2770
+
2771
+
2772
+
2773
+
2774
+ #### [SetSizeDistribution](#SetSizeDistribution)
2775
+
2776
+ | Properties | Type | Nullable | Description |
2777
+ | ---------- | ---- | -------- | ----------- |
2778
+ | sizes | [Sizes](#Sizes) | no | |
2779
+
2780
+ ---
2781
+
2782
+
2783
+
2784
+
2785
+ #### [Sizes](#Sizes)
2786
+
2787
+ | Properties | Type | Nullable | Description |
2788
+ | ---------- | ---- | -------- | ----------- |
2789
+ | size | string | no | |
2790
+ | pieces | number | no | |
2791
+
2792
+ ---
2793
+
2794
+
2795
+
2796
+
2797
+ #### [BagArticleReturnConfig](#BagArticleReturnConfig)
2798
+
2799
+ | Properties | Type | Nullable | Description |
2800
+ | ---------- | ---- | -------- | ----------- |
2801
+ | time | number | no | |
2802
+ | unit | string | no | |
2803
+ | returnable | boolean | no | |
2804
+
2805
+ ---
2806
+
2807
+
2808
+
2809
+
2810
+ #### [GstDetails](#GstDetails)
2811
+
2812
+ | Properties | Type | Nullable | Description |
2813
+ | ---------- | ---- | -------- | ----------- |
2814
+ | brand_calculated_amount | number | no | |
2815
+ | gst_fee | number | no | |
2816
+ | gst_tag | string | no | |
2817
+ | hsn_code | string | no | |
2818
+ | value_of_good | number | no | |
2819
+ | gst_tax_percentage | number | no | |
2820
+ | is_default_hsn_code | boolean | no | |
2821
+
2822
+ ---
2823
+
2824
+
2825
+
2826
+
2827
+ #### [BagBreakupValues](#BagBreakupValues)
2828
+
2829
+ | Properties | Type | Nullable | Description |
2830
+ | ---------- | ---- | -------- | ----------- |
2831
+ | name | string | no | |
2832
+ | display | string | no | |
2833
+ | value | number | no | |
2834
+
2835
+ ---
2836
+
2837
+
2838
+
2839
+
2840
+ #### [BagCurrentStatus](#BagCurrentStatus)
2841
+
2842
+ | Properties | Type | Nullable | Description |
2843
+ | ---------- | ---- | -------- | ----------- |
2844
+ | updated_at | string | no | |
2845
+ | bag_state_mapper | [BagStateMapper](#BagStateMapper) | no | |
2846
+ | status | string | no | |
2847
+ | state_type | string | no | |
2848
+
2849
+ ---
2850
+
2851
+
2852
+
2853
+
2854
+ #### [BagStateMapper](#BagStateMapper)
2855
+
2856
+ | Properties | Type | Nullable | Description |
2857
+ | ---------- | ---- | -------- | ----------- |
2858
+ | app_state_name | string | no | |
2859
+ | is_active | boolean | no | |
2860
+ | display_name | string | no | |
2861
+ | name | string | no | |
2862
+ | app_display_name | string | no | |
2863
+
2864
+ ---
2865
+
2866
+
2867
+
2868
+
2869
+ #### [BagStatus](#BagStatus)
2870
+
2871
+ | Properties | Type | Nullable | Description |
2872
+ | ---------- | ---- | -------- | ----------- |
2873
+ | status | string | no | |
2874
+ | state_type | string | no | |
2875
+ | updated_at | string | no | |
2876
+ | bag_state_mapper | [BagStatusBagStateMapper](#BagStatusBagStateMapper) | no | |
2877
+
2878
+ ---
2879
+
2880
+
2881
+
2882
+
2883
+ #### [BagStatusBagStateMapper](#BagStatusBagStateMapper)
2884
+
2885
+ | Properties | Type | Nullable | Description |
2886
+ | ---------- | ---- | -------- | ----------- |
2887
+ | is_active | boolean | no | |
2888
+ | display_name | string | no | |
2889
+ | name | string | no | |
2890
+ | app_display_name | string | no | |
2891
+ | app_state_name | string | no | |
2892
+
2893
+ ---
2894
+
2895
+
2896
+
2897
+
2898
+ #### [BagPrices](#BagPrices)
2899
+
2900
+ | Properties | Type | Nullable | Description |
2901
+ | ---------- | ---- | -------- | ----------- |
2902
+ | cashback | number | no | |
2903
+ | refund_credit | number | no | |
2904
+ | coupon_value | number | no | |
2905
+ | delivery_charge | number | no | |
2906
+ | fynd_credits | number | no | |
2907
+ | price_marked | number | no | |
2908
+ | cashback_applied | number | no | |
2909
+ | value_of_good | number | no | |
2910
+ | amount_paid_roundoff | number | no | |
2911
+ | amount_paid | number | no | |
2912
+ | cod_charges | number | no | |
2913
+ | price_effective | number | no | |
2914
+ | refund_amount | number | no | |
2915
+ | discount | number | no | |
2916
+
2917
+ ---
2918
+
2919
+
2920
+
2921
+
2922
+ #### [ShipmentBreakupValues](#ShipmentBreakupValues)
2923
+
2924
+ | Properties | Type | Nullable | Description |
2925
+ | ---------- | ---- | -------- | ----------- |
2926
+ | name | string | no | |
2927
+ | display | string | no | |
2928
+ | value | number | no | |
2929
+
2930
+ ---
2931
+
2932
+
2933
+
2934
+
2935
+ #### [DpDetails](#DpDetails)
2936
+
2937
+ | Properties | Type | Nullable | Description |
2938
+ | ---------- | ---- | -------- | ----------- |
2939
+ | gst_tag | string | no | |
2940
+
2941
+ ---
2942
+
2943
+
2944
+
2945
+
2946
+ #### [ShipmentInvoice](#ShipmentInvoice)
2947
+
2948
+ | Properties | Type | Nullable | Description |
2949
+ | ---------- | ---- | -------- | ----------- |
2950
+ | payment_type | string | no | |
2951
+ | updated_date | string | no | |
2952
+ | invoice_url | string | no | |
2953
+ | label_url | string | no | |
2954
+ | payment_mode | string | no | |
2955
+ | amount_to_collect | number | no | |
2956
+ | rto_address | [RtoAddress](#RtoAddress) | no | |
2957
+
2958
+ ---
2959
+
2960
+
2961
+
2962
+
2963
+ #### [RtoAddress](#RtoAddress)
2964
+
2965
+ | Properties | Type | Nullable | Description |
2966
+ | ---------- | ---- | -------- | ----------- |
2967
+ | name | string | no | |
2968
+ | id | number | no | |
2969
+ | phone | string | no | |
2970
+ | location_type | string | no | |
2971
+ | store_address_json | [StoreAddressJson](#StoreAddressJson) | no | |
2972
+ | code | string | no | |
2973
+ | address1 | string | no | |
2974
+ | city | string | no | |
2975
+ | country | string | no | |
2976
+ | pincode | string | no | |
2977
+ | company_id | number | no | |
2978
+ | contact_person | string | no | |
2979
+ | state | string | no | |
2980
+ | store_email | string | no | |
2981
+ | address2 | string | no | |
2982
+
2983
+ ---
2984
+
2985
+
2986
+
2987
+
2988
+ #### [StoreAddressJson](#StoreAddressJson)
2989
+
2990
+ | Properties | Type | Nullable | Description |
2991
+ | ---------- | ---- | -------- | ----------- |
2992
+ | country | string | no | |
2993
+ | updated_at | string | no | |
2994
+ | area | string | no | |
2995
+ | state | string | no | |
2996
+ | address_type | string | no | |
2997
+ | city | string | no | |
2998
+ | pincode | string | no | |
2999
+ | address1 | string | no | |
3000
+ | address2 | string | no | |
3001
+ | latitude | number | no | |
3002
+ | longitude | number | no | |
3003
+ | email | string | no | |
3004
+ | phone | string | no | |
3005
+ | created_at | string | no | |
3006
+ | contact_person | string | no | |
3007
+ | address_category | string | no | |
3008
+ | version | string | no | |
3009
+ | landmark | string | no | |
3010
+
3011
+ ---
3012
+
3013
+
3014
+
3015
+
3016
+ #### [PlatformFulfillingStore](#PlatformFulfillingStore)
3017
+
3018
+ | Properties | Type | Nullable | Description |
3019
+ | ---------- | ---- | -------- | ----------- |
3020
+ | packaging_material_count | number | no | |
3021
+ | location_type | string | no | |
3022
+ | code | string | no | |
3023
+ | city | string | no | |
3024
+ | meta | [FulfillingStoreMeta](#FulfillingStoreMeta) | no | |
3025
+ | name | string | no | |
3026
+ | is_active | boolean | no | |
3027
+ | address1 | string | no | |
3028
+ | store_email | string | no | |
3029
+ | is_archived | boolean | no | |
3030
+ | state | string | no | |
3031
+ | address2 | string | no | |
3032
+ | contact_person | string | no | |
3033
+ | phone | string | no | |
3034
+ | is_enabled_for_recon | boolean | no | |
3035
+ | fulfillment_channel | string | no | |
3036
+ | created_at | string | no | |
3037
+ | id | number | no | |
3038
+ | pincode | string | no | |
3039
+ | brand_store_tags | [string] | no | |
3040
+ | company_id | number | no | |
3041
+ | store_address_json | [FulfillingStoreStoreAddressJson](#FulfillingStoreStoreAddressJson) | no | |
3042
+ | updated_at | string | no | |
3043
+ | login_username | string | no | |
3044
+ | country | string | no | |
3045
+
3046
+ ---
3047
+
3048
+
3049
+
3050
+
3051
+ #### [FulfillingStoreMeta](#FulfillingStoreMeta)
3052
+
3053
+ | Properties | Type | Nullable | Description |
3054
+ | ---------- | ---- | -------- | ----------- |
3055
+ | additional_contact_details | [AdditionalContactDetails](#AdditionalContactDetails) | no | |
3056
+ | documents | [Documents](#Documents) | no | |
3057
+ | gst_number | string | no | |
3058
+ | display_name | string | no | |
3059
+ | product_return_config | [ProductReturnConfig](#ProductReturnConfig) | no | |
3060
+ | allow_dp_assignment_from_fynd | boolean | no | |
3061
+ | stage | string | no | |
3062
+ | timing | [Timing](#Timing) | no | |
3063
+
3064
+ ---
3065
+
3066
+
3067
+
3068
+
3069
+ #### [AdditionalContactDetails](#AdditionalContactDetails)
3070
+
3071
+ | Properties | Type | Nullable | Description |
3072
+ | ---------- | ---- | -------- | ----------- |
3073
+ | number | [string] | no | |
3074
+
3075
+ ---
3076
+
3077
+
3078
+
3079
+
3080
+ #### [Documents](#Documents)
3081
+
3082
+ | Properties | Type | Nullable | Description |
3083
+ | ---------- | ---- | -------- | ----------- |
3084
+ | gst | [Gst](#Gst) | no | |
3085
+
3086
+ ---
3087
+
3088
+
3089
+
3090
+
3091
+ #### [Gst](#Gst)
3092
+
3093
+ | Properties | Type | Nullable | Description |
3094
+ | ---------- | ---- | -------- | ----------- |
3095
+ | legal_name | string | no | |
3096
+ | type | string | no | |
3097
+ | value | string | no | |
3098
+ | verified | boolean | no | |
3099
+
3100
+ ---
3101
+
3102
+
3103
+
3104
+
3105
+ #### [ProductReturnConfig](#ProductReturnConfig)
3106
+
3107
+ | Properties | Type | Nullable | Description |
3108
+ | ---------- | ---- | -------- | ----------- |
3109
+ | on_same_store | boolean | no | |
3110
+
3111
+ ---
3112
+
3113
+
3114
+
3115
+
3116
+ #### [Timing](#Timing)
3117
+
3118
+ | Properties | Type | Nullable | Description |
3119
+ | ---------- | ---- | -------- | ----------- |
3120
+ | opening | [Opening](#Opening) | no | |
3121
+ | weekday | string | no | |
3122
+ | open | boolean | no | |
3123
+ | closing | [Closing](#Closing) | no | |
3124
+
3125
+ ---
3126
+
3127
+
3128
+
3129
+
3130
+ #### [Opening](#Opening)
3131
+
3132
+ | Properties | Type | Nullable | Description |
3133
+ | ---------- | ---- | -------- | ----------- |
3134
+ | minute | number | no | |
3135
+ | hour | number | no | |
3136
+
3137
+ ---
3138
+
3139
+
3140
+
3141
+
3142
+ #### [Closing](#Closing)
3143
+
3144
+ | Properties | Type | Nullable | Description |
3145
+ | ---------- | ---- | -------- | ----------- |
3146
+ | hour | number | no | |
3147
+ | minute | number | no | |
3148
+
3149
+ ---
3150
+
3151
+
3152
+
3153
+
3154
+ #### [FulfillingStoreStoreAddressJson](#FulfillingStoreStoreAddressJson)
3155
+
3156
+ | Properties | Type | Nullable | Description |
3157
+ | ---------- | ---- | -------- | ----------- |
3158
+ | address2 | string | no | |
3159
+ | area | string | no | |
3160
+ | email | string | no | |
3161
+ | phone | string | no | |
3162
+ | state | string | no | |
3163
+ | contact_person | string | no | |
3164
+ | country | string | no | |
3165
+ | pincode | string | no | |
3166
+ | version | string | no | |
3167
+ | created_at | string | no | |
3168
+ | address_type | string | no | |
3169
+ | city | string | no | |
3170
+ | address1 | string | no | |
3171
+ | landmark | string | no | |
3172
+ | latitude | number | no | |
3173
+ | longitude | number | no | |
3174
+ | updated_at | string | no | |
3175
+ | address_category | string | no | |
3176
+
3177
+ ---
3178
+
3179
+
3180
+
3181
+
3182
+ #### [ShipmentGst](#ShipmentGst)
3183
+
3184
+ | Properties | Type | Nullable | Description |
3185
+ | ---------- | ---- | -------- | ----------- |
3186
+ | brand_calculated_amount | number | no | |
3187
+ | value_of_good | number | no | |
3188
+ | gst_fee | number | no | |
3189
+
3190
+ ---
3191
+
3192
+
3193
+
3194
+
3195
+ #### [PlatformShipmentDetailsBrand](#PlatformShipmentDetailsBrand)
3196
+
3197
+ | Properties | Type | Nullable | Description |
3198
+ | ---------- | ---- | -------- | ----------- |
3199
+ | credit_note_allowed | boolean | no | |
3200
+ | brand_name | string | no | |
3201
+ | modified_on | string | no | |
3202
+ | id | number | no | |
3203
+ | is_virtual_invoice | boolean | no | |
3204
+ | created_on | string | no | |
3205
+ | logo | string | no | |
3206
+
3207
+ ---
3208
+
3209
+
3210
+
3211
+
3212
+ #### [Promise](#Promise)
3213
+
3214
+ | Properties | Type | Nullable | Description |
3215
+ | ---------- | ---- | -------- | ----------- |
3216
+ | timestamp | [Timestamp](#Timestamp) | no | |
3217
+
3218
+ ---
3219
+
3220
+
3221
+
3222
+
3223
+ #### [Timestamp](#Timestamp)
3224
+
3225
+ | Properties | Type | Nullable | Description |
3226
+ | ---------- | ---- | -------- | ----------- |
3227
+ | min | string | no | |
3228
+ | max | string | no | |
3229
+
3230
+ ---
3231
+
3232
+
3233
+
3234
+
3235
+ #### [ShipmentTrackingDetails](#ShipmentTrackingDetails)
3236
+
3237
+ | Properties | Type | Nullable | Description |
3238
+ | ---------- | ---- | -------- | ----------- |
3239
+ | status | string | no | |
3240
+ | time | string | no | |
3241
+ | is_passed | boolean | no | |
3242
+ | is_current | boolean | no | |
3243
+
3244
+ ---
3245
+
3246
+
3247
+
3248
+
3249
+ #### [ItemsPayments](#ItemsPayments)
3250
+
3251
+ | Properties | Type | Nullable | Description |
3252
+ | ---------- | ---- | -------- | ----------- |
3253
+ | display_priority | number | no | |
3254
+ | id | number | no | |
3255
+ | is_active | boolean | no | |
3256
+ | display_name | string | no | |
3257
+ | logo | string | no | |
3258
+ | payment_identifier | string | no | |
3259
+ | source_nickname | string | no | |
3260
+ | mode | string | no | |
3261
+ | source | string | no | |
3262
+
3263
+ ---
3264
+
3265
+
3266
+
3267
+
3268
+ #### [PlatformOrderDetailsPage](#PlatformOrderDetailsPage)
3269
+
3270
+ | Properties | Type | Nullable | Description |
3271
+ | ---------- | ---- | -------- | ----------- |
3272
+ | next | string | no | |
3273
+ | previous | string | no | |
3274
+
3275
+ ---
3276
+
3277
+
3278
+
3279
+
3280
+ #### [ShipmentDates](#ShipmentDates)
3281
+
3282
+ | Properties | Type | Nullable | Description |
3283
+ | ---------- | ---- | -------- | ----------- |
3284
+ | due_date | string | no | |
3285
+
3286
+ ---
3287
+
3288
+
3289
+
3290
+
3291
+ #### [OrderLanesCount](#OrderLanesCount)
3292
+
3293
+ | Properties | Type | Nullable | Description |
3294
+ | ---------- | ---- | -------- | ----------- |
3295
+ | stages | [[StageItem](#StageItem)] | yes | |
3296
+
3297
+ ---
3298
+
3299
+
3300
+
3301
+
3302
+ #### [StageItem](#StageItem)
3303
+
3304
+ | Properties | Type | Nullable | Description |
3305
+ | ---------- | ---- | -------- | ----------- |
3306
+ | count | number | no | |
3307
+ | text | string | no | |
3308
+ | value | string | no | |
3309
+
3310
+ ---
3311
+
3312
+
3313
+
3314
+
3315
+ #### [UpdateOrderReprocessResponse](#UpdateOrderReprocessResponse)
3316
+
3317
+ | Properties | Type | Nullable | Description |
3318
+ | ---------- | ---- | -------- | ----------- |
3319
+ | status | string | yes | |
3320
+
3321
+ ---
3322
+
3323
+
3324
+
3325
+
3326
+ #### [PlatformOrderTrack](#PlatformOrderTrack)
3327
+
3328
+ | Properties | Type | Nullable | Description |
3329
+ | ---------- | ---- | -------- | ----------- |
3330
+ | success | boolean | yes | |
3331
+ | request_id | string | yes | |
3332
+ | message | string | yes | |
3333
+ | mobile | string | yes | |
3334
+ | country_code | string | yes | |
3335
+ | resend_timer | number | yes | |
3336
+ | resend_token | string | no | |
3337
+
3338
+ ---
3339
+
3340
+
3341
+
3342
+
3343
+ #### [OrderPicklistListing](#OrderPicklistListing)
3344
+
3345
+ | Properties | Type | Nullable | Description |
3346
+ | ---------- | ---- | -------- | ----------- |
3347
+ | user | [PlatformOrderUserInfo](#PlatformOrderUserInfo) | no | |
3348
+ | delivery_address | [PlatformDeliveryAddress](#PlatformDeliveryAddress) | no | |
3349
+ | channel | [Channel](#Channel) | no | |
3350
+ | fyndstore_emp | string | no | |
3351
+ | ordering_store | [PlatformFulfillingStore](#PlatformFulfillingStore) | no | |
3352
+ | breakup_values | [[PlatformBreakupValues](#PlatformBreakupValues)] | no | |
3353
+ | id | string | no | |
3354
+ | application | [PlatformApplication](#PlatformApplication) | no | |
3355
+ | shipments | [[PlatformShipmentDetails](#PlatformShipmentDetails)] | no | |
3356
+ | created_at | string | no | |
3357
+ | total_shipments_in_order | number | no | |
3358
+ | payments | [ItemsPayments](#ItemsPayments) | no | |
3359
+ | payment_methods | string | no | |
3360
+
3361
+ ---
3362
+
3363
+
3364
+
3365
+
3366
+ #### [Stages](#Stages)
3367
+
3368
+ | Properties | Type | Nullable | Description |
3369
+ | ---------- | ---- | -------- | ----------- |
3370
+ | text | string | no | |
3371
+ | value | string | no | |
3372
+ | is_default | boolean | no | |
3373
+ | filters | [StagesFilters](#StagesFilters) | no | |
3374
+
3375
+ ---
3376
+
3377
+
3378
+
3379
+
3380
+ #### [ItemTotal](#ItemTotal)
3381
+
3382
+ | Properties | Type | Nullable | Description |
3383
+ | ---------- | ---- | -------- | ----------- |
3384
+ | new | number | no | |
3385
+ | processing | number | no | |
3386
+ | returns | number | no | |
3387
+ | all | number | no | |
3388
+
3389
+ ---
3390
+
3391
+
3392
+
3393
+
3394
+ #### [GetPingResponse](#GetPingResponse)
3395
+
3396
+ | Properties | Type | Nullable | Description |
3397
+ | ---------- | ---- | -------- | ----------- |
3398
+ | ping | string | yes | |
3399
+
3400
+ ---
3401
+
3402
+
3403
+
3404
+
3405
+ #### [GetShipmentAddressResponse](#GetShipmentAddressResponse)
3406
+
3407
+ | Properties | Type | Nullable | Description |
3408
+ | ---------- | ---- | -------- | ----------- |
3409
+ | message | string | yes | |
3410
+ | data | [DataShipmentAddress](#DataShipmentAddress) | yes | |
3411
+ | success | boolean | yes | |
3412
+
3413
+ ---
3414
+
3415
+
3416
+
3417
+
3418
+ #### [DataShipmentAddress](#DataShipmentAddress)
3419
+
3420
+ | Properties | Type | Nullable | Description |
3421
+ | ---------- | ---- | -------- | ----------- |
3422
+ | city | string | no | |
3423
+ | country | string | no | |
3424
+ | pincode | string | no | |
3425
+ | phone | string | no | |
3426
+ | area | string | no | |
3427
+ | address | string | no | |
3428
+ | landmark | string | no | |
3429
+ | state | string | no | |
3430
+ | address_type | string | no | |
3431
+ | address_category | string | no | |
3432
+ | email | string | no | |
3433
+ | name | string | no | |
3434
+
3435
+ ---
3436
+
3437
+
3438
+
3439
+
3440
+ #### [UpdateShipmentAddressRequest](#UpdateShipmentAddressRequest)
3441
+
3442
+ | Properties | Type | Nullable | Description |
3443
+ | ---------- | ---- | -------- | ----------- |
3444
+ | email | string | yes | |
3445
+ | address | string | yes | |
3446
+ | pincode | string | yes | |
3447
+ | state | string | yes | |
3448
+ | address_type | string | yes | |
3449
+ | country | string | yes | |
3450
+ | name | string | yes | |
3451
+ | phone | string | yes | |
3452
+ | area | string | yes | |
3453
+ | landmark | string | yes | |
3454
+ | city | string | yes | |
3455
+
3456
+ ---
3457
+
3458
+
3459
+
3460
+
3461
+ #### [UpdateShipmentAddressResponse](#UpdateShipmentAddressResponse)
3462
+
3463
+ | Properties | Type | Nullable | Description |
3464
+ | ---------- | ---- | -------- | ----------- |
3465
+ | success | boolean | yes | |
3466
+ | message | string | yes | |
3467
+
3468
+ ---
3469
+
3470
+
3471
+
3472
+
3473
+ #### [ShipmentTrackResponse](#ShipmentTrackResponse)
3474
+
3475
+ | Properties | Type | Nullable | Description |
3476
+ | ---------- | ---- | -------- | ----------- |
3477
+ | bag_list | [[ShipmentTrackResponseBagListItem](#ShipmentTrackResponseBagListItem)] | yes | |
3478
+ | message | string | yes | |
3479
+ | order_value | number | yes | |
3480
+
3481
+ ---
3482
+
3483
+
3484
+
3485
+
3486
+ #### [ShipmentTrackResponseBagListItem](#ShipmentTrackResponseBagListItem)
3487
+
3488
+ | Properties | Type | Nullable | Description |
3489
+ | ---------- | ---- | -------- | ----------- |
3490
+ | enable_tracking | boolean | no | |
3491
+ | price | string | no | |
3492
+ | time_slot | string | no | |
3493
+ | product_name | string | no | |
3494
+ | can_return | boolean | no | |
3495
+ | order_date | string | no | |
3496
+ | is_try_at_home | boolean | no | |
3497
+ | breakup_values | [[ShipmentTrackResponseBagListItemBreakValues](#ShipmentTrackResponseBagListItemBreakValues)] | no | |
3498
+ | statuses | [[ShipmentTrackResponseBagListItemStatuses](#ShipmentTrackResponseBagListItemStatuses)] | no | |
3499
+ | is_active | boolean | no | |
3500
+ | bag_id | string | no | |
3501
+ | order_id | string | no | |
3502
+ | size | string | no | |
3503
+ | payment_mode_source | string | no | |
3504
+ | dp_details | [ShipmentTrackResponseBagListItemDpDetails](#ShipmentTrackResponseBagListItemDpDetails) | no | |
3505
+ | product_id | number | no | |
3506
+ | product_image | [ShipmentTrackResponseBagListItemsProductImage](#ShipmentTrackResponseBagListItemsProductImage) | no | |
3507
+ | brand_name | string | no | |
3508
+ | price_marked | string | no | |
3509
+ | status | string | no | |
3510
+ | can_cancel | boolean | no | |
3511
+ | payment_mode | string | no | |
3512
+ | fynd_cash_msg | string | no | |
3513
+ | delivery_address | string | no | |
3514
+
3515
+ ---
3516
+
3517
+
3518
+
3519
+
3520
+ #### [ShipmentTrackResponseBagListItemBreakValues](#ShipmentTrackResponseBagListItemBreakValues)
3521
+
3522
+ | Properties | Type | Nullable | Description |
3523
+ | ---------- | ---- | -------- | ----------- |
3524
+ | name | string | no | |
3525
+ | display | string | no | |
3526
+ | value | string | no | |
3527
+
3528
+ ---
3529
+
3530
+
3531
+
3532
+
3533
+ #### [ShipmentTrackResponseBagListItemStatuses](#ShipmentTrackResponseBagListItemStatuses)
3534
+
3535
+ | Properties | Type | Nullable | Description |
3536
+ | ---------- | ---- | -------- | ----------- |
3537
+ | nps_rating | number | no | |
3538
+ | nps_string | string | no | |
3539
+ | progress_status | [[ShipmentTrackResponseBagListItemStatusesProgress](#ShipmentTrackResponseBagListItemStatusesProgress)] | no | |
3540
+ | flow_type | string | no | |
3541
+ | status_progress | number | no | |
3542
+ | is_nps_done | boolean | no | |
3543
+ | header_message | string | no | |
3544
+ | is_delayed | string | no | |
3545
+ | tracking_list | [[ShipmentTrackResponseBagListItemStatusesTrack](#ShipmentTrackResponseBagListItemStatusesTrack)] | no | |
3546
+
3547
+ ---
3548
+
3549
+
3550
+
3551
+
3552
+ #### [ShipmentTrackResponseBagListItemStatusesProgress](#ShipmentTrackResponseBagListItemStatusesProgress)
3553
+
3554
+ | Properties | Type | Nullable | Description |
3555
+ | ---------- | ---- | -------- | ----------- |
3556
+ | title | string | no | |
3557
+ | type | string | no | |
3558
+ | state | boolean | no | |
3559
+
3560
+ ---
3561
+
3562
+
3563
+
3564
+
3565
+ #### [ShipmentTrackResponseBagListItemStatusesTrack](#ShipmentTrackResponseBagListItemStatusesTrack)
3566
+
3567
+ | Properties | Type | Nullable | Description |
3568
+ | ---------- | ---- | -------- | ----------- |
3569
+ | status | string | no | |
3570
+ | time | string | no | |
3571
+ | is_passed | boolean | no | |
3572
+ | is_current | boolean | no | |
3573
+
3574
+ ---
3575
+
3576
+
3577
+
3578
+
3579
+ #### [ShipmentTrackResponseBagListItemDpDetails](#ShipmentTrackResponseBagListItemDpDetails)
3580
+
3581
+ | Properties | Type | Nullable | Description |
3582
+ | ---------- | ---- | -------- | ----------- |
3583
+ | tracking_no | string | no | |
3584
+ | courier | string | no | |
3585
+
3586
+ ---
3587
+
3588
+
3589
+
3590
+
3591
+ #### [ShipmentTrackResponseBagListItemsProductImage](#ShipmentTrackResponseBagListItemsProductImage)
3592
+
3593
+ | Properties | Type | Nullable | Description |
3594
+ | ---------- | ---- | -------- | ----------- |
3595
+ | aspect_ratio | string | no | |
3596
+ | url | string | no | |
3597
+
3598
+ ---
3599
+
3600
+
3601
+
3602
+
3603
+ #### [UpdateShipmentStatusResponse](#UpdateShipmentStatusResponse)
3604
+
3605
+ | Properties | Type | Nullable | Description |
3606
+ | ---------- | ---- | -------- | ----------- |
3607
+ | shipments | string | yes | |
3608
+ | error_shipments | [any] | no | |
3609
+
3610
+ ---
3611
+
3612
+
3613
+
3614
+
3615
+ #### [UpdateShipmentStatusBody](#UpdateShipmentStatusBody)
3616
+
3617
+ | Properties | Type | Nullable | Description |
3618
+ | ---------- | ---- | -------- | ----------- |
3619
+ | shipments | string | yes | |
3620
+ | force_transition | boolean | yes | |
3621
+ | task | boolean | yes | |
3622
+
3623
+ ---
3624
+
3625
+
3626
+
3627
+
3628
+ #### [ShipmentReasonsResponse](#ShipmentReasonsResponse)
3629
+
3630
+ | Properties | Type | Nullable | Description |
3631
+ | ---------- | ---- | -------- | ----------- |
3632
+ | success | boolean | yes | |
3633
+ | message | string | yes | |
3634
+ | reasons | [[ShipmentResponseReasons](#ShipmentResponseReasons)] | yes | |
3635
+
3636
+ ---
3637
+
3638
+
3639
+
3640
+
3641
+ #### [ShipmentResponseReasons](#ShipmentResponseReasons)
3642
+
3643
+ | Properties | Type | Nullable | Description |
3644
+ | ---------- | ---- | -------- | ----------- |
3645
+ | reason_id | number | no | |
3646
+ | reason | string | no | |
3647
+
3648
+ ---
3649
+
3650
+
3651
+
3652
+
3653
+ #### [PlatformShipmentTrack](#PlatformShipmentTrack)
3654
+
3655
+ | Properties | Type | Nullable | Description |
3656
+ | ---------- | ---- | -------- | ----------- |
3657
+ | results | [Results](#Results) | yes | |
3658
+
3659
+ ---
3660
+
3661
+
3662
+
3663
+
3664
+ #### [Results](#Results)
3665
+
3666
+ | Properties | Type | Nullable | Description |
3667
+ | ---------- | ---- | -------- | ----------- |
3668
+ | awb | string | no | |
3669
+ | updated_at | string | no | |
3670
+ | last_location_recieved_at | string | no | |
3671
+ | reason | string | no | |
3672
+ | shipment_type | string | no | |
3673
+ | status | string | no | |
3674
+ | updated_time | string | no | |
3675
+ | account_name | string | no | |
3676
+
3677
+ ---
3678
+
3679
+
3680
+
3681
+
3682
+ #### [ShipmentUpdateRequest](#ShipmentUpdateRequest)
3683
+
3684
+ | Properties | Type | Nullable | Description |
3685
+ | ---------- | ---- | -------- | ----------- |
3686
+ | bags | [string] | yes | |
3687
+ | reason | string | yes | |
3688
+ | comments | string | yes | |
3689
+ | action | string | yes | |
3690
+
3691
+ ---
3692
+
3693
+
3694
+
3695
+
3696
+ #### [ShipmentUpdateResponse](#ShipmentUpdateResponse)
3697
+
3698
+ | Properties | Type | Nullable | Description |
3699
+ | ---------- | ---- | -------- | ----------- |
3700
+ | success | boolean | yes | |
3701
+ | message | string | yes | |
3702
+
3703
+ ---
3704
+
3705
+
3706
+
3707
+
3708
+ #### [UpdateProcessShipmenstRequestBody](#UpdateProcessShipmenstRequestBody)
3709
+
3710
+ | Properties | Type | Nullable | Description |
3711
+ | ---------- | ---- | -------- | ----------- |
3712
+ | shipment_ids | [string] | yes | |
3713
+ | expected_status | string | yes | |
3714
+
3715
+ ---
3716
+
3717
+
3718
+
3719
+
3720
+ #### [UpdateProcessShipmenstRequestResponse](#UpdateProcessShipmenstRequestResponse)
3721
+
3722
+ | Properties | Type | Nullable | Description |
3723
+ | ---------- | ---- | -------- | ----------- |
3724
+ | success | boolean | yes | |
3725
+ | message | string | yes | |
3726
+
3727
+ ---
3728
+
3729
+
3730
+
3731
+
3732
+ #### [GetVoiceCallbackResponse](#GetVoiceCallbackResponse)
3733
+
3734
+ | Properties | Type | Nullable | Description |
3735
+ | ---------- | ---- | -------- | ----------- |
3736
+ | message | string | yes | |
3737
+
3738
+ ---
3739
+
3740
+
3741
+
3742
+
3743
+ #### [GetClickToCallResponse](#GetClickToCallResponse)
3744
+
3745
+ | Properties | Type | Nullable | Description |
3746
+ | ---------- | ---- | -------- | ----------- |
3747
+ | message | string | yes | |
3748
+
3749
+ ---
3750
+
3751
+
3752
+
3753
+
3754
+ #### [ApefaceApiError](#ApefaceApiError)
3755
+
3756
+ | Properties | Type | Nullable | Description |
3757
+ | ---------- | ---- | -------- | ----------- |
3758
+ | message | string | no | |
3759
+
3760
+ ---
3761
+
3762
+
3763
+
3764
+