@gofynd/fdk-client-javascript 0.1.35

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