@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

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 (326) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +0 -2
  8. package/sdk/application/ApplicationClient.js +0 -20
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -97
  10. package/sdk/application/Cart/CartApplicationClient.js +60 -1262
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -162
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1313
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -9
  14. package/sdk/application/Common/CommonApplicationClient.js +5 -90
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -80
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -725
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +63 -85
  20. package/sdk/application/Content/ContentApplicationClient.js +126 -942
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -15
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +26 -130
  23. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -17
  24. package/sdk/application/Lead/LeadApplicationClient.js +32 -201
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -62
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +51 -647
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -56
  28. package/sdk/application/Order/OrderApplicationClient.js +86 -555
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -209
  30. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2099
  31. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -26
  32. package/sdk/application/Rewards/RewardsApplicationClient.js +17 -303
  33. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  34. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  35. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  36. package/sdk/application/Theme/ThemeApplicationClient.js +30 -166
  37. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  38. package/sdk/application/User/UserApplicationClient.js +47 -1817
  39. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  40. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -49
  41. package/sdk/application/index.d.ts +0 -19
  42. package/sdk/application/index.js +0 -35
  43. package/sdk/common/Utility.d.ts +1 -1
  44. package/sdk/common/Utility.js +10 -7
  45. package/sdk/common/Validator.d.ts +1 -0
  46. package/sdk/common/Validator.js +20 -0
  47. package/sdk/common/utils.d.ts +0 -1
  48. package/sdk/common/utils.js +0 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  56. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  58. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
  65. package/sdk/partner/OAuthClient.js +1 -0
  66. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  67. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  68. package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
  69. package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
  70. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  71. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  72. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  73. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  74. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  75. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  76. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  90. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +1328 -4975
  98. package/sdk/platform/Cart/CartPlatformModel.js +1229 -1922
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1744 -1501
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +1211 -1383
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  110. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  112. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  117. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  118. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  125. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  126. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +138 -283
  132. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +100 -219
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  134. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
  138. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
  139. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  140. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  141. package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
  142. package/sdk/platform/Content/ContentPlatformModel.js +390 -521
  143. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  144. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  145. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  146. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  147. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  148. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  149. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  150. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  151. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  152. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  153. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  154. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  155. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  156. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  157. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  158. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  159. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  160. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  161. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  162. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  163. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  164. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  165. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  166. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  167. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  168. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  169. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  170. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -25
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -175
  173. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -52
  174. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -34
  175. package/sdk/platform/Order/OrderPlatformClient.d.ts +103 -174
  176. package/sdk/platform/Order/OrderPlatformClient.js +275 -528
  177. package/sdk/platform/Order/OrderPlatformModel.d.ts +3078 -5449
  178. package/sdk/platform/Order/OrderPlatformModel.js +1659 -3501
  179. package/sdk/platform/Order/OrderPlatformValidator.d.ts +219 -234
  180. package/sdk/platform/Order/OrderPlatformValidator.js +118 -146
  181. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  182. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
  193. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
  194. package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
  195. package/sdk/platform/PlatformClient.d.ts +2 -0
  196. package/sdk/platform/PlatformClient.js +4 -0
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  199. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  200. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  201. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +396 -620
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +326 -501
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +11 -11
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +10 -10
  213. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  214. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  215. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
  216. package/sdk/platform/Share/SharePlatformModel.js +4 -27
  217. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  218. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  219. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  220. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  221. package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
  222. package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  227. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  228. package/sdk/platform/User/UserPlatformModel.js +23 -23
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  235. package/sdk/platform/index.d.ts +1 -0
  236. package/sdk/platform/index.js +2 -0
  237. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  238. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -8
  239. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  240. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  241. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  242. package/sdk/public/Content/ContentPublicClient.js +19 -793
  243. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  244. package/sdk/public/Content/ContentPublicModel.js +3 -649
  245. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  246. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  247. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  248. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  249. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  250. package/sdk/public/Webhook/WebhookPublicClient.js +13 -10
  251. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  252. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  253. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  254. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  255. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -4340
  256. package/sdk/application/Cart/CartApplicationModel.js +0 -2718
  257. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -788
  258. package/sdk/application/Cart/CartApplicationValidator.js +0 -546
  259. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3909
  260. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2667
  261. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  262. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  263. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  264. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  265. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  266. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  267. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  268. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  269. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  270. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  271. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2544
  272. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1875
  273. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  274. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  275. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2189
  276. package/sdk/application/Content/ContentApplicationModel.js +0 -1640
  277. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -290
  278. package/sdk/application/Content/ContentApplicationValidator.js +0 -269
  279. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -270
  280. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -188
  281. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  282. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
  285. package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
  286. package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
  287. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
  288. package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
  289. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  290. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  291. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  292. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  293. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -2034
  294. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1391
  295. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -299
  296. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -224
  297. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2612
  298. package/sdk/application/Order/OrderApplicationModel.js +0 -1669
  299. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -279
  300. package/sdk/application/Order/OrderApplicationValidator.js +0 -210
  301. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4062
  302. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2632
  303. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  304. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  305. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  306. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  307. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  308. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  309. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  310. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  311. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  312. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  313. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1744
  314. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1446
  315. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -79
  316. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -65
  317. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  318. package/sdk/application/User/UserApplicationModel.js +0 -1382
  319. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  320. package/sdk/application/User/UserApplicationValidator.js +0 -573
  321. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -54
  322. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -48
  323. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  324. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  325. package/sdk/common/Clickstream.d.ts +0 -1
  326. package/sdk/common/Clickstream.js +0 -464
@@ -1,4340 +0,0 @@
1
- export = CartApplicationModel;
2
- /**
3
- * @typedef BuyRules
4
- * @property {Object} [item_criteria] - Item criteria of promotion.
5
- * @property {Object} [cart_conditions] - Cart conditions details for promotion.
6
- */
7
- /**
8
- * @typedef DiscountRulesApp
9
- * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion.
10
- * @property {Object} [raw_offer] - Raw offer details for promotion.
11
- * @property {Object} [offer] - Offer for promotion.
12
- * @property {Object} [item_criteria] - Item criteria of promotion.
13
- */
14
- /**
15
- * @typedef Ownership
16
- * @property {string} [payable_category] - Promotion amount payable category.
17
- * @property {string} [payable_by] - Promotion amount bearable party.
18
- */
19
- /**
20
- * @typedef FreeGiftItem
21
- * @property {string} [item_slug] - Item slug.
22
- * @property {string} [item_name] - Item name.
23
- * @property {Object} [item_price_details] - Item price details.
24
- * @property {string} [item_brand_name] - Item brand name.
25
- * @property {number} [item_id] - Item id.
26
- * @property {string[]} [item_images_url] - Item images URL.
27
- */
28
- /**
29
- * @typedef AppliedFreeArticles
30
- * @property {FreeGiftItems} [free_gift_item_details] - Free gift items details.
31
- * @property {string} [parent_item_identifier] - Parent item identifier for free article.
32
- * @property {number} [quantity] - Quantity of free articles.
33
- * @property {string} [article_id] - IDs of free articles.
34
- */
35
- /**
36
- * @typedef AppliedPromotion
37
- * @property {string} [promo_id] - Promotion id.
38
- * @property {BuyRules[]} [buy_rules] - Buy rules for promotions.
39
- * @property {string} [offer_text] - Offer text of current promotion.
40
- * @property {string} [promotion_group] - Promotion group for the promotion.
41
- * @property {boolean} [mrp_promotion] - If applied promotion is applied on
42
- * product MRP or ESP.
43
- * @property {string} [promotion_name] - Promotion name of current promotion.
44
- * @property {number} [amount] - Per unit discount amount applied with current promotion.
45
- * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions.
46
- * @property {Ownership} [ownership] - Ownership of promotion.
47
- * @property {number} [article_quantity] - Quantity of article on which
48
- * promotion is applicable.
49
- * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
50
- * article for free gift item promotions.
51
- * @property {string} [promotion_type] - Promotion type of current promotion.
52
- * @property {Object} [meta] - Meta object for extra data.
53
- * @property {string} [code] - Promotion code.
54
- */
55
- /**
56
- * @typedef PaymentSelectionLock
57
- * @property {boolean} [enabled] - Denotes if default payment selection is enable.
58
- * @property {string} [default_options] - Default Selection Payment Mode.
59
- * @property {string} [payment_identifier] - Identifier for Payment Mode.
60
- */
61
- /**
62
- * @typedef PromiseFormatted
63
- * @property {string} [max] - Maximum Delivery promise formatted timestamp.
64
- * @property {string} [min] - Minimum Delivery promise formatted timestamp.
65
- */
66
- /**
67
- * @typedef PromiseISOFormat
68
- * @property {string} [max] - Max promise in ISO format.
69
- * @property {string} [min] - Min Promise in ISO format.
70
- */
71
- /**
72
- * @typedef PromiseTimestamp
73
- * @property {number} [max] - Maximum Promise for the shipment.
74
- * @property {number} [min] - Minimum delivery promise time for the shipment.
75
- */
76
- /**
77
- * @typedef ShipmentPromise
78
- * @property {PromiseFormatted} [formatted]
79
- * @property {PromiseTimestamp} [timestamp]
80
- * @property {PromiseISOFormat} [iso]
81
- */
82
- /**
83
- * @typedef BasePrice
84
- * @property {number} [effective] - Current per unit price of product after
85
- * existing deductions.
86
- * @property {string} [currency_symbol] - Currency symbol of the currncy used for price.
87
- * @property {number} [marked] - Original price of product.
88
- * @property {string} [currency_code] - Currency code for all amounts.
89
- */
90
- /**
91
- * @typedef ArticlePriceInfo
92
- * @property {BasePrice} [base]
93
- * @property {BasePrice} [converted]
94
- */
95
- /**
96
- * @typedef BaseInfo
97
- * @property {number} [uid] - Unique identifier of entities like brand or seller.
98
- * @property {string} [name] - Name of entities like brand or seller.
99
- */
100
- /**
101
- * @typedef StoreInfo
102
- * @property {string} [store_code] - A unique code or identifier for the store,
103
- * often used for internal reference.
104
- * @property {number} [uid] - Unique identifiers of the store from where product
105
- * is fulfileld.
106
- * @property {string} [name] - Store name of the store from where the product is
107
- * fulfiled .
108
- */
109
- /**
110
- * @typedef ProductArticle
111
- * @property {ArticlePriceInfo} [price]
112
- * @property {string[]} [product_group_tags] - List fot the unique identifier
113
- * for the product grouping.
114
- * @property {Object} [extra_meta] - Field to update extra meta of the article in cart.
115
- * @property {number} [quantity] - Quantity of the article added in cart.
116
- * @property {Object} [_custom_json] - Field to update custom json of the article in cart.
117
- * @property {Object} [meta] - Article meta data.
118
- * @property {string} [size] - Size of the article added in cart.
119
- * @property {number} [mto_quantity] - Quantity of the product which will
120
- * specially manufactured as not available in stock.
121
- * @property {BaseInfo} [seller]
122
- * @property {string} [seller_identifier] - List of identifiers used by sellers
123
- * for the product size.
124
- * @property {Object} [parent_item_identifiers] - Fields to determine parent
125
- * product of the product.
126
- * @property {Object} [identifier] - Unique identifier of the article.
127
- * @property {StoreInfo} [store]
128
- * @property {Object} [cart_item_meta] - Meta details of the article added from cart.
129
- * @property {string} [uid] - This unique identifier is assigned to the specific
130
- * article. This represents item x size x location.
131
- * @property {Object} [gift_card] - Gift card detail if gift card applied to the
132
- * product which indicates gift price, gift applicable flag and display
133
- * message for the gift.
134
- * @property {boolean} [is_gift_visible] - Whether the product can be purchased
135
- * as a gift. It is true if the product is available for gifting and false otherwise.
136
- * @property {string} [type] - Type of the data sent in response. Possible value
137
- * is article.
138
- * @property {string[]} [tags] - A list of article tags.
139
- */
140
- /**
141
- * @typedef CartProductIdentifer
142
- * @property {string} [identifier] - Article idenfier generated by cart.
143
- */
144
- /**
145
- * @typedef PromoMeta
146
- * @property {string} [message] - Loyalty points message denotes how much
147
- * loyalty points and applied and how much left with the user.
148
- */
149
- /**
150
- * @typedef ChargesAmount
151
- * @property {number} [value] - This is the value of amount added.
152
- * @property {string} [currency] - This is destination currency of value.
153
- */
154
- /**
155
- * @typedef Charges
156
- * @property {Object} [meta] - Meta data realted to charges price adjustment.
157
- * @property {ChargesAmount} [amount]
158
- * @property {string} [name] - Name of the charge applied.
159
- * @property {boolean} [allow_refund] - Whether refund is allowed or not for the charge.
160
- * @property {string} [code] - Code of the charge applied.
161
- * @property {string} [type] - Type of the charge applied.
162
- */
163
- /**
164
- * @typedef ProductPrice
165
- * @property {string} [currency_symbol] - Currency symbol of the price defined
166
- * for the product.
167
- * @property {number} [selling] - Selling price of the product .
168
- * @property {string} [currency_code] - Currency code of the price defined for
169
- * the product.
170
- * @property {number} [add_on] - Price before promotion and coupon amount
171
- * applied for calculation.
172
- * @property {number} [effective] - Selling price of the product .
173
- * @property {number} [marked] - Maximum price of the product .
174
- */
175
- /**
176
- * @typedef ProductPriceInfo
177
- * @property {ProductPrice} [base]
178
- * @property {ProductPrice} [converted]
179
- */
180
- /**
181
- * @typedef ProductPricePerUnit
182
- * @property {string} [currency_symbol] - Currency symbol of the price defined
183
- * for the product.
184
- * @property {number} [selling_price] - Selling price of the product .
185
- * @property {string} [currency_code] - Currency code of the price defined for
186
- * the product.
187
- * @property {number} [add_on] - Price before promotion and coupon amount
188
- * applied for calculation.
189
- * @property {number} [effective] - Selling price of the product .
190
- * @property {number} [marked] - Maximum price of the product .
191
- */
192
- /**
193
- * @typedef ProductPricePerUnitInfo
194
- * @property {ProductPricePerUnit} [base]
195
- * @property {ProductPricePerUnit} [converted]
196
- */
197
- /**
198
- * @typedef ProductAvailabilitySize
199
- * @property {string} [display] - Display size of the product.
200
- * @property {string} [value] - Actual value of the size.
201
- * @property {boolean} [is_available] - Available flag for the size of the
202
- * product if that is available.
203
- */
204
- /**
205
- * @typedef ProductAvailability
206
- * @property {boolean} [out_of_stock] - Denotes if the product is available in stock.
207
- * @property {boolean} [deliverable] - Deliverable flag denotes if the product
208
- * is deliverable or not.
209
- * @property {ProductAvailabilitySize[]} [available_sizes] - Product sizes availability.
210
- * @property {boolean} [is_valid] - Valid flag for the product if the product
211
- * added in cart is valid to place the order.
212
- * @property {number} [other_store_quantity] - Quantity of the product available
213
- * on other store.
214
- * @property {string[]} [sizes] - All sizes of the product.
215
- */
216
- /**
217
- * @typedef ActionQuery
218
- * @property {string[]} [product_slug] - Contains list of product slug.
219
- */
220
- /**
221
- * @typedef ProductActionParams
222
- * @property {string[]} [slug] - Unique product url name generated via product
223
- * name and other meta data.
224
- */
225
- /**
226
- * @typedef ProductActionPage
227
- * @property {string} [type] - Entity of page to be redirected on click
228
- * @property {ProductActionParams} [params]
229
- */
230
- /**
231
- * @typedef ProductAction
232
- * @property {ActionQuery} [query]
233
- * @property {string} [url] - Url of the product to render the product
234
- * @property {string} [type] - Type of action.
235
- * @property {ProductActionPage} [page]
236
- */
237
- /**
238
- * @typedef Tags
239
- * @property {Object} [tags] - Tags is a lable or batch that is attached to a
240
- * product in cart.
241
- */
242
- /**
243
- * @typedef ProductImage
244
- * @property {string} [secure_url] - Secured url of the product image.
245
- * @property {string} [aspect_ratio] - Aspect ratio of the product image.
246
- * @property {string} [url] - Bucket link url for product image.
247
- */
248
- /**
249
- * @typedef CategoryInfo
250
- * @property {number} [uid] - Product Category Id.
251
- * @property {string} [name] - Category name of the product .
252
- */
253
- /**
254
- * @typedef CartProduct
255
- * @property {Object} [_custom_json] - Field to add custom json of the product in cart.
256
- * @property {BaseInfo} [brand]
257
- * @property {ProductAction} [action]
258
- * @property {Tags} [teaser_tag]
259
- * @property {string} [slug] - Unique product url name generated via product
260
- * name and other meta data.
261
- * @property {ProductImage[]} [images] - Product Images urls of different types
262
- * like secure url, aspect ration url and url.
263
- * @property {number} [uid] - Unique identifier of the product in cart.
264
- * @property {string} [name] - Product name of the product in cart which is
265
- * defined on platform.
266
- * @property {string} [item_code] - Product code of the product while defining
267
- * product on platform.
268
- * @property {CategoryInfo[]} [categories] - Product category information which
269
- * incldes category name and category id.
270
- * @property {string[]} [tags] - Products tags that are added to each product to
271
- * identify the set of products.
272
- * @property {string} [type] - Type of product in cart.
273
- * @property {Object} [attributes] - Product attributes defined on platform.
274
- */
275
- /**
276
- * @typedef CouponDetails
277
- * @property {number} [discount_single_quantity] - Discout amount applied from
278
- * coupon for single quantity of the product.
279
- * @property {string} [code] - Coupon code of the coupon applied.
280
- * @property {number} [discount_total_quantity] - Total discount earned from
281
- * coupon applied to cart.
282
- */
283
- /**
284
- * @typedef CartProductInfo
285
- * @property {ProductArticle} [article]
286
- * @property {Object} [moq] - An Integer indication the Minimum Order Quantity
287
- * of a product, e.g. 100.
288
- * @property {CartProductIdentifer} identifiers
289
- * @property {PromoMeta} [promo_meta]
290
- * @property {ProductPriceInfo} [price]
291
- * @property {number} [quantity] - Quantity of the product added in cart.
292
- * @property {Charges[]} [charges] - Charges information which denotes types of
293
- * charges and amount of charge applied to that product in cart.
294
- * @property {string} [discount] - Discount amount of the product in cart.
295
- * @property {ProductAvailability} [availability]
296
- * @property {ShipmentPromise} [delivery_promise]
297
- * @property {CartProduct} [product]
298
- * @property {string} [product_ean_id] - European Article Number of the product
299
- * (limited upto 50 EAN identifier in a single request).
300
- * @property {Object} [bulk_offer] - Bulk offer information for the product
301
- * which denotes if any bulk offer is applied to the product in cart.
302
- * @property {Object} [parent_item_identifiers] - Parent item information of the
303
- * product which identifies the parent of the product in cart.
304
- * @property {CouponDetails} [coupon]
305
- * @property {Object} [custom_order] - Whether MTO (Make to Order) is enabled or not.
306
- * @property {string} [coupon_message] - Message for the coupon denotes which
307
- * coupon is applied and empty if not applied.
308
- * @property {string} [key] - The attribute key associated with the size.
309
- * @property {string} [message] - Product level message which denotes error
310
- * information to display over the product in cart.
311
- * @property {boolean} [is_set] - Whether or not the product is a set of items.
312
- * @property {ProductPricePerUnitInfo} [price_per_unit]
313
- * @property {AppliedPromotion[]} [promotions_applied] - List of applicable
314
- * promotion for the product in cart.
315
- */
316
- /**
317
- * @typedef DisplayBreakup
318
- * @property {string} [currency_symbol] - Currency symbol for the price.
319
- * @property {string} [key] - Key of the price like total_mrp, total, subtotal etc.
320
- * @property {string} [display] - Display key field that to be shown against the value.
321
- * @property {string[]} [message] - List of message at price level to be displayed.
322
- * @property {string} [currency_code] - Currency code for the price .
323
- * @property {number} [value] - Numeric value of the price.
324
- * @property {number} [preset] - Value for the price which is set from platform
325
- * if applicable.
326
- */
327
- /**
328
- * @typedef RawBreakup
329
- * @property {number} [vog] - Total value of goods after all discount, coupons
330
- * and promotion applied of all products in cart.
331
- * @property {number} [subtotal] - Selling price amount of all products in cart.
332
- * @property {number} [fynd_cash] - Loyalty points applied on cart.
333
- * @property {number} [discount] - Discount amount recieved on cart.
334
- * @property {number} [convenience_fee] - Convenience fee amount applied to cart.
335
- * @property {number} [delivery_charge] - Delivery charge applied to cart.
336
- * @property {number} [gst_charges] - GST charges applied on cart.
337
- * @property {number} [mrp_total] - Maximum price total amount of all products in cart.
338
- * @property {number} [mop_total] - Total of payment modes by which payment is
339
- * going to be done.
340
- * @property {number} [total_charge] - Total amount of charges applied on cart.
341
- * @property {number} [coupon] - Coupon amount applied to cart.
342
- * @property {number} [total] - Total payable amount by the customer.
343
- * @property {number} [gift_card] - Gift cart amount applied on cart.
344
- * @property {number} [you_saved] - Total amount will be saved if customer
345
- * places the order.
346
- * @property {number} [cod_charge] - Cod charge value applied to cart. This is
347
- * applied when user select payment mode as COD.
348
- */
349
- /**
350
- * @typedef CouponBreakup
351
- * @property {number} [coupon_value] - Value of the coupon applied to cart.
352
- * @property {string} [title] - Coupon Title of the coupon applied denotes name
353
- * of the coupon.
354
- * @property {string} [sub_title] - Coupon subtitle of the coupon applied to
355
- * cart which is used to display.
356
- * @property {number} [minimum_cart_value] - Minumum cart value of cart after
357
- * which the coupon can be applied.
358
- * @property {string} [message] - Coupon message of the coupon applied to cart.
359
- * @property {string} [coupon_type] - Type of the coupon applied to cart.
360
- * @property {string} [uid] - Unique identifier of the coupon applied to cart.
361
- * @property {number} [value] - Coupon value of the coupon applied to cart.
362
- * @property {number} [max_discount_value] - Maximum discount value of the
363
- * coupon applied to cart.
364
- * @property {boolean} [is_applied] - Applied flag which denotes if any coupon
365
- * is applied to cart.
366
- * @property {string} [description] - Coupon description of the coupon applied to cart.
367
- * @property {string} [code] - Coupon code of the coupon applied.
368
- * @property {string} [type] - Type of the coupon applied to cart.
369
- */
370
- /**
371
- * @typedef LoyaltyPoints
372
- * @property {number} [total] - Total loyalty points available with user.
373
- * @property {string} [description] - Description for loyalty points.
374
- * @property {number} [applicable] - Whether the loyalty points are applicable
375
- * for the cart .
376
- * @property {boolean} [is_applied] - Whether the loyalty points are applied on the cart .
377
- */
378
- /**
379
- * @typedef CartBreakup
380
- * @property {DisplayBreakup[]} [display] - List of breakup data which is used
381
- * to display the breakup to the customer like MRP total, Discount, Sub total,
382
- * coupon value, promotion value and final total.
383
- * @property {RawBreakup} [raw]
384
- * @property {CouponBreakup} [coupon]
385
- * @property {LoyaltyPoints} [loyalty_points]
386
- */
387
- /**
388
- * @typedef CartCurrency
389
- * @property {string} [code] - Currency code defined by ISO 4217:2015.
390
- * @property {string} [symbol] - Currency symbol for currency of user cart prices.
391
- */
392
- /**
393
- * @typedef CartDetailCoupon
394
- * @property {number} [cashback_amount] - Fields denotes cashback amount applied to cart.
395
- * @property {string} [cashback_message_primary] - Primary cashback message for
396
- * coupon applied to cart.
397
- * @property {string} [cashback_message_secondary] - Secondary cashback message
398
- * for coupon applied to cart.
399
- * @property {string} [coupon_code] - Coupon code to be applied to cart.
400
- * @property {string} [coupon_description] - Coupon description of the coupon
401
- * applied to cart.
402
- * @property {string} [coupon_id] - Unique identifier of the coupon applied to cart.
403
- * @property {string} [coupon_subtitle] - Coupon subtitle of the coupon applied to cart.
404
- * @property {string} [coupon_title] - Coupon Title of the coupon applied.
405
- * @property {string} [coupon_type] - Type of the coupon applied to cart.
406
- * @property {number} [coupon_value] - Value of the coupon applied to cart.
407
- * @property {number} [discount] - Total discount earned from coupon applied to cart.
408
- * @property {boolean} [is_applied] - Flag to determine where the coupon is
409
- * applied to cart or not.
410
- * @property {boolean} [is_valid] - Determine where the coupon applied to cart is valid.
411
- * @property {number} [maximum_discount_value] - Maximum discount value of the
412
- * coupon applied to cart.
413
- * @property {string} [message] - Coupon message of the coupon applied to cart.
414
- * @property {number} [minimum_cart_value] - Minimum cart value of the coupon
415
- * applied to cart.
416
- */
417
- /**
418
- * @typedef ChargesThreshold
419
- * @property {number} [charges] - Charges amount to be applied on cart.
420
- * @property {number} [threshold] - Threshold of cart value on which the charge
421
- * should be applied .
422
- */
423
- /**
424
- * @typedef DeliveryChargesConfig
425
- * @property {boolean} [enabled] - Delivery charge enabled for the cart or not.
426
- * @property {ChargesThreshold[]} [charges] - Charges applicable based on threshold.
427
- */
428
- /**
429
- * @typedef CartCommonConfig
430
- * @property {DeliveryChargesConfig} [delivery_charges_config]
431
- */
432
- /**
433
- * @typedef CartDetailResult
434
- * @property {number} [cart_id] - Unique identifier of the user cart.
435
- * @property {string} [uid] - Unique identifier of the user cart.
436
- * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
437
- * promotions data to cart which includes promotion id, promotion name, offer
438
- * text, description, buy rules, discount rules and promotion type.
439
- * @property {string} [checkout_mode] - Checkout mode of user cart.
440
- * @property {string} [pan_no] - Permanent Account Number of the user.
441
- * @property {boolean} [is_valid] - Cart validity flag determines the if the
442
- * response is valid or not.
443
- * @property {string} [id] - Unique identifier of the user cart.
444
- * @property {PaymentSelectionLock} [payment_selection_lock]
445
- * @property {ShipmentPromise} [delivery_promise]
446
- * @property {string} [comment] - Comment message to be added in user cart.
447
- * @property {CartProductInfo[]} [items] - Items data list in user cart that
448
- * includes item id, item size, store id, available sizes and rest of the item
449
- * related data.
450
- * @property {string} [delivery_charge_info] - Delivery charge in information
451
- * message on shipment .
452
- * @property {CartCommonConfig} [common_config]
453
- * @property {CartDetailCoupon} [coupon]
454
- * @property {string} [message] - Message of the get cart detail API response.
455
- * @property {Object} [notification] - Notification object which denotes
456
- * notification data for user cart.
457
- * @property {string} [staff_user_id] - Staff employee user id if cart is
458
- * created by staff employee for the customer.
459
- * @property {boolean} [success] - Success flag of get cart detail API response.
460
- * @property {string} [gstin] - GSTIN added in user cart.
461
- * @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
462
- * the checkout process.
463
- * @property {string} [last_modified] - Last modified timestamp of cart.
464
- * @property {CartBreakup} [breakup_values]
465
- * @property {CartCurrency} [currency]
466
- * @property {string} [coupon_text] - Coupon text of coupon applied on cart.
467
- * @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
468
- * is doing fast checkout for the cart using buy now.
469
- * @property {Object} [pan_config] - Pan card config states at what condition
470
- * user should enter the pan card.
471
- * @property {Object} [custom_cart_meta] - Custom meta details added cart
472
- * checkout API payload .
473
- */
474
- /**
475
- * @typedef AddProductCart
476
- * @property {Object} [article_assignment] - Field to determine how article
477
- * assignment should happen by article assignment level and strategy.
478
- * @property {string[]} [product_group_tags] - Field to specify the product
479
- * groups of the product that the user is trying to add in cart.
480
- * @property {Object} [extra_meta] - Extra meta data to be added at article
481
- * level while add items to cart.
482
- * @property {number} [quantity] - Field to specify the product quantity that
483
- * user wants to buy.
484
- * @property {Object} [_custom_json] - Field to add custom json at article level
485
- * while add items to cart .
486
- * @property {string} [item_size] - Field to determine size of the product.
487
- * @property {number} [store_id] - Unique identifier of the store selected by
488
- * the user from which user want to buy a product.
489
- * @property {string} [display] - Display field at article level .
490
- * @property {string} [article_id] - Unique identifier of an article .
491
- * @property {Object[]} [parent_item_identifiers] - Fields to determine parent
492
- * product of the product.
493
- * @property {number} [seller_id] - Unique idetifier of the seller selected by
494
- * the user from which user want to buy a product .
495
- * @property {boolean} [pos] - Filed to determine whether user is making request
496
- * from pos or not.
497
- * @property {number} [item_id] - Unique identifier to identify product.
498
- * @property {Object} [meta] - Field to add meta data at article level.
499
- * @property {string} [seller_identifier] - Add items using seller identifier
500
- * for store os.
501
- */
502
- /**
503
- * @typedef AddCartCreation
504
- * @property {AddProductCart[]} [items] - List of items detail which need to be
505
- * added to cart like item id, item size, and item quantity.
506
- * @property {boolean} [new_cart] - Field to create to new cart whille user adds
507
- * item to cart.
508
- */
509
- /**
510
- * @typedef AddCartDetailResult
511
- * @property {string} [message] - Message of add to cart API response.
512
- * @property {boolean} [partial] - When adding multiple items check if all
513
- * added. True if only few are added.
514
- * @property {CartDetailResult} [cart]
515
- * @property {boolean} [success] - True if all items are added successfully.
516
- * False if partially added or not added.
517
- */
518
- /**
519
- * @typedef UpdateProductCart
520
- * @property {Object} [extra_meta] - Field to update extra meta of the product in cart.
521
- * @property {Object} [_custom_json] - Field to update custom json of the product in cart.
522
- * @property {number} [quantity] - Field to update the quantity of the item in cart.
523
- * @property {string} [item_size] - Field to update the size of the product in cart.
524
- * @property {number} [item_index] - Item index determines on which index the
525
- * product falls to be updated.
526
- * @property {CartProductIdentifer} identifiers
527
- * @property {string} [article_id] - Article id of the product in cart.
528
- * @property {Object} [parent_item_identifiers] - Field to update parent product
529
- * of the item in cart.
530
- * @property {number} [item_id] - Item id of the product that needs to be updated.
531
- * @property {Object} [meta] - Field to update meta of the item in cart.
532
- */
533
- /**
534
- * @typedef FreeGiftItemCreation
535
- * @property {string} promotion_id - Unique identifier of the free gift promotion.
536
- * @property {string} item_id - Unique identifier of the selected free gift item.
537
- * @property {string} item_size - Size of the selected free gift item.
538
- */
539
- /**
540
- * @typedef UpdateCartCreation
541
- * @property {UpdateProductCart[]} [items] - List items data that needs to be
542
- * updated in cart.
543
- * @property {FreeGiftItemCreation[]} [free_gift_items] - List of free gift
544
- * items with updated sizes.
545
- * @property {string} operation - Field to determine if item to be removed from
546
- * cart or it needs to be updated.
547
- */
548
- /**
549
- * @typedef UpdateCartDetailResult
550
- * @property {string} [message] - Message of update cart API response.
551
- * @property {CartDetailResult} [cart]
552
- * @property {boolean} [success] - True if all items are added successfully.
553
- * False if partially added or not added.
554
- */
555
- /**
556
- * @typedef DeleteCartDetailResult
557
- * @property {string} [message] - Message for delete cart response.
558
- * @property {boolean} [success] - True if cart is archived successfully. False
559
- * if not archived.
560
- */
561
- /**
562
- * @typedef CartItemCountResult
563
- * @property {number} [user_cart_items_count] - Item count present in cart.
564
- */
565
- /**
566
- * @typedef PageCoupon
567
- * @property {number} [total_item_count] - Total coupons are available for the cart.
568
- * @property {boolean} [has_next] - Denotes if next page of coupon is available.
569
- * @property {number} [total] - Total pages of coupon availalbe.
570
- * @property {number} [current] - Current page number.
571
- * @property {boolean} [has_previous] - Denotes if previous page of the coupon
572
- * is available.
573
- */
574
- /**
575
- * @typedef Coupon
576
- * @property {number} [coupon_amount] - The amount based on cart value.
577
- * @property {number} [coupon_value] - Coupon value of the coupon applied to cart.
578
- * @property {string} [title] - Coupon Title of the coupon applied denotes name
579
- * of the coupon.
580
- * @property {number} [minimum_cart_value] - Minimum cart value of the coupon
581
- * applied to cart.
582
- * @property {string} [sub_title] - Coupon subtitle of the coupon applied to
583
- * cart which is used to display.
584
- * @property {string} [expires_on] - Message to display to user for expiry of the coupon .
585
- * @property {string} [message] - Coupon message of the coupon applied to cart.
586
- * @property {string} [coupon_type] - Type of the coupon applied to cart.
587
- * @property {number} [max_discount_value] - Maximum discount value of the
588
- * coupon applied to cart.
589
- * @property {string} [coupon_code] - Coupon code of the coupon applied on cart.
590
- * @property {boolean} [is_applicable] - Flag to determine where the coupon is
591
- * applicable to cart or not.
592
- * @property {string} [description] - Coupon description of the coupon applied to cart.
593
- * @property {boolean} [is_applied] - Flag to determine where the coupon is
594
- * applied to cart or not.
595
- * @property {string} [start_date] - Start date of the coupon when the coupon
596
- * will be live for the users to apply on cart.
597
- * @property {string} [end_date] - End date of the coupon on which the coupon expires.
598
- * @property {string} [coupon_applicable_message] - Message which is used to
599
- * display to the customer if the coupon is applied successfully.
600
- * @property {string} [offer_text] - Offer text of the coupon which highligts
601
- * coupon offer defined while creating coupon .
602
- * @property {boolean} [is_bank_offer] - Bank offer flag for the coupon if the
603
- * coupon is applicable for only if payment done by bank or mode specified in coupon.
604
- */
605
- /**
606
- * @typedef GetCouponResult
607
- * @property {PageCoupon} [page]
608
- * @property {Coupon[]} [available_coupon_list] - List of available coupon which
609
- * can be applied on cart.
610
- */
611
- /**
612
- * @typedef ApplyCoupon
613
- * @property {string} coupon_code - Coupon code to be applied.
614
- */
615
- /**
616
- * @typedef OfferPrice
617
- * @property {string} [currency_symbol] - Currency symbol for currency.
618
- * @property {number} [bulk_effective] - Discounted per unit price for current
619
- * offer object.
620
- * @property {string} [currency_code] - The currency code for an offer price is
621
- * the three-letter code that corresponds to the currency in which the offer
622
- * price is denominated.
623
- * @property {number} [effective] - The "effective price" is the actual price
624
- * paid by the consumer after accounting for product discounts. It represents
625
- * the true cost of a product or service after all adjustments have been made.
626
- * @property {number} [marked] - The price at which the product is sold to the
627
- * end consumer, typically the original price before discounts.
628
- */
629
- /**
630
- * @typedef OfferItem
631
- * @property {OfferPrice} [price]
632
- * @property {number} [margin] - Percentage value of discount.
633
- * @property {number} [quantity] - Quantity on which offer is applicable.
634
- * @property {boolean} [best] - Is true for best offer from all offers present
635
- * for all sellers.
636
- * @property {number} [total] - Total price of offer quantity with discount.
637
- * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart.
638
- * @property {string} [type] - Type of the offer.
639
- */
640
- /**
641
- * @typedef OfferSeller
642
- * @property {number} [uid] - Unique identifier for a seller.
643
- * @property {string} [name] - Name of a seller.
644
- */
645
- /**
646
- * @typedef BulkPriceOffer
647
- * @property {OfferItem[]} [offers] - Offers is the list of Offer item, which
648
- * consists of margin percentage, price, quantity, offer type and offer price.
649
- * @property {OfferSeller} [seller]
650
- */
651
- /**
652
- * @typedef BulkPriceResult
653
- * @property {BulkPriceOffer[]} [data] - Actual data to be in response consist
654
- * of offers from multiple seller.
655
- */
656
- /**
657
- * @typedef RewardPointCreation
658
- * @property {boolean} points - Points to be applied for cart.
659
- */
660
- /**
661
- * @typedef GeoLocation
662
- * @property {number} [latitude] - Latitude coordinate for address.
663
- * @property {number} [longitude] - Longitude coordinate for address.
664
- */
665
- /**
666
- * @typedef Address
667
- * @property {string} [country_iso_code] - Country iso code for address.
668
- * @property {string} [area] - Area description for address.
669
- * @property {string} [phone] - Phone number for address.
670
- * @property {string} [country_phone_code] - Country phone code for address.
671
- * @property {string} [checkout_mode] - Checkout mode of address on which
672
- * address to be used for which checkout mode of cart.
673
- * @property {string} [address] - Address description for address data.
674
- * @property {string} [area_code_slug] - Area code slug for address. example
675
- * pincode is slug for India.
676
- * @property {GeoLocation} [geo_location]
677
- * @property {string} [id] - Id of the address.
678
- * @property {Object} [_custom_json] - Custom json of the address.
679
- * @property {string} [city] - City of the address.
680
- * @property {string} [sector] - Sector of the address.
681
- * @property {string} [state_code] - State code for address.
682
- * @property {string} [created_by_user_id] - Created by user id of address.
683
- * @property {string} [landmark] - Landmark of address.
684
- * @property {string} [user_id] - User id of address for which address is created.
685
- * @property {string} [name] - Name of person in address data to whom it belongs to.
686
- * @property {Object} [google_map_point] - Google map point of the address.
687
- * @property {boolean} [is_active] - States whether address is active or not.
688
- * @property {string[]} [tags] - Tags of address from which it can be identified.
689
- * @property {string} [country_code] - Country code of address.
690
- * @property {string} [address_type] - Address type of address.
691
- * @property {string} [country] - Country of address.
692
- * @property {boolean} [is_default_address] - Default address flag if no address
693
- * selected then this should be the default address selected.
694
- * @property {string} [area_code] - Area code of the address.
695
- * @property {string} [email] - Email address for address data.
696
- * @property {string} [state] - State of the address.
697
- * @property {Object} [meta] - Metadata of the address.
698
- */
699
- /**
700
- * @typedef ValidationConfig
701
- * @property {number} address_max_limit - The maximum number of addresses a user can have.
702
- * @property {number} user_address_count - The total number of addresses saved by a user.
703
- */
704
- /**
705
- * @typedef GetAddressesResult
706
- * @property {boolean} [pii_masking] - Personally Identifiable Information
707
- * masking flag to denote if the user data in address is masked or not.
708
- * @property {Address[]} [address] - Address description for address data.
709
- * @property {ValidationConfig} [validation_config]
710
- */
711
- /**
712
- * @typedef SaveAddressResult
713
- * @property {string} [id] - Id of the address.
714
- * @property {boolean} [success] - Success flag of save address Result.
715
- * @property {boolean} [is_default_address] - Default address flag if no address
716
- * selected then this should be the default address selected.
717
- */
718
- /**
719
- * @typedef UpdateAddressResult
720
- * @property {boolean} [is_updated] - Updated flag for update address operation
721
- * if the address updated or not.
722
- * @property {string} [id] - ID of an address.
723
- * @property {boolean} [success] - Success flag of update address response.
724
- * @property {boolean} [is_default_address] - Default address flag if no address
725
- * selected then this should be the default address selected.
726
- */
727
- /**
728
- * @typedef DeleteAddressResult
729
- * @property {string} [id] - Id of the address.
730
- * @property {boolean} [is_deleted] - Deleted flag in delete address response
731
- * states whether the address was deleted or not.
732
- */
733
- /**
734
- * @typedef SelectCartAddressCreation
735
- * @property {string} [id] - Address is selected by user on which shipment to be
736
- * delivered.
737
- * @property {string} [billing_address_id] - Billing address id selected by user
738
- * on which shipment bill to be generated.
739
- * @property {string} [cart_id] - Cart id of the user cart for which the select
740
- * address operation performed.
741
- */
742
- /**
743
- * @typedef UpdateCartPaymentCreation
744
- * @property {string} [id] - Cart id of the user cart for which the update cart
745
- * payment operation performed.
746
- * @property {string} [payment_identifier] - Payment identifier of the payment
747
- * mode selected to do the payment.
748
- * @property {string} [address_id] - Address id of the user address selected to
749
- * deliver the shipment.
750
- * @property {string} [merchant_code] - Merchant code of the payment mode
751
- * selected to do the payment.
752
- * @property {string} [aggregator_name] - Aggregator name of the payment gateway.
753
- * @property {string} [payment_mode] - Payment mode of the payment selected to
754
- * do the payment.
755
- */
756
- /**
757
- * @typedef CouponValidity
758
- * @property {string} [title] - Coupon Title of the coupon applied.
759
- * @property {number} [discount] - Coupon discount value of the coupon applied.
760
- * @property {boolean} [next_validation_required] - Flag for coupon validation
761
- * required on next page or not.
762
- * @property {boolean} [valid] - Valid flag which denotes if the applied coupon
763
- * is valid or not.
764
- * @property {string} [display_message_en] - Display message for coupon validity.
765
- * @property {string} [code] - Coupon code of the coupon applied.
766
- * @property {string} [error_en] - Error message for the selected payment mode.
767
- */
768
- /**
769
- * @typedef PaymentCouponValidate
770
- * @property {string} [message] - Payment mode valid message for coupon.
771
- * @property {CouponValidity} [coupon_validity]
772
- * @property {boolean} success - Success flag of coupon payment mode validity
773
- * API response.
774
- */
775
- /**
776
- * @typedef ShipmentResult
777
- * @property {number} [shipments] - Count of shipments that will be shipped.
778
- * @property {ShipmentPromise} [promise]
779
- * @property {string} [order_type] - Order type of the shipment like pickAtStore
780
- * or HomeDelivery.
781
- * @property {string} [box_type] - Box type of the shipment in which the
782
- * shipment will be delivered.
783
- * @property {string} [shipment_type] - Shipment type of the shipment returned
784
- * in get shipments API like single_shipment or multiple shipment. Single
785
- * Shipment means 1 item in 1 shipment and vice versa in the other one.
786
- * @property {Object} [dp_options] - Delivery partner options that are available
787
- * to deliver the shipment.
788
- * @property {string} [dp_id] - Delivery partner id of the shipment.
789
- * @property {CartProductInfo[]} [items] - Item details in the shipment.
790
- * @property {string} [fulfillment_type] - Fulfilment type of shipment.
791
- * @property {number} [fulfillment_id] - Fulfilment id of the shipment.
792
- */
793
- /**
794
- * @typedef CartShipmentsResult
795
- * @property {string} [delivery_charge_info] - Delivery charge in information
796
- * message on shipment.
797
- * @property {string} [checkout_mode] - Checkout mode of cart.
798
- * @property {string} [message] - Result message of get shipments API.
799
- * @property {string} [gstin] - GSTIN number added in cart.
800
- * @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
801
- * the checkout process.
802
- * @property {string} [last_modified] - Last modified timestamp of cart.
803
- * @property {number} [cart_id] - Cart id of the user cart.
804
- * @property {boolean} [is_valid] - Cart validity flag determines the if the
805
- * response is valid or not.
806
- * @property {CartBreakup} [breakup_values]
807
- * @property {CartCurrency} [currency]
808
- * @property {string} [id] - Cart id of the user cart.
809
- * @property {ShipmentResult[]} [shipments] - List of Shipments which includes
810
- * shipment data like shipment items, shipment promise, Shipment type,
811
- * shipment order type, shipment dp options etc.
812
- * @property {PaymentSelectionLock} [payment_selection_lock]
813
- * @property {string} [coupon_text] - Coupon text of coupon applied on cart.
814
- * @property {ShipmentPromise} [delivery_promise]
815
- * @property {boolean} [error] - Error details if any error occurs which
816
- * includes type of error, error code and error message.
817
- * @property {string} [comment] - Comment message added in cart.
818
- * @property {boolean} [buy_now] - Buy now flag of user cart.
819
- * @property {string} [uid] - Cart id of the user cart.
820
- * @property {Object} [custom_cart_meta] - Custom meta details added cart
821
- * checkout API payload.
822
- */
823
- /**
824
- * @typedef CartCheckoutCustomMeta
825
- * @property {string} key - Key name of custom meta.
826
- * @property {string} value - Value to be added in key.
827
- */
828
- /**
829
- * @typedef CustomerDetails
830
- * @property {string} [email] - Email address of the customer to be added in
831
- * customer detail while checkout.
832
- * @property {string} mobile - Mobile number of customer to be added in customer
833
- * detail while checkout.
834
- * @property {string} [name] - Name of customer to be added in customer detail
835
- * while checkout.
836
- */
837
- /**
838
- * @typedef StaffCheckout
839
- * @property {string} [employee_code] - Employee code of staff who does checkout
840
- * on behalf of customer.
841
- * @property {string} user - User id of the employee who does checkout on behalf
842
- * of customer.
843
- * @property {string} last_name - Last name of staff employee who does checkout
844
- * on behalf of customer.
845
- * @property {string} first_name - First name of staff emplyee who does checkout
846
- * on behalf of customer.
847
- * @property {string} _id - Id of staff who does checkout on behalf of customer.
848
- */
849
- /**
850
- * @typedef CartCheckoutDetailCreation
851
- * @property {CartCheckoutCustomMeta[]} [custom_meta] - Custom meta data to be
852
- * added in order.
853
- * @property {CustomerDetails} [customer_details] - Customer details to be added in order.
854
- * @property {string} [merchant_code] - Merchant code of the payment mode
855
- * selected to do the payment.
856
- * @property {string} [id] - Cart id of the user cart.
857
- * @property {boolean} [payment_auto_confirm] - Payment auto confirm flag if
858
- * payment need not to be collected from user.
859
- * @property {string} payment_mode - Payment mode from which the payment to be
860
- * done for the order.
861
- * @property {string} [aggregator] - Aggregator name of the payment gateway.
862
- * @property {string} [address_id] - Address id of the user on which the order
863
- * to be delivered.
864
- * @property {string} [callback_url] - Callback url to be redirected after
865
- * payment received/failed.
866
- * @property {Object} [delivery_address] - Delivery address data which includes
867
- * customer address, customer phone, customer email, customer pincode,
868
- * customer landmark and customer name.
869
- * @property {StaffCheckout} [staff]
870
- * @property {string} [order_type] - Order type of the order being placed like
871
- * pickAtStore or HomeDelivery.
872
- * @property {number} [ordering_store] - Ordering store id of the store from
873
- * which the order is getting placed.
874
- * @property {Object} [extra_meta] - Extra meta to be added while checkout in order.
875
- * @property {string} [payment_identifier] - Payment identifier of the payment
876
- * mode selected to do the payment.
877
- * @property {Object} [billing_address] - Billing address json which includes
878
- * customer address, customer phone, customer email, customer pincode,
879
- * customer landmark and customer name.
880
- * @property {Object} [payment_params] - Payment params which includes payment
881
- * identifier and merchant code.
882
- * @property {string} [billing_address_id] - Billing address id of the customer
883
- * on which the invoice to be generated after the order is placed.
884
- * @property {Object} [meta] - Meta data to be added in order.
885
- * @property {Object} [payment_extra_identifiers] - Payment extra identifier for
886
- * the payment mode to do the payment.
887
- * @property {string} [iin] - Issuer Identification Number' number of card if
888
- * payment mode is card.
889
- * @property {string} [network] - Network of card if payment mode is card to do
890
- * the payment.
891
- * @property {string} [type] - Type of cart if payment mode is card to do the payment.
892
- * @property {string} [card_id] - Saved card id if payment mode is card to do the payment.
893
- */
894
- /**
895
- * @typedef CheckCart
896
- * @property {string} [checkout_mode] - Checkout mode of user cart.
897
- * @property {string} [user_type] - User type of the cart who places the order.
898
- * @property {string} [cod_message] - Cash On Delivery message for the order placed.
899
- * @property {number} [cart_id] - Cart id of the user cart for which the order placed.
900
- * @property {boolean} [is_valid] - Valid flag fotr the checkout response if
901
- * order placed was valid.
902
- * @property {number} [delivery_charges] - Delivery charges of the order placed
903
- * via checkout API.
904
- * @property {string} [id] - Cart id of the user cart.
905
- * @property {PaymentSelectionLock} [payment_selection_lock]
906
- * @property {string} [error_message] - Error details if any error occurs which
907
- * includes type of error, error code and error message.
908
- * @property {ShipmentPromise} [delivery_promise]
909
- * @property {string} [comment] - Comment message added in cart after order placed.
910
- * @property {CartProductInfo[]} [items] - Items details in cart after order placed.
911
- * @property {string} [uid] - Cart id of user cart.
912
- * @property {number} [delivery_charge_order_value] - Delivery charge order value.
913
- * @property {string} [delivery_charge_info] - Delivery charge in information
914
- * message on shipment.
915
- * @property {boolean} [cod_available] - Whether Cash On Delivery available.
916
- * @property {boolean} [success] - Success flag of checkout cart API response.
917
- * @property {string} [store_code] - Store code from which the order placed.
918
- * @property {string} [message] - Message of the cart checkout API response.
919
- * @property {string} [gstin] - GSTIN number added in cart.
920
- * @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
921
- * the checkout process.
922
- * @property {string} [last_modified] - Last modified timestamp of cart.
923
- * @property {string} [order_id] - Order id generated after placing order.
924
- * @property {CartBreakup} [breakup_values]
925
- * @property {CartCurrency} [currency]
926
- * @property {Object[]} [store_emps] - Store employees data.
927
- * @property {string} [coupon_text] - Coupon text of the applied coupon on order placed.
928
- * @property {boolean} [buy_now] - Buy now flag of user cart.
929
- * @property {number} [cod_charges] - Cash On Delivery charges of the user cart.
930
- * @property {Object} [custom_cart_meta] - Custom cart meta details added in cart.
931
- */
932
- /**
933
- * @typedef CartCheckoutResult
934
- * @property {string} [payment_confirm_url] - Payment confirm url used to
935
- * redirect after payment is confirmed.
936
- * @property {string} [app_intercept_url] - App intercept url which is used to
937
- * redirect on app after payment in confirmed/failed.
938
- * @property {boolean} [success] - Success flag of cart checkout API response.
939
- * @property {string} [callback_url] - Callback url to be redirected after
940
- * payment received/failed.
941
- * @property {string} [message] - Message of the cart checkout v2 API response.
942
- * @property {Object} [data] - Data of the user cart checkout includes cart
943
- * data, address, user id, order type etc.
944
- * @property {string} [order_id] - Order id generated after placing order.
945
- * @property {CheckCart} [cart]
946
- */
947
- /**
948
- * @typedef GiftDetail
949
- * @property {boolean} [is_gift_applied] - Is gift applied flag which determines
950
- * if this is a gift oder not.
951
- * @property {string} [gift_message] - Gift message for the one while receive
952
- * the delivery of the order with this message.
953
- */
954
- /**
955
- * @typedef ArticleGiftDetail
956
- * @property {GiftDetail} [article_id]
957
- */
958
- /**
959
- * @typedef CartMetaCreation
960
- * @property {Object} [delivery_slots] - Delivery slots details includes article
961
- * level time slot when the shipment can be delivered.
962
- * @property {ArticleGiftDetail} [gift_details]
963
- * @property {Object} [pick_up_customer_details] - Customer contact details for
964
- * customer pickup at store.
965
- * @property {string} [checkout_mode] - Checkout mode of user cart.
966
- * @property {string} [comment] - Comment message to be added in user cart.
967
- * @property {string} [gstin] - GSTIN number to be added in user cart.
968
- * @property {Object} [custom_cart_meta] - Custom cart meta json to be added in
969
- * order meta which can be further received in cart API response and order
970
- * meta in order detail API or webhook.
971
- */
972
- /**
973
- * @typedef CartMetaResult
974
- * @property {string} [message] - Detailed message.
975
- * @property {boolean} [is_valid] - Whether added meta was vaild.
976
- */
977
- /**
978
- * @typedef CartMetaMissingResult
979
- * @property {string[]} [errors] - Detailed errors for invalid cart meta request.
980
- */
981
- /**
982
- * @typedef GetShareCartLinkCreation
983
- * @property {string} [id] - Cart id of user cart for generating cart sharing token.
984
- * @property {Object} [meta] - Staff, Ordering store or any other data. This
985
- * data will be used to generate link as well as sent as shared details.
986
- */
987
- /**
988
- * @typedef GetShareCartLinkResult
989
- * @property {string} [token] - Short url unique id of the cart which is opted
990
- * to share with other user.
991
- * @property {string} [share_url] - Short shareable final url which can populate
992
- * shared cart items in one's cart or replaced one's cart with shared cart items.
993
- */
994
- /**
995
- * @typedef SharedCartDetails
996
- * @property {string} [token] - Short link id of the user cart that needs to be shared.
997
- * @property {Object} [user] - User details of who generated share link.
998
- * @property {string} [created_on] - Created on timestamp of user cart.
999
- * @property {Object} [source] - Share link device and other source information.
1000
- * @property {Object} [meta] - Meta data sent while generating share cart link.
1001
- */
1002
- /**
1003
- * @typedef SharedCart
1004
- * @property {string} [checkout_mode] - Checkout mode of address on which
1005
- * address to be used for which checkout mode of cart.
1006
- * @property {number} [cart_id] - Cart id of user cart for generating cart sharing token.
1007
- * @property {boolean} [is_valid] - Valid flag for get shared cart detail API.
1008
- * @property {string} [id] - Cart id of shared cart.
1009
- * @property {PaymentSelectionLock} [payment_selection_lock]
1010
- * @property {ShipmentPromise} [delivery_promise]
1011
- * @property {string} [comment] - Comment message added in user cart.
1012
- * @property {CartProductInfo[]} [items] - Items data list in user cart that
1013
- * includes item id, item size, store id, available sizes and rest of the item
1014
- * related data.
1015
- * @property {string} [uid] - Cart id of the user cart.
1016
- * @property {string} [delivery_charge_info] - Delivery charge info message of
1017
- * the user cart.
1018
- * @property {string} [message] - Message of the get shared cart API response.
1019
- * @property {string} [gstin] - GSTIN added in user cart.
1020
- * @property {SharedCartDetails} [shared_cart_details]
1021
- * @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
1022
- * the checkout process.
1023
- * @property {string} [last_modified] - Last modified timestamp of user cart.
1024
- * @property {CartBreakup} [breakup_values]
1025
- * @property {CartCurrency} [currency]
1026
- * @property {string} [coupon_text] - Coupon text of the applied coupon on user cart.
1027
- * @property {boolean} [buy_now] - Buy now flag of user cart.
1028
- * @property {Object} [custom_cart_meta] - Custom cart meta of user cart added
1029
- * via update cart meta API.
1030
- */
1031
- /**
1032
- * @typedef SharedCartResult
1033
- * @property {string} [error] - Error details if any error occurs which includes
1034
- * type of error, error code and error message.
1035
- * @property {SharedCart} [cart]
1036
- */
1037
- /**
1038
- * @typedef PriceMinMax
1039
- * @property {number} [min] - Min price of article added in user cart.
1040
- * @property {number} [max] - Max price of article added in user cart.
1041
- */
1042
- /**
1043
- * @typedef ItemPriceDetails
1044
- * @property {PriceMinMax} [marked]
1045
- * @property {PriceMinMax} [effective]
1046
- * @property {string} [currency] - Currency of the article added in cart.
1047
- */
1048
- /**
1049
- * @typedef ArticlePriceDetails
1050
- * @property {number} [marked] - The Marked Price refers to the initial price of
1051
- * the free gift article before product discount.
1052
- * @property {number} [effective] - The Effective Price refers to the final
1053
- * amount of the free gift article after applying the product discount.
1054
- */
1055
- /**
1056
- * @typedef FreeGiftItems
1057
- * @property {string} [item_slug] - Slug for an item.
1058
- * @property {string} [item_name] - Name of the free gift item received via free
1059
- * gift promotion.
1060
- * @property {ItemPriceDetails} [item_price_details]
1061
- * @property {ArticlePriceDetails} [article_price]
1062
- * @property {string} [item_brand_name] - Item brand name of the free gift item
1063
- * promotion applied on cart.
1064
- * @property {number} [item_id] - Item id of the free gift item.
1065
- * @property {string[]} [available_sizes] - Available sizes for the free gift item.
1066
- * @property {string} [size] - Selected size for the free gift item.
1067
- * @property {string[]} [item_images_url] - Images URLs for free gift items.
1068
- */
1069
- /**
1070
- * @typedef PromotionOffer
1071
- * @property {string} [id] - Promotion id of the promotion which is available on product.
1072
- * @property {Object} [buy_rules] - Buy rules of promotion which is available on product.
1073
- * @property {string} [offer_text] - Offer title of the promotion which is
1074
- * available on product.
1075
- * @property {string} [promotion_type] - Promotion type of the promotion which
1076
- * is availalbe on product.
1077
- * @property {string} [promotion_name] - Name of the promotion which is
1078
- * available on product.
1079
- * @property {string} [promotion_group] - Group of the promotion which is
1080
- * available on product.
1081
- * @property {string} [valid_till] - Datetime ISO String for promotion end date
1082
- * which is available on product.
1083
- * @property {Object[]} [discount_rules] - Discount rules of promotions which is
1084
- * avaiable on product.
1085
- * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
1086
- * which included item id, brand name, item name, item slug, item price and
1087
- * item image url.
1088
- * @property {string} [description] - Offer details including T&C of the
1089
- * promotion which is avaiable on product.
1090
- */
1091
- /**
1092
- * @typedef PromotionOffersResult
1093
- * @property {PromotionOffer[]} [available_promotions] - Available promotion
1094
- * details which are available on product which includes promotion data like
1095
- * promotion id, promotion name, buy rules, discount rules validity dates etc.
1096
- */
1097
- /**
1098
- * @typedef PromotionPaymentOffer
1099
- * @property {string} [application_id] - Application id on which the promotion
1100
- * was created.
1101
- * @property {Object[]} [buy_rules] - Buy rules of promotions which denotes if
1102
- * the rules matches than only promotion is applicable.
1103
- * @property {string} [calculate_on] - Article Price on which promotion
1104
- * calculated like effective price or marked price.
1105
- * @property {string} [description] - Offer details including T&C of the
1106
- * promotion which is avaiable on cart.
1107
- * @property {Object[]} [discount_rules] - Discount rules of promotions which is
1108
- * avaiable on cart.
1109
- * @property {string} [id] - Promotion id of the promotion which is available on cart.
1110
- * @property {string} [offer_text] - Offer title of the promotion which is
1111
- * available on cart.
1112
- * @property {string} [promotion_group] - Group promotion which is available on cart.
1113
- * @property {string} [promotion_type] - Promotion type of the promotion which
1114
- * is availalbe on cart.
1115
- * @property {string} [promotion_name] - Name of the promotion which is available on cart.
1116
- */
1117
- /**
1118
- * @typedef PromotionPaymentOffersResult
1119
- * @property {boolean} [success] - Success flag of get payment offers API response.
1120
- * @property {PromotionPaymentOffer[]} [promotions] - List of promotions data
1121
- * which are applicable on cart/product.
1122
- */
1123
- /**
1124
- * @typedef OperationErrorResult
1125
- * @property {string} [message] - Message of get payment offer API response.
1126
- * @property {boolean} [success] - Success flag of get payment offer API response.
1127
- */
1128
- /**
1129
- * @typedef LadderPrice
1130
- * @property {string} [currency_symbol] - Currency symbol for currency of ladder
1131
- * price product.
1132
- * @property {number} [offer_price] - Discounted per unit price for current offer object.
1133
- * @property {string} [currency_code] - Currency code for all amounts.
1134
- * @property {number} [effective] - Current per unit price of product after
1135
- * existing deductions.
1136
- * @property {number} [marked] - Original price of product.
1137
- */
1138
- /**
1139
- * @typedef LadderOfferItem
1140
- * @property {LadderPrice} [price]
1141
- * @property {number} [margin] - Percentage value of discount.
1142
- * @property {number} [max_quantity] - Minimum quantity upto which offer is
1143
- * applicable. If not present that offer is applicable on all quantities.
1144
- * @property {number} [min_quantity] - Minimum quantity from which offer is applicable.
1145
- * @property {string} [type] - Offer type of the ladder promotion.
1146
- */
1147
- /**
1148
- * @typedef LadderPriceOffer
1149
- * @property {string} [id] - ID of the promotion.
1150
- * @property {Object} [buy_rules] - Buy rules of ladder price promotion
1151
- * applicable on product.
1152
- * @property {string} [calculate_on] - If this ladder offer is to be calculated
1153
- * on MRP or ESP price.
1154
- * @property {string} [offer_text] - Offer title of ladder price promotion
1155
- * applicable on product.
1156
- * @property {string} [promotion_group] - Group of ladder price promotion
1157
- * applicable on product.
1158
- * @property {string} [valid_till] - Datetime ISO String for promotion end date.
1159
- * @property {Object[]} [discount_rules] - Discount rules of ladder price
1160
- * promotion applicable on product.
1161
- * @property {LadderOfferItem[]} [offer_prices] - Offer prices for ladder price
1162
- * promotion applicable on product.
1163
- * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items list.
1164
- * @property {string} [description] - Offer details including T&C of ladder
1165
- * price promotion applicable on product.
1166
- */
1167
- /**
1168
- * @typedef CurrencyInfo
1169
- * @property {string} [code] - Currency code of ladder price promotion.
1170
- * @property {string} [symbol] - Currency symbol for currency of ladder price product.
1171
- */
1172
- /**
1173
- * @typedef LadderPriceOffers
1174
- * @property {LadderPriceOffer[]} [available_offers] - Available ladder
1175
- * promotions offers list.
1176
- * @property {CurrencyInfo} [currency]
1177
- */
1178
- /**
1179
- * @typedef PaymentMeta
1180
- * @property {string} [merchant_code] - Merchant code of the payment mode
1181
- * selected to do the payment.
1182
- * @property {string} [type] - Type of card if payment mode is card to do the payment.
1183
- * @property {string} [payment_gateway] - Payment gateway used to do the payment.
1184
- * @property {string} [payment_identifier] - Payment identifier of the payment
1185
- * mode selected to do the payment.
1186
- */
1187
- /**
1188
- * @typedef PaymentMethod
1189
- * @property {PaymentMeta} payment_meta
1190
- * @property {string} mode - Payment mode of payment method used to make payment.
1191
- * @property {string} [payment] - Payment name of payment method used to make payment.
1192
- * @property {number} [amount] - Amount of the payment mode to be paid.
1193
- * @property {string} [name] - Name of the payment mode used to make payment.
1194
- * @property {Object} [payment_extra_identifiers] - Payment extra identifier for
1195
- * the payment mode to do the payment.
1196
- */
1197
- /**
1198
- * @typedef CartCheckoutDetailV2Creation
1199
- * @property {CartCheckoutCustomMeta[]} [custom_meta] - Custom meta data to be
1200
- * added in order.
1201
- * @property {CustomerDetails} [customer_details]
1202
- * @property {string} [merchant_code] - Merchant code of the payment mode
1203
- * selected to do the payment.
1204
- * @property {string} [cart_id] - Cart id of the user cart.
1205
- * @property {string} [id] - Cart id of the user cart.
1206
- * @property {boolean} [payment_auto_confirm] - Payment auto confirm flag if
1207
- * payment need not to be collected from user.
1208
- * @property {PaymentMethod[]} payment_methods - Payment methods list used to
1209
- * make the payment.
1210
- * @property {string} payment_mode - Payment mode of the payment selected to do
1211
- * the payment.
1212
- * @property {string} [aggregator] - Aggregator of payment mode to do the payment.
1213
- * @property {string} [address_id] - Address id of the user where the order to
1214
- * be delivered.
1215
- * @property {string} [callback_url] - Callback url after payment received/failed.
1216
- * @property {Object} [delivery_address] - Delivery address data which includes
1217
- * customer address, customer phone, customer email, customer pincode,
1218
- * customer landmark and customer name.
1219
- * @property {StaffCheckout} [staff]
1220
- * @property {string} [order_type] - Order type of the order being placed like
1221
- * pickAtStore or HomeDelivery.
1222
- * @property {number} [ordering_store] - Ordering store id of the store from
1223
- * which the order is getting placed.
1224
- * @property {Object} [extra_meta] - Extra meta to be added while checkout in order.
1225
- * @property {string} [payment_identifier] - Payment identifier of the payment
1226
- * mode selected to do the payment.
1227
- * @property {Object} [billing_address] - Billing address json which includes
1228
- * customer address, customer phone, customer email, customer pincode,
1229
- * customer landmark and customer name.
1230
- * @property {Object} [payment_params] - Payment params which includes payment
1231
- * identifier and merchant code.
1232
- * @property {string} [billing_address_id] - Billing address id selected by user
1233
- * on which shipment bill to be generated.
1234
- * @property {Object} [meta] - Meta data sent while checkout v2.
1235
- * @property {string} [iin] - Issuer Identification Number' number of card if
1236
- * payment mode is card to do the payment.
1237
- * @property {string} [network] - Network of card if payment mode is card to do
1238
- * the payment.
1239
- * @property {string} [type] - Type of cart if payment mode is card to do the payment.
1240
- * @property {string} [card_id] - Saved card id if payment mode is card to do the payment.
1241
- */
1242
- /**
1243
- * @typedef ValidationError
1244
- * @property {string} message - A brief description of the error encountered.
1245
- * @property {string} field - The field in the request that caused the error.
1246
- */
1247
- declare class CartApplicationModel {
1248
- }
1249
- declare namespace CartApplicationModel {
1250
- export { BuyRules, DiscountRulesApp, Ownership, FreeGiftItem, AppliedFreeArticles, AppliedPromotion, PaymentSelectionLock, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, BasePrice, ArticlePriceInfo, BaseInfo, StoreInfo, ProductArticle, CartProductIdentifer, PromoMeta, ChargesAmount, Charges, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, ProductAvailabilitySize, ProductAvailability, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, Tags, ProductImage, CategoryInfo, CartProduct, CouponDetails, CartProductInfo, DisplayBreakup, RawBreakup, CouponBreakup, LoyaltyPoints, CartBreakup, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, DeleteCartDetailResult, CartItemCountResult, PageCoupon, Coupon, GetCouponResult, ApplyCoupon, OfferPrice, OfferItem, OfferSeller, BulkPriceOffer, BulkPriceResult, RewardPointCreation, GeoLocation, Address, ValidationConfig, GetAddressesResult, SaveAddressResult, UpdateAddressResult, DeleteAddressResult, SelectCartAddressCreation, UpdateCartPaymentCreation, CouponValidity, PaymentCouponValidate, ShipmentResult, CartShipmentsResult, CartCheckoutCustomMeta, CustomerDetails, StaffCheckout, CartCheckoutDetailCreation, CheckCart, CartCheckoutResult, GiftDetail, ArticleGiftDetail, CartMetaCreation, CartMetaResult, CartMetaMissingResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResult, PromotionPaymentOffer, PromotionPaymentOffersResult, OperationErrorResult, LadderPrice, LadderOfferItem, LadderPriceOffer, CurrencyInfo, LadderPriceOffers, PaymentMeta, PaymentMethod, CartCheckoutDetailV2Creation, ValidationError };
1251
- }
1252
- /** @returns {BuyRules} */
1253
- declare function BuyRules(): BuyRules;
1254
- type BuyRules = {
1255
- /**
1256
- * - Item criteria of promotion.
1257
- */
1258
- item_criteria?: any;
1259
- /**
1260
- * - Cart conditions details for promotion.
1261
- */
1262
- cart_conditions?: any;
1263
- };
1264
- /** @returns {DiscountRulesApp} */
1265
- declare function DiscountRulesApp(): DiscountRulesApp;
1266
- type DiscountRulesApp = {
1267
- /**
1268
- * - Matched buy rules for promotion.
1269
- */
1270
- matched_buy_rules?: string[];
1271
- /**
1272
- * - Raw offer details for promotion.
1273
- */
1274
- raw_offer?: any;
1275
- /**
1276
- * - Offer for promotion.
1277
- */
1278
- offer?: any;
1279
- /**
1280
- * - Item criteria of promotion.
1281
- */
1282
- item_criteria?: any;
1283
- };
1284
- /** @returns {Ownership} */
1285
- declare function Ownership(): Ownership;
1286
- type Ownership = {
1287
- /**
1288
- * - Promotion amount payable category.
1289
- */
1290
- payable_category?: string;
1291
- /**
1292
- * - Promotion amount bearable party.
1293
- */
1294
- payable_by?: string;
1295
- };
1296
- /** @returns {FreeGiftItem} */
1297
- declare function FreeGiftItem(): FreeGiftItem;
1298
- type FreeGiftItem = {
1299
- /**
1300
- * - Item slug.
1301
- */
1302
- item_slug?: string;
1303
- /**
1304
- * - Item name.
1305
- */
1306
- item_name?: string;
1307
- /**
1308
- * - Item price details.
1309
- */
1310
- item_price_details?: any;
1311
- /**
1312
- * - Item brand name.
1313
- */
1314
- item_brand_name?: string;
1315
- /**
1316
- * - Item id.
1317
- */
1318
- item_id?: number;
1319
- /**
1320
- * - Item images URL.
1321
- */
1322
- item_images_url?: string[];
1323
- };
1324
- /** @returns {AppliedFreeArticles} */
1325
- declare function AppliedFreeArticles(): AppliedFreeArticles;
1326
- type AppliedFreeArticles = {
1327
- /**
1328
- * - Free gift items details.
1329
- */
1330
- free_gift_item_details?: FreeGiftItems;
1331
- /**
1332
- * - Parent item identifier for free article.
1333
- */
1334
- parent_item_identifier?: string;
1335
- /**
1336
- * - Quantity of free articles.
1337
- */
1338
- quantity?: number;
1339
- /**
1340
- * - IDs of free articles.
1341
- */
1342
- article_id?: string;
1343
- };
1344
- /** @returns {AppliedPromotion} */
1345
- declare function AppliedPromotion(): AppliedPromotion;
1346
- type AppliedPromotion = {
1347
- /**
1348
- * - Promotion id.
1349
- */
1350
- promo_id?: string;
1351
- /**
1352
- * - Buy rules for promotions.
1353
- */
1354
- buy_rules?: BuyRules[];
1355
- /**
1356
- * - Offer text of current promotion.
1357
- */
1358
- offer_text?: string;
1359
- /**
1360
- * - Promotion group for the promotion.
1361
- */
1362
- promotion_group?: string;
1363
- /**
1364
- * - If applied promotion is applied on
1365
- * product MRP or ESP.
1366
- */
1367
- mrp_promotion?: boolean;
1368
- /**
1369
- * - Promotion name of current promotion.
1370
- */
1371
- promotion_name?: string;
1372
- /**
1373
- * - Per unit discount amount applied with current promotion.
1374
- */
1375
- amount?: number;
1376
- /**
1377
- * - Discount rules for promotions.
1378
- */
1379
- discount_rules?: DiscountRulesApp[];
1380
- /**
1381
- * - Ownership of promotion.
1382
- */
1383
- ownership?: Ownership;
1384
- /**
1385
- * - Quantity of article on which
1386
- * promotion is applicable.
1387
- */
1388
- article_quantity?: number;
1389
- /**
1390
- * - Applied free
1391
- * article for free gift item promotions.
1392
- */
1393
- applied_free_articles?: AppliedFreeArticles[];
1394
- /**
1395
- * - Promotion type of current promotion.
1396
- */
1397
- promotion_type?: string;
1398
- /**
1399
- * - Meta object for extra data.
1400
- */
1401
- meta?: any;
1402
- /**
1403
- * - Promotion code.
1404
- */
1405
- code?: string;
1406
- };
1407
- /** @returns {PaymentSelectionLock} */
1408
- declare function PaymentSelectionLock(): PaymentSelectionLock;
1409
- type PaymentSelectionLock = {
1410
- /**
1411
- * - Denotes if default payment selection is enable.
1412
- */
1413
- enabled?: boolean;
1414
- /**
1415
- * - Default Selection Payment Mode.
1416
- */
1417
- default_options?: string;
1418
- /**
1419
- * - Identifier for Payment Mode.
1420
- */
1421
- payment_identifier?: string;
1422
- };
1423
- /** @returns {PromiseFormatted} */
1424
- declare function PromiseFormatted(): PromiseFormatted;
1425
- type PromiseFormatted = {
1426
- /**
1427
- * - Maximum Delivery promise formatted timestamp.
1428
- */
1429
- max?: string;
1430
- /**
1431
- * - Minimum Delivery promise formatted timestamp.
1432
- */
1433
- min?: string;
1434
- };
1435
- /** @returns {PromiseISOFormat} */
1436
- declare function PromiseISOFormat(): PromiseISOFormat;
1437
- type PromiseISOFormat = {
1438
- /**
1439
- * - Max promise in ISO format.
1440
- */
1441
- max?: string;
1442
- /**
1443
- * - Min Promise in ISO format.
1444
- */
1445
- min?: string;
1446
- };
1447
- /** @returns {PromiseTimestamp} */
1448
- declare function PromiseTimestamp(): PromiseTimestamp;
1449
- type PromiseTimestamp = {
1450
- /**
1451
- * - Maximum Promise for the shipment.
1452
- */
1453
- max?: number;
1454
- /**
1455
- * - Minimum delivery promise time for the shipment.
1456
- */
1457
- min?: number;
1458
- };
1459
- /** @returns {ShipmentPromise} */
1460
- declare function ShipmentPromise(): ShipmentPromise;
1461
- type ShipmentPromise = {
1462
- formatted?: PromiseFormatted;
1463
- timestamp?: PromiseTimestamp;
1464
- iso?: PromiseISOFormat;
1465
- };
1466
- /** @returns {BasePrice} */
1467
- declare function BasePrice(): BasePrice;
1468
- type BasePrice = {
1469
- /**
1470
- * - Current per unit price of product after
1471
- * existing deductions.
1472
- */
1473
- effective?: number;
1474
- /**
1475
- * - Currency symbol of the currncy used for price.
1476
- */
1477
- currency_symbol?: string;
1478
- /**
1479
- * - Original price of product.
1480
- */
1481
- marked?: number;
1482
- /**
1483
- * - Currency code for all amounts.
1484
- */
1485
- currency_code?: string;
1486
- };
1487
- /** @returns {ArticlePriceInfo} */
1488
- declare function ArticlePriceInfo(): ArticlePriceInfo;
1489
- type ArticlePriceInfo = {
1490
- base?: BasePrice;
1491
- converted?: BasePrice;
1492
- };
1493
- /** @returns {BaseInfo} */
1494
- declare function BaseInfo(): BaseInfo;
1495
- type BaseInfo = {
1496
- /**
1497
- * - Unique identifier of entities like brand or seller.
1498
- */
1499
- uid?: number;
1500
- /**
1501
- * - Name of entities like brand or seller.
1502
- */
1503
- name?: string;
1504
- };
1505
- /** @returns {StoreInfo} */
1506
- declare function StoreInfo(): StoreInfo;
1507
- type StoreInfo = {
1508
- /**
1509
- * - A unique code or identifier for the store,
1510
- * often used for internal reference.
1511
- */
1512
- store_code?: string;
1513
- /**
1514
- * - Unique identifiers of the store from where product
1515
- * is fulfileld.
1516
- */
1517
- uid?: number;
1518
- /**
1519
- * - Store name of the store from where the product is
1520
- * fulfiled .
1521
- */
1522
- name?: string;
1523
- };
1524
- /** @returns {ProductArticle} */
1525
- declare function ProductArticle(): ProductArticle;
1526
- type ProductArticle = {
1527
- price?: ArticlePriceInfo;
1528
- /**
1529
- * - List fot the unique identifier
1530
- * for the product grouping.
1531
- */
1532
- product_group_tags?: string[];
1533
- /**
1534
- * - Field to update extra meta of the article in cart.
1535
- */
1536
- extra_meta?: any;
1537
- /**
1538
- * - Quantity of the article added in cart.
1539
- */
1540
- quantity?: number;
1541
- /**
1542
- * - Field to update custom json of the article in cart.
1543
- */
1544
- _custom_json?: any;
1545
- /**
1546
- * - Article meta data.
1547
- */
1548
- meta?: any;
1549
- /**
1550
- * - Size of the article added in cart.
1551
- */
1552
- size?: string;
1553
- /**
1554
- * - Quantity of the product which will
1555
- * specially manufactured as not available in stock.
1556
- */
1557
- mto_quantity?: number;
1558
- seller?: BaseInfo;
1559
- /**
1560
- * - List of identifiers used by sellers
1561
- * for the product size.
1562
- */
1563
- seller_identifier?: string;
1564
- /**
1565
- * - Fields to determine parent
1566
- * product of the product.
1567
- */
1568
- parent_item_identifiers?: any;
1569
- /**
1570
- * - Unique identifier of the article.
1571
- */
1572
- identifier?: any;
1573
- store?: StoreInfo;
1574
- /**
1575
- * - Meta details of the article added from cart.
1576
- */
1577
- cart_item_meta?: any;
1578
- /**
1579
- * - This unique identifier is assigned to the specific
1580
- * article. This represents item x size x location.
1581
- */
1582
- uid?: string;
1583
- /**
1584
- * - Gift card detail if gift card applied to the
1585
- * product which indicates gift price, gift applicable flag and display
1586
- * message for the gift.
1587
- */
1588
- gift_card?: any;
1589
- /**
1590
- * - Whether the product can be purchased
1591
- * as a gift. It is true if the product is available for gifting and false otherwise.
1592
- */
1593
- is_gift_visible?: boolean;
1594
- /**
1595
- * - Type of the data sent in response. Possible value
1596
- * is article.
1597
- */
1598
- type?: string;
1599
- /**
1600
- * - A list of article tags.
1601
- */
1602
- tags?: string[];
1603
- };
1604
- /** @returns {CartProductIdentifer} */
1605
- declare function CartProductIdentifer(): CartProductIdentifer;
1606
- type CartProductIdentifer = {
1607
- /**
1608
- * - Article idenfier generated by cart.
1609
- */
1610
- identifier?: string;
1611
- };
1612
- /** @returns {PromoMeta} */
1613
- declare function PromoMeta(): PromoMeta;
1614
- type PromoMeta = {
1615
- /**
1616
- * - Loyalty points message denotes how much
1617
- * loyalty points and applied and how much left with the user.
1618
- */
1619
- message?: string;
1620
- };
1621
- /** @returns {ChargesAmount} */
1622
- declare function ChargesAmount(): ChargesAmount;
1623
- type ChargesAmount = {
1624
- /**
1625
- * - This is the value of amount added.
1626
- */
1627
- value?: number;
1628
- /**
1629
- * - This is destination currency of value.
1630
- */
1631
- currency?: string;
1632
- };
1633
- /** @returns {Charges} */
1634
- declare function Charges(): Charges;
1635
- type Charges = {
1636
- /**
1637
- * - Meta data realted to charges price adjustment.
1638
- */
1639
- meta?: any;
1640
- amount?: ChargesAmount;
1641
- /**
1642
- * - Name of the charge applied.
1643
- */
1644
- name?: string;
1645
- /**
1646
- * - Whether refund is allowed or not for the charge.
1647
- */
1648
- allow_refund?: boolean;
1649
- /**
1650
- * - Code of the charge applied.
1651
- */
1652
- code?: string;
1653
- /**
1654
- * - Type of the charge applied.
1655
- */
1656
- type?: string;
1657
- };
1658
- /** @returns {ProductPrice} */
1659
- declare function ProductPrice(): ProductPrice;
1660
- type ProductPrice = {
1661
- /**
1662
- * - Currency symbol of the price defined
1663
- * for the product.
1664
- */
1665
- currency_symbol?: string;
1666
- /**
1667
- * - Selling price of the product .
1668
- */
1669
- selling?: number;
1670
- /**
1671
- * - Currency code of the price defined for
1672
- * the product.
1673
- */
1674
- currency_code?: string;
1675
- /**
1676
- * - Price before promotion and coupon amount
1677
- * applied for calculation.
1678
- */
1679
- add_on?: number;
1680
- /**
1681
- * - Selling price of the product .
1682
- */
1683
- effective?: number;
1684
- /**
1685
- * - Maximum price of the product .
1686
- */
1687
- marked?: number;
1688
- };
1689
- /** @returns {ProductPriceInfo} */
1690
- declare function ProductPriceInfo(): ProductPriceInfo;
1691
- type ProductPriceInfo = {
1692
- base?: ProductPrice;
1693
- converted?: ProductPrice;
1694
- };
1695
- /** @returns {ProductPricePerUnit} */
1696
- declare function ProductPricePerUnit(): ProductPricePerUnit;
1697
- type ProductPricePerUnit = {
1698
- /**
1699
- * - Currency symbol of the price defined
1700
- * for the product.
1701
- */
1702
- currency_symbol?: string;
1703
- /**
1704
- * - Selling price of the product .
1705
- */
1706
- selling_price?: number;
1707
- /**
1708
- * - Currency code of the price defined for
1709
- * the product.
1710
- */
1711
- currency_code?: string;
1712
- /**
1713
- * - Price before promotion and coupon amount
1714
- * applied for calculation.
1715
- */
1716
- add_on?: number;
1717
- /**
1718
- * - Selling price of the product .
1719
- */
1720
- effective?: number;
1721
- /**
1722
- * - Maximum price of the product .
1723
- */
1724
- marked?: number;
1725
- };
1726
- /** @returns {ProductPricePerUnitInfo} */
1727
- declare function ProductPricePerUnitInfo(): ProductPricePerUnitInfo;
1728
- type ProductPricePerUnitInfo = {
1729
- base?: ProductPricePerUnit;
1730
- converted?: ProductPricePerUnit;
1731
- };
1732
- /** @returns {ProductAvailabilitySize} */
1733
- declare function ProductAvailabilitySize(): ProductAvailabilitySize;
1734
- type ProductAvailabilitySize = {
1735
- /**
1736
- * - Display size of the product.
1737
- */
1738
- display?: string;
1739
- /**
1740
- * - Actual value of the size.
1741
- */
1742
- value?: string;
1743
- /**
1744
- * - Available flag for the size of the
1745
- * product if that is available.
1746
- */
1747
- is_available?: boolean;
1748
- };
1749
- /** @returns {ProductAvailability} */
1750
- declare function ProductAvailability(): ProductAvailability;
1751
- type ProductAvailability = {
1752
- /**
1753
- * - Denotes if the product is available in stock.
1754
- */
1755
- out_of_stock?: boolean;
1756
- /**
1757
- * - Deliverable flag denotes if the product
1758
- * is deliverable or not.
1759
- */
1760
- deliverable?: boolean;
1761
- /**
1762
- * - Product sizes availability.
1763
- */
1764
- available_sizes?: ProductAvailabilitySize[];
1765
- /**
1766
- * - Valid flag for the product if the product
1767
- * added in cart is valid to place the order.
1768
- */
1769
- is_valid?: boolean;
1770
- /**
1771
- * - Quantity of the product available
1772
- * on other store.
1773
- */
1774
- other_store_quantity?: number;
1775
- /**
1776
- * - All sizes of the product.
1777
- */
1778
- sizes?: string[];
1779
- };
1780
- /** @returns {ActionQuery} */
1781
- declare function ActionQuery(): ActionQuery;
1782
- type ActionQuery = {
1783
- /**
1784
- * - Contains list of product slug.
1785
- */
1786
- product_slug?: string[];
1787
- };
1788
- /** @returns {ProductActionParams} */
1789
- declare function ProductActionParams(): ProductActionParams;
1790
- type ProductActionParams = {
1791
- /**
1792
- * - Unique product url name generated via product
1793
- * name and other meta data.
1794
- */
1795
- slug?: string[];
1796
- };
1797
- /** @returns {ProductActionPage} */
1798
- declare function ProductActionPage(): ProductActionPage;
1799
- type ProductActionPage = {
1800
- /**
1801
- * - Entity of page to be redirected on click
1802
- */
1803
- type?: string;
1804
- params?: ProductActionParams;
1805
- };
1806
- /** @returns {ProductAction} */
1807
- declare function ProductAction(): ProductAction;
1808
- type ProductAction = {
1809
- query?: ActionQuery;
1810
- /**
1811
- * - Url of the product to render the product
1812
- */
1813
- url?: string;
1814
- /**
1815
- * - Type of action.
1816
- */
1817
- type?: string;
1818
- page?: ProductActionPage;
1819
- };
1820
- /** @returns {Tags} */
1821
- declare function Tags(): Tags;
1822
- type Tags = {
1823
- /**
1824
- * - Tags is a lable or batch that is attached to a
1825
- * product in cart.
1826
- */
1827
- tags?: any;
1828
- };
1829
- /** @returns {ProductImage} */
1830
- declare function ProductImage(): ProductImage;
1831
- type ProductImage = {
1832
- /**
1833
- * - Secured url of the product image.
1834
- */
1835
- secure_url?: string;
1836
- /**
1837
- * - Aspect ratio of the product image.
1838
- */
1839
- aspect_ratio?: string;
1840
- /**
1841
- * - Bucket link url for product image.
1842
- */
1843
- url?: string;
1844
- };
1845
- /** @returns {CategoryInfo} */
1846
- declare function CategoryInfo(): CategoryInfo;
1847
- type CategoryInfo = {
1848
- /**
1849
- * - Product Category Id.
1850
- */
1851
- uid?: number;
1852
- /**
1853
- * - Category name of the product .
1854
- */
1855
- name?: string;
1856
- };
1857
- /** @returns {CartProduct} */
1858
- declare function CartProduct(): CartProduct;
1859
- type CartProduct = {
1860
- /**
1861
- * - Field to add custom json of the product in cart.
1862
- */
1863
- _custom_json?: any;
1864
- brand?: BaseInfo;
1865
- action?: ProductAction;
1866
- teaser_tag?: Tags;
1867
- /**
1868
- * - Unique product url name generated via product
1869
- * name and other meta data.
1870
- */
1871
- slug?: string;
1872
- /**
1873
- * - Product Images urls of different types
1874
- * like secure url, aspect ration url and url.
1875
- */
1876
- images?: ProductImage[];
1877
- /**
1878
- * - Unique identifier of the product in cart.
1879
- */
1880
- uid?: number;
1881
- /**
1882
- * - Product name of the product in cart which is
1883
- * defined on platform.
1884
- */
1885
- name?: string;
1886
- /**
1887
- * - Product code of the product while defining
1888
- * product on platform.
1889
- */
1890
- item_code?: string;
1891
- /**
1892
- * - Product category information which
1893
- * incldes category name and category id.
1894
- */
1895
- categories?: CategoryInfo[];
1896
- /**
1897
- * - Products tags that are added to each product to
1898
- * identify the set of products.
1899
- */
1900
- tags?: string[];
1901
- /**
1902
- * - Type of product in cart.
1903
- */
1904
- type?: string;
1905
- /**
1906
- * - Product attributes defined on platform.
1907
- */
1908
- attributes?: any;
1909
- };
1910
- /** @returns {CouponDetails} */
1911
- declare function CouponDetails(): CouponDetails;
1912
- type CouponDetails = {
1913
- /**
1914
- * - Discout amount applied from
1915
- * coupon for single quantity of the product.
1916
- */
1917
- discount_single_quantity?: number;
1918
- /**
1919
- * - Coupon code of the coupon applied.
1920
- */
1921
- code?: string;
1922
- /**
1923
- * - Total discount earned from
1924
- * coupon applied to cart.
1925
- */
1926
- discount_total_quantity?: number;
1927
- };
1928
- /** @returns {CartProductInfo} */
1929
- declare function CartProductInfo(): CartProductInfo;
1930
- type CartProductInfo = {
1931
- article?: ProductArticle;
1932
- /**
1933
- * - An Integer indication the Minimum Order Quantity
1934
- * of a product, e.g. 100.
1935
- */
1936
- moq?: any;
1937
- identifiers: CartProductIdentifer;
1938
- promo_meta?: PromoMeta;
1939
- price?: ProductPriceInfo;
1940
- /**
1941
- * - Quantity of the product added in cart.
1942
- */
1943
- quantity?: number;
1944
- /**
1945
- * - Charges information which denotes types of
1946
- * charges and amount of charge applied to that product in cart.
1947
- */
1948
- charges?: Charges[];
1949
- /**
1950
- * - Discount amount of the product in cart.
1951
- */
1952
- discount?: string;
1953
- availability?: ProductAvailability;
1954
- delivery_promise?: ShipmentPromise;
1955
- product?: CartProduct;
1956
- /**
1957
- * - European Article Number of the product
1958
- * (limited upto 50 EAN identifier in a single request).
1959
- */
1960
- product_ean_id?: string;
1961
- /**
1962
- * - Bulk offer information for the product
1963
- * which denotes if any bulk offer is applied to the product in cart.
1964
- */
1965
- bulk_offer?: any;
1966
- /**
1967
- * - Parent item information of the
1968
- * product which identifies the parent of the product in cart.
1969
- */
1970
- parent_item_identifiers?: any;
1971
- coupon?: CouponDetails;
1972
- /**
1973
- * - Whether MTO (Make to Order) is enabled or not.
1974
- */
1975
- custom_order?: any;
1976
- /**
1977
- * - Message for the coupon denotes which
1978
- * coupon is applied and empty if not applied.
1979
- */
1980
- coupon_message?: string;
1981
- /**
1982
- * - The attribute key associated with the size.
1983
- */
1984
- key?: string;
1985
- /**
1986
- * - Product level message which denotes error
1987
- * information to display over the product in cart.
1988
- */
1989
- message?: string;
1990
- /**
1991
- * - Whether or not the product is a set of items.
1992
- */
1993
- is_set?: boolean;
1994
- price_per_unit?: ProductPricePerUnitInfo;
1995
- /**
1996
- * - List of applicable
1997
- * promotion for the product in cart.
1998
- */
1999
- promotions_applied?: AppliedPromotion[];
2000
- };
2001
- /** @returns {DisplayBreakup} */
2002
- declare function DisplayBreakup(): DisplayBreakup;
2003
- type DisplayBreakup = {
2004
- /**
2005
- * - Currency symbol for the price.
2006
- */
2007
- currency_symbol?: string;
2008
- /**
2009
- * - Key of the price like total_mrp, total, subtotal etc.
2010
- */
2011
- key?: string;
2012
- /**
2013
- * - Display key field that to be shown against the value.
2014
- */
2015
- display?: string;
2016
- /**
2017
- * - List of message at price level to be displayed.
2018
- */
2019
- message?: string[];
2020
- /**
2021
- * - Currency code for the price .
2022
- */
2023
- currency_code?: string;
2024
- /**
2025
- * - Numeric value of the price.
2026
- */
2027
- value?: number;
2028
- /**
2029
- * - Value for the price which is set from platform
2030
- * if applicable.
2031
- */
2032
- preset?: number;
2033
- };
2034
- /** @returns {RawBreakup} */
2035
- declare function RawBreakup(): RawBreakup;
2036
- type RawBreakup = {
2037
- /**
2038
- * - Total value of goods after all discount, coupons
2039
- * and promotion applied of all products in cart.
2040
- */
2041
- vog?: number;
2042
- /**
2043
- * - Selling price amount of all products in cart.
2044
- */
2045
- subtotal?: number;
2046
- /**
2047
- * - Loyalty points applied on cart.
2048
- */
2049
- fynd_cash?: number;
2050
- /**
2051
- * - Discount amount recieved on cart.
2052
- */
2053
- discount?: number;
2054
- /**
2055
- * - Convenience fee amount applied to cart.
2056
- */
2057
- convenience_fee?: number;
2058
- /**
2059
- * - Delivery charge applied to cart.
2060
- */
2061
- delivery_charge?: number;
2062
- /**
2063
- * - GST charges applied on cart.
2064
- */
2065
- gst_charges?: number;
2066
- /**
2067
- * - Maximum price total amount of all products in cart.
2068
- */
2069
- mrp_total?: number;
2070
- /**
2071
- * - Total of payment modes by which payment is
2072
- * going to be done.
2073
- */
2074
- mop_total?: number;
2075
- /**
2076
- * - Total amount of charges applied on cart.
2077
- */
2078
- total_charge?: number;
2079
- /**
2080
- * - Coupon amount applied to cart.
2081
- */
2082
- coupon?: number;
2083
- /**
2084
- * - Total payable amount by the customer.
2085
- */
2086
- total?: number;
2087
- /**
2088
- * - Gift cart amount applied on cart.
2089
- */
2090
- gift_card?: number;
2091
- /**
2092
- * - Total amount will be saved if customer
2093
- * places the order.
2094
- */
2095
- you_saved?: number;
2096
- /**
2097
- * - Cod charge value applied to cart. This is
2098
- * applied when user select payment mode as COD.
2099
- */
2100
- cod_charge?: number;
2101
- };
2102
- /** @returns {CouponBreakup} */
2103
- declare function CouponBreakup(): CouponBreakup;
2104
- type CouponBreakup = {
2105
- /**
2106
- * - Value of the coupon applied to cart.
2107
- */
2108
- coupon_value?: number;
2109
- /**
2110
- * - Coupon Title of the coupon applied denotes name
2111
- * of the coupon.
2112
- */
2113
- title?: string;
2114
- /**
2115
- * - Coupon subtitle of the coupon applied to
2116
- * cart which is used to display.
2117
- */
2118
- sub_title?: string;
2119
- /**
2120
- * - Minumum cart value of cart after
2121
- * which the coupon can be applied.
2122
- */
2123
- minimum_cart_value?: number;
2124
- /**
2125
- * - Coupon message of the coupon applied to cart.
2126
- */
2127
- message?: string;
2128
- /**
2129
- * - Type of the coupon applied to cart.
2130
- */
2131
- coupon_type?: string;
2132
- /**
2133
- * - Unique identifier of the coupon applied to cart.
2134
- */
2135
- uid?: string;
2136
- /**
2137
- * - Coupon value of the coupon applied to cart.
2138
- */
2139
- value?: number;
2140
- /**
2141
- * - Maximum discount value of the
2142
- * coupon applied to cart.
2143
- */
2144
- max_discount_value?: number;
2145
- /**
2146
- * - Applied flag which denotes if any coupon
2147
- * is applied to cart.
2148
- */
2149
- is_applied?: boolean;
2150
- /**
2151
- * - Coupon description of the coupon applied to cart.
2152
- */
2153
- description?: string;
2154
- /**
2155
- * - Coupon code of the coupon applied.
2156
- */
2157
- code?: string;
2158
- /**
2159
- * - Type of the coupon applied to cart.
2160
- */
2161
- type?: string;
2162
- };
2163
- /** @returns {LoyaltyPoints} */
2164
- declare function LoyaltyPoints(): LoyaltyPoints;
2165
- type LoyaltyPoints = {
2166
- /**
2167
- * - Total loyalty points available with user.
2168
- */
2169
- total?: number;
2170
- /**
2171
- * - Description for loyalty points.
2172
- */
2173
- description?: string;
2174
- /**
2175
- * - Whether the loyalty points are applicable
2176
- * for the cart .
2177
- */
2178
- applicable?: number;
2179
- /**
2180
- * - Whether the loyalty points are applied on the cart .
2181
- */
2182
- is_applied?: boolean;
2183
- };
2184
- /** @returns {CartBreakup} */
2185
- declare function CartBreakup(): CartBreakup;
2186
- type CartBreakup = {
2187
- /**
2188
- * - List of breakup data which is used
2189
- * to display the breakup to the customer like MRP total, Discount, Sub total,
2190
- * coupon value, promotion value and final total.
2191
- */
2192
- display?: DisplayBreakup[];
2193
- raw?: RawBreakup;
2194
- coupon?: CouponBreakup;
2195
- loyalty_points?: LoyaltyPoints;
2196
- };
2197
- /** @returns {CartCurrency} */
2198
- declare function CartCurrency(): CartCurrency;
2199
- type CartCurrency = {
2200
- /**
2201
- * - Currency code defined by ISO 4217:2015.
2202
- */
2203
- code?: string;
2204
- /**
2205
- * - Currency symbol for currency of user cart prices.
2206
- */
2207
- symbol?: string;
2208
- };
2209
- /** @returns {CartDetailCoupon} */
2210
- declare function CartDetailCoupon(): CartDetailCoupon;
2211
- type CartDetailCoupon = {
2212
- /**
2213
- * - Fields denotes cashback amount applied to cart.
2214
- */
2215
- cashback_amount?: number;
2216
- /**
2217
- * - Primary cashback message for
2218
- * coupon applied to cart.
2219
- */
2220
- cashback_message_primary?: string;
2221
- /**
2222
- * - Secondary cashback message
2223
- * for coupon applied to cart.
2224
- */
2225
- cashback_message_secondary?: string;
2226
- /**
2227
- * - Coupon code to be applied to cart.
2228
- */
2229
- coupon_code?: string;
2230
- /**
2231
- * - Coupon description of the coupon
2232
- * applied to cart.
2233
- */
2234
- coupon_description?: string;
2235
- /**
2236
- * - Unique identifier of the coupon applied to cart.
2237
- */
2238
- coupon_id?: string;
2239
- /**
2240
- * - Coupon subtitle of the coupon applied to cart.
2241
- */
2242
- coupon_subtitle?: string;
2243
- /**
2244
- * - Coupon Title of the coupon applied.
2245
- */
2246
- coupon_title?: string;
2247
- /**
2248
- * - Type of the coupon applied to cart.
2249
- */
2250
- coupon_type?: string;
2251
- /**
2252
- * - Value of the coupon applied to cart.
2253
- */
2254
- coupon_value?: number;
2255
- /**
2256
- * - Total discount earned from coupon applied to cart.
2257
- */
2258
- discount?: number;
2259
- /**
2260
- * - Flag to determine where the coupon is
2261
- * applied to cart or not.
2262
- */
2263
- is_applied?: boolean;
2264
- /**
2265
- * - Determine where the coupon applied to cart is valid.
2266
- */
2267
- is_valid?: boolean;
2268
- /**
2269
- * - Maximum discount value of the
2270
- * coupon applied to cart.
2271
- */
2272
- maximum_discount_value?: number;
2273
- /**
2274
- * - Coupon message of the coupon applied to cart.
2275
- */
2276
- message?: string;
2277
- /**
2278
- * - Minimum cart value of the coupon
2279
- * applied to cart.
2280
- */
2281
- minimum_cart_value?: number;
2282
- };
2283
- /** @returns {ChargesThreshold} */
2284
- declare function ChargesThreshold(): ChargesThreshold;
2285
- type ChargesThreshold = {
2286
- /**
2287
- * - Charges amount to be applied on cart.
2288
- */
2289
- charges?: number;
2290
- /**
2291
- * - Threshold of cart value on which the charge
2292
- * should be applied .
2293
- */
2294
- threshold?: number;
2295
- };
2296
- /** @returns {DeliveryChargesConfig} */
2297
- declare function DeliveryChargesConfig(): DeliveryChargesConfig;
2298
- type DeliveryChargesConfig = {
2299
- /**
2300
- * - Delivery charge enabled for the cart or not.
2301
- */
2302
- enabled?: boolean;
2303
- /**
2304
- * - Charges applicable based on threshold.
2305
- */
2306
- charges?: ChargesThreshold[];
2307
- };
2308
- /** @returns {CartCommonConfig} */
2309
- declare function CartCommonConfig(): CartCommonConfig;
2310
- type CartCommonConfig = {
2311
- delivery_charges_config?: DeliveryChargesConfig;
2312
- };
2313
- /** @returns {CartDetailResult} */
2314
- declare function CartDetailResult(): CartDetailResult;
2315
- type CartDetailResult = {
2316
- /**
2317
- * - Unique identifier of the user cart.
2318
- */
2319
- cart_id?: number;
2320
- /**
2321
- * - Unique identifier of the user cart.
2322
- */
2323
- uid?: string;
2324
- /**
2325
- * - List of applied
2326
- * promotions data to cart which includes promotion id, promotion name, offer
2327
- * text, description, buy rules, discount rules and promotion type.
2328
- */
2329
- applied_promo_details?: AppliedPromotion[];
2330
- /**
2331
- * - Checkout mode of user cart.
2332
- */
2333
- checkout_mode?: string;
2334
- /**
2335
- * - Permanent Account Number of the user.
2336
- */
2337
- pan_no?: string;
2338
- /**
2339
- * - Cart validity flag determines the if the
2340
- * response is valid or not.
2341
- */
2342
- is_valid?: boolean;
2343
- /**
2344
- * - Unique identifier of the user cart.
2345
- */
2346
- id?: string;
2347
- payment_selection_lock?: PaymentSelectionLock;
2348
- delivery_promise?: ShipmentPromise;
2349
- /**
2350
- * - Comment message to be added in user cart.
2351
- */
2352
- comment?: string;
2353
- /**
2354
- * - Items data list in user cart that
2355
- * includes item id, item size, store id, available sizes and rest of the item
2356
- * related data.
2357
- */
2358
- items?: CartProductInfo[];
2359
- /**
2360
- * - Delivery charge in information
2361
- * message on shipment .
2362
- */
2363
- delivery_charge_info?: string;
2364
- common_config?: CartCommonConfig;
2365
- coupon?: CartDetailCoupon;
2366
- /**
2367
- * - Message of the get cart detail API response.
2368
- */
2369
- message?: string;
2370
- /**
2371
- * - Notification object which denotes
2372
- * notification data for user cart.
2373
- */
2374
- notification?: any;
2375
- /**
2376
- * - Staff employee user id if cart is
2377
- * created by staff employee for the customer.
2378
- */
2379
- staff_user_id?: string;
2380
- /**
2381
- * - Success flag of get cart detail API response.
2382
- */
2383
- success?: boolean;
2384
- /**
2385
- * - GSTIN added in user cart.
2386
- */
2387
- gstin?: string;
2388
- /**
2389
- * - Restrict checkout flag to restrict
2390
- * the checkout process.
2391
- */
2392
- restrict_checkout?: boolean;
2393
- /**
2394
- * - Last modified timestamp of cart.
2395
- */
2396
- last_modified?: string;
2397
- breakup_values?: CartBreakup;
2398
- currency?: CartCurrency;
2399
- /**
2400
- * - Coupon text of coupon applied on cart.
2401
- */
2402
- coupon_text?: string;
2403
- /**
2404
- * - Buy now flag for the cart which denotes user
2405
- * is doing fast checkout for the cart using buy now.
2406
- */
2407
- buy_now?: boolean;
2408
- /**
2409
- * - Pan card config states at what condition
2410
- * user should enter the pan card.
2411
- */
2412
- pan_config?: any;
2413
- /**
2414
- * - Custom meta details added cart
2415
- * checkout API payload .
2416
- */
2417
- custom_cart_meta?: any;
2418
- };
2419
- /** @returns {AddProductCart} */
2420
- declare function AddProductCart(): AddProductCart;
2421
- type AddProductCart = {
2422
- /**
2423
- * - Field to determine how article
2424
- * assignment should happen by article assignment level and strategy.
2425
- */
2426
- article_assignment?: any;
2427
- /**
2428
- * - Field to specify the product
2429
- * groups of the product that the user is trying to add in cart.
2430
- */
2431
- product_group_tags?: string[];
2432
- /**
2433
- * - Extra meta data to be added at article
2434
- * level while add items to cart.
2435
- */
2436
- extra_meta?: any;
2437
- /**
2438
- * - Field to specify the product quantity that
2439
- * user wants to buy.
2440
- */
2441
- quantity?: number;
2442
- /**
2443
- * - Field to add custom json at article level
2444
- * while add items to cart .
2445
- */
2446
- _custom_json?: any;
2447
- /**
2448
- * - Field to determine size of the product.
2449
- */
2450
- item_size?: string;
2451
- /**
2452
- * - Unique identifier of the store selected by
2453
- * the user from which user want to buy a product.
2454
- */
2455
- store_id?: number;
2456
- /**
2457
- * - Display field at article level .
2458
- */
2459
- display?: string;
2460
- /**
2461
- * - Unique identifier of an article .
2462
- */
2463
- article_id?: string;
2464
- /**
2465
- * - Fields to determine parent
2466
- * product of the product.
2467
- */
2468
- parent_item_identifiers?: any[];
2469
- /**
2470
- * - Unique idetifier of the seller selected by
2471
- * the user from which user want to buy a product .
2472
- */
2473
- seller_id?: number;
2474
- /**
2475
- * - Filed to determine whether user is making request
2476
- * from pos or not.
2477
- */
2478
- pos?: boolean;
2479
- /**
2480
- * - Unique identifier to identify product.
2481
- */
2482
- item_id?: number;
2483
- /**
2484
- * - Field to add meta data at article level.
2485
- */
2486
- meta?: any;
2487
- /**
2488
- * - Add items using seller identifier
2489
- * for store os.
2490
- */
2491
- seller_identifier?: string;
2492
- };
2493
- /** @returns {AddCartCreation} */
2494
- declare function AddCartCreation(): AddCartCreation;
2495
- type AddCartCreation = {
2496
- /**
2497
- * - List of items detail which need to be
2498
- * added to cart like item id, item size, and item quantity.
2499
- */
2500
- items?: AddProductCart[];
2501
- /**
2502
- * - Field to create to new cart whille user adds
2503
- * item to cart.
2504
- */
2505
- new_cart?: boolean;
2506
- };
2507
- /** @returns {AddCartDetailResult} */
2508
- declare function AddCartDetailResult(): AddCartDetailResult;
2509
- type AddCartDetailResult = {
2510
- /**
2511
- * - Message of add to cart API response.
2512
- */
2513
- message?: string;
2514
- /**
2515
- * - When adding multiple items check if all
2516
- * added. True if only few are added.
2517
- */
2518
- partial?: boolean;
2519
- cart?: CartDetailResult;
2520
- /**
2521
- * - True if all items are added successfully.
2522
- * False if partially added or not added.
2523
- */
2524
- success?: boolean;
2525
- };
2526
- /** @returns {UpdateProductCart} */
2527
- declare function UpdateProductCart(): UpdateProductCart;
2528
- type UpdateProductCart = {
2529
- /**
2530
- * - Field to update extra meta of the product in cart.
2531
- */
2532
- extra_meta?: any;
2533
- /**
2534
- * - Field to update custom json of the product in cart.
2535
- */
2536
- _custom_json?: any;
2537
- /**
2538
- * - Field to update the quantity of the item in cart.
2539
- */
2540
- quantity?: number;
2541
- /**
2542
- * - Field to update the size of the product in cart.
2543
- */
2544
- item_size?: string;
2545
- /**
2546
- * - Item index determines on which index the
2547
- * product falls to be updated.
2548
- */
2549
- item_index?: number;
2550
- identifiers: CartProductIdentifer;
2551
- /**
2552
- * - Article id of the product in cart.
2553
- */
2554
- article_id?: string;
2555
- /**
2556
- * - Field to update parent product
2557
- * of the item in cart.
2558
- */
2559
- parent_item_identifiers?: any;
2560
- /**
2561
- * - Item id of the product that needs to be updated.
2562
- */
2563
- item_id?: number;
2564
- /**
2565
- * - Field to update meta of the item in cart.
2566
- */
2567
- meta?: any;
2568
- };
2569
- /** @returns {FreeGiftItemCreation} */
2570
- declare function FreeGiftItemCreation(): FreeGiftItemCreation;
2571
- type FreeGiftItemCreation = {
2572
- /**
2573
- * - Unique identifier of the free gift promotion.
2574
- */
2575
- promotion_id: string;
2576
- /**
2577
- * - Unique identifier of the selected free gift item.
2578
- */
2579
- item_id: string;
2580
- /**
2581
- * - Size of the selected free gift item.
2582
- */
2583
- item_size: string;
2584
- };
2585
- /** @returns {UpdateCartCreation} */
2586
- declare function UpdateCartCreation(): UpdateCartCreation;
2587
- type UpdateCartCreation = {
2588
- /**
2589
- * - List items data that needs to be
2590
- * updated in cart.
2591
- */
2592
- items?: UpdateProductCart[];
2593
- /**
2594
- * - List of free gift
2595
- * items with updated sizes.
2596
- */
2597
- free_gift_items?: FreeGiftItemCreation[];
2598
- /**
2599
- * - Field to determine if item to be removed from
2600
- * cart or it needs to be updated.
2601
- */
2602
- operation: string;
2603
- };
2604
- /** @returns {UpdateCartDetailResult} */
2605
- declare function UpdateCartDetailResult(): UpdateCartDetailResult;
2606
- type UpdateCartDetailResult = {
2607
- /**
2608
- * - Message of update cart API response.
2609
- */
2610
- message?: string;
2611
- cart?: CartDetailResult;
2612
- /**
2613
- * - True if all items are added successfully.
2614
- * False if partially added or not added.
2615
- */
2616
- success?: boolean;
2617
- };
2618
- /** @returns {DeleteCartDetailResult} */
2619
- declare function DeleteCartDetailResult(): DeleteCartDetailResult;
2620
- type DeleteCartDetailResult = {
2621
- /**
2622
- * - Message for delete cart response.
2623
- */
2624
- message?: string;
2625
- /**
2626
- * - True if cart is archived successfully. False
2627
- * if not archived.
2628
- */
2629
- success?: boolean;
2630
- };
2631
- /** @returns {CartItemCountResult} */
2632
- declare function CartItemCountResult(): CartItemCountResult;
2633
- type CartItemCountResult = {
2634
- /**
2635
- * - Item count present in cart.
2636
- */
2637
- user_cart_items_count?: number;
2638
- };
2639
- /** @returns {PageCoupon} */
2640
- declare function PageCoupon(): PageCoupon;
2641
- type PageCoupon = {
2642
- /**
2643
- * - Total coupons are available for the cart.
2644
- */
2645
- total_item_count?: number;
2646
- /**
2647
- * - Denotes if next page of coupon is available.
2648
- */
2649
- has_next?: boolean;
2650
- /**
2651
- * - Total pages of coupon availalbe.
2652
- */
2653
- total?: number;
2654
- /**
2655
- * - Current page number.
2656
- */
2657
- current?: number;
2658
- /**
2659
- * - Denotes if previous page of the coupon
2660
- * is available.
2661
- */
2662
- has_previous?: boolean;
2663
- };
2664
- /** @returns {Coupon} */
2665
- declare function Coupon(): Coupon;
2666
- type Coupon = {
2667
- /**
2668
- * - The amount based on cart value.
2669
- */
2670
- coupon_amount?: number;
2671
- /**
2672
- * - Coupon value of the coupon applied to cart.
2673
- */
2674
- coupon_value?: number;
2675
- /**
2676
- * - Coupon Title of the coupon applied denotes name
2677
- * of the coupon.
2678
- */
2679
- title?: string;
2680
- /**
2681
- * - Minimum cart value of the coupon
2682
- * applied to cart.
2683
- */
2684
- minimum_cart_value?: number;
2685
- /**
2686
- * - Coupon subtitle of the coupon applied to
2687
- * cart which is used to display.
2688
- */
2689
- sub_title?: string;
2690
- /**
2691
- * - Message to display to user for expiry of the coupon .
2692
- */
2693
- expires_on?: string;
2694
- /**
2695
- * - Coupon message of the coupon applied to cart.
2696
- */
2697
- message?: string;
2698
- /**
2699
- * - Type of the coupon applied to cart.
2700
- */
2701
- coupon_type?: string;
2702
- /**
2703
- * - Maximum discount value of the
2704
- * coupon applied to cart.
2705
- */
2706
- max_discount_value?: number;
2707
- /**
2708
- * - Coupon code of the coupon applied on cart.
2709
- */
2710
- coupon_code?: string;
2711
- /**
2712
- * - Flag to determine where the coupon is
2713
- * applicable to cart or not.
2714
- */
2715
- is_applicable?: boolean;
2716
- /**
2717
- * - Coupon description of the coupon applied to cart.
2718
- */
2719
- description?: string;
2720
- /**
2721
- * - Flag to determine where the coupon is
2722
- * applied to cart or not.
2723
- */
2724
- is_applied?: boolean;
2725
- /**
2726
- * - Start date of the coupon when the coupon
2727
- * will be live for the users to apply on cart.
2728
- */
2729
- start_date?: string;
2730
- /**
2731
- * - End date of the coupon on which the coupon expires.
2732
- */
2733
- end_date?: string;
2734
- /**
2735
- * - Message which is used to
2736
- * display to the customer if the coupon is applied successfully.
2737
- */
2738
- coupon_applicable_message?: string;
2739
- /**
2740
- * - Offer text of the coupon which highligts
2741
- * coupon offer defined while creating coupon .
2742
- */
2743
- offer_text?: string;
2744
- /**
2745
- * - Bank offer flag for the coupon if the
2746
- * coupon is applicable for only if payment done by bank or mode specified in coupon.
2747
- */
2748
- is_bank_offer?: boolean;
2749
- };
2750
- /** @returns {GetCouponResult} */
2751
- declare function GetCouponResult(): GetCouponResult;
2752
- type GetCouponResult = {
2753
- page?: PageCoupon;
2754
- /**
2755
- * - List of available coupon which
2756
- * can be applied on cart.
2757
- */
2758
- available_coupon_list?: Coupon[];
2759
- };
2760
- /** @returns {ApplyCoupon} */
2761
- declare function ApplyCoupon(): ApplyCoupon;
2762
- type ApplyCoupon = {
2763
- /**
2764
- * - Coupon code to be applied.
2765
- */
2766
- coupon_code: string;
2767
- };
2768
- /** @returns {OfferPrice} */
2769
- declare function OfferPrice(): OfferPrice;
2770
- type OfferPrice = {
2771
- /**
2772
- * - Currency symbol for currency.
2773
- */
2774
- currency_symbol?: string;
2775
- /**
2776
- * - Discounted per unit price for current
2777
- * offer object.
2778
- */
2779
- bulk_effective?: number;
2780
- /**
2781
- * - The currency code for an offer price is
2782
- * the three-letter code that corresponds to the currency in which the offer
2783
- * price is denominated.
2784
- */
2785
- currency_code?: string;
2786
- /**
2787
- * - The "effective price" is the actual price
2788
- * paid by the consumer after accounting for product discounts. It represents
2789
- * the true cost of a product or service after all adjustments have been made.
2790
- */
2791
- effective?: number;
2792
- /**
2793
- * - The price at which the product is sold to the
2794
- * end consumer, typically the original price before discounts.
2795
- */
2796
- marked?: number;
2797
- };
2798
- /** @returns {OfferItem} */
2799
- declare function OfferItem(): OfferItem;
2800
- type OfferItem = {
2801
- price?: OfferPrice;
2802
- /**
2803
- * - Percentage value of discount.
2804
- */
2805
- margin?: number;
2806
- /**
2807
- * - Quantity on which offer is applicable.
2808
- */
2809
- quantity?: number;
2810
- /**
2811
- * - Is true for best offer from all offers present
2812
- * for all sellers.
2813
- */
2814
- best?: boolean;
2815
- /**
2816
- * - Total price of offer quantity with discount.
2817
- */
2818
- total?: number;
2819
- /**
2820
- * - Whether offer discount is auto applied in cart.
2821
- */
2822
- auto_applied?: boolean;
2823
- /**
2824
- * - Type of the offer.
2825
- */
2826
- type?: string;
2827
- };
2828
- /** @returns {OfferSeller} */
2829
- declare function OfferSeller(): OfferSeller;
2830
- type OfferSeller = {
2831
- /**
2832
- * - Unique identifier for a seller.
2833
- */
2834
- uid?: number;
2835
- /**
2836
- * - Name of a seller.
2837
- */
2838
- name?: string;
2839
- };
2840
- /** @returns {BulkPriceOffer} */
2841
- declare function BulkPriceOffer(): BulkPriceOffer;
2842
- type BulkPriceOffer = {
2843
- /**
2844
- * - Offers is the list of Offer item, which
2845
- * consists of margin percentage, price, quantity, offer type and offer price.
2846
- */
2847
- offers?: OfferItem[];
2848
- seller?: OfferSeller;
2849
- };
2850
- /** @returns {BulkPriceResult} */
2851
- declare function BulkPriceResult(): BulkPriceResult;
2852
- type BulkPriceResult = {
2853
- /**
2854
- * - Actual data to be in response consist
2855
- * of offers from multiple seller.
2856
- */
2857
- data?: BulkPriceOffer[];
2858
- };
2859
- /** @returns {RewardPointCreation} */
2860
- declare function RewardPointCreation(): RewardPointCreation;
2861
- type RewardPointCreation = {
2862
- /**
2863
- * - Points to be applied for cart.
2864
- */
2865
- points: boolean;
2866
- };
2867
- /** @returns {GeoLocation} */
2868
- declare function GeoLocation(): GeoLocation;
2869
- type GeoLocation = {
2870
- /**
2871
- * - Latitude coordinate for address.
2872
- */
2873
- latitude?: number;
2874
- /**
2875
- * - Longitude coordinate for address.
2876
- */
2877
- longitude?: number;
2878
- };
2879
- /** @returns {Address} */
2880
- declare function Address(): Address;
2881
- type Address = {
2882
- /**
2883
- * - Country iso code for address.
2884
- */
2885
- country_iso_code?: string;
2886
- /**
2887
- * - Area description for address.
2888
- */
2889
- area?: string;
2890
- /**
2891
- * - Phone number for address.
2892
- */
2893
- phone?: string;
2894
- /**
2895
- * - Country phone code for address.
2896
- */
2897
- country_phone_code?: string;
2898
- /**
2899
- * - Checkout mode of address on which
2900
- * address to be used for which checkout mode of cart.
2901
- */
2902
- checkout_mode?: string;
2903
- /**
2904
- * - Address description for address data.
2905
- */
2906
- address?: string;
2907
- /**
2908
- * - Area code slug for address. example
2909
- * pincode is slug for India.
2910
- */
2911
- area_code_slug?: string;
2912
- geo_location?: GeoLocation;
2913
- /**
2914
- * - Id of the address.
2915
- */
2916
- id?: string;
2917
- /**
2918
- * - Custom json of the address.
2919
- */
2920
- _custom_json?: any;
2921
- /**
2922
- * - City of the address.
2923
- */
2924
- city?: string;
2925
- /**
2926
- * - Sector of the address.
2927
- */
2928
- sector?: string;
2929
- /**
2930
- * - State code for address.
2931
- */
2932
- state_code?: string;
2933
- /**
2934
- * - Created by user id of address.
2935
- */
2936
- created_by_user_id?: string;
2937
- /**
2938
- * - Landmark of address.
2939
- */
2940
- landmark?: string;
2941
- /**
2942
- * - User id of address for which address is created.
2943
- */
2944
- user_id?: string;
2945
- /**
2946
- * - Name of person in address data to whom it belongs to.
2947
- */
2948
- name?: string;
2949
- /**
2950
- * - Google map point of the address.
2951
- */
2952
- google_map_point?: any;
2953
- /**
2954
- * - States whether address is active or not.
2955
- */
2956
- is_active?: boolean;
2957
- /**
2958
- * - Tags of address from which it can be identified.
2959
- */
2960
- tags?: string[];
2961
- /**
2962
- * - Country code of address.
2963
- */
2964
- country_code?: string;
2965
- /**
2966
- * - Address type of address.
2967
- */
2968
- address_type?: string;
2969
- /**
2970
- * - Country of address.
2971
- */
2972
- country?: string;
2973
- /**
2974
- * - Default address flag if no address
2975
- * selected then this should be the default address selected.
2976
- */
2977
- is_default_address?: boolean;
2978
- /**
2979
- * - Area code of the address.
2980
- */
2981
- area_code?: string;
2982
- /**
2983
- * - Email address for address data.
2984
- */
2985
- email?: string;
2986
- /**
2987
- * - State of the address.
2988
- */
2989
- state?: string;
2990
- /**
2991
- * - Metadata of the address.
2992
- */
2993
- meta?: any;
2994
- };
2995
- /** @returns {ValidationConfig} */
2996
- declare function ValidationConfig(): ValidationConfig;
2997
- type ValidationConfig = {
2998
- /**
2999
- * - The maximum number of addresses a user can have.
3000
- */
3001
- address_max_limit: number;
3002
- /**
3003
- * - The total number of addresses saved by a user.
3004
- */
3005
- user_address_count: number;
3006
- };
3007
- /** @returns {GetAddressesResult} */
3008
- declare function GetAddressesResult(): GetAddressesResult;
3009
- type GetAddressesResult = {
3010
- /**
3011
- * - Personally Identifiable Information
3012
- * masking flag to denote if the user data in address is masked or not.
3013
- */
3014
- pii_masking?: boolean;
3015
- /**
3016
- * - Address description for address data.
3017
- */
3018
- address?: Address[];
3019
- validation_config?: ValidationConfig;
3020
- };
3021
- /** @returns {SaveAddressResult} */
3022
- declare function SaveAddressResult(): SaveAddressResult;
3023
- type SaveAddressResult = {
3024
- /**
3025
- * - Id of the address.
3026
- */
3027
- id?: string;
3028
- /**
3029
- * - Success flag of save address Result.
3030
- */
3031
- success?: boolean;
3032
- /**
3033
- * - Default address flag if no address
3034
- * selected then this should be the default address selected.
3035
- */
3036
- is_default_address?: boolean;
3037
- };
3038
- /** @returns {UpdateAddressResult} */
3039
- declare function UpdateAddressResult(): UpdateAddressResult;
3040
- type UpdateAddressResult = {
3041
- /**
3042
- * - Updated flag for update address operation
3043
- * if the address updated or not.
3044
- */
3045
- is_updated?: boolean;
3046
- /**
3047
- * - ID of an address.
3048
- */
3049
- id?: string;
3050
- /**
3051
- * - Success flag of update address response.
3052
- */
3053
- success?: boolean;
3054
- /**
3055
- * - Default address flag if no address
3056
- * selected then this should be the default address selected.
3057
- */
3058
- is_default_address?: boolean;
3059
- };
3060
- /** @returns {DeleteAddressResult} */
3061
- declare function DeleteAddressResult(): DeleteAddressResult;
3062
- type DeleteAddressResult = {
3063
- /**
3064
- * - Id of the address.
3065
- */
3066
- id?: string;
3067
- /**
3068
- * - Deleted flag in delete address response
3069
- * states whether the address was deleted or not.
3070
- */
3071
- is_deleted?: boolean;
3072
- };
3073
- /** @returns {SelectCartAddressCreation} */
3074
- declare function SelectCartAddressCreation(): SelectCartAddressCreation;
3075
- type SelectCartAddressCreation = {
3076
- /**
3077
- * - Address is selected by user on which shipment to be
3078
- * delivered.
3079
- */
3080
- id?: string;
3081
- /**
3082
- * - Billing address id selected by user
3083
- * on which shipment bill to be generated.
3084
- */
3085
- billing_address_id?: string;
3086
- /**
3087
- * - Cart id of the user cart for which the select
3088
- * address operation performed.
3089
- */
3090
- cart_id?: string;
3091
- };
3092
- /** @returns {UpdateCartPaymentCreation} */
3093
- declare function UpdateCartPaymentCreation(): UpdateCartPaymentCreation;
3094
- type UpdateCartPaymentCreation = {
3095
- /**
3096
- * - Cart id of the user cart for which the update cart
3097
- * payment operation performed.
3098
- */
3099
- id?: string;
3100
- /**
3101
- * - Payment identifier of the payment
3102
- * mode selected to do the payment.
3103
- */
3104
- payment_identifier?: string;
3105
- /**
3106
- * - Address id of the user address selected to
3107
- * deliver the shipment.
3108
- */
3109
- address_id?: string;
3110
- /**
3111
- * - Merchant code of the payment mode
3112
- * selected to do the payment.
3113
- */
3114
- merchant_code?: string;
3115
- /**
3116
- * - Aggregator name of the payment gateway.
3117
- */
3118
- aggregator_name?: string;
3119
- /**
3120
- * - Payment mode of the payment selected to
3121
- * do the payment.
3122
- */
3123
- payment_mode?: string;
3124
- };
3125
- /** @returns {CouponValidity} */
3126
- declare function CouponValidity(): CouponValidity;
3127
- type CouponValidity = {
3128
- /**
3129
- * - Coupon Title of the coupon applied.
3130
- */
3131
- title?: string;
3132
- /**
3133
- * - Coupon discount value of the coupon applied.
3134
- */
3135
- discount?: number;
3136
- /**
3137
- * - Flag for coupon validation
3138
- * required on next page or not.
3139
- */
3140
- next_validation_required?: boolean;
3141
- /**
3142
- * - Valid flag which denotes if the applied coupon
3143
- * is valid or not.
3144
- */
3145
- valid?: boolean;
3146
- /**
3147
- * - Display message for coupon validity.
3148
- */
3149
- display_message_en?: string;
3150
- /**
3151
- * - Coupon code of the coupon applied.
3152
- */
3153
- code?: string;
3154
- /**
3155
- * - Error message for the selected payment mode.
3156
- */
3157
- error_en?: string;
3158
- };
3159
- /** @returns {PaymentCouponValidate} */
3160
- declare function PaymentCouponValidate(): PaymentCouponValidate;
3161
- type PaymentCouponValidate = {
3162
- /**
3163
- * - Payment mode valid message for coupon.
3164
- */
3165
- message?: string;
3166
- coupon_validity?: CouponValidity;
3167
- /**
3168
- * - Success flag of coupon payment mode validity
3169
- * API response.
3170
- */
3171
- success: boolean;
3172
- };
3173
- /** @returns {ShipmentResult} */
3174
- declare function ShipmentResult(): ShipmentResult;
3175
- type ShipmentResult = {
3176
- /**
3177
- * - Count of shipments that will be shipped.
3178
- */
3179
- shipments?: number;
3180
- promise?: ShipmentPromise;
3181
- /**
3182
- * - Order type of the shipment like pickAtStore
3183
- * or HomeDelivery.
3184
- */
3185
- order_type?: string;
3186
- /**
3187
- * - Box type of the shipment in which the
3188
- * shipment will be delivered.
3189
- */
3190
- box_type?: string;
3191
- /**
3192
- * - Shipment type of the shipment returned
3193
- * in get shipments API like single_shipment or multiple shipment. Single
3194
- * Shipment means 1 item in 1 shipment and vice versa in the other one.
3195
- */
3196
- shipment_type?: string;
3197
- /**
3198
- * - Delivery partner options that are available
3199
- * to deliver the shipment.
3200
- */
3201
- dp_options?: any;
3202
- /**
3203
- * - Delivery partner id of the shipment.
3204
- */
3205
- dp_id?: string;
3206
- /**
3207
- * - Item details in the shipment.
3208
- */
3209
- items?: CartProductInfo[];
3210
- /**
3211
- * - Fulfilment type of shipment.
3212
- */
3213
- fulfillment_type?: string;
3214
- /**
3215
- * - Fulfilment id of the shipment.
3216
- */
3217
- fulfillment_id?: number;
3218
- };
3219
- /** @returns {CartShipmentsResult} */
3220
- declare function CartShipmentsResult(): CartShipmentsResult;
3221
- type CartShipmentsResult = {
3222
- /**
3223
- * - Delivery charge in information
3224
- * message on shipment.
3225
- */
3226
- delivery_charge_info?: string;
3227
- /**
3228
- * - Checkout mode of cart.
3229
- */
3230
- checkout_mode?: string;
3231
- /**
3232
- * - Result message of get shipments API.
3233
- */
3234
- message?: string;
3235
- /**
3236
- * - GSTIN number added in cart.
3237
- */
3238
- gstin?: string;
3239
- /**
3240
- * - Restrict checkout flag to restrict
3241
- * the checkout process.
3242
- */
3243
- restrict_checkout?: boolean;
3244
- /**
3245
- * - Last modified timestamp of cart.
3246
- */
3247
- last_modified?: string;
3248
- /**
3249
- * - Cart id of the user cart.
3250
- */
3251
- cart_id?: number;
3252
- /**
3253
- * - Cart validity flag determines the if the
3254
- * response is valid or not.
3255
- */
3256
- is_valid?: boolean;
3257
- breakup_values?: CartBreakup;
3258
- currency?: CartCurrency;
3259
- /**
3260
- * - Cart id of the user cart.
3261
- */
3262
- id?: string;
3263
- /**
3264
- * - List of Shipments which includes
3265
- * shipment data like shipment items, shipment promise, Shipment type,
3266
- * shipment order type, shipment dp options etc.
3267
- */
3268
- shipments?: ShipmentResult[];
3269
- payment_selection_lock?: PaymentSelectionLock;
3270
- /**
3271
- * - Coupon text of coupon applied on cart.
3272
- */
3273
- coupon_text?: string;
3274
- delivery_promise?: ShipmentPromise;
3275
- /**
3276
- * - Error details if any error occurs which
3277
- * includes type of error, error code and error message.
3278
- */
3279
- error?: boolean;
3280
- /**
3281
- * - Comment message added in cart.
3282
- */
3283
- comment?: string;
3284
- /**
3285
- * - Buy now flag of user cart.
3286
- */
3287
- buy_now?: boolean;
3288
- /**
3289
- * - Cart id of the user cart.
3290
- */
3291
- uid?: string;
3292
- /**
3293
- * - Custom meta details added cart
3294
- * checkout API payload.
3295
- */
3296
- custom_cart_meta?: any;
3297
- };
3298
- /** @returns {CartCheckoutCustomMeta} */
3299
- declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
3300
- type CartCheckoutCustomMeta = {
3301
- /**
3302
- * - Key name of custom meta.
3303
- */
3304
- key: string;
3305
- /**
3306
- * - Value to be added in key.
3307
- */
3308
- value: string;
3309
- };
3310
- /** @returns {CustomerDetails} */
3311
- declare function CustomerDetails(): CustomerDetails;
3312
- type CustomerDetails = {
3313
- /**
3314
- * - Email address of the customer to be added in
3315
- * customer detail while checkout.
3316
- */
3317
- email?: string;
3318
- /**
3319
- * - Mobile number of customer to be added in customer
3320
- * detail while checkout.
3321
- */
3322
- mobile: string;
3323
- /**
3324
- * - Name of customer to be added in customer detail
3325
- * while checkout.
3326
- */
3327
- name?: string;
3328
- };
3329
- /** @returns {StaffCheckout} */
3330
- declare function StaffCheckout(): StaffCheckout;
3331
- type StaffCheckout = {
3332
- /**
3333
- * - Employee code of staff who does checkout
3334
- * on behalf of customer.
3335
- */
3336
- employee_code?: string;
3337
- /**
3338
- * - User id of the employee who does checkout on behalf
3339
- * of customer.
3340
- */
3341
- user: string;
3342
- /**
3343
- * - Last name of staff employee who does checkout
3344
- * on behalf of customer.
3345
- */
3346
- last_name: string;
3347
- /**
3348
- * - First name of staff emplyee who does checkout
3349
- * on behalf of customer.
3350
- */
3351
- first_name: string;
3352
- /**
3353
- * - Id of staff who does checkout on behalf of customer.
3354
- */
3355
- _id: string;
3356
- };
3357
- /** @returns {CartCheckoutDetailCreation} */
3358
- declare function CartCheckoutDetailCreation(): CartCheckoutDetailCreation;
3359
- type CartCheckoutDetailCreation = {
3360
- /**
3361
- * - Custom meta data to be
3362
- * added in order.
3363
- */
3364
- custom_meta?: CartCheckoutCustomMeta[];
3365
- /**
3366
- * - Customer details to be added in order.
3367
- */
3368
- customer_details?: CustomerDetails;
3369
- /**
3370
- * - Merchant code of the payment mode
3371
- * selected to do the payment.
3372
- */
3373
- merchant_code?: string;
3374
- /**
3375
- * - Cart id of the user cart.
3376
- */
3377
- id?: string;
3378
- /**
3379
- * - Payment auto confirm flag if
3380
- * payment need not to be collected from user.
3381
- */
3382
- payment_auto_confirm?: boolean;
3383
- /**
3384
- * - Payment mode from which the payment to be
3385
- * done for the order.
3386
- */
3387
- payment_mode: string;
3388
- /**
3389
- * - Aggregator name of the payment gateway.
3390
- */
3391
- aggregator?: string;
3392
- /**
3393
- * - Address id of the user on which the order
3394
- * to be delivered.
3395
- */
3396
- address_id?: string;
3397
- /**
3398
- * - Callback url to be redirected after
3399
- * payment received/failed.
3400
- */
3401
- callback_url?: string;
3402
- /**
3403
- * - Delivery address data which includes
3404
- * customer address, customer phone, customer email, customer pincode,
3405
- * customer landmark and customer name.
3406
- */
3407
- delivery_address?: any;
3408
- staff?: StaffCheckout;
3409
- /**
3410
- * - Order type of the order being placed like
3411
- * pickAtStore or HomeDelivery.
3412
- */
3413
- order_type?: string;
3414
- /**
3415
- * - Ordering store id of the store from
3416
- * which the order is getting placed.
3417
- */
3418
- ordering_store?: number;
3419
- /**
3420
- * - Extra meta to be added while checkout in order.
3421
- */
3422
- extra_meta?: any;
3423
- /**
3424
- * - Payment identifier of the payment
3425
- * mode selected to do the payment.
3426
- */
3427
- payment_identifier?: string;
3428
- /**
3429
- * - Billing address json which includes
3430
- * customer address, customer phone, customer email, customer pincode,
3431
- * customer landmark and customer name.
3432
- */
3433
- billing_address?: any;
3434
- /**
3435
- * - Payment params which includes payment
3436
- * identifier and merchant code.
3437
- */
3438
- payment_params?: any;
3439
- /**
3440
- * - Billing address id of the customer
3441
- * on which the invoice to be generated after the order is placed.
3442
- */
3443
- billing_address_id?: string;
3444
- /**
3445
- * - Meta data to be added in order.
3446
- */
3447
- meta?: any;
3448
- /**
3449
- * - Payment extra identifier for
3450
- * the payment mode to do the payment.
3451
- */
3452
- payment_extra_identifiers?: any;
3453
- /**
3454
- * - Issuer Identification Number' number of card if
3455
- * payment mode is card.
3456
- */
3457
- iin?: string;
3458
- /**
3459
- * - Network of card if payment mode is card to do
3460
- * the payment.
3461
- */
3462
- network?: string;
3463
- /**
3464
- * - Type of cart if payment mode is card to do the payment.
3465
- */
3466
- type?: string;
3467
- /**
3468
- * - Saved card id if payment mode is card to do the payment.
3469
- */
3470
- card_id?: string;
3471
- };
3472
- /** @returns {CheckCart} */
3473
- declare function CheckCart(): CheckCart;
3474
- type CheckCart = {
3475
- /**
3476
- * - Checkout mode of user cart.
3477
- */
3478
- checkout_mode?: string;
3479
- /**
3480
- * - User type of the cart who places the order.
3481
- */
3482
- user_type?: string;
3483
- /**
3484
- * - Cash On Delivery message for the order placed.
3485
- */
3486
- cod_message?: string;
3487
- /**
3488
- * - Cart id of the user cart for which the order placed.
3489
- */
3490
- cart_id?: number;
3491
- /**
3492
- * - Valid flag fotr the checkout response if
3493
- * order placed was valid.
3494
- */
3495
- is_valid?: boolean;
3496
- /**
3497
- * - Delivery charges of the order placed
3498
- * via checkout API.
3499
- */
3500
- delivery_charges?: number;
3501
- /**
3502
- * - Cart id of the user cart.
3503
- */
3504
- id?: string;
3505
- payment_selection_lock?: PaymentSelectionLock;
3506
- /**
3507
- * - Error details if any error occurs which
3508
- * includes type of error, error code and error message.
3509
- */
3510
- error_message?: string;
3511
- delivery_promise?: ShipmentPromise;
3512
- /**
3513
- * - Comment message added in cart after order placed.
3514
- */
3515
- comment?: string;
3516
- /**
3517
- * - Items details in cart after order placed.
3518
- */
3519
- items?: CartProductInfo[];
3520
- /**
3521
- * - Cart id of user cart.
3522
- */
3523
- uid?: string;
3524
- /**
3525
- * - Delivery charge order value.
3526
- */
3527
- delivery_charge_order_value?: number;
3528
- /**
3529
- * - Delivery charge in information
3530
- * message on shipment.
3531
- */
3532
- delivery_charge_info?: string;
3533
- /**
3534
- * - Whether Cash On Delivery available.
3535
- */
3536
- cod_available?: boolean;
3537
- /**
3538
- * - Success flag of checkout cart API response.
3539
- */
3540
- success?: boolean;
3541
- /**
3542
- * - Store code from which the order placed.
3543
- */
3544
- store_code?: string;
3545
- /**
3546
- * - Message of the cart checkout API response.
3547
- */
3548
- message?: string;
3549
- /**
3550
- * - GSTIN number added in cart.
3551
- */
3552
- gstin?: string;
3553
- /**
3554
- * - Restrict checkout flag to restrict
3555
- * the checkout process.
3556
- */
3557
- restrict_checkout?: boolean;
3558
- /**
3559
- * - Last modified timestamp of cart.
3560
- */
3561
- last_modified?: string;
3562
- /**
3563
- * - Order id generated after placing order.
3564
- */
3565
- order_id?: string;
3566
- breakup_values?: CartBreakup;
3567
- currency?: CartCurrency;
3568
- /**
3569
- * - Store employees data.
3570
- */
3571
- store_emps?: any[];
3572
- /**
3573
- * - Coupon text of the applied coupon on order placed.
3574
- */
3575
- coupon_text?: string;
3576
- /**
3577
- * - Buy now flag of user cart.
3578
- */
3579
- buy_now?: boolean;
3580
- /**
3581
- * - Cash On Delivery charges of the user cart.
3582
- */
3583
- cod_charges?: number;
3584
- /**
3585
- * - Custom cart meta details added in cart.
3586
- */
3587
- custom_cart_meta?: any;
3588
- };
3589
- /** @returns {CartCheckoutResult} */
3590
- declare function CartCheckoutResult(): CartCheckoutResult;
3591
- type CartCheckoutResult = {
3592
- /**
3593
- * - Payment confirm url used to
3594
- * redirect after payment is confirmed.
3595
- */
3596
- payment_confirm_url?: string;
3597
- /**
3598
- * - App intercept url which is used to
3599
- * redirect on app after payment in confirmed/failed.
3600
- */
3601
- app_intercept_url?: string;
3602
- /**
3603
- * - Success flag of cart checkout API response.
3604
- */
3605
- success?: boolean;
3606
- /**
3607
- * - Callback url to be redirected after
3608
- * payment received/failed.
3609
- */
3610
- callback_url?: string;
3611
- /**
3612
- * - Message of the cart checkout v2 API response.
3613
- */
3614
- message?: string;
3615
- /**
3616
- * - Data of the user cart checkout includes cart
3617
- * data, address, user id, order type etc.
3618
- */
3619
- data?: any;
3620
- /**
3621
- * - Order id generated after placing order.
3622
- */
3623
- order_id?: string;
3624
- cart?: CheckCart;
3625
- };
3626
- /** @returns {GiftDetail} */
3627
- declare function GiftDetail(): GiftDetail;
3628
- type GiftDetail = {
3629
- /**
3630
- * - Is gift applied flag which determines
3631
- * if this is a gift oder not.
3632
- */
3633
- is_gift_applied?: boolean;
3634
- /**
3635
- * - Gift message for the one while receive
3636
- * the delivery of the order with this message.
3637
- */
3638
- gift_message?: string;
3639
- };
3640
- /** @returns {ArticleGiftDetail} */
3641
- declare function ArticleGiftDetail(): ArticleGiftDetail;
3642
- type ArticleGiftDetail = {
3643
- article_id?: GiftDetail;
3644
- };
3645
- /** @returns {CartMetaCreation} */
3646
- declare function CartMetaCreation(): CartMetaCreation;
3647
- type CartMetaCreation = {
3648
- /**
3649
- * - Delivery slots details includes article
3650
- * level time slot when the shipment can be delivered.
3651
- */
3652
- delivery_slots?: any;
3653
- gift_details?: ArticleGiftDetail;
3654
- /**
3655
- * - Customer contact details for
3656
- * customer pickup at store.
3657
- */
3658
- pick_up_customer_details?: any;
3659
- /**
3660
- * - Checkout mode of user cart.
3661
- */
3662
- checkout_mode?: string;
3663
- /**
3664
- * - Comment message to be added in user cart.
3665
- */
3666
- comment?: string;
3667
- /**
3668
- * - GSTIN number to be added in user cart.
3669
- */
3670
- gstin?: string;
3671
- /**
3672
- * - Custom cart meta json to be added in
3673
- * order meta which can be further received in cart API response and order
3674
- * meta in order detail API or webhook.
3675
- */
3676
- custom_cart_meta?: any;
3677
- };
3678
- /** @returns {CartMetaResult} */
3679
- declare function CartMetaResult(): CartMetaResult;
3680
- type CartMetaResult = {
3681
- /**
3682
- * - Detailed message.
3683
- */
3684
- message?: string;
3685
- /**
3686
- * - Whether added meta was vaild.
3687
- */
3688
- is_valid?: boolean;
3689
- };
3690
- /** @returns {CartMetaMissingResult} */
3691
- declare function CartMetaMissingResult(): CartMetaMissingResult;
3692
- type CartMetaMissingResult = {
3693
- /**
3694
- * - Detailed errors for invalid cart meta request.
3695
- */
3696
- errors?: string[];
3697
- };
3698
- /** @returns {GetShareCartLinkCreation} */
3699
- declare function GetShareCartLinkCreation(): GetShareCartLinkCreation;
3700
- type GetShareCartLinkCreation = {
3701
- /**
3702
- * - Cart id of user cart for generating cart sharing token.
3703
- */
3704
- id?: string;
3705
- /**
3706
- * - Staff, Ordering store or any other data. This
3707
- * data will be used to generate link as well as sent as shared details.
3708
- */
3709
- meta?: any;
3710
- };
3711
- /** @returns {GetShareCartLinkResult} */
3712
- declare function GetShareCartLinkResult(): GetShareCartLinkResult;
3713
- type GetShareCartLinkResult = {
3714
- /**
3715
- * - Short url unique id of the cart which is opted
3716
- * to share with other user.
3717
- */
3718
- token?: string;
3719
- /**
3720
- * - Short shareable final url which can populate
3721
- * shared cart items in one's cart or replaced one's cart with shared cart items.
3722
- */
3723
- share_url?: string;
3724
- };
3725
- /** @returns {SharedCartDetails} */
3726
- declare function SharedCartDetails(): SharedCartDetails;
3727
- type SharedCartDetails = {
3728
- /**
3729
- * - Short link id of the user cart that needs to be shared.
3730
- */
3731
- token?: string;
3732
- /**
3733
- * - User details of who generated share link.
3734
- */
3735
- user?: any;
3736
- /**
3737
- * - Created on timestamp of user cart.
3738
- */
3739
- created_on?: string;
3740
- /**
3741
- * - Share link device and other source information.
3742
- */
3743
- source?: any;
3744
- /**
3745
- * - Meta data sent while generating share cart link.
3746
- */
3747
- meta?: any;
3748
- };
3749
- /** @returns {SharedCart} */
3750
- declare function SharedCart(): SharedCart;
3751
- type SharedCart = {
3752
- /**
3753
- * - Checkout mode of address on which
3754
- * address to be used for which checkout mode of cart.
3755
- */
3756
- checkout_mode?: string;
3757
- /**
3758
- * - Cart id of user cart for generating cart sharing token.
3759
- */
3760
- cart_id?: number;
3761
- /**
3762
- * - Valid flag for get shared cart detail API.
3763
- */
3764
- is_valid?: boolean;
3765
- /**
3766
- * - Cart id of shared cart.
3767
- */
3768
- id?: string;
3769
- payment_selection_lock?: PaymentSelectionLock;
3770
- delivery_promise?: ShipmentPromise;
3771
- /**
3772
- * - Comment message added in user cart.
3773
- */
3774
- comment?: string;
3775
- /**
3776
- * - Items data list in user cart that
3777
- * includes item id, item size, store id, available sizes and rest of the item
3778
- * related data.
3779
- */
3780
- items?: CartProductInfo[];
3781
- /**
3782
- * - Cart id of the user cart.
3783
- */
3784
- uid?: string;
3785
- /**
3786
- * - Delivery charge info message of
3787
- * the user cart.
3788
- */
3789
- delivery_charge_info?: string;
3790
- /**
3791
- * - Message of the get shared cart API response.
3792
- */
3793
- message?: string;
3794
- /**
3795
- * - GSTIN added in user cart.
3796
- */
3797
- gstin?: string;
3798
- shared_cart_details?: SharedCartDetails;
3799
- /**
3800
- * - Restrict checkout flag to restrict
3801
- * the checkout process.
3802
- */
3803
- restrict_checkout?: boolean;
3804
- /**
3805
- * - Last modified timestamp of user cart.
3806
- */
3807
- last_modified?: string;
3808
- breakup_values?: CartBreakup;
3809
- currency?: CartCurrency;
3810
- /**
3811
- * - Coupon text of the applied coupon on user cart.
3812
- */
3813
- coupon_text?: string;
3814
- /**
3815
- * - Buy now flag of user cart.
3816
- */
3817
- buy_now?: boolean;
3818
- /**
3819
- * - Custom cart meta of user cart added
3820
- * via update cart meta API.
3821
- */
3822
- custom_cart_meta?: any;
3823
- };
3824
- /** @returns {SharedCartResult} */
3825
- declare function SharedCartResult(): SharedCartResult;
3826
- type SharedCartResult = {
3827
- /**
3828
- * - Error details if any error occurs which includes
3829
- * type of error, error code and error message.
3830
- */
3831
- error?: string;
3832
- cart?: SharedCart;
3833
- };
3834
- /** @returns {PriceMinMax} */
3835
- declare function PriceMinMax(): PriceMinMax;
3836
- type PriceMinMax = {
3837
- /**
3838
- * - Min price of article added in user cart.
3839
- */
3840
- min?: number;
3841
- /**
3842
- * - Max price of article added in user cart.
3843
- */
3844
- max?: number;
3845
- };
3846
- /** @returns {ItemPriceDetails} */
3847
- declare function ItemPriceDetails(): ItemPriceDetails;
3848
- type ItemPriceDetails = {
3849
- marked?: PriceMinMax;
3850
- effective?: PriceMinMax;
3851
- /**
3852
- * - Currency of the article added in cart.
3853
- */
3854
- currency?: string;
3855
- };
3856
- /** @returns {ArticlePriceDetails} */
3857
- declare function ArticlePriceDetails(): ArticlePriceDetails;
3858
- type ArticlePriceDetails = {
3859
- /**
3860
- * - The Marked Price refers to the initial price of
3861
- * the free gift article before product discount.
3862
- */
3863
- marked?: number;
3864
- /**
3865
- * - The Effective Price refers to the final
3866
- * amount of the free gift article after applying the product discount.
3867
- */
3868
- effective?: number;
3869
- };
3870
- /** @returns {FreeGiftItems} */
3871
- declare function FreeGiftItems(): FreeGiftItems;
3872
- type FreeGiftItems = {
3873
- /**
3874
- * - Slug for an item.
3875
- */
3876
- item_slug?: string;
3877
- /**
3878
- * - Name of the free gift item received via free
3879
- * gift promotion.
3880
- */
3881
- item_name?: string;
3882
- item_price_details?: ItemPriceDetails;
3883
- article_price?: ArticlePriceDetails;
3884
- /**
3885
- * - Item brand name of the free gift item
3886
- * promotion applied on cart.
3887
- */
3888
- item_brand_name?: string;
3889
- /**
3890
- * - Item id of the free gift item.
3891
- */
3892
- item_id?: number;
3893
- /**
3894
- * - Available sizes for the free gift item.
3895
- */
3896
- available_sizes?: string[];
3897
- /**
3898
- * - Selected size for the free gift item.
3899
- */
3900
- size?: string;
3901
- /**
3902
- * - Images URLs for free gift items.
3903
- */
3904
- item_images_url?: string[];
3905
- };
3906
- /** @returns {PromotionOffer} */
3907
- declare function PromotionOffer(): PromotionOffer;
3908
- type PromotionOffer = {
3909
- /**
3910
- * - Promotion id of the promotion which is available on product.
3911
- */
3912
- id?: string;
3913
- /**
3914
- * - Buy rules of promotion which is available on product.
3915
- */
3916
- buy_rules?: any;
3917
- /**
3918
- * - Offer title of the promotion which is
3919
- * available on product.
3920
- */
3921
- offer_text?: string;
3922
- /**
3923
- * - Promotion type of the promotion which
3924
- * is availalbe on product.
3925
- */
3926
- promotion_type?: string;
3927
- /**
3928
- * - Name of the promotion which is
3929
- * available on product.
3930
- */
3931
- promotion_name?: string;
3932
- /**
3933
- * - Group of the promotion which is
3934
- * available on product.
3935
- */
3936
- promotion_group?: string;
3937
- /**
3938
- * - Datetime ISO String for promotion end date
3939
- * which is available on product.
3940
- */
3941
- valid_till?: string;
3942
- /**
3943
- * - Discount rules of promotions which is
3944
- * avaiable on product.
3945
- */
3946
- discount_rules?: any[];
3947
- /**
3948
- * - Details of free gift items
3949
- * which included item id, brand name, item name, item slug, item price and
3950
- * item image url.
3951
- */
3952
- free_gift_items?: FreeGiftItems[];
3953
- /**
3954
- * - Offer details including T&C of the
3955
- * promotion which is avaiable on product.
3956
- */
3957
- description?: string;
3958
- };
3959
- /** @returns {PromotionOffersResult} */
3960
- declare function PromotionOffersResult(): PromotionOffersResult;
3961
- type PromotionOffersResult = {
3962
- /**
3963
- * - Available promotion
3964
- * details which are available on product which includes promotion data like
3965
- * promotion id, promotion name, buy rules, discount rules validity dates etc.
3966
- */
3967
- available_promotions?: PromotionOffer[];
3968
- };
3969
- /** @returns {PromotionPaymentOffer} */
3970
- declare function PromotionPaymentOffer(): PromotionPaymentOffer;
3971
- type PromotionPaymentOffer = {
3972
- /**
3973
- * - Application id on which the promotion
3974
- * was created.
3975
- */
3976
- application_id?: string;
3977
- /**
3978
- * - Buy rules of promotions which denotes if
3979
- * the rules matches than only promotion is applicable.
3980
- */
3981
- buy_rules?: any[];
3982
- /**
3983
- * - Article Price on which promotion
3984
- * calculated like effective price or marked price.
3985
- */
3986
- calculate_on?: string;
3987
- /**
3988
- * - Offer details including T&C of the
3989
- * promotion which is avaiable on cart.
3990
- */
3991
- description?: string;
3992
- /**
3993
- * - Discount rules of promotions which is
3994
- * avaiable on cart.
3995
- */
3996
- discount_rules?: any[];
3997
- /**
3998
- * - Promotion id of the promotion which is available on cart.
3999
- */
4000
- id?: string;
4001
- /**
4002
- * - Offer title of the promotion which is
4003
- * available on cart.
4004
- */
4005
- offer_text?: string;
4006
- /**
4007
- * - Group promotion which is available on cart.
4008
- */
4009
- promotion_group?: string;
4010
- /**
4011
- * - Promotion type of the promotion which
4012
- * is availalbe on cart.
4013
- */
4014
- promotion_type?: string;
4015
- /**
4016
- * - Name of the promotion which is available on cart.
4017
- */
4018
- promotion_name?: string;
4019
- };
4020
- /** @returns {PromotionPaymentOffersResult} */
4021
- declare function PromotionPaymentOffersResult(): PromotionPaymentOffersResult;
4022
- type PromotionPaymentOffersResult = {
4023
- /**
4024
- * - Success flag of get payment offers API response.
4025
- */
4026
- success?: boolean;
4027
- /**
4028
- * - List of promotions data
4029
- * which are applicable on cart/product.
4030
- */
4031
- promotions?: PromotionPaymentOffer[];
4032
- };
4033
- /** @returns {OperationErrorResult} */
4034
- declare function OperationErrorResult(): OperationErrorResult;
4035
- type OperationErrorResult = {
4036
- /**
4037
- * - Message of get payment offer API response.
4038
- */
4039
- message?: string;
4040
- /**
4041
- * - Success flag of get payment offer API response.
4042
- */
4043
- success?: boolean;
4044
- };
4045
- /** @returns {LadderPrice} */
4046
- declare function LadderPrice(): LadderPrice;
4047
- type LadderPrice = {
4048
- /**
4049
- * - Currency symbol for currency of ladder
4050
- * price product.
4051
- */
4052
- currency_symbol?: string;
4053
- /**
4054
- * - Discounted per unit price for current offer object.
4055
- */
4056
- offer_price?: number;
4057
- /**
4058
- * - Currency code for all amounts.
4059
- */
4060
- currency_code?: string;
4061
- /**
4062
- * - Current per unit price of product after
4063
- * existing deductions.
4064
- */
4065
- effective?: number;
4066
- /**
4067
- * - Original price of product.
4068
- */
4069
- marked?: number;
4070
- };
4071
- /** @returns {LadderOfferItem} */
4072
- declare function LadderOfferItem(): LadderOfferItem;
4073
- type LadderOfferItem = {
4074
- price?: LadderPrice;
4075
- /**
4076
- * - Percentage value of discount.
4077
- */
4078
- margin?: number;
4079
- /**
4080
- * - Minimum quantity upto which offer is
4081
- * applicable. If not present that offer is applicable on all quantities.
4082
- */
4083
- max_quantity?: number;
4084
- /**
4085
- * - Minimum quantity from which offer is applicable.
4086
- */
4087
- min_quantity?: number;
4088
- /**
4089
- * - Offer type of the ladder promotion.
4090
- */
4091
- type?: string;
4092
- };
4093
- /** @returns {LadderPriceOffer} */
4094
- declare function LadderPriceOffer(): LadderPriceOffer;
4095
- type LadderPriceOffer = {
4096
- /**
4097
- * - ID of the promotion.
4098
- */
4099
- id?: string;
4100
- /**
4101
- * - Buy rules of ladder price promotion
4102
- * applicable on product.
4103
- */
4104
- buy_rules?: any;
4105
- /**
4106
- * - If this ladder offer is to be calculated
4107
- * on MRP or ESP price.
4108
- */
4109
- calculate_on?: string;
4110
- /**
4111
- * - Offer title of ladder price promotion
4112
- * applicable on product.
4113
- */
4114
- offer_text?: string;
4115
- /**
4116
- * - Group of ladder price promotion
4117
- * applicable on product.
4118
- */
4119
- promotion_group?: string;
4120
- /**
4121
- * - Datetime ISO String for promotion end date.
4122
- */
4123
- valid_till?: string;
4124
- /**
4125
- * - Discount rules of ladder price
4126
- * promotion applicable on product.
4127
- */
4128
- discount_rules?: any[];
4129
- /**
4130
- * - Offer prices for ladder price
4131
- * promotion applicable on product.
4132
- */
4133
- offer_prices?: LadderOfferItem[];
4134
- /**
4135
- * - Details of free gift items list.
4136
- */
4137
- free_gift_items?: FreeGiftItems[];
4138
- /**
4139
- * - Offer details including T&C of ladder
4140
- * price promotion applicable on product.
4141
- */
4142
- description?: string;
4143
- };
4144
- /** @returns {CurrencyInfo} */
4145
- declare function CurrencyInfo(): CurrencyInfo;
4146
- type CurrencyInfo = {
4147
- /**
4148
- * - Currency code of ladder price promotion.
4149
- */
4150
- code?: string;
4151
- /**
4152
- * - Currency symbol for currency of ladder price product.
4153
- */
4154
- symbol?: string;
4155
- };
4156
- /** @returns {LadderPriceOffers} */
4157
- declare function LadderPriceOffers(): LadderPriceOffers;
4158
- type LadderPriceOffers = {
4159
- /**
4160
- * - Available ladder
4161
- * promotions offers list.
4162
- */
4163
- available_offers?: LadderPriceOffer[];
4164
- currency?: CurrencyInfo;
4165
- };
4166
- /** @returns {PaymentMeta} */
4167
- declare function PaymentMeta(): PaymentMeta;
4168
- type PaymentMeta = {
4169
- /**
4170
- * - Merchant code of the payment mode
4171
- * selected to do the payment.
4172
- */
4173
- merchant_code?: string;
4174
- /**
4175
- * - Type of card if payment mode is card to do the payment.
4176
- */
4177
- type?: string;
4178
- /**
4179
- * - Payment gateway used to do the payment.
4180
- */
4181
- payment_gateway?: string;
4182
- /**
4183
- * - Payment identifier of the payment
4184
- * mode selected to do the payment.
4185
- */
4186
- payment_identifier?: string;
4187
- };
4188
- /** @returns {PaymentMethod} */
4189
- declare function PaymentMethod(): PaymentMethod;
4190
- type PaymentMethod = {
4191
- payment_meta: PaymentMeta;
4192
- /**
4193
- * - Payment mode of payment method used to make payment.
4194
- */
4195
- mode: string;
4196
- /**
4197
- * - Payment name of payment method used to make payment.
4198
- */
4199
- payment?: string;
4200
- /**
4201
- * - Amount of the payment mode to be paid.
4202
- */
4203
- amount?: number;
4204
- /**
4205
- * - Name of the payment mode used to make payment.
4206
- */
4207
- name?: string;
4208
- /**
4209
- * - Payment extra identifier for
4210
- * the payment mode to do the payment.
4211
- */
4212
- payment_extra_identifiers?: any;
4213
- };
4214
- /** @returns {CartCheckoutDetailV2Creation} */
4215
- declare function CartCheckoutDetailV2Creation(): CartCheckoutDetailV2Creation;
4216
- type CartCheckoutDetailV2Creation = {
4217
- /**
4218
- * - Custom meta data to be
4219
- * added in order.
4220
- */
4221
- custom_meta?: CartCheckoutCustomMeta[];
4222
- customer_details?: CustomerDetails;
4223
- /**
4224
- * - Merchant code of the payment mode
4225
- * selected to do the payment.
4226
- */
4227
- merchant_code?: string;
4228
- /**
4229
- * - Cart id of the user cart.
4230
- */
4231
- cart_id?: string;
4232
- /**
4233
- * - Cart id of the user cart.
4234
- */
4235
- id?: string;
4236
- /**
4237
- * - Payment auto confirm flag if
4238
- * payment need not to be collected from user.
4239
- */
4240
- payment_auto_confirm?: boolean;
4241
- /**
4242
- * - Payment methods list used to
4243
- * make the payment.
4244
- */
4245
- payment_methods: PaymentMethod[];
4246
- /**
4247
- * - Payment mode of the payment selected to do
4248
- * the payment.
4249
- */
4250
- payment_mode: string;
4251
- /**
4252
- * - Aggregator of payment mode to do the payment.
4253
- */
4254
- aggregator?: string;
4255
- /**
4256
- * - Address id of the user where the order to
4257
- * be delivered.
4258
- */
4259
- address_id?: string;
4260
- /**
4261
- * - Callback url after payment received/failed.
4262
- */
4263
- callback_url?: string;
4264
- /**
4265
- * - Delivery address data which includes
4266
- * customer address, customer phone, customer email, customer pincode,
4267
- * customer landmark and customer name.
4268
- */
4269
- delivery_address?: any;
4270
- staff?: StaffCheckout;
4271
- /**
4272
- * - Order type of the order being placed like
4273
- * pickAtStore or HomeDelivery.
4274
- */
4275
- order_type?: string;
4276
- /**
4277
- * - Ordering store id of the store from
4278
- * which the order is getting placed.
4279
- */
4280
- ordering_store?: number;
4281
- /**
4282
- * - Extra meta to be added while checkout in order.
4283
- */
4284
- extra_meta?: any;
4285
- /**
4286
- * - Payment identifier of the payment
4287
- * mode selected to do the payment.
4288
- */
4289
- payment_identifier?: string;
4290
- /**
4291
- * - Billing address json which includes
4292
- * customer address, customer phone, customer email, customer pincode,
4293
- * customer landmark and customer name.
4294
- */
4295
- billing_address?: any;
4296
- /**
4297
- * - Payment params which includes payment
4298
- * identifier and merchant code.
4299
- */
4300
- payment_params?: any;
4301
- /**
4302
- * - Billing address id selected by user
4303
- * on which shipment bill to be generated.
4304
- */
4305
- billing_address_id?: string;
4306
- /**
4307
- * - Meta data sent while checkout v2.
4308
- */
4309
- meta?: any;
4310
- /**
4311
- * - Issuer Identification Number' number of card if
4312
- * payment mode is card to do the payment.
4313
- */
4314
- iin?: string;
4315
- /**
4316
- * - Network of card if payment mode is card to do
4317
- * the payment.
4318
- */
4319
- network?: string;
4320
- /**
4321
- * - Type of cart if payment mode is card to do the payment.
4322
- */
4323
- type?: string;
4324
- /**
4325
- * - Saved card id if payment mode is card to do the payment.
4326
- */
4327
- card_id?: string;
4328
- };
4329
- /** @returns {ValidationError} */
4330
- declare function ValidationError(): ValidationError;
4331
- type ValidationError = {
4332
- /**
4333
- * - A brief description of the error encountered.
4334
- */
4335
- message: string;
4336
- /**
4337
- * - The field in the request that caused the error.
4338
- */
4339
- field: string;
4340
- };