@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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 (346) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  12. package/sdk/application/Cart/CartApplicationClient.js +595 -594
  13. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  14. package/sdk/application/Cart/CartApplicationModel.js +490 -885
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  16. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  17. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  18. package/sdk/application/Catalog/CatalogApplicationClient.js +1079 -1078
  19. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  20. package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
  21. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  22. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  23. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  24. package/sdk/application/Common/CommonApplicationClient.js +43 -42
  25. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  26. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  27. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  28. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  29. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  30. package/sdk/application/Communication/CommunicationApplicationClient.js +32 -31
  31. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  32. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  33. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  34. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  41. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  42. package/sdk/application/Content/ContentApplicationClient.js +216 -215
  43. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  44. package/sdk/application/Content/ContentApplicationModel.js +468 -884
  45. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  46. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.js +65 -64
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  53. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  54. package/sdk/application/Lead/LeadApplicationClient.js +109 -108
  55. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  56. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  57. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  58. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  59. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +31 -22
  60. package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
  61. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  62. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  63. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  64. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -9
  65. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  66. package/sdk/application/Order/OrderApplicationClient.js +247 -246
  67. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  68. package/sdk/application/Order/OrderApplicationModel.js +361 -656
  69. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  70. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  71. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  72. package/sdk/application/Payment/PaymentApplicationClient.js +781 -780
  73. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  74. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  75. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  76. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  77. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  78. package/sdk/application/PosCart/PosCartApplicationClient.js +646 -645
  79. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  80. package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
  81. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  82. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +122 -121
  85. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  86. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  87. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  88. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  89. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  90. package/sdk/application/Share/ShareApplicationClient.js +94 -93
  91. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  92. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  93. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  94. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  95. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  96. package/sdk/application/Theme/ThemeApplicationClient.js +38 -37
  97. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  98. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  99. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  100. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  101. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  102. package/sdk/application/User/UserApplicationClient.js +619 -618
  103. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  104. package/sdk/application/User/UserApplicationModel.js +440 -689
  105. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  106. package/sdk/application/User/UserApplicationValidator.js +89 -89
  107. package/sdk/common/AxiosHelper.js +18 -7
  108. package/sdk/constructUrl.d.ts +5 -0
  109. package/sdk/constructUrl.js +13 -0
  110. package/sdk/index.d.ts +3 -0
  111. package/sdk/index.js +5 -0
  112. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  113. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
  114. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  115. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
  116. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  117. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  118. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  119. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +7 -6
  126. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  127. package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
  128. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  129. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  130. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  131. package/sdk/platform/Billing/BillingPlatformValidator.js +26 -25
  132. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
  133. package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
  134. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
  135. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
  136. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  137. package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
  140. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  142. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
  143. package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
  144. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  145. package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
  146. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  147. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
  148. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  149. package/sdk/platform/Common/CommonPlatformClient.js +40 -51
  150. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  151. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  152. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  153. package/sdk/platform/Common/CommonPlatformValidator.js +7 -6
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
  158. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -24
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +39 -38
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  183. package/sdk/platform/Content/ContentPlatformModel.js +485 -907
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +30 -29
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +12 -11
  200. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  201. package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
  202. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  203. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  204. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  205. package/sdk/platform/Inventory/InventoryPlatformValidator.js +29 -28
  206. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  207. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
  208. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  209. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
  210. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  211. package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
  212. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  213. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  214. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  215. package/sdk/platform/Lead/LeadPlatformValidator.js +25 -24
  216. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  217. package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
  218. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
  220. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  221. package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
  222. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  223. package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
  224. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  225. package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
  226. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  227. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  228. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  229. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  230. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
  231. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
  232. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  233. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
  234. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  235. package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
  236. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  237. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  238. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  239. package/sdk/platform/Payment/PaymentPlatformValidator.js +22 -21
  240. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  241. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  242. package/sdk/platform/PlatformClient.d.ts +7972 -7888
  243. package/sdk/platform/PlatformClient.js +8678 -10107
  244. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
  245. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
  246. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  247. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
  248. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  249. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  250. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  251. package/sdk/platform/Share/SharePlatformApplicationClient.js +62 -60
  252. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  253. package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
  254. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  255. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  256. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  257. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +314 -312
  258. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  259. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
  260. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  261. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  262. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  263. package/sdk/platform/User/UserPlatformApplicationClient.js +507 -166
  264. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  265. package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
  266. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  267. package/sdk/platform/User/UserPlatformModel.js +440 -689
  268. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  269. package/sdk/platform/Webhook/WebhookPlatformClient.js +91 -90
  270. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  271. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  272. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  273. package/sdk/platform/Webhook/WebhookPlatformValidator.js +15 -14
  274. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  275. package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -38
  276. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  277. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  278. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  279. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  280. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  281. package/sdk/public/Inventory/InventoryPublicClient.js +115 -113
  282. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  283. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  284. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  285. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  286. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  287. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  288. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  289. package/.github/workflows/on_create_release.yml +0 -23
  290. package/.github/workflows/on_merge_main.yml +0 -38
  291. package/.github/workflows/on_pull_request.yml +0 -35
  292. package/.prettierrc +0 -5
  293. package/documentation/application/CART.md +0 -7339
  294. package/documentation/application/CATALOG.md +0 -9597
  295. package/documentation/application/COMMON.md +0 -452
  296. package/documentation/application/COMMUNICATION.md +0 -467
  297. package/documentation/application/CONFIGURATION.md +0 -2906
  298. package/documentation/application/CONTENT.md +0 -3351
  299. package/documentation/application/FILESTORAGE.md +0 -578
  300. package/documentation/application/LEAD.md +0 -1895
  301. package/documentation/application/LOGISTIC.md +0 -765
  302. package/documentation/application/ORDER.md +0 -3432
  303. package/documentation/application/PAYMENT.md +0 -5221
  304. package/documentation/application/POSCART.md +0 -7938
  305. package/documentation/application/README.md +0 -21
  306. package/documentation/application/REWARDS.md +0 -708
  307. package/documentation/application/SHARE.md +0 -733
  308. package/documentation/application/THEME.md +0 -5800
  309. package/documentation/application/USER.md +0 -4335
  310. package/documentation/platform/ANALYTICS.md +0 -1154
  311. package/documentation/platform/AUDITTRAIL.md +0 -576
  312. package/documentation/platform/BILLING.md +0 -2400
  313. package/documentation/platform/CART.md +0 -5559
  314. package/documentation/platform/CATALOG.md +0 -23261
  315. package/documentation/platform/COMMON.md +0 -452
  316. package/documentation/platform/COMMUNICATION.md +0 -5718
  317. package/documentation/platform/COMPANYPROFILE.md +0 -2031
  318. package/documentation/platform/CONFIGURATION.md +0 -7339
  319. package/documentation/platform/CONTENT.md +0 -9098
  320. package/documentation/platform/DISCOUNT.md +0 -863
  321. package/documentation/platform/FILESTORAGE.md +0 -1081
  322. package/documentation/platform/INVENTORY.md +0 -1779
  323. package/documentation/platform/LEAD.md +0 -4740
  324. package/documentation/platform/ORDER.md +0 -8486
  325. package/documentation/platform/PARTNER.md +0 -220
  326. package/documentation/platform/PAYMENT.md +0 -3448
  327. package/documentation/platform/README.md +0 -27
  328. package/documentation/platform/REWARDS.md +0 -1083
  329. package/documentation/platform/SHARE.md +0 -606
  330. package/documentation/platform/THEME.md +0 -35729
  331. package/documentation/platform/USER.md +0 -2319
  332. package/documentation/platform/WEBHOOK.md +0 -591
  333. package/documentation/public/CONFIGURATION.md +0 -452
  334. package/documentation/public/INVENTORY.md +0 -690
  335. package/documentation/public/WEBHOOK.md +0 -352
  336. package/jest.config.d.ts +0 -4
  337. package/jest.config.js +0 -6
  338. package/tests/application/catalog.spec.js +0 -47
  339. package/tests/common/action-url.spec.js +0 -35
  340. package/tests/common/schema/action-url.json +0 -178
  341. package/tests/common/schema/url-action.json +0 -683
  342. package/tests/common/url-action.spec.js +0 -48
  343. package/tests/helpers/cookie.helper.js +0 -31
  344. package/tests/helpers/oauth.helper.js +0 -43
  345. package/tests/platform/catalog.spec.js +0 -49
  346. package/tests/public/location.spec.js +0 -39
@@ -1,2906 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Application docs](./README.md)
7
-
8
- ## Configuration Methods
9
- Application configuration apis
10
-
11
- * [getApplication](#getapplication)
12
- * [getOwnerInfo](#getownerinfo)
13
- * [getBasicDetails](#getbasicdetails)
14
- * [getIntegrationTokens](#getintegrationtokens)
15
- * [getOrderingStores](#getorderingstores)
16
- * [getStoreDetailById](#getstoredetailbyid)
17
- * [getFeatures](#getfeatures)
18
- * [getContactInfo](#getcontactinfo)
19
- * [getCurrencies](#getcurrencies)
20
- * [getCurrencyById](#getcurrencybyid)
21
- * [getAppCurrencies](#getappcurrencies)
22
- * [getLanguages](#getlanguages)
23
- * [getOrderingStoreCookie](#getorderingstorecookie)
24
- * [removeOrderingStoreCookie](#removeorderingstorecookie)
25
- * [getAppStaffList](#getappstafflist)
26
- * [getAppStaffs](#getappstaffs)
27
-
28
-
29
-
30
- ## Methods with example and description
31
-
32
-
33
-
34
-
35
- ### getApplication
36
- Get current application details
37
-
38
-
39
-
40
- ```javascript
41
- // Promise
42
- const promise = configuration.getApplication();
43
-
44
- // Async/Await
45
- const data = await configuration.getApplication();
46
- ```
47
-
48
-
49
-
50
-
51
-
52
-
53
- Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
54
-
55
- *Returned Response:*
56
-
57
-
58
-
59
-
60
- [Application](#Application)
61
-
62
- Success. Check the example shown below or refer `Application` for more details.
63
-
64
-
65
-
66
-
67
- <details>
68
- <summary><i>&nbsp; Example:</i></summary>
69
-
70
- ```json
71
- {
72
- "website": {
73
- "enabled": true,
74
- "basepath": "/"
75
- },
76
- "cors": {
77
- "domains": []
78
- },
79
- "auth": {
80
- "enabled": false
81
- },
82
- "description": "Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan",
83
- "channel_type": "uniket",
84
- "cache_ttl": -1,
85
- "internal": false,
86
- "is_active": true,
87
- "_id": "000000000000000000000004",
88
- "name": "Uniket B2B",
89
- "owner": "5e71a60dc671daffd81992ea",
90
- "company_id": 1,
91
- "token": "iTNjY_yAI",
92
- "redirections": [],
93
- "meta": [],
94
- "created_at": "2019-12-26T13:22:23.619Z",
95
- "modified_at": "2020-12-02T05:49:41.610Z",
96
- "__v": 29,
97
- "banner": {
98
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"
99
- },
100
- "logo": {
101
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
102
- },
103
- "favicon": {
104
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"
105
- },
106
- "domains": [
107
- {
108
- "verified": true,
109
- "is_primary": true,
110
- "is_shortlink": true,
111
- "_id": "5eb1177748312a3bd55d0f1e",
112
- "name": "uniket.hostx0.de"
113
- },
114
- {
115
- "verified": true,
116
- "is_primary": false,
117
- "is_shortlink": false,
118
- "_id": "5f0858c5f86e00cd42dccc8d",
119
- "name": "jd.hostx0.de"
120
- }
121
- ],
122
- "app_type": "live",
123
- "mobile_logo": {
124
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
125
- },
126
- "domain": {
127
- "verified": true,
128
- "is_primary": true,
129
- "is_shortlink": true,
130
- "_id": "5eb1177748312a3bd55d0f1e",
131
- "name": "uniket.hostx0.de"
132
- },
133
- "id": "000000000000000000000004"
134
- }
135
- ```
136
- </details>
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
- ---
147
-
148
-
149
- ### getOwnerInfo
150
- Get application, owner and seller information
151
-
152
-
153
-
154
- ```javascript
155
- // Promise
156
- const promise = configuration.getOwnerInfo();
157
-
158
- // Async/Await
159
- const data = await configuration.getOwnerInfo();
160
- ```
161
-
162
-
163
-
164
-
165
-
166
-
167
- Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
168
-
169
- *Returned Response:*
170
-
171
-
172
-
173
-
174
- [ApplicationAboutResponse](#ApplicationAboutResponse)
175
-
176
- Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
177
-
178
-
179
-
180
-
181
- <details>
182
- <summary><i>&nbsp; Example:</i></summary>
183
-
184
- ```json
185
- {
186
- "application_info": {
187
- "domains": [
188
- {
189
- "verified": true,
190
- "name": "uniket-testing.addsale.link",
191
- "custom": false,
192
- "is_primary": true
193
- }
194
- ],
195
- "website": {
196
- "enabled": true,
197
- "basepath": "/"
198
- },
199
- "cors": {
200
- "domains": []
201
- },
202
- "description": "R-City Mall,Ghatkoper East,Mumbai",
203
- "is_active": true,
204
- "_id": "5cd3db5e9d692cfe5302a7ba",
205
- "name": "Shivam Clothing Store",
206
- "meta": [
207
- {
208
- "name": "tes",
209
- "value": "test"
210
- }
211
- ],
212
- "token": "xOfcP-aYE",
213
- "secret": "",
214
- "created_at": "2019-05-09T07:48:46.218Z",
215
- "banner": {
216
- "secure_url": "https://res.cloudinary.com/jkvora/image/upload/v1561551809/fqt2djkddoe2yjjlln2h.png"
217
- },
218
- "logo": {
219
- "secure_url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1577513094/addsale/applications/app_5cd3db5e9d692cfe5302a7ba/media/store/logo/ayrkk2uzfknst2ohluzc.png"
220
- },
221
- "id": "5cd3db5e9d692cfe5302a7ba",
222
- "company_info": {
223
- "_id": "5da4274a723af4000188a66c",
224
- "uid": 873,
225
- "created_on": "2019-10-14T07:44:10.391Z",
226
- "is_active": true,
227
- "name": "SAPPER LIFESTYLE PRIVATE LIMITED",
228
- "addresses": [
229
- {
230
- "pincode": 110042,
231
- "address1": "412, SISODIA MOHALLA BADALI VILLAGE",
232
- "city": "NEW DELHI",
233
- "state": "DELHI",
234
- "country": "INDIA",
235
- "address_type": "registered"
236
- },
237
- {
238
- "pincode": 110042,
239
- "address1": "412, SISODIA MOHALLA BADALI VILLAGE",
240
- "city": "NEW DELHI",
241
- "state": "DELHI",
242
- "country": "INDIA",
243
- "address_type": "office"
244
- }
245
- ],
246
- "notification_emails": [
247
- "ecom.sapperlifestyle@f2fretail.com"
248
- ]
249
- },
250
- "owner_info": {
251
- "_id": "5c77921fa1bf7d8695ed57fd",
252
- "emails": [
253
- {
254
- "active": true,
255
- "primary": true,
256
- "verified": true,
257
- "email": "abc@test.com"
258
- },
259
- {
260
- "active": true,
261
- "primary": false,
262
- "verified": true,
263
- "email": "abc@test.com"
264
- },
265
- {
266
- "active": true,
267
- "primary": false,
268
- "verified": true,
269
- "email": "abc@test.com"
270
- }
271
- ],
272
- "phone_numbers": [
273
- {
274
- "active": true,
275
- "primary": true,
276
- "verified": true,
277
- "country_code": 91,
278
- "phone": "9408282323"
279
- }
280
- ],
281
- "first_name": "Jalak",
282
- "last_name": "Vora",
283
- "profile_pic": ""
284
- }
285
- }
286
- }
287
- ```
288
- </details>
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
- ---
299
-
300
-
301
- ### getBasicDetails
302
- Get basic application details
303
-
304
-
305
-
306
- ```javascript
307
- // Promise
308
- const promise = configuration.getBasicDetails();
309
-
310
- // Async/Await
311
- const data = await configuration.getBasicDetails();
312
- ```
313
-
314
-
315
-
316
-
317
-
318
-
319
- Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
320
-
321
- *Returned Response:*
322
-
323
-
324
-
325
-
326
- [ApplicationDetail](#ApplicationDetail)
327
-
328
- Success. Check the example shown below or refer `ApplicationDetail` for more details.
329
-
330
-
331
-
332
-
333
- <details>
334
- <summary><i>&nbsp; Example:</i></summary>
335
-
336
- ```json
337
- {
338
- "name": "Uniket B2B",
339
- "description": "Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan",
340
- "logo": {
341
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
342
- },
343
- "mobile_logo": {
344
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
345
- },
346
- "favicon": {
347
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"
348
- },
349
- "banner": {
350
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"
351
- },
352
- "domain": {
353
- "verified": true,
354
- "is_primary": true,
355
- "is_shortlink": false,
356
- "_id": "5eb1177748312a3bd55d0f1e",
357
- "name": "uniket.hostx0.de"
358
- },
359
- "domains": [
360
- {
361
- "verified": true,
362
- "is_primary": true,
363
- "is_shortlink": false,
364
- "_id": "5eb1177748312a3bd55d0f1e",
365
- "name": "uniket.hostx0.de"
366
- },
367
- {
368
- "verified": true,
369
- "is_primary": false,
370
- "is_shortlink": true,
371
- "_id": "5f0858c5f86e00cd42dccc8d",
372
- "name": "jd.hostx0.de"
373
- }
374
- ],
375
- "company_id": 1,
376
- "_id": "000000000000000000000004"
377
- }
378
- ```
379
- </details>
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
- ---
390
-
391
-
392
- ### getIntegrationTokens
393
- Get integration tokens
394
-
395
-
396
-
397
- ```javascript
398
- // Promise
399
- const promise = configuration.getIntegrationTokens();
400
-
401
- // Async/Await
402
- const data = await configuration.getIntegrationTokens();
403
- ```
404
-
405
-
406
-
407
-
408
-
409
-
410
- Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key.
411
-
412
- *Returned Response:*
413
-
414
-
415
-
416
-
417
- [AppTokenResponse](#AppTokenResponse)
418
-
419
- Success. Check the example shown below or refer `AppTokenResponse` for more details.
420
-
421
-
422
-
423
-
424
- <details>
425
- <summary><i>&nbsp; Example:</i></summary>
426
-
427
- ```json
428
- {
429
- "tokens": {
430
- "firebase": {
431
- "credentials": {
432
- "project_id": "",
433
- "gcm_sender_id": "",
434
- "application_id": "",
435
- "api_key": ""
436
- },
437
- "enabled": false
438
- },
439
- "moengage": {
440
- "credentials": {
441
- "app_id": ""
442
- },
443
- "enabled": false
444
- },
445
- "segment": {
446
- "credentials": {
447
- "write_key": "U2FsdGVkX18E920z+xtaD+GnGWoK/5SNxu61phXf6/o="
448
- },
449
- "enabled": false
450
- },
451
- "gtm": {
452
- "credentials": {
453
- "api_key": ""
454
- },
455
- "enabled": false
456
- },
457
- "freshchat": {
458
- "credentials": {
459
- "app_id": "U2FsdGVkX19+Egjfy8alIB4S+n2IQEXz2X4yxzimxbGzq9M5+iFsvGjrBAyQrDZ/iIXgWQyWOFRHmf9xhFGajQ==",
460
- "app_key": "U2FsdGVkX18OydYSvUBRKJDsLD1KCcwK6+jJVGma4Ck2PVwOv6BW5vyiM2sZ4kEpHbRV38KBPZPqlx3EfZd6mw=="
461
- },
462
- "enabled": true
463
- },
464
- "safetynet": {
465
- "credentials": {
466
- "api_key": "U2FsdGVkX1/Ex0BXvB16B81dwWIfVK8LPwexMMbVC3/nB9Y5n4stcnOMUCDalDs8Z92MecOQKydWg+E17QfZ4Q=="
467
- },
468
- "enabled": true
469
- },
470
- "fynd_rewards": {
471
- "credentials": {
472
- "public_key": "U2FsdGVkX1/C7x0hybxKPpWSMYBEKukQCVjnm7wfW3lrTJPmcr06xvLzVatPQJTKXeXvay0rdvcXuHlp8n/VAX7v9Usobmp1znadnPWt07GOvq5aPK9zDlg05tb+TX8Wx0q2rVonRK0Q6ZyMcn6Oy+Z812TpRAlcU1AmSrDtl/PMjuH1rSRTxKJLD0HzXk9zPl2M6GOKmgzjpHD4ZmtRSfJmm/h+qbZZ4AuD9upTbJzDm/pcp4S4cYu9rSV31JpOtAkrCxZFzCT8seWKa2eU8VdleRltwF5DO1x8Pny/hKNmhrUqxdkevY6lm4aEQjThA/EeBv1UPq52EFDteXLsZ6yBXyNAxcFNuPupour+K8hi0nfgbd/fsFqu5NUBOwz0hsqQh9OsTGt7SdiIyMSQgCttphaqhBbJ926UlG9d/O1W1u+i9rn7pECcH1eyUYlsNbYqghciz9pTrfRdqA8AIa2j7H/3Lxq37arxZCIDlTgl+Kk/8QUTsTefk+seGZsyiDyIkxW+FcmHBZLr3y85ST23szWSnyweV2hQHtPWnCE="
473
- }
474
- },
475
- "auth": {
476
- "google": {
477
- "app_id": "U2FsdGVkX19ZkUS8HAnz17Sbcixaj0N4xDcaxztzAPdkxsc2i56kuEL+hVDv5z47HjiY4jOFN0zd5HbO9vf5/adwr6L8QQVEmz1BEEGEze13a5PgONGZlfQkxeuQLBT9"
478
- },
479
- "facebook": {
480
- "app_id": "U2FsdGVkX1/kPjoWmEvESc276Ect4VZmAFVTkQKKjsxgk6LXWjj73vPrBsnJyPpR"
481
- },
482
- "accountkit": {
483
- "app_id": ""
484
- }
485
- },
486
- "google_map": {
487
- "credentials": {
488
- "api_key": "U2FsdGVkX1+5tBH/3lREPiDwVukCS/Q2ftu/CYD9RdLYK8hGO/XJfrs2zpoGDKCJBhgTDRESItRKR7Lt/w+zeQ=="
489
- }
490
- }
491
- },
492
- "_id": "5e285cb1df7e5b1421d5f840",
493
- "application": "000000000000000000000004",
494
- "created_at": "2020-01-22T14:31:13.192Z",
495
- "modified_at": "2020-05-01T04:14:42.117Z",
496
- "__v": 0
497
- }
498
- ```
499
- </details>
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
- ---
510
-
511
-
512
- ### getOrderingStores
513
- Get deployment stores
514
-
515
-
516
-
517
- ```javascript
518
- // Promise
519
- const promise = configuration.getOrderingStores({ pageNo : value,
520
- pageSize : value,
521
- q : value });
522
-
523
- // Async/Await
524
- const data = await configuration.getOrderingStores({ pageNo : value,
525
- pageSize : value,
526
- q : value });
527
- ```
528
-
529
-
530
-
531
-
532
-
533
- | Argument | Type | Required | Description |
534
- | --------- | ----- | -------- | ----------- |
535
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
536
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
537
- | q | string | no | Store code or name of the ordering store. |
538
-
539
-
540
-
541
- Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
542
-
543
- *Returned Response:*
544
-
545
-
546
-
547
-
548
- [OrderingStores](#OrderingStores)
549
-
550
- Success. Check the example shown below or refer `OrderingStores` for more details.
551
-
552
-
553
-
554
-
555
- <details>
556
- <summary><i>&nbsp; Example:</i></summary>
557
-
558
- ```json
559
-
560
- ```
561
- </details>
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
- ---
572
-
573
-
574
- ### getStoreDetailById
575
- Get ordering store details
576
-
577
-
578
-
579
- ```javascript
580
- // Promise
581
- const promise = configuration.getStoreDetailById({ storeId : value });
582
-
583
- // Async/Await
584
- const data = await configuration.getStoreDetailById({ storeId : value });
585
- ```
586
-
587
-
588
-
589
-
590
-
591
- | Argument | Type | Required | Description |
592
- | --------- | ----- | -------- | ----------- |
593
- | storeId | number | yes | Store uid |
594
-
595
-
596
-
597
- Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
598
-
599
- *Returned Response:*
600
-
601
-
602
-
603
-
604
- [OrderingStore](#OrderingStore)
605
-
606
- Success. Check the example shown below or refer `OrderingStore` for more details.
607
-
608
-
609
-
610
-
611
- <details>
612
- <summary><i>&nbsp; Example:</i></summary>
613
-
614
- ```json
615
- {
616
- "uid": 1060,
617
- "name": "THE MANDHANA PARK KAMLANAGAR DELHI",
618
- "pincode": 110007,
619
- "store_code": "MRVLB22",
620
- "code": "MRVLB22",
621
- "display_name": "Kamla Nagar",
622
- "store_type": "mall"
623
- }
624
- ```
625
- </details>
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
- ---
636
-
637
-
638
- ### getFeatures
639
- Get features of application
640
-
641
-
642
-
643
- ```javascript
644
- // Promise
645
- const promise = configuration.getFeatures();
646
-
647
- // Async/Await
648
- const data = await configuration.getFeatures();
649
- ```
650
-
651
-
652
-
653
-
654
-
655
-
656
- Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more.
657
-
658
- *Returned Response:*
659
-
660
-
661
-
662
-
663
- [AppFeatureResponse](#AppFeatureResponse)
664
-
665
- Success. Check the example shown below or refer `AppFeatureResponse` for more details.
666
-
667
-
668
-
669
-
670
- <details>
671
- <summary><i>&nbsp; Example:</i></summary>
672
-
673
- ```json
674
- {
675
- "feature": {
676
- "product_detail": {
677
- "similar": [
678
- "basic",
679
- "visual",
680
- "brand",
681
- "category",
682
- "seller",
683
- "price",
684
- "specs"
685
- ],
686
- "seller_selection": true,
687
- "update_product_meta": true,
688
- "request_product": true
689
- },
690
- "landing_page": {
691
- "launch_page": {
692
- "page_type": "home",
693
- "params": null,
694
- "query": null
695
- },
696
- "continue_as_guest": true,
697
- "login_btn_text": "Click here to sign-in",
698
- "show_domain_textbox": true,
699
- "show_register_btn": true
700
- },
701
- "registration_page": {
702
- "ask_store_address": false
703
- },
704
- "home_page": {
705
- "order_processing": true
706
- },
707
- "common": {
708
- "communication_optin_dialog": {
709
- "visibility": true
710
- },
711
- "deployment_store_selection": {
712
- "enabled": true,
713
- "type": "hard"
714
- },
715
- "listing_price": {
716
- "value": "min",
717
- "sort": "min"
718
- },
719
- "currency": {
720
- "value": [
721
- "INR"
722
- ],
723
- "type": "explicit",
724
- "default_currency": "INR"
725
- },
726
- "revenue_engine": {
727
- "enabled": false
728
- },
729
- "feedback": {
730
- "enabled": true
731
- },
732
- "compare_products": {
733
- "enabled": true
734
- },
735
- "reward_points": {
736
- "credit": {
737
- "enabled": true
738
- },
739
- "debit": {
740
- "enabled": true,
741
- "auto_apply": false,
742
- "strategy_channel": "REWARDS"
743
- }
744
- }
745
- },
746
- "cart": {
747
- "gst_input": true,
748
- "staff_selection": true,
749
- "placing_for_customer": true,
750
- "google_map": true
751
- },
752
- "qr": {
753
- "application": true,
754
- "products": true,
755
- "collections": true
756
- },
757
- "pcr": {
758
- "staff_selection": true
759
- },
760
- "order": {
761
- "buy_again": true
762
- },
763
- "_id": "5e57643c986e4119c973df7d",
764
- "app": "000000000000000000000004",
765
- "created_at": "2020-02-27T06:39:56.088Z",
766
- "modified_at": "2021-02-02T11:04:14.289Z",
767
- "__v": 1
768
- }
769
- }
770
- ```
771
- </details>
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
- ---
782
-
783
-
784
- ### getContactInfo
785
- Get application information
786
-
787
-
788
-
789
- ```javascript
790
- // Promise
791
- const promise = configuration.getContactInfo();
792
-
793
- // Async/Await
794
- const data = await configuration.getContactInfo();
795
- ```
796
-
797
-
798
-
799
-
800
-
801
-
802
- Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application.
803
-
804
- *Returned Response:*
805
-
806
-
807
-
808
-
809
- [ApplicationInformation](#ApplicationInformation)
810
-
811
- Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
812
-
813
-
814
-
815
-
816
- <details>
817
- <summary><i>&nbsp; Example:</i></summary>
818
-
819
- ```json
820
- {
821
- "value": {
822
- "address": {
823
- "loc": null,
824
- "address_line": [
825
- "Warehouse 5, Near Industrial Complex",
826
- "2nd Lane, Andheri"
827
- ],
828
- "phone": [
829
- {
830
- "code": "+91",
831
- "number": "9988776654"
832
- }
833
- ],
834
- "city": "Mumbai , Maharashtra , India",
835
- "country": "India",
836
- "pincode": 400059
837
- },
838
- "support": {
839
- "phone": [],
840
- "email": [],
841
- "timing": "9 AM to 9 PM"
842
- },
843
- "social_links": {
844
- "facebook": {
845
- "title": "Facebook",
846
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg",
847
- "link": ""
848
- },
849
- "instagram": {
850
- "title": "Instagram",
851
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg",
852
- "link": ""
853
- },
854
- "twitter": {
855
- "title": "Twitter",
856
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg",
857
- "link": ""
858
- },
859
- "pinterest": {
860
- "title": "Pinterest",
861
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg",
862
- "link": ""
863
- },
864
- "google_plus": {
865
- "title": "Google+",
866
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png",
867
- "link": ""
868
- },
869
- "youtube": {
870
- "title": "Youtube",
871
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg",
872
- "link": ""
873
- },
874
- "linked_in": {
875
- "title": "LinkedIn",
876
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg",
877
- "link": ""
878
- },
879
- "vimeo": {
880
- "title": "Vimeo",
881
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/Ttc80b3U78-vimeofooternho4br.svg",
882
- "link": ""
883
- },
884
- "blog_link": {
885
- "title": "Blog",
886
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg",
887
- "link": ""
888
- }
889
- },
890
- "links": [
891
- {
892
- "title": "Shipping",
893
- "link": "www.uniket.store/shipping-details"
894
- },
895
- {
896
- "title": "Returns",
897
- "link": "www.uniket.store/policy/return-policy"
898
- },
899
- {
900
- "title": "Privacy",
901
- "link": "www.uniket.store/policy/privacy-policy"
902
- },
903
- {
904
- "title": "Terms",
905
- "link": "www.uniket.store/policy/terms-conditions"
906
- }
907
- ],
908
- "copyright_text": "#MadeInIndia © 2020 Shopsense Retail Technologies",
909
- "_id": "5e6627bd0732616083e83750",
910
- "business_highlights": [
911
- {
912
- "_id": "5fc901611dfba6c2e87d1ca9",
913
- "title": "100% Genuine Products",
914
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png",
915
- "sub_title": "Directly from brands"
916
- },
917
- {
918
- "_id": "5fc901611dfba64ce57d1caa",
919
- "title": "Credit Facility Available",
920
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png",
921
- "sub_title": "Free 30 Days Credit"
922
- },
923
- {
924
- "_id": "5fc901611dfba64b2e7d1cab",
925
- "title": "Assured Returns",
926
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png",
927
- "sub_title": "For all damaged/wrong items"
928
- }
929
- ],
930
- "application": "000000000000000000000004",
931
- "created_at": "2020-03-09T11:25:49.921Z",
932
- "modified_at": "2020-12-03T15:16:49.087Z",
933
- "__v": 99
934
- }
935
- }
936
- ```
937
- </details>
938
-
939
-
940
-
941
-
942
-
943
-
944
-
945
-
946
-
947
- ---
948
-
949
-
950
- ### getCurrencies
951
- Get all currencies list
952
-
953
-
954
-
955
- ```javascript
956
- // Promise
957
- const promise = configuration.getCurrencies();
958
-
959
- // Async/Await
960
- const data = await configuration.getCurrencies();
961
- ```
962
-
963
-
964
-
965
-
966
-
967
-
968
- Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
969
-
970
- *Returned Response:*
971
-
972
-
973
-
974
-
975
- [CurrenciesResponse](#CurrenciesResponse)
976
-
977
- Success. Check the example shown below or refer `CurrenciesResponse` for more details.
978
-
979
-
980
-
981
-
982
- <details>
983
- <summary><i>&nbsp; Example:</i></summary>
984
-
985
- ```json
986
- {
987
- "items": [
988
- {
989
- "_id": "5ec75d11f7bfb54d798f3516",
990
- "is_active": true,
991
- "name": "United States Dollar",
992
- "code": "USD",
993
- "created_at": "2020-05-22T05:03:13.354Z",
994
- "modified_at": "2020-06-05T09:12:04.248Z",
995
- "decimal_digits": 2,
996
- "symbol": "$"
997
- }
998
- ]
999
- }
1000
- ```
1001
- </details>
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
- ---
1012
-
1013
-
1014
- ### getCurrencyById
1015
- Get currency by its ID
1016
-
1017
-
1018
-
1019
- ```javascript
1020
- // Promise
1021
- const promise = configuration.getCurrencyById({ id : value });
1022
-
1023
- // Async/Await
1024
- const data = await configuration.getCurrencyById({ id : value });
1025
- ```
1026
-
1027
-
1028
-
1029
-
1030
-
1031
- | Argument | Type | Required | Description |
1032
- | --------- | ----- | -------- | ----------- |
1033
- | id | string | yes | Object ID assigned to the currency |
1034
-
1035
-
1036
-
1037
- Use this API to retrieve a currency using its ID.
1038
-
1039
- *Returned Response:*
1040
-
1041
-
1042
-
1043
-
1044
- [Currency](#Currency)
1045
-
1046
- Success. Check the example shown below or refer `Currency` for more details.
1047
-
1048
-
1049
-
1050
-
1051
- <details>
1052
- <summary><i>&nbsp; Example:</i></summary>
1053
-
1054
- ```json
1055
- {
1056
- "_id": "5ec75d11f7bfb501d88f3559",
1057
- "is_active": true,
1058
- "name": "Gold Ounce",
1059
- "code": "XAU",
1060
- "created_at": "2020-05-22T05:03:13.429Z",
1061
- "modified_at": "2020-06-05T09:12:04.248Z",
1062
- "decimal_digits": null,
1063
- "symbol": null
1064
- }
1065
- ```
1066
- </details>
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
- ---
1077
-
1078
-
1079
- ### getAppCurrencies
1080
- Get currencies enabled in the application
1081
-
1082
-
1083
-
1084
- ```javascript
1085
- // Promise
1086
- const promise = configuration.getAppCurrencies();
1087
-
1088
- // Async/Await
1089
- const data = await configuration.getAppCurrencies();
1090
- ```
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
- Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
1098
-
1099
- *Returned Response:*
1100
-
1101
-
1102
-
1103
-
1104
- [AppCurrencyResponse](#AppCurrencyResponse)
1105
-
1106
- Success. Check the example shown below or refer `AppCurrencyResponse` for more details.
1107
-
1108
-
1109
-
1110
-
1111
- <details>
1112
- <summary><i>&nbsp; Example:</i></summary>
1113
-
1114
- ```json
1115
- {
1116
- "application": "000000000000000000000001",
1117
- "default_currency": {
1118
- "ref": "5ecf6122d953d4242c044907",
1119
- "code": "INR"
1120
- },
1121
- "supported_currency": [
1122
- {
1123
- "_id": "5ecf6122d953d4242c044907",
1124
- "is_active": true,
1125
- "name": "Indian Rupee",
1126
- "code": "INR",
1127
- "decimal_digits": 2,
1128
- "symbol": "₹",
1129
- "created_at": "2020-05-28T06:58:42.532Z",
1130
- "modified_at": "2021-04-05T16:44:14.358Z"
1131
- }
1132
- ]
1133
- }
1134
- ```
1135
- </details>
1136
-
1137
-
1138
-
1139
-
1140
-
1141
-
1142
-
1143
-
1144
-
1145
- ---
1146
-
1147
-
1148
- ### getLanguages
1149
- Get list of languages
1150
-
1151
-
1152
-
1153
- ```javascript
1154
- // Promise
1155
- const promise = configuration.getLanguages();
1156
-
1157
- // Async/Await
1158
- const data = await configuration.getLanguages();
1159
- ```
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
- Use this API to get a list of languages supported in the application.
1167
-
1168
- *Returned Response:*
1169
-
1170
-
1171
-
1172
-
1173
- [LanguageResponse](#LanguageResponse)
1174
-
1175
- Success. Check the example shown below or refer `LanguageResponse` for more details.
1176
-
1177
-
1178
-
1179
-
1180
- <details>
1181
- <summary><i>&nbsp; Example:</i></summary>
1182
-
1183
- ```json
1184
- {
1185
- "items": [
1186
- {
1187
- "name": "हिन्दी",
1188
- "code": "hi-IN"
1189
- },
1190
- {
1191
- "name": "English",
1192
- "code": "en-IN"
1193
- },
1194
- {
1195
- "name": "عربى",
1196
- "code": "ar-AE"
1197
- }
1198
- ]
1199
- }
1200
- ```
1201
- </details>
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
- ---
1212
-
1213
-
1214
- ### getOrderingStoreCookie
1215
- Get an Ordering Store signed cookie on selection of ordering store.
1216
-
1217
-
1218
-
1219
- ```javascript
1220
- // Promise
1221
- const promise = configuration.getOrderingStoreCookie({ body : value });
1222
-
1223
- // Async/Await
1224
- const data = await configuration.getOrderingStoreCookie({ body : value });
1225
- ```
1226
-
1227
-
1228
-
1229
-
1230
-
1231
- | Argument | Type | Required | Description |
1232
- | --------- | ----- | -------- | ----------- |
1233
- | body | [OrderingStoreSelectRequest](#OrderingStoreSelectRequest) | yes | Request body |
1234
-
1235
-
1236
- Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart.
1237
-
1238
- *Returned Response:*
1239
-
1240
-
1241
-
1242
-
1243
- [SuccessMessageResponse](#SuccessMessageResponse)
1244
-
1245
- Success
1246
-
1247
-
1248
-
1249
-
1250
- <details>
1251
- <summary><i>&nbsp; Example:</i></summary>
1252
-
1253
- ```json
1254
-
1255
- ```
1256
- </details>
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
- ---
1267
-
1268
-
1269
- ### removeOrderingStoreCookie
1270
- Unset the Ordering Store signed cookie.
1271
-
1272
-
1273
-
1274
- ```javascript
1275
- // Promise
1276
- const promise = configuration.removeOrderingStoreCookie();
1277
-
1278
- // Async/Await
1279
- const data = await configuration.removeOrderingStoreCookie();
1280
- ```
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
- Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
1288
-
1289
- *Returned Response:*
1290
-
1291
-
1292
-
1293
-
1294
- [SuccessMessageResponse](#SuccessMessageResponse)
1295
-
1296
- Success
1297
-
1298
-
1299
-
1300
-
1301
- <details>
1302
- <summary><i>&nbsp; Example:</i></summary>
1303
-
1304
- ```json
1305
-
1306
- ```
1307
- </details>
1308
-
1309
-
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
- ---
1318
-
1319
-
1320
- ### getAppStaffList
1321
- Get a list of staff.
1322
-
1323
-
1324
-
1325
- ```javascript
1326
- // Promise
1327
- const promise = configuration.getAppStaffList({ pageNo : value,
1328
- pageSize : value,
1329
- orderIncent : value,
1330
- orderingStore : value,
1331
- user : value });
1332
-
1333
- // Async/Await
1334
- const data = await configuration.getAppStaffList({ pageNo : value,
1335
- pageSize : value,
1336
- orderIncent : value,
1337
- orderingStore : value,
1338
- user : value });
1339
- ```
1340
-
1341
-
1342
-
1343
-
1344
-
1345
- | Argument | Type | Required | Description |
1346
- | --------- | ----- | -------- | ----------- |
1347
- | pageNo | number | no | |
1348
- | pageSize | number | no | |
1349
- | orderIncent | boolean | no | This is a boolean value. Select `true` to retrieve the staff members eligible for getting incentives on orders. |
1350
- | orderingStore | number | no | ID of the ordering store. Helps in retrieving staff members working at a particular ordering store. |
1351
- | user | string | no | Mongo ID of the staff. Helps in retrieving the details of a particular staff member. |
1352
-
1353
-
1354
-
1355
- Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
1356
-
1357
- *Returned Response:*
1358
-
1359
-
1360
-
1361
-
1362
- [AppStaffListResponse](#AppStaffListResponse)
1363
-
1364
- Success. Check the example shown below or refer `AppStaffListResponse` for more details.
1365
-
1366
-
1367
-
1368
-
1369
- <details>
1370
- <summary><i>&nbsp; Example:</i></summary>
1371
-
1372
- ```json
1373
-
1374
- ```
1375
- </details>
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
- ---
1386
-
1387
-
1388
- ### getAppStaffs
1389
- Get a list of staff.
1390
-
1391
-
1392
-
1393
- ```javascript
1394
- // Promise
1395
- const promise = configuration.getAppStaffs({ orderIncent : value,
1396
- orderingStore : value,
1397
- user : value });
1398
-
1399
- // Async/Await
1400
- const data = await configuration.getAppStaffs({ orderIncent : value,
1401
- orderingStore : value,
1402
- user : value });
1403
- ```
1404
-
1405
-
1406
-
1407
-
1408
-
1409
- | Argument | Type | Required | Description |
1410
- | --------- | ----- | -------- | ----------- |
1411
- | orderIncent | boolean | no | This is a boolean value. Select `true` to retrieve the staff members eligible for getting incentives on orders. |
1412
- | orderingStore | number | no | ID of the ordering store. Helps in retrieving staff members working at a particular ordering store. |
1413
- | user | string | no | Mongo ID of the staff. Helps in retrieving the details of a particular staff member. |
1414
-
1415
-
1416
-
1417
- Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
1418
-
1419
- *Returned Response:*
1420
-
1421
-
1422
-
1423
-
1424
- [AppStaffResponse](#AppStaffResponse)
1425
-
1426
- Success. Check the example shown below or refer `AppStaffResponse` for more details.
1427
-
1428
-
1429
-
1430
-
1431
- <details>
1432
- <summary><i>&nbsp; Example:</i></summary>
1433
-
1434
- ```json
1435
-
1436
- ```
1437
- </details>
1438
-
1439
-
1440
-
1441
-
1442
-
1443
-
1444
-
1445
-
1446
-
1447
- ---
1448
-
1449
-
1450
-
1451
- ### Schemas
1452
-
1453
-
1454
-
1455
- #### [ApplicationAboutResponse](#ApplicationAboutResponse)
1456
-
1457
- | Properties | Type | Nullable | Description |
1458
- | ---------- | ---- | -------- | ----------- |
1459
- | application_info | [ApplicationInfo](#ApplicationInfo) | no | |
1460
- | company_info | [CompanyInfo](#CompanyInfo) | no | |
1461
- | owner_info | [OwnerInfo](#OwnerInfo) | no | |
1462
-
1463
- ---
1464
-
1465
-
1466
-
1467
-
1468
- #### [ApplicationInfo](#ApplicationInfo)
1469
-
1470
- | Properties | Type | Nullable | Description |
1471
- | ---------- | ---- | -------- | ----------- |
1472
- | _id | string | no | |
1473
- | domain | [Domain](#Domain) | no | |
1474
- | website | [ApplicationWebsite](#ApplicationWebsite) | no | |
1475
- | cors | [ApplicationCors](#ApplicationCors) | no | |
1476
- | description | string | no | |
1477
- | name | string | no | |
1478
- | meta | [ApplicationMeta](#ApplicationMeta) | no | |
1479
- | token | string | no | |
1480
- | secret | string | no | |
1481
- | created_at | string | no | |
1482
- | banner | [SecureUrl](#SecureUrl) | no | |
1483
- | logo | [SecureUrl](#SecureUrl) | no | |
1484
- | is_active | boolean | no | |
1485
-
1486
- ---
1487
-
1488
-
1489
-
1490
-
1491
- #### [CompanyInfo](#CompanyInfo)
1492
-
1493
- | Properties | Type | Nullable | Description |
1494
- | ---------- | ---- | -------- | ----------- |
1495
- | _id | string | no | |
1496
- | uid | number | no | |
1497
- | created_on | string | no | |
1498
- | is_active | boolean | no | |
1499
- | name | string | no | |
1500
- | addresses | [[CompanyAboutAddress](#CompanyAboutAddress)] | no | |
1501
- | notification_emails | [string] | no | |
1502
-
1503
- ---
1504
-
1505
-
1506
-
1507
-
1508
- #### [OwnerInfo](#OwnerInfo)
1509
-
1510
- | Properties | Type | Nullable | Description |
1511
- | ---------- | ---- | -------- | ----------- |
1512
- | _id | string | no | |
1513
- | emails | [[UserEmail](#UserEmail)] | no | |
1514
- | phone_numbers | [[UserPhoneNumber](#UserPhoneNumber)] | no | |
1515
- | first_name | string | no | |
1516
- | last_name | string | no | |
1517
- | profile_pic | string | no | |
1518
-
1519
- ---
1520
-
1521
-
1522
-
1523
-
1524
- #### [AppVersionRequest](#AppVersionRequest)
1525
-
1526
- | Properties | Type | Nullable | Description |
1527
- | ---------- | ---- | -------- | ----------- |
1528
- | application | [ApplicationVersionRequest](#ApplicationVersionRequest) | yes | |
1529
- | device | [Device](#Device) | yes | |
1530
- | locale | string | no | |
1531
- | timezone | string | no | |
1532
-
1533
- ---
1534
-
1535
-
1536
-
1537
-
1538
- #### [ApplicationVersionRequest](#ApplicationVersionRequest)
1539
-
1540
- | Properties | Type | Nullable | Description |
1541
- | ---------- | ---- | -------- | ----------- |
1542
- | id | string | no | |
1543
- | name | string | yes | |
1544
- | namespace | string | no | |
1545
- | token | string | no | |
1546
- | version | string | yes | |
1547
-
1548
- ---
1549
-
1550
-
1551
-
1552
-
1553
- #### [Device](#Device)
1554
-
1555
- | Properties | Type | Nullable | Description |
1556
- | ---------- | ---- | -------- | ----------- |
1557
- | build | number | no | |
1558
- | model | string | no | |
1559
- | os | [OS](#OS) | yes | |
1560
-
1561
- ---
1562
-
1563
-
1564
-
1565
-
1566
- #### [OS](#OS)
1567
-
1568
- | Properties | Type | Nullable | Description |
1569
- | ---------- | ---- | -------- | ----------- |
1570
- | name | string | yes | |
1571
- | version | string | no | |
1572
-
1573
- ---
1574
-
1575
-
1576
-
1577
-
1578
- #### [SupportedLanguage](#SupportedLanguage)
1579
-
1580
- | Properties | Type | Nullable | Description |
1581
- | ---------- | ---- | -------- | ----------- |
1582
- | name | string | no | |
1583
- | code | string | no | |
1584
-
1585
- ---
1586
-
1587
-
1588
-
1589
-
1590
- #### [LanguageResponse](#LanguageResponse)
1591
-
1592
- | Properties | Type | Nullable | Description |
1593
- | ---------- | ---- | -------- | ----------- |
1594
- | items | [[SupportedLanguage](#SupportedLanguage)] | no | |
1595
-
1596
- ---
1597
-
1598
-
1599
-
1600
-
1601
- #### [AppStaffResponse](#AppStaffResponse)
1602
-
1603
- | Properties | Type | Nullable | Description |
1604
- | ---------- | ---- | -------- | ----------- |
1605
- | staff_users | [[AppStaff](#AppStaff)] | no | |
1606
-
1607
- ---
1608
-
1609
-
1610
-
1611
-
1612
- #### [AppStaffListResponse](#AppStaffListResponse)
1613
-
1614
- | Properties | Type | Nullable | Description |
1615
- | ---------- | ---- | -------- | ----------- |
1616
- | page | [Page](#Page) | no | |
1617
- | items | [[AppStaff](#AppStaff)] | no | |
1618
-
1619
- ---
1620
-
1621
-
1622
-
1623
-
1624
- #### [UpdateDialog](#UpdateDialog)
1625
-
1626
- | Properties | Type | Nullable | Description |
1627
- | ---------- | ---- | -------- | ----------- |
1628
- | type | string | no | |
1629
- | interval | number | no | |
1630
-
1631
- ---
1632
-
1633
-
1634
-
1635
-
1636
- #### [OrderingStoreSelectRequest](#OrderingStoreSelectRequest)
1637
-
1638
- | Properties | Type | Nullable | Description |
1639
- | ---------- | ---- | -------- | ----------- |
1640
- | ordering_store | [OrderingStoreSelect](#OrderingStoreSelect) | yes | |
1641
-
1642
- ---
1643
-
1644
-
1645
-
1646
-
1647
- #### [OrderingStoreSelect](#OrderingStoreSelect)
1648
-
1649
- | Properties | Type | Nullable | Description |
1650
- | ---------- | ---- | -------- | ----------- |
1651
- | uid | number | yes | store uid |
1652
-
1653
- ---
1654
-
1655
-
1656
-
1657
-
1658
- #### [AppStaff](#AppStaff)
1659
-
1660
- | Properties | Type | Nullable | Description |
1661
- | ---------- | ---- | -------- | ----------- |
1662
- | _id | string | no | |
1663
- | order_incent | boolean | no | |
1664
- | stores | [number] | no | |
1665
- | application | string | no | |
1666
- | title | string | no | |
1667
- | user | string | no | |
1668
- | employee_code | string | no | |
1669
- | first_name | string | no | |
1670
- | last_name | string | no | |
1671
- | profile_pic_url | string | no | |
1672
-
1673
- ---
1674
-
1675
-
1676
-
1677
-
1678
- #### [AppTokenResponse](#AppTokenResponse)
1679
-
1680
- | Properties | Type | Nullable | Description |
1681
- | ---------- | ---- | -------- | ----------- |
1682
- | tokens | [Tokens](#Tokens) | no | |
1683
- | _id | string | no | |
1684
- | application | string | no | |
1685
- | created_at | string | no | |
1686
- | updated_at | string | no | |
1687
- | __v | number | no | |
1688
-
1689
- ---
1690
-
1691
-
1692
-
1693
-
1694
- #### [Tokens](#Tokens)
1695
-
1696
- | Properties | Type | Nullable | Description |
1697
- | ---------- | ---- | -------- | ----------- |
1698
- | firebase | [Firebase](#Firebase) | no | |
1699
- | moengage | [Moengage](#Moengage) | no | |
1700
- | segment | [Segment](#Segment) | no | |
1701
- | gtm | [Gtm](#Gtm) | no | |
1702
- | freshchat | [Freshchat](#Freshchat) | no | |
1703
- | safetynet | [Safetynet](#Safetynet) | no | |
1704
- | fynd_rewards | [FyndRewards](#FyndRewards) | no | |
1705
- | google_map | [GoogleMap](#GoogleMap) | no | |
1706
-
1707
- ---
1708
-
1709
-
1710
-
1711
-
1712
- #### [Firebase](#Firebase)
1713
-
1714
- | Properties | Type | Nullable | Description |
1715
- | ---------- | ---- | -------- | ----------- |
1716
- | credentials | [Credentials](#Credentials) | no | |
1717
- | enabled | boolean | no | |
1718
-
1719
- ---
1720
-
1721
-
1722
-
1723
-
1724
- #### [Credentials](#Credentials)
1725
-
1726
- | Properties | Type | Nullable | Description |
1727
- | ---------- | ---- | -------- | ----------- |
1728
- | ios | [Ios](#Ios) | no | |
1729
- | android | [Android](#Android) | no | |
1730
- | project_id | string | no | |
1731
- | gcm_sender_id | string | no | |
1732
- | application_id | string | no | |
1733
- | api_key | string | no | |
1734
-
1735
- ---
1736
-
1737
-
1738
-
1739
-
1740
- #### [Ios](#Ios)
1741
-
1742
- | Properties | Type | Nullable | Description |
1743
- | ---------- | ---- | -------- | ----------- |
1744
- | application_id | string | no | |
1745
- | api_key | string | no | |
1746
-
1747
- ---
1748
-
1749
-
1750
-
1751
-
1752
- #### [Android](#Android)
1753
-
1754
- | Properties | Type | Nullable | Description |
1755
- | ---------- | ---- | -------- | ----------- |
1756
- | application_id | string | no | |
1757
- | api_key | string | no | |
1758
-
1759
- ---
1760
-
1761
-
1762
-
1763
-
1764
- #### [Moengage](#Moengage)
1765
-
1766
- | Properties | Type | Nullable | Description |
1767
- | ---------- | ---- | -------- | ----------- |
1768
- | credentials | [MoengageCredentials](#MoengageCredentials) | no | |
1769
- | enabled | boolean | no | |
1770
-
1771
- ---
1772
-
1773
-
1774
-
1775
-
1776
- #### [MoengageCredentials](#MoengageCredentials)
1777
-
1778
- | Properties | Type | Nullable | Description |
1779
- | ---------- | ---- | -------- | ----------- |
1780
- | app_id | string | no | |
1781
-
1782
- ---
1783
-
1784
-
1785
-
1786
-
1787
- #### [Segment](#Segment)
1788
-
1789
- | Properties | Type | Nullable | Description |
1790
- | ---------- | ---- | -------- | ----------- |
1791
- | credentials | [SegmentCredentials](#SegmentCredentials) | no | |
1792
- | enabled | boolean | no | |
1793
-
1794
- ---
1795
-
1796
-
1797
-
1798
-
1799
- #### [SegmentCredentials](#SegmentCredentials)
1800
-
1801
- | Properties | Type | Nullable | Description |
1802
- | ---------- | ---- | -------- | ----------- |
1803
- | write_key | string | no | |
1804
-
1805
- ---
1806
-
1807
-
1808
-
1809
-
1810
- #### [Gtm](#Gtm)
1811
-
1812
- | Properties | Type | Nullable | Description |
1813
- | ---------- | ---- | -------- | ----------- |
1814
- | credentials | [GtmCredentials](#GtmCredentials) | no | |
1815
- | enabled | boolean | no | |
1816
-
1817
- ---
1818
-
1819
-
1820
-
1821
-
1822
- #### [GtmCredentials](#GtmCredentials)
1823
-
1824
- | Properties | Type | Nullable | Description |
1825
- | ---------- | ---- | -------- | ----------- |
1826
- | api_key | string | no | |
1827
-
1828
- ---
1829
-
1830
-
1831
-
1832
-
1833
- #### [Freshchat](#Freshchat)
1834
-
1835
- | Properties | Type | Nullable | Description |
1836
- | ---------- | ---- | -------- | ----------- |
1837
- | credentials | [FreshchatCredentials](#FreshchatCredentials) | no | |
1838
- | enabled | boolean | no | |
1839
-
1840
- ---
1841
-
1842
-
1843
-
1844
-
1845
- #### [FreshchatCredentials](#FreshchatCredentials)
1846
-
1847
- | Properties | Type | Nullable | Description |
1848
- | ---------- | ---- | -------- | ----------- |
1849
- | app_id | string | no | |
1850
- | app_key | string | no | |
1851
- | web_token | string | no | |
1852
-
1853
- ---
1854
-
1855
-
1856
-
1857
-
1858
- #### [Safetynet](#Safetynet)
1859
-
1860
- | Properties | Type | Nullable | Description |
1861
- | ---------- | ---- | -------- | ----------- |
1862
- | credentials | [SafetynetCredentials](#SafetynetCredentials) | no | |
1863
- | enabled | boolean | no | |
1864
-
1865
- ---
1866
-
1867
-
1868
-
1869
-
1870
- #### [SafetynetCredentials](#SafetynetCredentials)
1871
-
1872
- | Properties | Type | Nullable | Description |
1873
- | ---------- | ---- | -------- | ----------- |
1874
- | api_key | string | no | |
1875
-
1876
- ---
1877
-
1878
-
1879
-
1880
-
1881
- #### [FyndRewards](#FyndRewards)
1882
-
1883
- | Properties | Type | Nullable | Description |
1884
- | ---------- | ---- | -------- | ----------- |
1885
- | credentials | [FyndRewardsCredentials](#FyndRewardsCredentials) | no | |
1886
-
1887
- ---
1888
-
1889
-
1890
-
1891
-
1892
- #### [FyndRewardsCredentials](#FyndRewardsCredentials)
1893
-
1894
- | Properties | Type | Nullable | Description |
1895
- | ---------- | ---- | -------- | ----------- |
1896
- | public_key | string | no | |
1897
-
1898
- ---
1899
-
1900
-
1901
-
1902
-
1903
- #### [GoogleMap](#GoogleMap)
1904
-
1905
- | Properties | Type | Nullable | Description |
1906
- | ---------- | ---- | -------- | ----------- |
1907
- | credentials | [GoogleMapCredentials](#GoogleMapCredentials) | no | |
1908
-
1909
- ---
1910
-
1911
-
1912
-
1913
-
1914
- #### [GoogleMapCredentials](#GoogleMapCredentials)
1915
-
1916
- | Properties | Type | Nullable | Description |
1917
- | ---------- | ---- | -------- | ----------- |
1918
- | api_key | string | no | |
1919
-
1920
- ---
1921
-
1922
-
1923
-
1924
-
1925
- #### [RewardPointsConfig](#RewardPointsConfig)
1926
-
1927
- | Properties | Type | Nullable | Description |
1928
- | ---------- | ---- | -------- | ----------- |
1929
- | credit | [Credit](#Credit) | no | |
1930
- | debit | [Debit](#Debit) | no | |
1931
-
1932
- ---
1933
-
1934
-
1935
-
1936
-
1937
- #### [Credit](#Credit)
1938
-
1939
- | Properties | Type | Nullable | Description |
1940
- | ---------- | ---- | -------- | ----------- |
1941
- | enabled | boolean | no | |
1942
-
1943
- ---
1944
-
1945
-
1946
-
1947
-
1948
- #### [Debit](#Debit)
1949
-
1950
- | Properties | Type | Nullable | Description |
1951
- | ---------- | ---- | -------- | ----------- |
1952
- | enabled | boolean | no | |
1953
- | auto_apply | boolean | no | |
1954
- | strategy_channel | string | no | |
1955
-
1956
- ---
1957
-
1958
-
1959
-
1960
-
1961
- #### [ProductDetailFeature](#ProductDetailFeature)
1962
-
1963
- | Properties | Type | Nullable | Description |
1964
- | ---------- | ---- | -------- | ----------- |
1965
- | similar | [string] | no | |
1966
- | seller_selection | boolean | no | |
1967
- | update_product_meta | boolean | no | |
1968
- | request_product | boolean | no | |
1969
-
1970
- ---
1971
-
1972
-
1973
-
1974
-
1975
- #### [LaunchPage](#LaunchPage)
1976
-
1977
- | Properties | Type | Nullable | Description |
1978
- | ---------- | ---- | -------- | ----------- |
1979
- | page_type | string | no | |
1980
- | params | string | no | |
1981
- | query | string | no | |
1982
-
1983
- ---
1984
-
1985
-
1986
-
1987
-
1988
- #### [LandingPageFeature](#LandingPageFeature)
1989
-
1990
- | Properties | Type | Nullable | Description |
1991
- | ---------- | ---- | -------- | ----------- |
1992
- | launch_page | [LaunchPage](#LaunchPage) | no | |
1993
- | continue_as_guest | boolean | no | |
1994
- | login_btn_text | string | no | |
1995
- | show_domain_textbox | boolean | no | |
1996
- | show_register_btn | boolean | no | |
1997
-
1998
- ---
1999
-
2000
-
2001
-
2002
-
2003
- #### [RegistrationPageFeature](#RegistrationPageFeature)
2004
-
2005
- | Properties | Type | Nullable | Description |
2006
- | ---------- | ---- | -------- | ----------- |
2007
- | ask_store_address | boolean | no | |
2008
-
2009
- ---
2010
-
2011
-
2012
-
2013
-
2014
- #### [AppFeature](#AppFeature)
2015
-
2016
- | Properties | Type | Nullable | Description |
2017
- | ---------- | ---- | -------- | ----------- |
2018
- | product_detail | [ProductDetailFeature](#ProductDetailFeature) | no | |
2019
- | landing_page | [LandingPageFeature](#LandingPageFeature) | no | |
2020
- | registration_page | [RegistrationPageFeature](#RegistrationPageFeature) | no | |
2021
- | home_page | [HomePageFeature](#HomePageFeature) | no | |
2022
- | common | [CommonFeature](#CommonFeature) | no | |
2023
- | cart | [CartFeature](#CartFeature) | no | |
2024
- | qr | [QrFeature](#QrFeature) | no | |
2025
- | pcr | [PcrFeature](#PcrFeature) | no | |
2026
- | order | [OrderFeature](#OrderFeature) | no | |
2027
- | _id | string | no | |
2028
- | app | string | no | |
2029
- | created_at | string | no | |
2030
- | updated_at | string | no | |
2031
- | __v | number | no | |
2032
-
2033
- ---
2034
-
2035
-
2036
-
2037
-
2038
- #### [HomePageFeature](#HomePageFeature)
2039
-
2040
- | Properties | Type | Nullable | Description |
2041
- | ---------- | ---- | -------- | ----------- |
2042
- | order_processing | boolean | no | |
2043
-
2044
- ---
2045
-
2046
-
2047
-
2048
-
2049
- #### [CommonFeature](#CommonFeature)
2050
-
2051
- | Properties | Type | Nullable | Description |
2052
- | ---------- | ---- | -------- | ----------- |
2053
- | communication_optin_dialog | [CommunicationOptinDialogFeature](#CommunicationOptinDialogFeature) | no | |
2054
- | deployment_store_selection | [DeploymentStoreSelectionFeature](#DeploymentStoreSelectionFeature) | no | |
2055
- | listing_price | [ListingPriceFeature](#ListingPriceFeature) | no | |
2056
- | currency | [CurrencyFeature](#CurrencyFeature) | no | |
2057
- | revenue_engine | [RevenueEngineFeature](#RevenueEngineFeature) | no | |
2058
- | feedback | [FeedbackFeature](#FeedbackFeature) | no | |
2059
- | compare_products | [CompareProductsFeature](#CompareProductsFeature) | no | |
2060
- | reward_points | [RewardPointsConfig](#RewardPointsConfig) | no | |
2061
-
2062
- ---
2063
-
2064
-
2065
-
2066
-
2067
- #### [CommunicationOptinDialogFeature](#CommunicationOptinDialogFeature)
2068
-
2069
- | Properties | Type | Nullable | Description |
2070
- | ---------- | ---- | -------- | ----------- |
2071
- | visibility | boolean | no | |
2072
-
2073
- ---
2074
-
2075
-
2076
-
2077
-
2078
- #### [DeploymentStoreSelectionFeature](#DeploymentStoreSelectionFeature)
2079
-
2080
- | Properties | Type | Nullable | Description |
2081
- | ---------- | ---- | -------- | ----------- |
2082
- | enabled | boolean | no | |
2083
- | type | string | no | |
2084
-
2085
- ---
2086
-
2087
-
2088
-
2089
-
2090
- #### [ListingPriceFeature](#ListingPriceFeature)
2091
-
2092
- | Properties | Type | Nullable | Description |
2093
- | ---------- | ---- | -------- | ----------- |
2094
- | value | string | no | |
2095
-
2096
- ---
2097
-
2098
-
2099
-
2100
-
2101
- #### [CurrencyFeature](#CurrencyFeature)
2102
-
2103
- | Properties | Type | Nullable | Description |
2104
- | ---------- | ---- | -------- | ----------- |
2105
- | value | [string] | no | |
2106
- | type | string | no | |
2107
- | default_currency | string | no | |
2108
-
2109
- ---
2110
-
2111
-
2112
-
2113
-
2114
- #### [RevenueEngineFeature](#RevenueEngineFeature)
2115
-
2116
- | Properties | Type | Nullable | Description |
2117
- | ---------- | ---- | -------- | ----------- |
2118
- | enabled | boolean | no | |
2119
-
2120
- ---
2121
-
2122
-
2123
-
2124
-
2125
- #### [FeedbackFeature](#FeedbackFeature)
2126
-
2127
- | Properties | Type | Nullable | Description |
2128
- | ---------- | ---- | -------- | ----------- |
2129
- | enabled | boolean | no | |
2130
-
2131
- ---
2132
-
2133
-
2134
-
2135
-
2136
- #### [CompareProductsFeature](#CompareProductsFeature)
2137
-
2138
- | Properties | Type | Nullable | Description |
2139
- | ---------- | ---- | -------- | ----------- |
2140
- | enabled | boolean | no | |
2141
-
2142
- ---
2143
-
2144
-
2145
-
2146
-
2147
- #### [CartFeature](#CartFeature)
2148
-
2149
- | Properties | Type | Nullable | Description |
2150
- | ---------- | ---- | -------- | ----------- |
2151
- | gst_input | boolean | no | |
2152
- | staff_selection | boolean | no | |
2153
- | placing_for_customer | boolean | no | |
2154
- | google_map | boolean | no | |
2155
- | revenue_engine_coupon | boolean | no | |
2156
-
2157
- ---
2158
-
2159
-
2160
-
2161
-
2162
- #### [QrFeature](#QrFeature)
2163
-
2164
- | Properties | Type | Nullable | Description |
2165
- | ---------- | ---- | -------- | ----------- |
2166
- | application | boolean | no | |
2167
- | products | boolean | no | |
2168
- | collections | boolean | no | |
2169
-
2170
- ---
2171
-
2172
-
2173
-
2174
-
2175
- #### [PcrFeature](#PcrFeature)
2176
-
2177
- | Properties | Type | Nullable | Description |
2178
- | ---------- | ---- | -------- | ----------- |
2179
- | staff_selection | boolean | no | |
2180
-
2181
- ---
2182
-
2183
-
2184
-
2185
-
2186
- #### [OrderFeature](#OrderFeature)
2187
-
2188
- | Properties | Type | Nullable | Description |
2189
- | ---------- | ---- | -------- | ----------- |
2190
- | buy_again | boolean | no | |
2191
-
2192
- ---
2193
-
2194
-
2195
-
2196
-
2197
- #### [AppFeatureRequest](#AppFeatureRequest)
2198
-
2199
- | Properties | Type | Nullable | Description |
2200
- | ---------- | ---- | -------- | ----------- |
2201
- | feature | [AppFeature](#AppFeature) | no | |
2202
-
2203
- ---
2204
-
2205
-
2206
-
2207
-
2208
- #### [AppFeatureResponse](#AppFeatureResponse)
2209
-
2210
- | Properties | Type | Nullable | Description |
2211
- | ---------- | ---- | -------- | ----------- |
2212
- | feature | [AppFeature](#AppFeature) | no | |
2213
-
2214
- ---
2215
-
2216
-
2217
-
2218
-
2219
- #### [Currency](#Currency)
2220
-
2221
- | Properties | Type | Nullable | Description |
2222
- | ---------- | ---- | -------- | ----------- |
2223
- | _id | string | no | |
2224
- | is_active | boolean | no | |
2225
- | name | string | no | |
2226
- | code | string | no | |
2227
- | created_at | string | no | |
2228
- | updated_at | string | no | |
2229
- | decimal_digits | number | no | |
2230
- | symbol | string | no | |
2231
-
2232
- ---
2233
-
2234
-
2235
-
2236
-
2237
- #### [Domain](#Domain)
2238
-
2239
- | Properties | Type | Nullable | Description |
2240
- | ---------- | ---- | -------- | ----------- |
2241
- | verified | boolean | no | |
2242
- | is_primary | boolean | no | |
2243
- | is_shortlink | boolean | no | |
2244
- | _id | string | no | |
2245
- | name | string | no | |
2246
- | is_predefined | boolean | no | Domain is hosting domain or not. |
2247
-
2248
- ---
2249
-
2250
-
2251
-
2252
-
2253
- #### [ApplicationWebsite](#ApplicationWebsite)
2254
-
2255
- | Properties | Type | Nullable | Description |
2256
- | ---------- | ---- | -------- | ----------- |
2257
- | enabled | boolean | no | |
2258
- | basepath | string | no | |
2259
-
2260
- ---
2261
-
2262
-
2263
-
2264
-
2265
- #### [ApplicationCors](#ApplicationCors)
2266
-
2267
- | Properties | Type | Nullable | Description |
2268
- | ---------- | ---- | -------- | ----------- |
2269
- | domains | [string] | no | |
2270
-
2271
- ---
2272
-
2273
-
2274
-
2275
-
2276
- #### [ApplicationAuth](#ApplicationAuth)
2277
-
2278
- | Properties | Type | Nullable | Description |
2279
- | ---------- | ---- | -------- | ----------- |
2280
- | enabled | boolean | no | |
2281
-
2282
- ---
2283
-
2284
-
2285
-
2286
-
2287
- #### [ApplicationRedirections](#ApplicationRedirections)
2288
-
2289
- | Properties | Type | Nullable | Description |
2290
- | ---------- | ---- | -------- | ----------- |
2291
- | redirect_from | string | no | |
2292
- | redirect_to | string | no | |
2293
- | type | string | no | |
2294
-
2295
- ---
2296
-
2297
-
2298
-
2299
-
2300
- #### [ApplicationMeta](#ApplicationMeta)
2301
-
2302
- | Properties | Type | Nullable | Description |
2303
- | ---------- | ---- | -------- | ----------- |
2304
- | name | string | no | |
2305
- | value | string | no | |
2306
-
2307
- ---
2308
-
2309
-
2310
-
2311
-
2312
- #### [SecureUrl](#SecureUrl)
2313
-
2314
- | Properties | Type | Nullable | Description |
2315
- | ---------- | ---- | -------- | ----------- |
2316
- | secure_url | string | no | |
2317
-
2318
- ---
2319
-
2320
-
2321
-
2322
-
2323
- #### [Application](#Application)
2324
-
2325
- | Properties | Type | Nullable | Description |
2326
- | ---------- | ---- | -------- | ----------- |
2327
- | website | [ApplicationWebsite](#ApplicationWebsite) | no | |
2328
- | cors | [ApplicationCors](#ApplicationCors) | no | |
2329
- | auth | [ApplicationAuth](#ApplicationAuth) | no | |
2330
- | description | string | no | |
2331
- | channel_type | string | no | |
2332
- | cache_ttl | number | no | |
2333
- | is_internal | boolean | no | |
2334
- | is_active | boolean | no | |
2335
- | _id | string | no | |
2336
- | name | string | no | |
2337
- | owner | string | no | |
2338
- | company_id | number | no | |
2339
- | token | string | no | |
2340
- | redirections | [[ApplicationRedirections](#ApplicationRedirections)] | no | |
2341
- | meta | [[ApplicationMeta](#ApplicationMeta)] | no | |
2342
- | created_at | string | no | |
2343
- | updated_at | string | no | |
2344
- | __v | number | no | |
2345
- | banner | [SecureUrl](#SecureUrl) | no | |
2346
- | logo | [SecureUrl](#SecureUrl) | no | |
2347
- | favicon | [SecureUrl](#SecureUrl) | no | |
2348
- | domains | [[Domain](#Domain)] | no | |
2349
- | app_type | string | no | |
2350
- | mobile_logo | [SecureUrl](#SecureUrl) | no | |
2351
- | domain | [Domain](#Domain) | no | |
2352
-
2353
- ---
2354
-
2355
-
2356
-
2357
-
2358
- #### [NotFound](#NotFound)
2359
-
2360
- | Properties | Type | Nullable | Description |
2361
- | ---------- | ---- | -------- | ----------- |
2362
- | message | string | no | |
2363
-
2364
- ---
2365
-
2366
-
2367
-
2368
-
2369
- #### [UnhandledError](#UnhandledError)
2370
-
2371
- | Properties | Type | Nullable | Description |
2372
- | ---------- | ---- | -------- | ----------- |
2373
- | message | string | no | |
2374
-
2375
- ---
2376
-
2377
-
2378
-
2379
-
2380
- #### [InvalidPayloadRequest](#InvalidPayloadRequest)
2381
-
2382
- | Properties | Type | Nullable | Description |
2383
- | ---------- | ---- | -------- | ----------- |
2384
- | message | string | no | |
2385
-
2386
- ---
2387
-
2388
-
2389
-
2390
-
2391
- #### [SuccessMessageResponse](#SuccessMessageResponse)
2392
-
2393
- | Properties | Type | Nullable | Description |
2394
- | ---------- | ---- | -------- | ----------- |
2395
- | message | string | no | |
2396
-
2397
- ---
2398
-
2399
-
2400
-
2401
-
2402
- #### [InventoryBrandRule](#InventoryBrandRule)
2403
-
2404
- | Properties | Type | Nullable | Description |
2405
- | ---------- | ---- | -------- | ----------- |
2406
- | criteria | string | no | Whether enable all or explicitly few brands as inventory |
2407
- | brands | [number] | no | Brand uids in case of explicit criteria |
2408
-
2409
- ---
2410
-
2411
-
2412
-
2413
-
2414
- #### [StoreCriteriaRule](#StoreCriteriaRule)
2415
-
2416
- | Properties | Type | Nullable | Description |
2417
- | ---------- | ---- | -------- | ----------- |
2418
- | companies | [number] | no | list of company uids |
2419
- | brands | [number] | no | list of brand uids |
2420
-
2421
- ---
2422
-
2423
-
2424
-
2425
-
2426
- #### [InventoryStoreRule](#InventoryStoreRule)
2427
-
2428
- | Properties | Type | Nullable | Description |
2429
- | ---------- | ---- | -------- | ----------- |
2430
- | criteria | string | no | Whether enable all or explicitly few stores or use filter of brands and company as inventory stores |
2431
- | rules | [[StoreCriteriaRule](#StoreCriteriaRule)] | no | List of rules with company and brands uids. Used when critera is `filter` |
2432
- | stores | [number] | no | List of store uids. Used when critera is `explicit` |
2433
-
2434
- ---
2435
-
2436
-
2437
-
2438
-
2439
- #### [InventoryPaymentConfig](#InventoryPaymentConfig)
2440
-
2441
- | Properties | Type | Nullable | Description |
2442
- | ---------- | ---- | -------- | ----------- |
2443
- | mode_of_payment | string | no | |
2444
- | source | string | no | |
2445
-
2446
- ---
2447
-
2448
-
2449
-
2450
-
2451
- #### [StorePriorityRule](#StorePriorityRule)
2452
-
2453
- | Properties | Type | Nullable | Description |
2454
- | ---------- | ---- | -------- | ----------- |
2455
- | enabled | boolean | no | |
2456
- | storetype_order | [string] | no | |
2457
-
2458
- ---
2459
-
2460
-
2461
-
2462
-
2463
- #### [ArticleAssignmentRule](#ArticleAssignmentRule)
2464
-
2465
- | Properties | Type | Nullable | Description |
2466
- | ---------- | ---- | -------- | ----------- |
2467
- | store_priority | [StorePriorityRule](#StorePriorityRule) | no | |
2468
-
2469
- ---
2470
-
2471
-
2472
-
2473
-
2474
- #### [InventoryArticleAssignment](#InventoryArticleAssignment)
2475
-
2476
- | Properties | Type | Nullable | Description |
2477
- | ---------- | ---- | -------- | ----------- |
2478
- | post_order_reassignment | boolean | no | |
2479
- | rules | [ArticleAssignmentRule](#ArticleAssignmentRule) | no | |
2480
-
2481
- ---
2482
-
2483
-
2484
-
2485
-
2486
- #### [CompanyAboutAddress](#CompanyAboutAddress)
2487
-
2488
- | Properties | Type | Nullable | Description |
2489
- | ---------- | ---- | -------- | ----------- |
2490
- | pincode | number | no | |
2491
- | address1 | string | no | |
2492
- | address2 | string | no | |
2493
- | city | string | no | |
2494
- | state | string | no | |
2495
- | country | string | no | |
2496
- | address_type | string | no | |
2497
-
2498
- ---
2499
-
2500
-
2501
-
2502
-
2503
- #### [UserEmail](#UserEmail)
2504
-
2505
- | Properties | Type | Nullable | Description |
2506
- | ---------- | ---- | -------- | ----------- |
2507
- | active | boolean | no | |
2508
- | primary | boolean | no | |
2509
- | verified | boolean | no | |
2510
- | email | string | no | |
2511
-
2512
- ---
2513
-
2514
-
2515
-
2516
-
2517
- #### [UserPhoneNumber](#UserPhoneNumber)
2518
-
2519
- | Properties | Type | Nullable | Description |
2520
- | ---------- | ---- | -------- | ----------- |
2521
- | active | boolean | no | |
2522
- | primary | boolean | no | |
2523
- | verified | boolean | no | |
2524
- | country_code | number | no | |
2525
- | phone | string | no | |
2526
-
2527
- ---
2528
-
2529
-
2530
-
2531
-
2532
- #### [Page](#Page)
2533
-
2534
- | Properties | Type | Nullable | Description |
2535
- | ---------- | ---- | -------- | ----------- |
2536
- | type | string | yes | |
2537
- | size | number | no | |
2538
- | current | number | no | |
2539
- | has_next | boolean | no | |
2540
- | item_total | number | no | |
2541
- | next_id | string | no | |
2542
- | has_previous | boolean | no | |
2543
-
2544
- ---
2545
-
2546
-
2547
-
2548
-
2549
- #### [ApplicationInformation](#ApplicationInformation)
2550
-
2551
- | Properties | Type | Nullable | Description |
2552
- | ---------- | ---- | -------- | ----------- |
2553
- | address | [InformationAddress](#InformationAddress) | no | |
2554
- | support | [InformationSupport](#InformationSupport) | no | |
2555
- | social_links | [SocialLinks](#SocialLinks) | no | |
2556
- | links | [Links](#Links) | no | |
2557
- | copyright_text | string | no | |
2558
- | _id | string | no | |
2559
- | business_highlights | [BusinessHighlights](#BusinessHighlights) | no | |
2560
- | application | string | no | |
2561
- | created_at | string | no | |
2562
- | updated_at | string | no | |
2563
- | __v | number | no | |
2564
-
2565
- ---
2566
-
2567
-
2568
-
2569
-
2570
- #### [InformationAddress](#InformationAddress)
2571
-
2572
- | Properties | Type | Nullable | Description |
2573
- | ---------- | ---- | -------- | ----------- |
2574
- | loc | string | no | |
2575
- | address_line | [string] | no | |
2576
- | phone | [InformationPhone](#InformationPhone) | no | |
2577
- | city | string | no | |
2578
- | country | string | no | |
2579
- | pincode | number | no | |
2580
-
2581
- ---
2582
-
2583
-
2584
-
2585
-
2586
- #### [InformationPhone](#InformationPhone)
2587
-
2588
- | Properties | Type | Nullable | Description |
2589
- | ---------- | ---- | -------- | ----------- |
2590
- | code | string | no | |
2591
- | number | string | no | |
2592
-
2593
- ---
2594
-
2595
-
2596
-
2597
-
2598
- #### [InformationSupport](#InformationSupport)
2599
-
2600
- | Properties | Type | Nullable | Description |
2601
- | ---------- | ---- | -------- | ----------- |
2602
- | phone | [string] | no | |
2603
- | email | [string] | no | |
2604
- | timing | string | no | |
2605
-
2606
- ---
2607
-
2608
-
2609
-
2610
-
2611
- #### [SocialLinks](#SocialLinks)
2612
-
2613
- | Properties | Type | Nullable | Description |
2614
- | ---------- | ---- | -------- | ----------- |
2615
- | facebook | [FacebookLink](#FacebookLink) | no | |
2616
- | instagram | [InstagramLink](#InstagramLink) | no | |
2617
- | twitter | [TwitterLink](#TwitterLink) | no | |
2618
- | pinterest | [PinterestLink](#PinterestLink) | no | |
2619
- | google_plus | [GooglePlusLink](#GooglePlusLink) | no | |
2620
- | youtube | [YoutubeLink](#YoutubeLink) | no | |
2621
- | linked_in | [LinkedInLink](#LinkedInLink) | no | |
2622
- | vimeo | [VimeoLink](#VimeoLink) | no | |
2623
- | blog_link | [BlogLink](#BlogLink) | no | |
2624
-
2625
- ---
2626
-
2627
-
2628
-
2629
-
2630
- #### [FacebookLink](#FacebookLink)
2631
-
2632
- | Properties | Type | Nullable | Description |
2633
- | ---------- | ---- | -------- | ----------- |
2634
- | title | string | no | |
2635
- | icon | string | no | |
2636
- | link | string | no | |
2637
-
2638
- ---
2639
-
2640
-
2641
-
2642
-
2643
- #### [InstagramLink](#InstagramLink)
2644
-
2645
- | Properties | Type | Nullable | Description |
2646
- | ---------- | ---- | -------- | ----------- |
2647
- | title | string | no | |
2648
- | icon | string | no | |
2649
- | link | string | no | |
2650
-
2651
- ---
2652
-
2653
-
2654
-
2655
-
2656
- #### [TwitterLink](#TwitterLink)
2657
-
2658
- | Properties | Type | Nullable | Description |
2659
- | ---------- | ---- | -------- | ----------- |
2660
- | title | string | no | |
2661
- | icon | string | no | |
2662
- | link | string | no | |
2663
-
2664
- ---
2665
-
2666
-
2667
-
2668
-
2669
- #### [PinterestLink](#PinterestLink)
2670
-
2671
- | Properties | Type | Nullable | Description |
2672
- | ---------- | ---- | -------- | ----------- |
2673
- | title | string | no | |
2674
- | icon | string | no | |
2675
- | link | string | no | |
2676
-
2677
- ---
2678
-
2679
-
2680
-
2681
-
2682
- #### [GooglePlusLink](#GooglePlusLink)
2683
-
2684
- | Properties | Type | Nullable | Description |
2685
- | ---------- | ---- | -------- | ----------- |
2686
- | title | string | no | |
2687
- | icon | string | no | |
2688
- | link | string | no | |
2689
-
2690
- ---
2691
-
2692
-
2693
-
2694
-
2695
- #### [YoutubeLink](#YoutubeLink)
2696
-
2697
- | Properties | Type | Nullable | Description |
2698
- | ---------- | ---- | -------- | ----------- |
2699
- | title | string | no | |
2700
- | icon | string | no | |
2701
- | link | string | no | |
2702
-
2703
- ---
2704
-
2705
-
2706
-
2707
-
2708
- #### [LinkedInLink](#LinkedInLink)
2709
-
2710
- | Properties | Type | Nullable | Description |
2711
- | ---------- | ---- | -------- | ----------- |
2712
- | title | string | no | |
2713
- | icon | string | no | |
2714
- | link | string | no | |
2715
-
2716
- ---
2717
-
2718
-
2719
-
2720
-
2721
- #### [VimeoLink](#VimeoLink)
2722
-
2723
- | Properties | Type | Nullable | Description |
2724
- | ---------- | ---- | -------- | ----------- |
2725
- | title | string | no | |
2726
- | icon | string | no | |
2727
- | link | string | no | |
2728
-
2729
- ---
2730
-
2731
-
2732
-
2733
-
2734
- #### [BlogLink](#BlogLink)
2735
-
2736
- | Properties | Type | Nullable | Description |
2737
- | ---------- | ---- | -------- | ----------- |
2738
- | title | string | no | |
2739
- | icon | string | no | |
2740
- | link | string | no | |
2741
-
2742
- ---
2743
-
2744
-
2745
-
2746
-
2747
- #### [Links](#Links)
2748
-
2749
- | Properties | Type | Nullable | Description |
2750
- | ---------- | ---- | -------- | ----------- |
2751
- | title | string | no | |
2752
- | link | string | no | |
2753
-
2754
- ---
2755
-
2756
-
2757
-
2758
-
2759
- #### [BusinessHighlights](#BusinessHighlights)
2760
-
2761
- | Properties | Type | Nullable | Description |
2762
- | ---------- | ---- | -------- | ----------- |
2763
- | _id | string | no | |
2764
- | title | string | no | |
2765
- | icon | string | no | |
2766
- | sub_title | string | no | |
2767
-
2768
- ---
2769
-
2770
-
2771
-
2772
-
2773
- #### [ApplicationDetail](#ApplicationDetail)
2774
-
2775
- | Properties | Type | Nullable | Description |
2776
- | ---------- | ---- | -------- | ----------- |
2777
- | name | string | yes | |
2778
- | description | string | yes | |
2779
- | logo | [SecureUrl](#SecureUrl) | yes | |
2780
- | mobile_logo | [SecureUrl](#SecureUrl) | yes | |
2781
- | favicon | [SecureUrl](#SecureUrl) | yes | |
2782
- | banner | [SecureUrl](#SecureUrl) | yes | |
2783
- | domain | [Domain](#Domain) | no | |
2784
- | domains | [[Domain](#Domain)] | no | |
2785
- | _id | string | no | |
2786
-
2787
- ---
2788
-
2789
-
2790
-
2791
-
2792
- #### [CurrenciesResponse](#CurrenciesResponse)
2793
-
2794
- | Properties | Type | Nullable | Description |
2795
- | ---------- | ---- | -------- | ----------- |
2796
- | items | [[Currency](#Currency)] | no | |
2797
-
2798
- ---
2799
-
2800
-
2801
-
2802
-
2803
- #### [DefaultCurrency](#DefaultCurrency)
2804
-
2805
- | Properties | Type | Nullable | Description |
2806
- | ---------- | ---- | -------- | ----------- |
2807
- | ref | string | no | |
2808
- | code | string | no | |
2809
-
2810
- ---
2811
-
2812
-
2813
-
2814
-
2815
- #### [AppCurrencyResponse](#AppCurrencyResponse)
2816
-
2817
- | Properties | Type | Nullable | Description |
2818
- | ---------- | ---- | -------- | ----------- |
2819
- | application | string | no | |
2820
- | default_currency | [DefaultCurrency](#DefaultCurrency) | no | |
2821
- | supported_currency | [[Currency](#Currency)] | no | |
2822
-
2823
- ---
2824
-
2825
-
2826
-
2827
-
2828
- #### [StoreLatLong](#StoreLatLong)
2829
-
2830
- | Properties | Type | Nullable | Description |
2831
- | ---------- | ---- | -------- | ----------- |
2832
- | type | string | no | |
2833
- | coordinates | [number] | no | |
2834
-
2835
- ---
2836
-
2837
-
2838
-
2839
-
2840
- #### [OptedStoreAddress](#OptedStoreAddress)
2841
-
2842
- | Properties | Type | Nullable | Description |
2843
- | ---------- | ---- | -------- | ----------- |
2844
- | state | string | no | |
2845
- | address1 | string | no | |
2846
- | lat_long | [StoreLatLong](#StoreLatLong) | no | |
2847
- | address2 | string | no | |
2848
- | pincode | number | no | |
2849
- | country | string | no | |
2850
- | city | string | no | |
2851
-
2852
- ---
2853
-
2854
-
2855
-
2856
-
2857
- #### [OrderingStore](#OrderingStore)
2858
-
2859
- | Properties | Type | Nullable | Description |
2860
- | ---------- | ---- | -------- | ----------- |
2861
- | address | [OptedStoreAddress](#OptedStoreAddress) | no | |
2862
- | _id | string | no | |
2863
- | uid | number | no | |
2864
- | name | string | no | |
2865
- | display_name | string | no | |
2866
- | store_type | string | no | |
2867
- | store_code | string | no | |
2868
- | pincode | number | no | |
2869
- | code | string | no | |
2870
-
2871
- ---
2872
-
2873
-
2874
-
2875
-
2876
- #### [OrderingStores](#OrderingStores)
2877
-
2878
- | Properties | Type | Nullable | Description |
2879
- | ---------- | ---- | -------- | ----------- |
2880
- | page | [Page](#Page) | no | |
2881
- | items | [[OrderingStore](#OrderingStore)] | no | |
2882
- | deployed_stores | [number] | no | |
2883
- | all_stores | boolean | no | |
2884
- | enabled | boolean | no | |
2885
- | type | string | no | |
2886
- | _id | string | no | |
2887
- | app | string | no | |
2888
- | __v | number | no | |
2889
-
2890
- ---
2891
-
2892
-
2893
-
2894
-
2895
- #### [OrderingStoresResponse](#OrderingStoresResponse)
2896
-
2897
- | Properties | Type | Nullable | Description |
2898
- | ---------- | ---- | -------- | ----------- |
2899
- | page | [Page](#Page) | no | |
2900
- | items | [[OrderingStore](#OrderingStore)] | no | |
2901
-
2902
- ---
2903
-
2904
-
2905
-
2906
-