@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

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 (310) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +557 -1279
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +14453 -17192
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3438 -4172
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3400 -5361
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  44. package/sdk/application/Cart/CartApplicationClient.js +567 -567
  45. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  46. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  47. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  48. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  49. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  50. package/sdk/application/Catalog/CatalogApplicationClient.js +1036 -1036
  51. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  52. package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
  53. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  54. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  55. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  56. package/sdk/application/Common/CommonApplicationClient.js +38 -38
  57. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  58. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  59. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  60. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  61. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  62. package/sdk/application/Communication/CommunicationApplicationClient.js +26 -26
  63. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  64. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  65. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  66. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  67. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.js +330 -330
  69. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  71. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  73. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  74. package/sdk/application/Content/ContentApplicationClient.js +191 -191
  75. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  76. package/sdk/application/Content/ContentApplicationModel.js +467 -884
  77. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  78. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  79. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.js +59 -59
  81. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  83. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  85. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  86. package/sdk/application/Lead/LeadApplicationClient.js +100 -100
  87. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  88. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  89. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  90. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  91. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  92. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -43
  93. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  94. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  95. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  96. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  97. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  98. package/sdk/application/Order/OrderApplicationClient.js +232 -232
  99. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  100. package/sdk/application/Order/OrderApplicationModel.js +352 -656
  101. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  102. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  103. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  104. package/sdk/application/Payment/PaymentApplicationClient.js +739 -739
  105. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  106. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  107. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  108. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  109. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  110. package/sdk/application/PosCart/PosCartApplicationClient.js +617 -617
  111. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  112. package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
  113. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  114. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  115. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  116. package/sdk/application/Rewards/RewardsApplicationClient.js +112 -112
  117. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  118. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  119. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  120. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  121. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  122. package/sdk/application/Share/ShareApplicationClient.js +84 -84
  123. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  124. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  125. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  126. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  127. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  128. package/sdk/application/Theme/ThemeApplicationClient.js +31 -31
  129. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  130. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  131. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  132. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  133. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  134. package/sdk/application/User/UserApplicationClient.js +581 -581
  135. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  136. package/sdk/application/User/UserApplicationModel.js +440 -689
  137. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  138. package/sdk/application/User/UserApplicationValidator.js +89 -89
  139. package/sdk/common/AxiosHelper.js +1 -1
  140. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  144. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  145. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  146. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  147. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
  148. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  152. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  153. package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
  154. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  155. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  156. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  157. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  158. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +168 -168
  159. package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
  160. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  161. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  162. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  163. package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
  164. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  165. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
  166. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
  168. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
  169. package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
  170. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  171. package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
  172. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  173. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
  174. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  175. package/sdk/platform/Common/CommonPlatformClient.js +41 -41
  176. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  177. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  178. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  179. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  180. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  181. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
  182. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  184. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  185. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  186. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  187. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
  188. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  189. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  190. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  192. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  193. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
  194. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  195. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  196. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  197. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
  198. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  199. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  200. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  201. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  202. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +534 -534
  203. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
  204. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
  205. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
  206. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  207. package/sdk/platform/Content/ContentPlatformModel.js +484 -907
  208. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  209. package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
  210. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  211. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  212. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  213. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  214. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -24
  215. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
  216. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  217. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  218. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
  219. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
  220. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  221. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  222. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  223. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  224. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  225. package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
  226. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  227. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  228. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  229. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  230. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  231. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
  232. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  233. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  234. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  235. package/sdk/platform/Lead/LeadPlatformClient.js +212 -212
  236. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  237. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  238. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  239. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  240. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  241. package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
  242. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  243. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  244. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  245. package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
  246. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  247. package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
  248. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  249. package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
  250. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  251. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  252. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
  253. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
  254. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  255. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  256. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  257. package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
  258. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  259. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  260. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  261. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  262. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  263. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  264. package/sdk/platform/PlatformClient.d.ts +7965 -7885
  265. package/sdk/platform/PlatformClient.js +8672 -10105
  266. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  270. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  271. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  272. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  273. package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
  274. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  275. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  276. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  277. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  278. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  279. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
  280. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  281. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  282. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  283. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  284. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  285. package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
  286. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  287. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  288. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  289. package/sdk/platform/User/UserPlatformModel.js +440 -689
  290. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  291. package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
  292. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  293. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  294. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  295. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  296. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  297. package/sdk/public/Configuration/ConfigurationPublicClient.js +38 -38
  298. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  299. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  300. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  301. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  302. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  303. package/sdk/public/Inventory/InventoryPublicClient.js +113 -113
  304. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  305. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  306. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  307. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  308. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  309. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  310. package/tests/application/catalog.spec.js +7 -0
@@ -8,18 +8,18 @@
8
8
  ## Order Methods
9
9
  Handles all Application order and shipment api(s)
10
10
 
11
- * [getOrders](#getorders)
11
+ * [getCustomerDetailsByShipmentId](#getcustomerdetailsbyshipmentid)
12
+ * [getInvoiceByShipmentId](#getinvoicebyshipmentid)
12
13
  * [getOrderById](#getorderbyid)
14
+ * [getOrders](#getorders)
13
15
  * [getPosOrderById](#getposorderbyid)
14
- * [getShipmentById](#getshipmentbyid)
15
- * [getInvoiceByShipmentId](#getinvoicebyshipmentid)
16
- * [trackShipment](#trackshipment)
17
- * [getCustomerDetailsByShipmentId](#getcustomerdetailsbyshipmentid)
18
- * [sendOtpToShipmentCustomer](#sendotptoshipmentcustomer)
19
- * [verifyOtpShipmentCustomer](#verifyotpshipmentcustomer)
20
16
  * [getShipmentBagReasons](#getshipmentbagreasons)
17
+ * [getShipmentById](#getshipmentbyid)
21
18
  * [getShipmentReasons](#getshipmentreasons)
19
+ * [sendOtpToShipmentCustomer](#sendotptoshipmentcustomer)
20
+ * [trackShipment](#trackshipment)
22
21
  * [updateShipmentStatus](#updateshipmentstatus)
22
+ * [verifyOtpShipmentCustomer](#verifyotpshipmentcustomer)
23
23
 
24
24
 
25
25
 
@@ -28,27 +28,19 @@ Handles all Application order and shipment api(s)
28
28
 
29
29
 
30
30
 
31
- ### getOrders
32
- Get all orders
31
+ ### getCustomerDetailsByShipmentId
32
+ Get Customer Details by Shipment Id
33
33
 
34
34
 
35
35
 
36
36
  ```javascript
37
37
  // Promise
38
- const promise = order.getOrders({ status : value,
39
- pageNo : value,
40
- pageSize : value,
41
- fromDate : value,
42
- toDate : value,
43
- customMeta : value });
38
+ const promise = order.getCustomerDetailsByShipmentId({ orderId : value,
39
+ shipmentId : value });
44
40
 
45
41
  // Async/Await
46
- const data = await order.getOrders({ status : value,
47
- pageNo : value,
48
- pageSize : value,
49
- fromDate : value,
50
- toDate : value,
51
- customMeta : value });
42
+ const data = await order.getCustomerDetailsByShipmentId({ orderId : value,
43
+ shipmentId : value });
52
44
  ```
53
45
 
54
46
 
@@ -56,26 +48,84 @@ const data = await order.getOrders({ status : value,
56
48
 
57
49
 
58
50
  | Argument | Type | Required | Description |
59
- | --------- | ----- | -------- | ----------- |
60
- | status | number | no | A filter to retrieve orders by their current status such as _placed_, _delivered_, etc. |
61
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
62
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
63
- | fromDate | string | no | The date from which the orders should be retrieved. |
64
- | toDate | string | no | The date till which the orders should be retrieved. |
65
- | customMeta | string | no | A filter and retrieve data using special fields included for special use-cases |
51
+ | --------- | ----- | -------- | ----------- |
52
+ | orderId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
53
+ | shipmentId | string | yes | A unique number used for identifying and tracking your orders. |
66
54
 
67
55
 
68
56
 
69
- Use this API to retrieve all the orders.
57
+ Use this API to retrieve customer details such as mobileno using Shipment ID.
70
58
 
71
59
  *Returned Response:*
72
60
 
73
61
 
74
62
 
75
63
 
76
- [OrderList](#OrderList)
64
+ [CustomerDetailsResponse](#CustomerDetailsResponse)
77
65
 
78
- Success. Returns all the orders. Check the example shown below or refer `OrderList` for more details.
66
+ Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
67
+
68
+
69
+
70
+
71
+ <details>
72
+ <summary><i>&nbsp; Example:</i></summary>
73
+
74
+ ```json
75
+ {
76
+ "order_id": "FYMP629D972D01B6BD76",
77
+ "shipment_id": "16544950215681060915J",
78
+ "name": "sagar Kulkarni",
79
+ "phone": "XXX-XXX-6780",
80
+ "country": "India"
81
+ }
82
+ ```
83
+ </details>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+ ---
94
+
95
+
96
+ ### getInvoiceByShipmentId
97
+ Get Invoice of a shipment
98
+
99
+
100
+
101
+ ```javascript
102
+ // Promise
103
+ const promise = order.getInvoiceByShipmentId({ shipmentId : value });
104
+
105
+ // Async/Await
106
+ const data = await order.getInvoiceByShipmentId({ shipmentId : value });
107
+ ```
108
+
109
+
110
+
111
+
112
+
113
+ | Argument | Type | Required | Description |
114
+ | --------- | ----- | -------- | ----------- |
115
+ | shipmentId | string | yes | ID of the shipment. |
116
+
117
+
118
+
119
+ Use this API to retrieve shipment invoice.
120
+
121
+ *Returned Response:*
122
+
123
+
124
+
125
+
126
+ [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
127
+
128
+ Success. Check the example shown below or refer `ShipmentById` for more details.
79
129
 
80
130
 
81
131
 
@@ -1087,6 +1137,77 @@ Success. Check the example shown below or refer `OrderById` for more details.
1087
1137
 
1088
1138
 
1089
1139
 
1140
+ ---
1141
+
1142
+
1143
+ ### getOrders
1144
+ Get all orders
1145
+
1146
+
1147
+
1148
+ ```javascript
1149
+ // Promise
1150
+ const promise = order.getOrders({ status : value,
1151
+ pageNo : value,
1152
+ pageSize : value,
1153
+ fromDate : value,
1154
+ toDate : value,
1155
+ customMeta : value });
1156
+
1157
+ // Async/Await
1158
+ const data = await order.getOrders({ status : value,
1159
+ pageNo : value,
1160
+ pageSize : value,
1161
+ fromDate : value,
1162
+ toDate : value,
1163
+ customMeta : value });
1164
+ ```
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+ | Argument | Type | Required | Description |
1171
+ | --------- | ----- | -------- | ----------- |
1172
+ | status | number | no | A filter to retrieve orders by their current status such as _placed_, _delivered_, etc. |
1173
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
1174
+ | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
1175
+ | fromDate | string | no | The date from which the orders should be retrieved. |
1176
+ | toDate | string | no | The date till which the orders should be retrieved. |
1177
+ | customMeta | string | no | A filter and retrieve data using special fields included for special use-cases |
1178
+
1179
+
1180
+
1181
+ Use this API to retrieve all the orders.
1182
+
1183
+ *Returned Response:*
1184
+
1185
+
1186
+
1187
+
1188
+ [OrderList](#OrderList)
1189
+
1190
+ Success. Returns all the orders. Check the example shown below or refer `OrderList` for more details.
1191
+
1192
+
1193
+
1194
+
1195
+ <details>
1196
+ <summary><i>&nbsp; Example:</i></summary>
1197
+
1198
+ ```json
1199
+
1200
+ ```
1201
+ </details>
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1090
1211
  ---
1091
1212
 
1092
1213
 
@@ -1433,17 +1554,19 @@ Success. Check the example shown below or refer `PosOrderById` for more details.
1433
1554
  ---
1434
1555
 
1435
1556
 
1436
- ### getShipmentById
1437
- Get details of a shipment
1557
+ ### getShipmentBagReasons
1558
+ Get reasons behind full or partial cancellation of a shipment
1438
1559
 
1439
1560
 
1440
1561
 
1441
1562
  ```javascript
1442
1563
  // Promise
1443
- const promise = order.getShipmentById({ shipmentId : value });
1564
+ const promise = order.getShipmentBagReasons({ shipmentId : value,
1565
+ bagId : value });
1444
1566
 
1445
1567
  // Async/Await
1446
- const data = await order.getShipmentById({ shipmentId : value });
1568
+ const data = await order.getShipmentBagReasons({ shipmentId : value,
1569
+ bagId : value });
1447
1570
  ```
1448
1571
 
1449
1572
 
@@ -1452,20 +1575,21 @@ const data = await order.getShipmentById({ shipmentId : value });
1452
1575
 
1453
1576
  | Argument | Type | Required | Description |
1454
1577
  | --------- | ----- | -------- | ----------- |
1455
- | 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. |
1578
+ | shipmentId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1579
+ | bagId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1456
1580
 
1457
1581
 
1458
1582
 
1459
- Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
1583
+ Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
1460
1584
 
1461
1585
  *Returned Response:*
1462
1586
 
1463
1587
 
1464
1588
 
1465
1589
 
1466
- [ShipmentById](#ShipmentById)
1590
+ [ShipmentBagReasons](#ShipmentBagReasons)
1467
1591
 
1468
- Success. Check the example shown below or refer `ShipmentById` for more details.
1592
+ Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
1469
1593
 
1470
1594
 
1471
1595
 
@@ -1475,60 +1599,158 @@ Success. Check the example shown below or refer `ShipmentById` for more details.
1475
1599
 
1476
1600
  ```json
1477
1601
  {
1478
- "shipment": {
1479
- "order_id": "FY62F3B8290150D13E36",
1480
- "breakup_values": [
1481
- {
1482
- "name": "mrp_total",
1483
- "display": "MRP Total",
1484
- "value": 50
1485
- },
1486
- {
1487
- "name": "sub_total",
1488
- "display": "Sub Total",
1489
- "value": 50
1490
- },
1491
- {
1492
- "name": "coupon",
1493
- "display": "Coupon",
1494
- "value": 0
1495
- },
1496
- {
1497
- "name": "discount",
1498
- "display": "Discount",
1499
- "value": 0
1500
- },
1501
- {
1502
- "name": "promotion",
1503
- "display": "Promotion",
1504
- "value": 0
1505
- },
1506
- {
1507
- "name": "reward_points",
1508
- "display": "Reward Points",
1509
- "value": 0
1510
- },
1511
- {
1512
- "name": "cashback_applied",
1513
- "display": "Cashback Applied",
1514
- "value": 0
1515
- },
1516
- {
1517
- "name": "delivery_charges",
1518
- "display": "Delivery Charges",
1519
- "value": 0
1520
- },
1521
- {
1522
- "name": "cod_charges",
1523
- "display": "COD Charges",
1524
- "value": 0
1525
- },
1526
- {
1527
- "name": "total",
1528
- "display": "Total",
1529
- "value": 50
1530
- }
1531
- ],
1602
+ "success": true,
1603
+ "reasons": [
1604
+ {
1605
+ "id": 1,
1606
+ "display_name": "Not available",
1607
+ "qc_type": [],
1608
+ "question_set": []
1609
+ },
1610
+ {
1611
+ "reasons": [
1612
+ {
1613
+ "id": 2,
1614
+ "display_name": "Processing other orders",
1615
+ "qc_type": [],
1616
+ "question_set": []
1617
+ },
1618
+ {
1619
+ "id": 3,
1620
+ "display_name": "Printer not working",
1621
+ "qc_type": [],
1622
+ "question_set": []
1623
+ },
1624
+ {
1625
+ "reasons": [
1626
+ {
1627
+ "id": 4,
1628
+ "display_name": "Card issues",
1629
+ "qc_type": [],
1630
+ "question_set": []
1631
+ }
1632
+ ]
1633
+ }
1634
+ ]
1635
+ },
1636
+ {
1637
+ "id": 4,
1638
+ "display_name": "Card issues",
1639
+ "qc_type": [],
1640
+ "question_set": []
1641
+ }
1642
+ ]
1643
+ }
1644
+ ```
1645
+ </details>
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+ ---
1656
+
1657
+
1658
+ ### getShipmentById
1659
+ Get details of a shipment
1660
+
1661
+
1662
+
1663
+ ```javascript
1664
+ // Promise
1665
+ const promise = order.getShipmentById({ shipmentId : value });
1666
+
1667
+ // Async/Await
1668
+ const data = await order.getShipmentById({ shipmentId : value });
1669
+ ```
1670
+
1671
+
1672
+
1673
+
1674
+
1675
+ | Argument | Type | Required | Description |
1676
+ | --------- | ----- | -------- | ----------- |
1677
+ | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1678
+
1679
+
1680
+
1681
+ Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
1682
+
1683
+ *Returned Response:*
1684
+
1685
+
1686
+
1687
+
1688
+ [ShipmentById](#ShipmentById)
1689
+
1690
+ Success. Check the example shown below or refer `ShipmentById` for more details.
1691
+
1692
+
1693
+
1694
+
1695
+ <details>
1696
+ <summary><i>&nbsp; Example:</i></summary>
1697
+
1698
+ ```json
1699
+ {
1700
+ "shipment": {
1701
+ "order_id": "FY62F3B8290150D13E36",
1702
+ "breakup_values": [
1703
+ {
1704
+ "name": "mrp_total",
1705
+ "display": "MRP Total",
1706
+ "value": 50
1707
+ },
1708
+ {
1709
+ "name": "sub_total",
1710
+ "display": "Sub Total",
1711
+ "value": 50
1712
+ },
1713
+ {
1714
+ "name": "coupon",
1715
+ "display": "Coupon",
1716
+ "value": 0
1717
+ },
1718
+ {
1719
+ "name": "discount",
1720
+ "display": "Discount",
1721
+ "value": 0
1722
+ },
1723
+ {
1724
+ "name": "promotion",
1725
+ "display": "Promotion",
1726
+ "value": 0
1727
+ },
1728
+ {
1729
+ "name": "reward_points",
1730
+ "display": "Reward Points",
1731
+ "value": 0
1732
+ },
1733
+ {
1734
+ "name": "cashback_applied",
1735
+ "display": "Cashback Applied",
1736
+ "value": 0
1737
+ },
1738
+ {
1739
+ "name": "delivery_charges",
1740
+ "display": "Delivery Charges",
1741
+ "value": 0
1742
+ },
1743
+ {
1744
+ "name": "cod_charges",
1745
+ "display": "COD Charges",
1746
+ "value": 0
1747
+ },
1748
+ {
1749
+ "name": "total",
1750
+ "display": "Total",
1751
+ "value": 50
1752
+ }
1753
+ ],
1532
1754
  "beneficiary_details": false,
1533
1755
  "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
1534
1756
  "shipment_created_at": "2022-08-10T19:22:42.000Z",
@@ -1849,17 +2071,17 @@ Success. Check the example shown below or refer `ShipmentById` for more details.
1849
2071
  ---
1850
2072
 
1851
2073
 
1852
- ### getInvoiceByShipmentId
1853
- Get Invoice of a shipment
2074
+ ### getShipmentReasons
2075
+ Get reasons behind full or partial cancellation of a shipment
1854
2076
 
1855
2077
 
1856
2078
 
1857
2079
  ```javascript
1858
2080
  // Promise
1859
- const promise = order.getInvoiceByShipmentId({ shipmentId : value });
2081
+ const promise = order.getShipmentReasons({ shipmentId : value });
1860
2082
 
1861
2083
  // Async/Await
1862
- const data = await order.getInvoiceByShipmentId({ shipmentId : value });
2084
+ const data = await order.getShipmentReasons({ shipmentId : value });
1863
2085
  ```
1864
2086
 
1865
2087
 
@@ -1868,20 +2090,20 @@ const data = await order.getInvoiceByShipmentId({ shipmentId : value });
1868
2090
 
1869
2091
  | Argument | Type | Required | Description |
1870
2092
  | --------- | ----- | -------- | ----------- |
1871
- | shipmentId | string | yes | ID of the shipment. |
2093
+ | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1872
2094
 
1873
2095
 
1874
2096
 
1875
- Use this API to retrieve shipment invoice.
2097
+ Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
1876
2098
 
1877
2099
  *Returned Response:*
1878
2100
 
1879
2101
 
1880
2102
 
1881
2103
 
1882
- [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
2104
+ [ShipmentReasons](#ShipmentReasons)
1883
2105
 
1884
- Success. Check the example shown below or refer `ShipmentById` for more details.
2106
+ Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
1885
2107
 
1886
2108
 
1887
2109
 
@@ -1890,141 +2112,90 @@ Success. Check the example shown below or refer `ShipmentById` for more details.
1890
2112
  <summary><i>&nbsp; Example:</i></summary>
1891
2113
 
1892
2114
  ```json
1893
-
1894
- ```
1895
- </details>
1896
-
1897
-
1898
-
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
- ---
1906
-
1907
-
1908
- ### trackShipment
1909
- Track shipment
1910
-
1911
-
1912
-
1913
- ```javascript
1914
- // Promise
1915
- const promise = order.trackShipment({ shipmentId : value });
1916
-
1917
- // Async/Await
1918
- const data = await order.trackShipment({ shipmentId : value });
1919
- ```
1920
-
1921
-
1922
-
1923
-
1924
-
1925
- | Argument | Type | Required | Description |
1926
- | --------- | ----- | -------- | ----------- |
1927
- | 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. |
1928
-
1929
-
1930
-
1931
- Track Shipment by shipment id, for application based on application Id
1932
-
1933
- *Returned Response:*
1934
-
1935
-
1936
-
1937
-
1938
- [ShipmentTrack](#ShipmentTrack)
1939
-
1940
- Success. Check the example shown below or refer `ShipmentTrack` for more details.
1941
-
1942
-
1943
-
1944
-
1945
- <details>
1946
- <summary><i>&nbsp; Example:</i></summary>
1947
-
1948
- ```json
1949
- {
1950
- "results": [
1951
- {
1952
- "awb": "string",
1953
- "updated_at": "string",
1954
- "last_location_recieved_at": "string",
1955
- "reason": "string",
1956
- "shipment_type": "string",
1957
- "status": "string",
1958
- "updated_time": "string",
1959
- "account_name": "string"
1960
- }
1961
- ]
1962
- }
1963
- ```
1964
- </details>
1965
-
1966
-
1967
-
1968
-
1969
-
1970
-
1971
-
1972
-
1973
-
1974
- ---
1975
-
1976
-
1977
- ### getCustomerDetailsByShipmentId
1978
- Get Customer Details by Shipment Id
1979
-
1980
-
1981
-
1982
- ```javascript
1983
- // Promise
1984
- const promise = order.getCustomerDetailsByShipmentId({ orderId : value,
1985
- shipmentId : value });
1986
-
1987
- // Async/Await
1988
- const data = await order.getCustomerDetailsByShipmentId({ orderId : value,
1989
- shipmentId : value });
1990
- ```
1991
-
1992
-
1993
-
1994
-
1995
-
1996
- | Argument | Type | Required | Description |
1997
- | --------- | ----- | -------- | ----------- |
1998
- | orderId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
1999
- | shipmentId | string | yes | A unique number used for identifying and tracking your orders. |
2000
-
2001
-
2002
-
2003
- Use this API to retrieve customer details such as mobileno using Shipment ID.
2004
-
2005
- *Returned Response:*
2006
-
2007
-
2008
-
2009
-
2010
- [CustomerDetailsResponse](#CustomerDetailsResponse)
2011
-
2012
- Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
2013
-
2014
-
2015
-
2016
-
2017
- <details>
2018
- <summary><i>&nbsp; Example:</i></summary>
2019
-
2020
- ```json
2021
- {
2022
- "order_id": "FYMP629D972D01B6BD76",
2023
- "shipment_id": "16544950215681060915J",
2024
- "name": "sagar Kulkarni",
2025
- "phone": "XXX-XXX-6780",
2026
- "country": "India"
2027
- }
2115
+ {
2116
+ "reasons": [
2117
+ {
2118
+ "reason_id": 115,
2119
+ "priority": 9,
2120
+ "reason_text": "Wrong size/colour delivered",
2121
+ "show_text_area": false,
2122
+ "feedback_type": "bag",
2123
+ "flow": "return"
2124
+ },
2125
+ {
2126
+ "reason_id": 116,
2127
+ "priority": 10,
2128
+ "reason_text": "Product does not fit me",
2129
+ "show_text_area": false,
2130
+ "feedback_type": "bag",
2131
+ "flow": "return"
2132
+ },
2133
+ {
2134
+ "reason_id": 117,
2135
+ "priority": 11,
2136
+ "reason_text": "Quality of product is not good",
2137
+ "show_text_area": false,
2138
+ "feedback_type": "bag",
2139
+ "flow": "return"
2140
+ },
2141
+ {
2142
+ "reason_id": 118,
2143
+ "priority": 12,
2144
+ "reason_text": "Wrong product delivered",
2145
+ "show_text_area": true,
2146
+ "feedback_type": "bag",
2147
+ "flow": "return"
2148
+ },
2149
+ {
2150
+ "reason_id": 119,
2151
+ "priority": 13,
2152
+ "reason_text": "Damaged product delivered",
2153
+ "show_text_area": true,
2154
+ "feedback_type": "bag",
2155
+ "flow": "return"
2156
+ },
2157
+ {
2158
+ "reason_id": 120,
2159
+ "priority": 14,
2160
+ "reason_text": "Used product delivered",
2161
+ "show_text_area": true,
2162
+ "feedback_type": "bag",
2163
+ "flow": "return"
2164
+ },
2165
+ {
2166
+ "reason_id": 124,
2167
+ "priority": 15,
2168
+ "reason_text": "Missing Items/Partially Received",
2169
+ "show_text_area": true,
2170
+ "feedback_type": "bag",
2171
+ "flow": "return"
2172
+ },
2173
+ {
2174
+ "reason_id": 121,
2175
+ "priority": 16,
2176
+ "reason_text": "Found better price elsewhere",
2177
+ "show_text_area": true,
2178
+ "feedback_type": "bag",
2179
+ "flow": "return"
2180
+ },
2181
+ {
2182
+ "reason_id": 122,
2183
+ "priority": 17,
2184
+ "reason_text": "Product looks different from image",
2185
+ "show_text_area": true,
2186
+ "feedback_type": "bag",
2187
+ "flow": "return"
2188
+ },
2189
+ {
2190
+ "reason_id": 123,
2191
+ "priority": 18,
2192
+ "reason_text": "Other issue",
2193
+ "show_text_area": true,
2194
+ "feedback_type": "bag",
2195
+ "flow": "return"
2196
+ }
2197
+ ]
2198
+ }
2028
2199
  ```
2029
2200
  </details>
2030
2201
 
@@ -2061,197 +2232,33 @@ const data = await order.sendOtpToShipmentCustomer({ orderId : value,
2061
2232
  | Argument | Type | Required | Description |
2062
2233
  | --------- | ----- | -------- | ----------- |
2063
2234
  | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2064
- | 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. |
2065
-
2066
-
2067
-
2068
- Use this API to send OTP to the customer of the mapped Shipment.
2069
-
2070
- *Returned Response:*
2071
-
2072
-
2073
-
2074
-
2075
- [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
2076
-
2077
- Success to acknowledge the service was notified
2078
-
2079
-
2080
-
2081
-
2082
- <details>
2083
- <summary><i>&nbsp; Example:</i></summary>
2084
-
2085
- ```json
2086
- {
2087
- "success": true,
2088
- "request_id": "0fe0d6e16205ddc57d212e947ee31896",
2089
- "message": "OTP sent",
2090
- "resend_timer": 30
2091
- }
2092
- ```
2093
- </details>
2094
-
2095
-
2096
-
2097
-
2098
-
2099
-
2100
-
2101
-
2102
-
2103
- ---
2104
-
2105
-
2106
- ### verifyOtpShipmentCustomer
2107
- Verify Otp code
2108
-
2109
-
2110
-
2111
- ```javascript
2112
- // Promise
2113
- const promise = order.verifyOtpShipmentCustomer({ orderId : value,
2114
- shipmentId : value,
2115
- body : value });
2116
-
2117
- // Async/Await
2118
- const data = await order.verifyOtpShipmentCustomer({ orderId : value,
2119
- shipmentId : value,
2120
- body : value });
2121
- ```
2122
-
2123
-
2124
-
2125
-
2126
-
2127
- | Argument | Type | Required | Description |
2128
- | --------- | ----- | -------- | ----------- |
2129
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2130
- | 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. |
2131
- | body | [VerifyOtp](#VerifyOtp) | yes | Request body |
2132
-
2133
-
2134
- Use this API to verify OTP and create a session token with custom payload.
2135
-
2136
- *Returned Response:*
2137
-
2138
-
2139
-
2140
-
2141
- [VerifyOtpResponse](#VerifyOtpResponse)
2142
-
2143
- Success, the code is valid and returns a session token
2144
-
2145
-
2146
-
2147
-
2148
- <details>
2149
- <summary><i>&nbsp; Example:</i></summary>
2150
-
2151
- ```json
2152
- {
2153
- "success": true
2154
- }
2155
- ```
2156
- </details>
2157
-
2158
-
2159
-
2160
-
2161
-
2162
-
2163
-
2164
-
2165
-
2166
- ---
2167
-
2168
-
2169
- ### getShipmentBagReasons
2170
- Get reasons behind full or partial cancellation of a shipment
2171
-
2172
-
2173
-
2174
- ```javascript
2175
- // Promise
2176
- const promise = order.getShipmentBagReasons({ shipmentId : value,
2177
- bagId : value });
2178
-
2179
- // Async/Await
2180
- const data = await order.getShipmentBagReasons({ shipmentId : value,
2181
- bagId : value });
2182
- ```
2183
-
2184
-
2185
-
2186
-
2187
-
2188
- | Argument | Type | Required | Description |
2189
- | --------- | ----- | -------- | ----------- |
2190
- | shipmentId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2191
- | bagId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2192
-
2193
-
2194
-
2195
- Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
2196
-
2197
- *Returned Response:*
2198
-
2199
-
2200
-
2201
-
2202
- [ShipmentBagReasons](#ShipmentBagReasons)
2203
-
2204
- Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
2205
-
2206
-
2207
-
2208
-
2209
- <details>
2210
- <summary><i>&nbsp; Example:</i></summary>
2211
-
2212
- ```json
2213
- {
2214
- "success": true,
2215
- "reasons": [
2216
- {
2217
- "id": 1,
2218
- "display_name": "Not available",
2219
- "qc_type": [],
2220
- "question_set": []
2221
- },
2222
- {
2223
- "reasons": [
2224
- {
2225
- "id": 2,
2226
- "display_name": "Processing other orders",
2227
- "qc_type": [],
2228
- "question_set": []
2229
- },
2230
- {
2231
- "id": 3,
2232
- "display_name": "Printer not working",
2233
- "qc_type": [],
2234
- "question_set": []
2235
- },
2236
- {
2237
- "reasons": [
2238
- {
2239
- "id": 4,
2240
- "display_name": "Card issues",
2241
- "qc_type": [],
2242
- "question_set": []
2243
- }
2244
- ]
2245
- }
2246
- ]
2247
- },
2248
- {
2249
- "id": 4,
2250
- "display_name": "Card issues",
2251
- "qc_type": [],
2252
- "question_set": []
2253
- }
2254
- ]
2235
+ | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2236
+
2237
+
2238
+
2239
+ Use this API to send OTP to the customer of the mapped Shipment.
2240
+
2241
+ *Returned Response:*
2242
+
2243
+
2244
+
2245
+
2246
+ [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
2247
+
2248
+ Success to acknowledge the service was notified
2249
+
2250
+
2251
+
2252
+
2253
+ <details>
2254
+ <summary><i>&nbsp; Example:</i></summary>
2255
+
2256
+ ```json
2257
+ {
2258
+ "success": true,
2259
+ "request_id": "0fe0d6e16205ddc57d212e947ee31896",
2260
+ "message": "OTP sent",
2261
+ "resend_timer": 30
2255
2262
  }
2256
2263
  ```
2257
2264
  </details>
@@ -2267,17 +2274,17 @@ Success. Check the example shown below or refer `ShipmentBagReasons` for more de
2267
2274
  ---
2268
2275
 
2269
2276
 
2270
- ### getShipmentReasons
2271
- Get reasons behind full or partial cancellation of a shipment
2277
+ ### trackShipment
2278
+ Track shipment
2272
2279
 
2273
2280
 
2274
2281
 
2275
2282
  ```javascript
2276
2283
  // Promise
2277
- const promise = order.getShipmentReasons({ shipmentId : value });
2284
+ const promise = order.trackShipment({ shipmentId : value });
2278
2285
 
2279
2286
  // Async/Await
2280
- const data = await order.getShipmentReasons({ shipmentId : value });
2287
+ const data = await order.trackShipment({ shipmentId : value });
2281
2288
  ```
2282
2289
 
2283
2290
 
@@ -2290,16 +2297,16 @@ const data = await order.getShipmentReasons({ shipmentId : value });
2290
2297
 
2291
2298
 
2292
2299
 
2293
- Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
2300
+ Track Shipment by shipment id, for application based on application Id
2294
2301
 
2295
2302
  *Returned Response:*
2296
2303
 
2297
2304
 
2298
2305
 
2299
2306
 
2300
- [ShipmentReasons](#ShipmentReasons)
2307
+ [ShipmentTrack](#ShipmentTrack)
2301
2308
 
2302
- Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
2309
+ Success. Check the example shown below or refer `ShipmentTrack` for more details.
2303
2310
 
2304
2311
 
2305
2312
 
@@ -2309,86 +2316,16 @@ Success. Check the example shown below or refer `ShipmentBagReasons` for more de
2309
2316
 
2310
2317
  ```json
2311
2318
  {
2312
- "reasons": [
2313
- {
2314
- "reason_id": 115,
2315
- "priority": 9,
2316
- "reason_text": "Wrong size/colour delivered",
2317
- "show_text_area": false,
2318
- "feedback_type": "bag",
2319
- "flow": "return"
2320
- },
2321
- {
2322
- "reason_id": 116,
2323
- "priority": 10,
2324
- "reason_text": "Product does not fit me",
2325
- "show_text_area": false,
2326
- "feedback_type": "bag",
2327
- "flow": "return"
2328
- },
2329
- {
2330
- "reason_id": 117,
2331
- "priority": 11,
2332
- "reason_text": "Quality of product is not good",
2333
- "show_text_area": false,
2334
- "feedback_type": "bag",
2335
- "flow": "return"
2336
- },
2337
- {
2338
- "reason_id": 118,
2339
- "priority": 12,
2340
- "reason_text": "Wrong product delivered",
2341
- "show_text_area": true,
2342
- "feedback_type": "bag",
2343
- "flow": "return"
2344
- },
2345
- {
2346
- "reason_id": 119,
2347
- "priority": 13,
2348
- "reason_text": "Damaged product delivered",
2349
- "show_text_area": true,
2350
- "feedback_type": "bag",
2351
- "flow": "return"
2352
- },
2353
- {
2354
- "reason_id": 120,
2355
- "priority": 14,
2356
- "reason_text": "Used product delivered",
2357
- "show_text_area": true,
2358
- "feedback_type": "bag",
2359
- "flow": "return"
2360
- },
2361
- {
2362
- "reason_id": 124,
2363
- "priority": 15,
2364
- "reason_text": "Missing Items/Partially Received",
2365
- "show_text_area": true,
2366
- "feedback_type": "bag",
2367
- "flow": "return"
2368
- },
2369
- {
2370
- "reason_id": 121,
2371
- "priority": 16,
2372
- "reason_text": "Found better price elsewhere",
2373
- "show_text_area": true,
2374
- "feedback_type": "bag",
2375
- "flow": "return"
2376
- },
2377
- {
2378
- "reason_id": 122,
2379
- "priority": 17,
2380
- "reason_text": "Product looks different from image",
2381
- "show_text_area": true,
2382
- "feedback_type": "bag",
2383
- "flow": "return"
2384
- },
2319
+ "results": [
2385
2320
  {
2386
- "reason_id": 123,
2387
- "priority": 18,
2388
- "reason_text": "Other issue",
2389
- "show_text_area": true,
2390
- "feedback_type": "bag",
2391
- "flow": "return"
2321
+ "awb": "string",
2322
+ "updated_at": "string",
2323
+ "last_location_recieved_at": "string",
2324
+ "reason": "string",
2325
+ "shipment_type": "string",
2326
+ "status": "string",
2327
+ "updated_time": "string",
2328
+ "account_name": "string"
2392
2329
  }
2393
2330
  ]
2394
2331
  }
@@ -2480,950 +2417,518 @@ Successfully updateShipmentStatus!
2480
2417
  ---
2481
2418
 
2482
2419
 
2420
+ ### verifyOtpShipmentCustomer
2421
+ Verify Otp code
2483
2422
 
2484
- ### Schemas
2485
2423
 
2486
-
2487
-
2488
- #### [OrderPage](#OrderPage)
2489
2424
 
2490
- | Properties | Type | Nullable | Description |
2491
- | ---------- | ---- | -------- | ----------- |
2492
- | current | number | no | |
2493
- | type | string | no | |
2494
- | item_total | number | no | |
2495
- | size | number | no | |
2496
- | has_next | boolean | no | |
2425
+ ```javascript
2426
+ // Promise
2427
+ const promise = order.verifyOtpShipmentCustomer({ orderId : value,
2428
+ shipmentId : value,
2429
+ body : value });
2497
2430
 
2498
- ---
2431
+ // Async/Await
2432
+ const data = await order.verifyOtpShipmentCustomer({ orderId : value,
2433
+ shipmentId : value,
2434
+ body : value });
2435
+ ```
2499
2436
 
2500
2437
 
2501
-
2502
-
2503
- #### [OrderStatuses](#OrderStatuses)
2504
2438
 
2505
- | Properties | Type | Nullable | Description |
2506
- | ---------- | ---- | -------- | ----------- |
2507
- | is_selected | boolean | no | |
2508
- | value | number | no | |
2509
- | display | string | no | |
2510
2439
 
2511
- ---
2512
2440
 
2441
+ | Argument | Type | Required | Description |
2442
+ | --------- | ----- | -------- | ----------- |
2443
+ | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2444
+ | shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |
2445
+ | body | [VerifyOtp](#VerifyOtp) | yes | Request body |
2513
2446
 
2514
-
2515
-
2516
- #### [OrderFilters](#OrderFilters)
2517
2447
 
2518
- | Properties | Type | Nullable | Description |
2519
- | ---------- | ---- | -------- | ----------- |
2520
- | statuses | [[OrderStatuses](#OrderStatuses)] | no | |
2448
+ Use this API to verify OTP and create a session token with custom payload.
2521
2449
 
2522
- ---
2450
+ *Returned Response:*
2523
2451
 
2524
2452
 
2525
-
2526
-
2527
- #### [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment)
2528
2453
 
2529
- | Properties | Type | Nullable | Description |
2530
- | ---------- | ---- | -------- | ----------- |
2531
- | level | string | no | |
2532
- | strategy | string | no | |
2533
2454
 
2534
- ---
2455
+ [VerifyOtpResponse](#VerifyOtpResponse)
2535
2456
 
2457
+ Success, the code is valid and returns a session token
2536
2458
 
2537
-
2538
-
2539
- #### [BagsForReorder](#BagsForReorder)
2540
2459
 
2541
- | Properties | Type | Nullable | Description |
2542
- | ---------- | ---- | -------- | ----------- |
2543
- | article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) | no | |
2544
- | quantity | number | no | |
2545
- | item_size | string | no | |
2546
- | seller_id | number | no | |
2547
- | store_id | number | no | |
2548
- | item_id | number | no | |
2549
2460
 
2550
- ---
2461
+
2462
+ <details>
2463
+ <summary><i>&nbsp; Example:</i></summary>
2464
+
2465
+ ```json
2466
+ {
2467
+ "success": true
2468
+ }
2469
+ ```
2470
+ </details>
2471
+
2551
2472
 
2552
2473
 
2553
-
2554
-
2555
- #### [BreakupValues](#BreakupValues)
2556
2474
 
2557
- | Properties | Type | Nullable | Description |
2558
- | ---------- | ---- | -------- | ----------- |
2559
- | name | string | no | |
2560
- | value | number | no | |
2561
- | display | string | no | |
2562
2475
 
2563
- ---
2564
2476
 
2565
2477
 
2566
-
2567
-
2568
- #### [UserInfo](#UserInfo)
2569
2478
 
2570
- | Properties | Type | Nullable | Description |
2571
- | ---------- | ---- | -------- | ----------- |
2572
- | gender | string | no | |
2573
- | email | string | no | |
2574
- | name | string | no | |
2575
- | mobile | string | no | |
2576
2479
 
2577
2480
  ---
2578
2481
 
2579
2482
 
2580
-
2581
-
2582
- #### [ShipmentTotalDetails](#ShipmentTotalDetails)
2483
+
2484
+ ### Schemas
2485
+
2486
+
2487
+ #### [ApefaceApiError](#ApefaceApiError)
2583
2488
 
2584
2489
  | Properties | Type | Nullable | Description |
2585
- | ---------- | ---- | -------- | ----------- |
2586
- | sizes | number | no | |
2587
- | pieces | number | no | |
2588
- | total_price | number | no | |
2490
+ | ---------- | ---- | -------- | ----------- || message | string | no | || success | boolean | no | |
2589
2491
 
2590
2492
  ---
2591
2493
 
2592
-
2593
-
2594
-
2595
- #### [Prices](#Prices)
2494
+ #### [AppliedFreeArticles](#AppliedFreeArticles)
2596
2495
 
2597
2496
  | Properties | Type | Nullable | Description |
2598
- | ---------- | ---- | -------- | ----------- |
2599
- | refund_credit | number | no | |
2600
- | brand_calculated_amount | number | no | |
2601
- | cod_charges | number | no | |
2602
- | amount_paid | number | no | |
2603
- | discount | number | no | |
2604
- | transfer_price | number | no | |
2605
- | gst_tax_percentage | number | no | |
2606
- | refund_amount | number | no | |
2607
- | cashback_applied | number | no | |
2608
- | price_marked | number | no | |
2609
- | coupon_value | number | no | |
2610
- | value_of_good | number | no | |
2611
- | price_effective | number | no | |
2612
- | added_to_fynd_cash | boolean | no | |
2613
- | delivery_charge | number | no | |
2614
- | cashback | number | no | |
2615
- | fynd_credits | number | no | |
2616
- | coupon_effective_discount | number | no | |
2617
- | amount_paid_roundoff | number | no | |
2618
- | promotion_effective_discount | number | no | |
2497
+ | ---------- | ---- | -------- | ----------- || article_id | string | no | || free_gift_item_details | string | no | || parent_item_identifier | string | no | || quantity | number | no | |
2619
2498
 
2620
2499
  ---
2621
2500
 
2622
-
2623
-
2624
-
2625
- #### [ShipmentPayment](#ShipmentPayment)
2501
+ #### [AppliedPromos](#AppliedPromos)
2626
2502
 
2627
2503
  | Properties | Type | Nullable | Description |
2628
- | ---------- | ---- | -------- | ----------- |
2629
- | mop | string | no | |
2630
- | logo | string | no | |
2631
- | display_name | string | no | |
2632
- | payment_mode | string | no | |
2633
- | status | string | no | |
2634
- | mode | string | no | |
2504
+ | ---------- | ---- | -------- | ----------- || amount | number | no | || applied_free_articles | [[AppliedFreeArticles](#AppliedFreeArticles)] | no | || article_quantity | number | no | || mrp_promotion | boolean | no | || promo_id | string | no | || promotion_name | string | no | || promotion_type | string | no | |
2635
2505
 
2636
2506
  ---
2637
2507
 
2638
-
2639
-
2640
-
2641
- #### [Invoice](#Invoice)
2508
+ #### [BagReasonMeta](#BagReasonMeta)
2642
2509
 
2643
2510
  | Properties | Type | Nullable | Description |
2644
- | ---------- | ---- | -------- | ----------- |
2645
- | label_url | string | no | |
2646
- | invoice_url | string | no | |
2647
- | updated_date | string | no | |
2511
+ | ---------- | ---- | -------- | ----------- || show_text_area | boolean | no | |
2648
2512
 
2649
2513
  ---
2650
2514
 
2651
-
2652
-
2653
-
2654
- #### [FulfillingStore](#FulfillingStore)
2515
+ #### [BagReasons](#BagReasons)
2655
2516
 
2656
2517
  | Properties | Type | Nullable | Description |
2657
- | ---------- | ---- | -------- | ----------- |
2658
- | code | string | no | |
2659
- | name | string | no | |
2660
- | id | number | no | |
2661
- | company_name | string | no | |
2662
- | company_id | number | no | |
2518
+ | ---------- | ---- | -------- | ----------- || display_name | string | no | || id | number | no | || meta | [BagReasonMeta](#BagReasonMeta) | no | || qc_type | [string] | no | || question_set | [[QuestionSet](#QuestionSet)] | no | || reasons | [[BagReasons](#BagReasons)] | no | |
2663
2519
 
2664
2520
  ---
2665
2521
 
2666
-
2667
-
2668
-
2669
- #### [NestedTrackingDetails](#NestedTrackingDetails)
2522
+ #### [Bags](#Bags)
2670
2523
 
2671
2524
  | Properties | Type | Nullable | Description |
2672
- | ---------- | ---- | -------- | ----------- |
2673
- | is_current | boolean | no | |
2674
- | is_passed | boolean | no | |
2675
- | time | string | no | |
2676
- | status | string | no | |
2525
+ | ---------- | ---- | -------- | ----------- || applied_promos | [[AppliedPromos](#AppliedPromos)] | no | || can_cancel | boolean | no | || can_return | boolean | no | || current_status | [CurrentStatus](#CurrentStatus) | no | || delivery_date | string | no | || financial_breakup | [[FinancialBreakup](#FinancialBreakup)] | no | || id | number | no | || item | [Item](#Item) | no | || line_number | number | no | || parent_promo_bags | string | no | || prices | [Prices](#Prices) | no | || quantity | number | no | || returnable_date | string | no | || seller_identifier | string | no | |
2677
2526
 
2678
2527
  ---
2679
2528
 
2680
-
2681
-
2682
-
2683
- #### [TrackingDetails](#TrackingDetails)
2529
+ #### [BagsForReorder](#BagsForReorder)
2684
2530
 
2685
2531
  | Properties | Type | Nullable | Description |
2686
- | ---------- | ---- | -------- | ----------- |
2687
- | tracking_details | [[NestedTrackingDetails](#NestedTrackingDetails)] | no | |
2688
- | status | string | no | |
2689
- | time | string | no | |
2690
- | is_current | boolean | no | |
2691
- | is_passed | boolean | no | |
2532
+ | ---------- | ---- | -------- | ----------- || article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) | no | || item_id | number | no | || item_size | string | no | || quantity | number | no | || seller_id | number | no | || store_id | number | no | |
2692
2533
 
2693
2534
  ---
2694
2535
 
2695
-
2696
-
2697
-
2698
- #### [DeliveryAddress](#DeliveryAddress)
2536
+ #### [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment)
2699
2537
 
2700
2538
  | Properties | Type | Nullable | Description |
2701
- | ---------- | ---- | -------- | ----------- |
2702
- | address_type | string | no | |
2703
- | latitude | number | no | |
2704
- | landmark | string | no | |
2705
- | contact_person | string | no | |
2706
- | address | string | no | |
2707
- | longitude | number | no | |
2708
- | state | string | no | |
2709
- | updated_at | string | no | |
2710
- | address1 | string | no | |
2711
- | address_category | string | no | |
2712
- | version | string | no | |
2713
- | city | string | no | |
2714
- | name | string | no | |
2715
- | address2 | string | no | |
2716
- | country | string | no | |
2717
- | area | string | no | |
2718
- | pincode | string | no | |
2719
- | email | string | no | |
2720
- | created_at | string | no | |
2721
- | phone | string | no | |
2539
+ | ---------- | ---- | -------- | ----------- || level | string | no | || strategy | string | no | |
2722
2540
 
2723
2541
  ---
2724
2542
 
2725
-
2726
-
2727
-
2728
- #### [FulfillingCompany](#FulfillingCompany)
2543
+ #### [BreakupValues](#BreakupValues)
2729
2544
 
2730
2545
  | Properties | Type | Nullable | Description |
2731
- | ---------- | ---- | -------- | ----------- |
2732
- | id | number | no | |
2733
- | name | string | no | |
2546
+ | ---------- | ---- | -------- | ----------- || display | string | no | || name | string | no | || value | number | no | |
2734
2547
 
2735
2548
  ---
2736
2549
 
2737
-
2738
-
2739
-
2740
- #### [ShipmentUserInfo](#ShipmentUserInfo)
2550
+ #### [CurrentStatus](#CurrentStatus)
2741
2551
 
2742
2552
  | Properties | Type | Nullable | Description |
2743
- | ---------- | ---- | -------- | ----------- |
2744
- | gender | string | no | |
2745
- | last_name | string | no | |
2746
- | first_name | string | no | |
2747
- | mobile | string | no | |
2553
+ | ---------- | ---- | -------- | ----------- || journey_type | string | no | || name | string | no | || status | string | no | || updated_at | string | no | |
2748
2554
 
2749
2555
  ---
2750
2556
 
2751
-
2752
-
2753
-
2754
- #### [TimeStampData](#TimeStampData)
2557
+ #### [CustomerDetailsResponse](#CustomerDetailsResponse)
2755
2558
 
2756
2559
  | Properties | Type | Nullable | Description |
2757
- | ---------- | ---- | -------- | ----------- |
2758
- | min | string | no | |
2759
- | max | string | no | |
2560
+ | ---------- | ---- | -------- | ----------- || country | string | no | || name | string | no | || order_id | string | no | || phone | string | no | || shipment_id | string | no | |
2760
2561
 
2761
2562
  ---
2762
2563
 
2763
-
2764
-
2765
-
2766
- #### [Promise](#Promise)
2564
+ #### [DataUpdates](#DataUpdates)
2767
2565
 
2768
2566
  | Properties | Type | Nullable | Description |
2769
- | ---------- | ---- | -------- | ----------- |
2770
- | show_promise | boolean | no | |
2771
- | timestamp | [TimeStampData](#TimeStampData) | no | |
2567
+ | ---------- | ---- | -------- | ----------- || entities | [[EntitiesDataUpdates](#EntitiesDataUpdates)] | no | || products | [[ProductsDataUpdates](#ProductsDataUpdates)] | no | |
2772
2568
 
2773
2569
  ---
2774
2570
 
2775
-
2776
-
2777
-
2778
- #### [ShipmentStatus](#ShipmentStatus)
2571
+ #### [DeliveryAddress](#DeliveryAddress)
2779
2572
 
2780
2573
  | Properties | Type | Nullable | Description |
2781
- | ---------- | ---- | -------- | ----------- |
2782
- | title | string | no | |
2783
- | hex_code | string | no | |
2574
+ | ---------- | ---- | -------- | ----------- || address | string | no | || address1 | string | no | || address2 | string | no | || address_category | string | no | || address_type | string | no | || area | string | no | || city | string | no | || contact_person | string | no | || country | string | no | || created_at | string | no | || email | string | no | || landmark | string | no | || latitude | number | no | || longitude | number | no | || name | string | no | || phone | string | no | || pincode | string | no | || state | string | no | || updated_at | string | no | || version | string | no | |
2784
2575
 
2785
2576
  ---
2786
2577
 
2787
-
2788
-
2789
-
2790
- #### [ItemBrand](#ItemBrand)
2578
+ #### [EntitiesDataUpdates](#EntitiesDataUpdates)
2791
2579
 
2792
2580
  | Properties | Type | Nullable | Description |
2793
- | ---------- | ---- | -------- | ----------- |
2794
- | name | string | no | |
2795
- | logo | string | no | |
2581
+ | ---------- | ---- | -------- | ----------- || data | string | no | || filters | [string] | no | |
2796
2582
 
2797
2583
  ---
2798
2584
 
2799
-
2800
-
2801
-
2802
- #### [Item](#Item)
2585
+ #### [EntitiesReasons](#EntitiesReasons)
2803
2586
 
2804
2587
  | Properties | Type | Nullable | Description |
2805
- | ---------- | ---- | -------- | ----------- |
2806
- | slug_key | string | no | |
2807
- | code | string | no | |
2808
- | size | string | no | |
2809
- | brand | [ItemBrand](#ItemBrand) | no | |
2810
- | image | [string] | no | |
2811
- | id | number | no | |
2812
- | seller_identifier | string | no | |
2813
- | name | string | no | |
2588
+ | ---------- | ---- | -------- | ----------- || data | [EntityReasonData](#EntityReasonData) | no | || filters | [string] | no | |
2814
2589
 
2815
2590
  ---
2816
2591
 
2817
-
2818
-
2819
-
2820
- #### [Identifiers](#Identifiers)
2592
+ #### [EntityReasonData](#EntityReasonData)
2821
2593
 
2822
2594
  | Properties | Type | Nullable | Description |
2823
- | ---------- | ---- | -------- | ----------- |
2824
- | sku_code | string | no | |
2825
- | ean | string | no | |
2595
+ | ---------- | ---- | -------- | ----------- || reason_id | number | no | || reason_text | string | no | |
2826
2596
 
2827
2597
  ---
2828
2598
 
2829
-
2830
-
2831
-
2832
- #### [FinancialBreakup](#FinancialBreakup)
2599
+ #### [ErrorResponse](#ErrorResponse)
2833
2600
 
2834
2601
  | Properties | Type | Nullable | Description |
2835
- | ---------- | ---- | -------- | ----------- |
2836
- | refund_credit | number | no | |
2837
- | size | string | no | |
2838
- | brand_calculated_amount | number | no | |
2839
- | cod_charges | number | no | |
2840
- | amount_paid | number | no | |
2841
- | discount | number | no | |
2842
- | identifiers | [Identifiers](#Identifiers) | no | |
2843
- | transfer_price | number | no | |
2844
- | hsn_code | string | no | |
2845
- | gst_tax_percentage | number | no | |
2846
- | refund_amount | number | no | |
2847
- | cashback_applied | number | no | |
2848
- | coupon_value | number | no | |
2849
- | price_marked | number | no | |
2850
- | value_of_good | number | no | |
2851
- | price_effective | number | no | |
2852
- | added_to_fynd_cash | boolean | no | |
2853
- | gst_tag | string | no | |
2854
- | delivery_charge | number | no | |
2855
- | gst_fee | number | no | |
2856
- | item_name | string | no | |
2857
- | cashback | number | no | |
2858
- | fynd_credits | number | no | |
2859
- | coupon_effective_discount | number | no | |
2860
- | amount_paid_roundoff | number | no | |
2861
- | promotion_effective_discount | number | no | |
2862
- | total_units | number | no | |
2602
+ | ---------- | ---- | -------- | ----------- || code | string | no | || exception | string | no | || message | string | no | || stack_trace | string | no | || status | number | no | |
2863
2603
 
2864
2604
  ---
2865
2605
 
2866
-
2867
-
2868
-
2869
- #### [AppliedFreeArticles](#AppliedFreeArticles)
2606
+ #### [FinancialBreakup](#FinancialBreakup)
2870
2607
 
2871
2608
  | Properties | Type | Nullable | Description |
2872
- | ---------- | ---- | -------- | ----------- |
2873
- | article_id | string | no | |
2874
- | quantity | number | no | |
2875
- | free_gift_item_details | string | no | |
2876
- | parent_item_identifier | string | no | |
2609
+ | ---------- | ---- | -------- | ----------- || added_to_fynd_cash | boolean | no | || amount_paid | number | no | || amount_paid_roundoff | number | no | || brand_calculated_amount | number | no | || cashback | number | no | || cashback_applied | number | no | || cod_charges | number | no | || coupon_effective_discount | number | no | || coupon_value | number | no | || delivery_charge | number | no | || discount | number | no | || fynd_credits | number | no | || gst_fee | number | no | || gst_tag | string | no | || gst_tax_percentage | number | no | || hsn_code | string | no | || identifiers | [Identifiers](#Identifiers) | no | || item_name | string | no | || price_effective | number | no | || price_marked | number | no | || promotion_effective_discount | number | no | || refund_amount | number | no | || refund_credit | number | no | || size | string | no | || total_units | number | no | || transfer_price | number | no | || value_of_good | number | no | |
2877
2610
 
2878
2611
  ---
2879
2612
 
2880
-
2881
-
2882
-
2883
- #### [AppliedPromos](#AppliedPromos)
2613
+ #### [FulfillingCompany](#FulfillingCompany)
2884
2614
 
2885
2615
  | Properties | Type | Nullable | Description |
2886
- | ---------- | ---- | -------- | ----------- |
2887
- | applied_free_articles | [[AppliedFreeArticles](#AppliedFreeArticles)] | no | |
2888
- | mrp_promotion | boolean | no | |
2889
- | promo_id | string | no | |
2890
- | promotion_type | string | no | |
2891
- | article_quantity | number | no | |
2892
- | amount | number | no | |
2893
- | promotion_name | string | no | |
2616
+ | ---------- | ---- | -------- | ----------- || id | number | no | || name | string | no | |
2894
2617
 
2895
2618
  ---
2896
2619
 
2897
-
2898
-
2899
-
2900
- #### [CurrentStatus](#CurrentStatus)
2620
+ #### [FulfillingStore](#FulfillingStore)
2901
2621
 
2902
2622
  | Properties | Type | Nullable | Description |
2903
- | ---------- | ---- | -------- | ----------- |
2904
- | journey_type | string | no | |
2905
- | name | string | no | |
2906
- | updated_at | string | no | |
2907
- | status | string | no | |
2623
+ | ---------- | ---- | -------- | ----------- || code | string | no | || company_id | number | no | || company_name | string | no | || id | number | no | || name | string | no | |
2908
2624
 
2909
2625
  ---
2910
2626
 
2911
-
2912
-
2913
-
2914
- #### [Bags](#Bags)
2627
+ #### [Identifiers](#Identifiers)
2915
2628
 
2916
2629
  | Properties | Type | Nullable | Description |
2917
- | ---------- | ---- | -------- | ----------- |
2918
- | returnable_date | string | no | |
2919
- | item | [Item](#Item) | no | |
2920
- | prices | [Prices](#Prices) | no | |
2921
- | quantity | number | no | |
2922
- | financial_breakup | [[FinancialBreakup](#FinancialBreakup)] | no | |
2923
- | parent_promo_bags | string | no | |
2924
- | line_number | number | no | |
2925
- | can_return | boolean | no | |
2926
- | id | number | no | |
2927
- | seller_identifier | string | no | |
2928
- | applied_promos | [[AppliedPromos](#AppliedPromos)] | no | |
2929
- | can_cancel | boolean | no | |
2930
- | delivery_date | string | no | |
2931
- | current_status | [CurrentStatus](#CurrentStatus) | no | |
2630
+ | ---------- | ---- | -------- | ----------- || ean | string | no | || sku_code | string | no | |
2932
2631
 
2933
2632
  ---
2934
2633
 
2935
-
2936
-
2937
-
2938
- #### [Shipments](#Shipments)
2634
+ #### [Invoice](#Invoice)
2939
2635
 
2940
2636
  | Properties | Type | Nullable | Description |
2941
- | ---------- | ---- | -------- | ----------- |
2942
- | shipment_id | string | no | |
2943
- | total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) | no | |
2944
- | prices | [Prices](#Prices) | no | |
2945
- | payment | [ShipmentPayment](#ShipmentPayment) | no | |
2946
- | can_return | boolean | no | |
2947
- | order_id | string | no | |
2948
- | awb_no | string | no | |
2949
- | invoice | [Invoice](#Invoice) | no | |
2950
- | shipment_created_at | string | no | |
2951
- | fulfilling_store | [FulfillingStore](#FulfillingStore) | no | |
2952
- | show_track_link | boolean | no | |
2953
- | need_help_url | string | no | |
2954
- | order_type | string | no | |
2955
- | dp_name | string | no | |
2956
- | can_cancel | boolean | no | |
2957
- | returnable_date | string | no | |
2958
- | refund_details | string | no | |
2959
- | breakup_values | [[BreakupValues](#BreakupValues)] | no | |
2960
- | traking_no | string | no | |
2961
- | tracking_details | [[TrackingDetails](#TrackingDetails)] | no | |
2962
- | delivery_address | [DeliveryAddress](#DeliveryAddress) | no | |
2963
- | size_info | string | no | |
2964
- | can_break | string | no | |
2965
- | fulfilling_company | [FulfillingCompany](#FulfillingCompany) | no | |
2966
- | track_url | string | no | |
2967
- | user_info | [ShipmentUserInfo](#ShipmentUserInfo) | no | |
2968
- | beneficiary_details | boolean | no | |
2969
- | promise | [Promise](#Promise) | no | |
2970
- | total_bags | number | no | |
2971
- | shipment_status | [ShipmentStatus](#ShipmentStatus) | no | |
2972
- | show_download_invoice | boolean | no | |
2973
- | bags | [[Bags](#Bags)] | no | |
2974
- | delivery_date | string | no | |
2975
- | custom_meta | [string] | no | |
2976
- | comment | string | no | |
2637
+ | ---------- | ---- | -------- | ----------- || invoice_url | string | no | || label_url | string | no | || updated_date | string | no | |
2977
2638
 
2978
2639
  ---
2979
2640
 
2980
-
2981
-
2982
-
2983
- #### [OrderSchema](#OrderSchema)
2641
+ #### [Item](#Item)
2984
2642
 
2985
2643
  | Properties | Type | Nullable | Description |
2986
- | ---------- | ---- | -------- | ----------- |
2987
- | bags_for_reorder | [[BagsForReorder](#BagsForReorder)] | no | |
2988
- | breakup_values | [[BreakupValues](#BreakupValues)] | no | |
2989
- | user_info | [UserInfo](#UserInfo) | no | |
2990
- | order_id | string | no | |
2991
- | total_shipments_in_order | number | no | |
2992
- | order_created_time | string | no | |
2993
- | shipments | [[Shipments](#Shipments)] | no | |
2644
+ | ---------- | ---- | -------- | ----------- || brand | [ItemBrand](#ItemBrand) | no | || code | string | no | || id | number | no | || image | [string] | no | || name | string | no | || seller_identifier | string | no | || size | string | no | || slug_key | string | no | |
2994
2645
 
2995
2646
  ---
2996
2647
 
2997
-
2998
-
2999
-
3000
- #### [OrderList](#OrderList)
2648
+ #### [ItemBrand](#ItemBrand)
3001
2649
 
3002
2650
  | Properties | Type | Nullable | Description |
3003
- | ---------- | ---- | -------- | ----------- |
3004
- | page | [OrderPage](#OrderPage) | no | |
3005
- | filters | [OrderFilters](#OrderFilters) | no | |
3006
- | items | [[OrderSchema](#OrderSchema)] | no | |
2651
+ | ---------- | ---- | -------- | ----------- || logo | string | no | || name | string | no | |
3007
2652
 
3008
2653
  ---
3009
2654
 
3010
-
3011
-
3012
-
3013
- #### [ApefaceApiError](#ApefaceApiError)
2655
+ #### [NestedTrackingDetails](#NestedTrackingDetails)
3014
2656
 
3015
2657
  | Properties | Type | Nullable | Description |
3016
- | ---------- | ---- | -------- | ----------- |
3017
- | message | string | no | |
3018
- | success | boolean | no | |
2658
+ | ---------- | ---- | -------- | ----------- || is_current | boolean | no | || is_passed | boolean | no | || status | string | no | || time | string | no | |
3019
2659
 
3020
2660
  ---
3021
2661
 
3022
-
3023
-
3024
-
3025
- #### [OrderById](#OrderById)
2662
+ #### [OrderById](#OrderById)
3026
2663
 
3027
2664
  | Properties | Type | Nullable | Description |
3028
- | ---------- | ---- | -------- | ----------- |
3029
- | order | [OrderSchema](#OrderSchema) | no | |
2665
+ | ---------- | ---- | -------- | ----------- || order | [OrderSchema](#OrderSchema) | no | |
3030
2666
 
3031
2667
  ---
3032
2668
 
3033
-
3034
-
3035
-
3036
- #### [ShipmentById](#ShipmentById)
2669
+ #### [OrderFilters](#OrderFilters)
3037
2670
 
3038
2671
  | Properties | Type | Nullable | Description |
3039
- | ---------- | ---- | -------- | ----------- |
3040
- | shipment | [Shipments](#Shipments) | no | |
2672
+ | ---------- | ---- | -------- | ----------- || statuses | [[OrderStatuses](#OrderStatuses)] | no | |
3041
2673
 
3042
2674
  ---
3043
2675
 
3044
-
3045
-
3046
-
3047
- #### [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
2676
+ #### [OrderList](#OrderList)
3048
2677
 
3049
2678
  | Properties | Type | Nullable | Description |
3050
- | ---------- | ---- | -------- | ----------- |
3051
- | presigned_url | string | yes | |
3052
- | shipment_id | string | yes | |
3053
- | success | boolean | yes | |
3054
- | presigned_type | string | yes | |
2679
+ | ---------- | ---- | -------- | ----------- || filters | [OrderFilters](#OrderFilters) | no | || items | [[OrderSchema](#OrderSchema)] | no | || page | [OrderPage](#OrderPage) | no | |
3055
2680
 
3056
2681
  ---
3057
2682
 
3058
-
3059
-
3060
-
3061
- #### [Track](#Track)
2683
+ #### [OrderPage](#OrderPage)
3062
2684
 
3063
2685
  | Properties | Type | Nullable | Description |
3064
- | ---------- | ---- | -------- | ----------- |
3065
- | last_location_recieved_at | string | no | |
3066
- | reason | string | no | |
3067
- | updated_time | string | no | |
3068
- | account_name | string | no | |
3069
- | updated_at | string | no | |
3070
- | awb | string | no | |
3071
- | status | string | no | |
3072
- | shipment_type | string | no | |
2686
+ | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || item_total | number | no | || size | number | no | || type | string | no | |
3073
2687
 
3074
2688
  ---
3075
2689
 
3076
-
3077
-
3078
-
3079
- #### [ShipmentTrack](#ShipmentTrack)
2690
+ #### [OrderSchema](#OrderSchema)
3080
2691
 
3081
2692
  | Properties | Type | Nullable | Description |
3082
- | ---------- | ---- | -------- | ----------- |
3083
- | results | [[Track](#Track)] | no | |
2693
+ | ---------- | ---- | -------- | ----------- || bags_for_reorder | [[BagsForReorder](#BagsForReorder)] | no | || breakup_values | [[BreakupValues](#BreakupValues)] | no | || order_created_time | string | no | || order_id | string | no | || shipments | [[Shipments](#Shipments)] | no | || total_shipments_in_order | number | no | || user_info | [UserInfo](#UserInfo) | no | |
3084
2694
 
3085
2695
  ---
3086
2696
 
3087
-
3088
-
3089
-
3090
- #### [CustomerDetailsResponse](#CustomerDetailsResponse)
2697
+ #### [OrderStatuses](#OrderStatuses)
3091
2698
 
3092
2699
  | Properties | Type | Nullable | Description |
3093
- | ---------- | ---- | -------- | ----------- |
3094
- | shipment_id | string | no | |
3095
- | country | string | no | |
3096
- | order_id | string | no | |
3097
- | phone | string | no | |
3098
- | name | string | no | |
2700
+ | ---------- | ---- | -------- | ----------- || display | string | no | || is_selected | boolean | no | || value | number | no | |
3099
2701
 
3100
2702
  ---
3101
2703
 
3102
-
3103
-
3104
-
3105
- #### [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
2704
+ #### [Prices](#Prices)
3106
2705
 
3107
2706
  | Properties | Type | Nullable | Description |
3108
- | ---------- | ---- | -------- | ----------- |
3109
- | request_id | string | no | |
3110
- | message | string | no | |
3111
- | success | boolean | no | |
3112
- | resend_timer | number | no | |
2707
+ | ---------- | ---- | -------- | ----------- || added_to_fynd_cash | boolean | no | || amount_paid | number | no | || amount_paid_roundoff | number | no | || brand_calculated_amount | number | no | || cashback | number | no | || cashback_applied | number | no | || cod_charges | number | no | || coupon_effective_discount | number | no | || coupon_value | number | no | || delivery_charge | number | no | || discount | number | no | || fynd_credits | number | no | || gst_tax_percentage | number | no | || price_effective | number | no | || price_marked | number | no | || promotion_effective_discount | number | no | || refund_amount | number | no | || refund_credit | number | no | || transfer_price | number | no | || value_of_good | number | no | |
3113
2708
 
3114
2709
  ---
3115
2710
 
3116
-
3117
-
3118
-
3119
- #### [VerifyOtp](#VerifyOtp)
2711
+ #### [Products](#Products)
3120
2712
 
3121
2713
  | Properties | Type | Nullable | Description |
3122
- | ---------- | ---- | -------- | ----------- |
3123
- | request_id | string | no | |
3124
- | otp_code | string | no | |
2714
+ | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | || quantity | number | no | |
3125
2715
 
3126
2716
  ---
3127
2717
 
3128
-
3129
-
3130
-
3131
- #### [VerifyOtpResponse](#VerifyOtpResponse)
2718
+ #### [ProductsDataUpdates](#ProductsDataUpdates)
3132
2719
 
3133
2720
  | Properties | Type | Nullable | Description |
3134
- | ---------- | ---- | -------- | ----------- |
3135
- | success | boolean | no | |
2721
+ | ---------- | ---- | -------- | ----------- || data | string | no | || filters | [[ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)] | no | |
3136
2722
 
3137
2723
  ---
3138
2724
 
3139
-
3140
-
3141
-
3142
- #### [QuestionSet](#QuestionSet)
2725
+ #### [ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)
3143
2726
 
3144
2727
  | Properties | Type | Nullable | Description |
3145
- | ---------- | ---- | -------- | ----------- |
3146
- | id | number | no | |
3147
- | display_name | string | no | |
2728
+ | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | |
3148
2729
 
3149
2730
  ---
3150
2731
 
3151
-
3152
-
3153
-
3154
- #### [BagReasonMeta](#BagReasonMeta)
2732
+ #### [ProductsReasons](#ProductsReasons)
3155
2733
 
3156
2734
  | Properties | Type | Nullable | Description |
3157
- | ---------- | ---- | -------- | ----------- |
3158
- | show_text_area | boolean | no | |
2735
+ | ---------- | ---- | -------- | ----------- || data | [ProductsReasonsData](#ProductsReasonsData) | no | || filters | [[ProductsReasonsFilters](#ProductsReasonsFilters)] | no | |
3159
2736
 
3160
2737
  ---
3161
2738
 
3162
-
3163
-
3164
-
3165
- #### [BagReasons](#BagReasons)
2739
+ #### [ProductsReasonsData](#ProductsReasonsData)
3166
2740
 
3167
2741
  | Properties | Type | Nullable | Description |
3168
- | ---------- | ---- | -------- | ----------- |
3169
- | question_set | [[QuestionSet](#QuestionSet)] | no | |
3170
- | meta | [BagReasonMeta](#BagReasonMeta) | no | |
3171
- | display_name | string | no | |
3172
- | reasons | [[BagReasons](#BagReasons)] | no | |
3173
- | id | number | no | |
3174
- | qc_type | [string] | no | |
2742
+ | ---------- | ---- | -------- | ----------- || reason_id | number | no | || reason_text | string | no | |
3175
2743
 
3176
2744
  ---
3177
2745
 
3178
-
3179
-
3180
-
3181
- #### [ShipmentBagReasons](#ShipmentBagReasons)
2746
+ #### [ProductsReasonsFilters](#ProductsReasonsFilters)
3182
2747
 
3183
2748
  | Properties | Type | Nullable | Description |
3184
- | ---------- | ---- | -------- | ----------- |
3185
- | success | boolean | no | |
3186
- | reasons | [[BagReasons](#BagReasons)] | no | |
2749
+ | ---------- | ---- | -------- | ----------- || identifier | string | no | || line_number | number | no | || quantity | number | no | |
3187
2750
 
3188
2751
  ---
3189
2752
 
3190
-
3191
-
3192
-
3193
- #### [ShipmentReason](#ShipmentReason)
2753
+ #### [Promise](#Promise)
3194
2754
 
3195
2755
  | Properties | Type | Nullable | Description |
3196
- | ---------- | ---- | -------- | ----------- |
3197
- | reason_id | number | no | |
3198
- | feedback_type | string | no | |
3199
- | flow | string | no | |
3200
- | reason_text | string | no | |
3201
- | show_text_area | boolean | no | |
3202
- | priority | number | no | |
2756
+ | ---------- | ---- | -------- | ----------- || show_promise | boolean | no | || timestamp | [TimeStampData](#TimeStampData) | no | |
3203
2757
 
3204
2758
  ---
3205
2759
 
3206
-
3207
-
3208
-
3209
- #### [ShipmentReasons](#ShipmentReasons)
2760
+ #### [QuestionSet](#QuestionSet)
3210
2761
 
3211
2762
  | Properties | Type | Nullable | Description |
3212
- | ---------- | ---- | -------- | ----------- |
3213
- | reasons | [[ShipmentReason](#ShipmentReason)] | no | |
2763
+ | ---------- | ---- | -------- | ----------- || display_name | string | no | || id | number | no | |
3214
2764
 
3215
2765
  ---
3216
2766
 
3217
-
3218
-
3219
-
3220
- #### [Products](#Products)
2767
+ #### [ReasonsData](#ReasonsData)
3221
2768
 
3222
2769
  | Properties | Type | Nullable | Description |
3223
- | ---------- | ---- | -------- | ----------- |
3224
- | line_number | number | no | |
3225
- | identifier | string | no | |
3226
- | quantity | number | no | |
2770
+ | ---------- | ---- | -------- | ----------- || entities | [[EntitiesReasons](#EntitiesReasons)] | no | || products | [[ProductsReasons](#ProductsReasons)] | no | |
3227
2771
 
3228
2772
  ---
3229
2773
 
3230
-
3231
-
3232
-
3233
- #### [ProductsReasonsData](#ProductsReasonsData)
2774
+ #### [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
3234
2775
 
3235
2776
  | Properties | Type | Nullable | Description |
3236
- | ---------- | ---- | -------- | ----------- |
3237
- | reason_text | string | no | |
3238
- | reason_id | number | no | |
2777
+ | ---------- | ---- | -------- | ----------- || presigned_type | string | yes | || presigned_url | string | yes | || shipment_id | string | yes | || success | boolean | yes | |
3239
2778
 
3240
2779
  ---
3241
2780
 
3242
-
3243
-
3244
-
3245
- #### [ProductsReasonsFilters](#ProductsReasonsFilters)
2781
+ #### [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
3246
2782
 
3247
2783
  | Properties | Type | Nullable | Description |
3248
- | ---------- | ---- | -------- | ----------- |
3249
- | line_number | number | no | |
3250
- | identifier | string | no | |
3251
- | quantity | number | no | |
2784
+ | ---------- | ---- | -------- | ----------- || message | string | no | || request_id | string | no | || resend_timer | number | no | || success | boolean | no | |
3252
2785
 
3253
2786
  ---
3254
2787
 
3255
-
3256
-
3257
-
3258
- #### [ProductsReasons](#ProductsReasons)
2788
+ #### [ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
3259
2789
 
3260
2790
  | Properties | Type | Nullable | Description |
3261
- | ---------- | ---- | -------- | ----------- |
3262
- | data | [ProductsReasonsData](#ProductsReasonsData) | no | |
3263
- | filters | [[ProductsReasonsFilters](#ProductsReasonsFilters)] | no | |
2791
+ | ---------- | ---- | -------- | ----------- || statuses | [[StatusesBodyResponse](#StatusesBodyResponse)] | no | |
3264
2792
 
3265
2793
  ---
3266
2794
 
3267
-
3268
-
3269
-
3270
- #### [EntityReasonData](#EntityReasonData)
2795
+ #### [ShipmentBagReasons](#ShipmentBagReasons)
3271
2796
 
3272
2797
  | Properties | Type | Nullable | Description |
3273
- | ---------- | ---- | -------- | ----------- |
3274
- | reason_text | string | no | |
3275
- | reason_id | number | no | |
2798
+ | ---------- | ---- | -------- | ----------- || reasons | [[BagReasons](#BagReasons)] | no | || success | boolean | no | |
3276
2799
 
3277
2800
  ---
3278
2801
 
3279
-
3280
-
3281
-
3282
- #### [EntitiesReasons](#EntitiesReasons)
2802
+ #### [ShipmentById](#ShipmentById)
3283
2803
 
3284
2804
  | Properties | Type | Nullable | Description |
3285
- | ---------- | ---- | -------- | ----------- |
3286
- | data | [EntityReasonData](#EntityReasonData) | no | |
3287
- | filters | [string] | no | |
2805
+ | ---------- | ---- | -------- | ----------- || shipment | [Shipments](#Shipments) | no | |
3288
2806
 
3289
2807
  ---
3290
2808
 
3291
-
3292
-
3293
-
3294
- #### [ReasonsData](#ReasonsData)
2809
+ #### [ShipmentPayment](#ShipmentPayment)
3295
2810
 
3296
2811
  | Properties | Type | Nullable | Description |
3297
- | ---------- | ---- | -------- | ----------- |
3298
- | products | [[ProductsReasons](#ProductsReasons)] | no | |
3299
- | entities | [[EntitiesReasons](#EntitiesReasons)] | no | |
2812
+ | ---------- | ---- | -------- | ----------- || display_name | string | no | || logo | string | no | || mode | string | no | || mop | string | no | || payment_mode | string | no | || status | string | no | |
3300
2813
 
3301
2814
  ---
3302
2815
 
3303
-
3304
-
3305
-
3306
- #### [ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)
2816
+ #### [ShipmentReason](#ShipmentReason)
3307
2817
 
3308
2818
  | Properties | Type | Nullable | Description |
3309
- | ---------- | ---- | -------- | ----------- |
3310
- | line_number | number | no | |
3311
- | identifier | string | no | |
2819
+ | ---------- | ---- | -------- | ----------- || feedback_type | string | no | || flow | string | no | || priority | number | no | || reason_id | number | no | || reason_text | string | no | || show_text_area | boolean | no | |
3312
2820
 
3313
2821
  ---
3314
2822
 
3315
-
3316
-
3317
-
3318
- #### [ProductsDataUpdates](#ProductsDataUpdates)
2823
+ #### [ShipmentReasons](#ShipmentReasons)
3319
2824
 
3320
2825
  | Properties | Type | Nullable | Description |
3321
- | ---------- | ---- | -------- | ----------- |
3322
- | data | string | no | |
3323
- | filters | [[ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)] | no | |
2826
+ | ---------- | ---- | -------- | ----------- || reasons | [[ShipmentReason](#ShipmentReason)] | no | |
3324
2827
 
3325
2828
  ---
3326
2829
 
3327
-
3328
-
3329
-
3330
- #### [EntitiesDataUpdates](#EntitiesDataUpdates)
2830
+ #### [Shipments](#Shipments)
3331
2831
 
3332
2832
  | Properties | Type | Nullable | Description |
3333
- | ---------- | ---- | -------- | ----------- |
3334
- | data | string | no | |
3335
- | filters | [string] | no | |
2833
+ | ---------- | ---- | -------- | ----------- || awb_no | string | no | || bags | [[Bags](#Bags)] | no | || beneficiary_details | boolean | no | || breakup_values | [[BreakupValues](#BreakupValues)] | no | || can_break | string | no | || can_cancel | boolean | no | || can_return | boolean | no | || comment | string | no | || custom_meta | [string] | no | || delivery_address | [DeliveryAddress](#DeliveryAddress) | no | || delivery_date | string | no | || dp_name | string | no | || fulfilling_company | [FulfillingCompany](#FulfillingCompany) | no | || fulfilling_store | [FulfillingStore](#FulfillingStore) | no | || invoice | [Invoice](#Invoice) | no | || need_help_url | string | no | || order_id | string | no | || order_type | string | no | || payment | [ShipmentPayment](#ShipmentPayment) | no | || prices | [Prices](#Prices) | no | || promise | [Promise](#Promise) | no | || refund_details | string | no | || returnable_date | string | no | || shipment_created_at | string | no | || shipment_id | string | no | || shipment_status | [ShipmentStatus](#ShipmentStatus) | no | || show_download_invoice | boolean | no | || show_track_link | boolean | no | || size_info | string | no | || total_bags | number | no | || total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) | no | || track_url | string | no | || tracking_details | [[TrackingDetails](#TrackingDetails)] | no | || traking_no | string | no | || user_info | [ShipmentUserInfo](#ShipmentUserInfo) | no | |
3336
2834
 
3337
2835
  ---
3338
2836
 
2837
+ #### [ShipmentsRequest](#ShipmentsRequest)
2838
+
2839
+ | Properties | Type | Nullable | Description |
2840
+ | ---------- | ---- | -------- | ----------- || data_updates | [DataUpdates](#DataUpdates) | no | || identifier | string | yes | || products | [[Products](#Products)] | no | || reasons | [ReasonsData](#ReasonsData) | no | |
2841
+
2842
+ ---
3339
2843
 
3340
-
3341
-
3342
- #### [DataUpdates](#DataUpdates)
2844
+ #### [ShipmentStatus](#ShipmentStatus)
3343
2845
 
3344
2846
  | Properties | Type | Nullable | Description |
3345
- | ---------- | ---- | -------- | ----------- |
3346
- | products | [[ProductsDataUpdates](#ProductsDataUpdates)] | no | |
3347
- | entities | [[EntitiesDataUpdates](#EntitiesDataUpdates)] | no | |
2847
+ | ---------- | ---- | -------- | ----------- || hex_code | string | no | || title | string | no | |
3348
2848
 
3349
2849
  ---
3350
2850
 
2851
+ #### [ShipmentTotalDetails](#ShipmentTotalDetails)
3351
2852
 
3352
-
3353
-
3354
- #### [ShipmentsRequest](#ShipmentsRequest)
2853
+ | Properties | Type | Nullable | Description |
2854
+ | ---------- | ---- | -------- | ----------- || pieces | number | no | || sizes | number | no | || total_price | number | no | |
2855
+
2856
+ ---
2857
+
2858
+ #### [ShipmentTrack](#ShipmentTrack)
3355
2859
 
3356
2860
  | Properties | Type | Nullable | Description |
3357
- | ---------- | ---- | -------- | ----------- |
3358
- | identifier | string | yes | |
3359
- | products | [[Products](#Products)] | no | |
3360
- | reasons | [ReasonsData](#ReasonsData) | no | |
3361
- | data_updates | [DataUpdates](#DataUpdates) | no | |
2861
+ | ---------- | ---- | -------- | ----------- || results | [[Track](#Track)] | no | |
3362
2862
 
3363
2863
  ---
3364
2864
 
2865
+ #### [ShipmentUserInfo](#ShipmentUserInfo)
2866
+
2867
+ | Properties | Type | Nullable | Description |
2868
+ | ---------- | ---- | -------- | ----------- || first_name | string | no | || gender | string | no | || last_name | string | no | || mobile | string | no | |
2869
+
2870
+ ---
3365
2871
 
3366
-
3367
-
3368
- #### [StatuesRequest](#StatuesRequest)
2872
+ #### [StatuesRequest](#StatuesRequest)
3369
2873
 
3370
2874
  | Properties | Type | Nullable | Description |
3371
- | ---------- | ---- | -------- | ----------- |
3372
- | exclude_bags_next_state | string | no | |
3373
- | shipments | [[ShipmentsRequest](#ShipmentsRequest)] | no | |
3374
- | status | string | no | |
2875
+ | ---------- | ---- | -------- | ----------- || exclude_bags_next_state | string | no | || shipments | [[ShipmentsRequest](#ShipmentsRequest)] | no | || status | string | no | |
3375
2876
 
3376
2877
  ---
3377
2878
 
2879
+ #### [StatusesBodyResponse](#StatusesBodyResponse)
3378
2880
 
3379
-
3380
-
3381
- #### [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest)
2881
+ | Properties | Type | Nullable | Description |
2882
+ | ---------- | ---- | -------- | ----------- || shipments | [string] | no | |
2883
+
2884
+ ---
2885
+
2886
+ #### [TimeStampData](#TimeStampData)
3382
2887
 
3383
2888
  | Properties | Type | Nullable | Description |
3384
- | ---------- | ---- | -------- | ----------- |
3385
- | statuses | [[StatuesRequest](#StatuesRequest)] | no | |
3386
- | task | boolean | no | |
3387
- | unlock_before_transition | boolean | no | |
3388
- | force_transition | boolean | no | |
3389
- | lock_after_transition | boolean | no | |
2889
+ | ---------- | ---- | -------- | ----------- || max | string | no | || min | string | no | |
3390
2890
 
3391
2891
  ---
3392
2892
 
2893
+ #### [Track](#Track)
2894
+
2895
+ | Properties | Type | Nullable | Description |
2896
+ | ---------- | ---- | -------- | ----------- || account_name | string | no | || awb | string | no | || last_location_recieved_at | string | no | || reason | string | no | || shipment_type | string | no | || status | string | no | || updated_at | string | no | || updated_time | string | no | |
2897
+
2898
+ ---
3393
2899
 
3394
-
3395
-
3396
- #### [StatusesBodyResponse](#StatusesBodyResponse)
2900
+ #### [TrackingDetails](#TrackingDetails)
3397
2901
 
3398
2902
  | Properties | Type | Nullable | Description |
3399
- | ---------- | ---- | -------- | ----------- |
3400
- | shipments | [string] | no | |
2903
+ | ---------- | ---- | -------- | ----------- || is_current | boolean | no | || is_passed | boolean | no | || status | string | no | || time | string | no | || tracking_details | [[NestedTrackingDetails](#NestedTrackingDetails)] | no | |
3401
2904
 
3402
2905
  ---
3403
2906
 
2907
+ #### [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest)
3404
2908
 
3405
-
3406
-
3407
- #### [ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
2909
+ | Properties | Type | Nullable | Description |
2910
+ | ---------- | ---- | -------- | ----------- || force_transition | boolean | no | || lock_after_transition | boolean | no | || statuses | [[StatuesRequest](#StatuesRequest)] | no | || task | boolean | no | || unlock_before_transition | boolean | no | |
2911
+
2912
+ ---
2913
+
2914
+ #### [UserInfo](#UserInfo)
3408
2915
 
3409
2916
  | Properties | Type | Nullable | Description |
3410
- | ---------- | ---- | -------- | ----------- |
3411
- | statuses | [[StatusesBodyResponse](#StatusesBodyResponse)] | no | |
2917
+ | ---------- | ---- | -------- | ----------- || email | string | no | || gender | string | no | || mobile | string | no | || name | string | no | |
3412
2918
 
3413
2919
  ---
3414
2920
 
2921
+ #### [VerifyOtp](#VerifyOtp)
2922
+
2923
+ | Properties | Type | Nullable | Description |
2924
+ | ---------- | ---- | -------- | ----------- || otp_code | string | no | || request_id | string | no | |
2925
+
2926
+ ---
3415
2927
 
3416
-
3417
-
3418
- #### [ErrorResponse](#ErrorResponse)
2928
+ #### [VerifyOtpResponse](#VerifyOtpResponse)
3419
2929
 
3420
2930
  | Properties | Type | Nullable | Description |
3421
- | ---------- | ---- | -------- | ----------- |
3422
- | stack_trace | string | no | |
3423
- | code | string | no | |
3424
- | message | string | no | |
3425
- | exception | string | no | |
3426
- | status | number | no | |
2931
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
3427
2932
 
3428
2933
  ---
3429
2934