@gofynd/fdk-client-javascript 1.0.3 → 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 (175) 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.js +29 -28
  12. package/sdk/application/Cart/CartApplicationModel.js +3 -1
  13. package/sdk/application/Catalog/CatalogApplicationClient.js +43 -42
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +1 -1
  15. package/sdk/application/Common/CommonApplicationClient.js +5 -4
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -5
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +21 -20
  18. package/sdk/application/Content/ContentApplicationClient.js +26 -25
  19. package/sdk/application/Content/ContentApplicationModel.js +1 -0
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -5
  21. package/sdk/application/Lead/LeadApplicationClient.js +10 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -3
  23. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -12
  24. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -1
  25. package/sdk/application/Order/OrderApplicationClient.js +15 -14
  26. package/sdk/application/Order/OrderApplicationModel.js +9 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.js +42 -41
  28. package/sdk/application/PosCart/PosCartApplicationClient.js +30 -29
  29. package/sdk/application/PosCart/PosCartApplicationModel.js +3 -1
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +11 -10
  31. package/sdk/application/Share/ShareApplicationClient.js +10 -9
  32. package/sdk/application/Theme/ThemeApplicationClient.js +7 -6
  33. package/sdk/application/User/UserApplicationClient.js +38 -37
  34. package/sdk/common/AxiosHelper.js +17 -6
  35. package/sdk/constructUrl.d.ts +5 -0
  36. package/sdk/constructUrl.js +13 -0
  37. package/sdk/index.d.ts +3 -0
  38. package/sdk/index.js +5 -0
  39. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -1
  40. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  41. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  42. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  43. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -2
  44. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +1 -0
  45. package/sdk/platform/Billing/BillingPlatformClient.js +3 -2
  46. package/sdk/platform/Billing/BillingPlatformValidator.js +1 -0
  47. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +27 -0
  48. package/sdk/platform/Cart/CartPlatformApplicationClient.js +177 -1
  49. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +3 -0
  50. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +17 -1
  51. package/sdk/platform/Cart/CartPlatformModel.js +7 -3
  52. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +3 -1
  53. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -1
  54. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  55. package/sdk/platform/Catalog/CatalogPlatformClient.js +6 -9
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +7 -7
  57. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -1
  58. package/sdk/platform/Common/CommonPlatformClient.js +7 -18
  59. package/sdk/platform/Common/CommonPlatformValidator.js +1 -0
  60. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3 -1
  61. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -1
  62. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  63. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +5 -4
  65. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +1 -0
  66. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -1
  67. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
  68. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +9 -8
  69. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +1 -0
  70. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  71. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3 -62
  72. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +0 -1
  73. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +1 -7
  74. package/sdk/platform/Content/ContentPlatformModel.js +1 -0
  75. package/sdk/platform/Discount/DiscountPlatformClient.js +3 -2
  76. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -0
  77. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -3
  78. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +27 -5
  79. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  80. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -3
  81. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -6
  82. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +1 -0
  83. package/sdk/platform/Inventory/InventoryPlatformClient.js +3 -2
  84. package/sdk/platform/Inventory/InventoryPlatformValidator.js +1 -0
  85. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +3 -1
  86. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Lead/LeadPlatformClient.js +4 -3
  88. package/sdk/platform/Lead/LeadPlatformValidator.js +1 -0
  89. package/sdk/platform/Order/OrderPlatformApplicationClient.js +3 -1
  90. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -1
  91. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  92. package/sdk/platform/Order/OrderPlatformClient.js +16 -3
  93. package/sdk/platform/Order/OrderPlatformModel.js +1 -0
  94. package/sdk/platform/Order/OrderPlatformValidator.js +1 -0
  95. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  96. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  97. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  98. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +14 -14
  99. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +1 -1
  100. package/sdk/platform/Payment/PaymentPlatformClient.js +3 -2
  101. package/sdk/platform/Payment/PaymentPlatformValidator.js +1 -0
  102. package/sdk/platform/PlatformClient.d.ts +13 -9
  103. package/sdk/platform/PlatformClient.js +13 -9
  104. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +4 -4
  105. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +36 -17
  106. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +1 -1
  107. package/sdk/platform/Share/SharePlatformApplicationClient.js +3 -1
  108. package/sdk/platform/Share/SharePlatformApplicationValidator.js +1 -1
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +3 -1
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +1 -1
  111. package/sdk/platform/User/UserPlatformApplicationClient.js +3 -1
  112. package/sdk/platform/User/UserPlatformApplicationValidator.js +1 -1
  113. package/sdk/platform/Webhook/WebhookPlatformClient.js +3 -2
  114. package/sdk/platform/Webhook/WebhookPlatformValidator.js +1 -0
  115. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -0
  116. package/sdk/public/Inventory/InventoryPublicClient.js +2 -0
  117. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  118. package/.github/workflows/on_create_release.yml +0 -23
  119. package/.github/workflows/on_merge_main.yml +0 -38
  120. package/.github/workflows/on_pull_request.yml +0 -35
  121. package/.prettierrc +0 -5
  122. package/documentation/application/CART.md +0 -8771
  123. package/documentation/application/CATALOG.md +0 -8690
  124. package/documentation/application/COMMON.md +0 -325
  125. package/documentation/application/COMMUNICATION.md +0 -387
  126. package/documentation/application/CONFIGURATION.md +0 -2212
  127. package/documentation/application/CONTENT.md +0 -2629
  128. package/documentation/application/FILESTORAGE.md +0 -442
  129. package/documentation/application/LEAD.md +0 -1549
  130. package/documentation/application/LOGISTIC.md +0 -689
  131. package/documentation/application/ORDER.md +0 -2937
  132. package/documentation/application/PAYMENT.md +0 -4475
  133. package/documentation/application/POSCART.md +0 -9375
  134. package/documentation/application/README.md +0 -21
  135. package/documentation/application/REWARDS.md +0 -554
  136. package/documentation/application/SHARE.md +0 -635
  137. package/documentation/application/THEME.md +0 -5517
  138. package/documentation/application/USER.md +0 -3798
  139. package/documentation/platform/ANALYTICS.md +0 -1012
  140. package/documentation/platform/AUDITTRAIL.md +0 -493
  141. package/documentation/platform/BILLING.md +0 -1889
  142. package/documentation/platform/CART.md +0 -4711
  143. package/documentation/platform/CATALOG.md +0 -20522
  144. package/documentation/platform/COMMON.md +0 -325
  145. package/documentation/platform/COMMUNICATION.md +0 -4970
  146. package/documentation/platform/COMPANYPROFILE.md +0 -1646
  147. package/documentation/platform/CONFIGURATION.md +0 -6316
  148. package/documentation/platform/CONTENT.md +0 -8364
  149. package/documentation/platform/DISCOUNT.md +0 -767
  150. package/documentation/platform/FILESTORAGE.md +0 -945
  151. package/documentation/platform/INVENTORY.md +0 -1136
  152. package/documentation/platform/LEAD.md +0 -4394
  153. package/documentation/platform/ORDER.md +0 -6525
  154. package/documentation/platform/PARTNER.md +0 -193
  155. package/documentation/platform/PAYMENT.md +0 -3138
  156. package/documentation/platform/README.md +0 -27
  157. package/documentation/platform/REWARDS.md +0 -919
  158. package/documentation/platform/SHARE.md +0 -513
  159. package/documentation/platform/THEME.md +0 -35446
  160. package/documentation/platform/USER.md +0 -2174
  161. package/documentation/platform/WEBHOOK.md +0 -485
  162. package/documentation/public/CONFIGURATION.md +0 -325
  163. package/documentation/public/INVENTORY.md +0 -508
  164. package/documentation/public/WEBHOOK.md +0 -246
  165. package/jest.config.d.ts +0 -4
  166. package/jest.config.js +0 -6
  167. package/tests/application/catalog.spec.js +0 -54
  168. package/tests/common/action-url.spec.js +0 -35
  169. package/tests/common/schema/action-url.json +0 -178
  170. package/tests/common/schema/url-action.json +0 -683
  171. package/tests/common/url-action.spec.js +0 -48
  172. package/tests/helpers/cookie.helper.js +0 -31
  173. package/tests/helpers/oauth.helper.js +0 -43
  174. package/tests/platform/catalog.spec.js +0 -49
  175. package/tests/public/location.spec.js +0 -39
@@ -1,2212 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Application docs](./README.md)
7
-
8
- ## Configuration Methods
9
- Application configuration apis
10
-
11
- * [getAppCurrencies](#getappcurrencies)
12
- * [getAppStaffList](#getappstafflist)
13
- * [getAppStaffs](#getappstaffs)
14
- * [getApplication](#getapplication)
15
- * [getBasicDetails](#getbasicdetails)
16
- * [getContactInfo](#getcontactinfo)
17
- * [getCurrencies](#getcurrencies)
18
- * [getCurrencyById](#getcurrencybyid)
19
- * [getFeatures](#getfeatures)
20
- * [getIntegrationTokens](#getintegrationtokens)
21
- * [getLanguages](#getlanguages)
22
- * [getOrderingStoreCookie](#getorderingstorecookie)
23
- * [getOrderingStores](#getorderingstores)
24
- * [getOwnerInfo](#getownerinfo)
25
- * [getStoreDetailById](#getstoredetailbyid)
26
- * [removeOrderingStoreCookie](#removeorderingstorecookie)
27
-
28
-
29
-
30
- ## Methods with example and description
31
-
32
-
33
-
34
-
35
- ### getAppCurrencies
36
- Get currencies enabled in the application
37
-
38
-
39
-
40
- ```javascript
41
- // Promise
42
- const promise = configuration.getAppCurrencies();
43
-
44
- // Async/Await
45
- const data = await configuration.getAppCurrencies();
46
- ```
47
-
48
-
49
-
50
-
51
-
52
-
53
- 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.
54
-
55
- *Returned Response:*
56
-
57
-
58
-
59
-
60
- [AppCurrencyResponse](#AppCurrencyResponse)
61
-
62
- Success. Check the example shown below or refer `AppCurrencyResponse` for more details.
63
-
64
-
65
-
66
-
67
- <details>
68
- <summary><i>&nbsp; Example:</i></summary>
69
-
70
- ```json
71
- {
72
- "application": "000000000000000000000001",
73
- "default_currency": {
74
- "ref": "5ecf6122d953d4242c044907",
75
- "code": "INR"
76
- },
77
- "supported_currency": [
78
- {
79
- "_id": "5ecf6122d953d4242c044907",
80
- "is_active": true,
81
- "name": "Indian Rupee",
82
- "code": "INR",
83
- "decimal_digits": 2,
84
- "symbol": "₹",
85
- "created_at": "2020-05-28T06:58:42.532Z",
86
- "modified_at": "2021-04-05T16:44:14.358Z"
87
- }
88
- ]
89
- }
90
- ```
91
- </details>
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
- ---
102
-
103
-
104
- ### getAppStaffList
105
- Get a list of staff.
106
-
107
-
108
-
109
- ```javascript
110
- // Promise
111
- const promise = configuration.getAppStaffList({ pageNo : value,
112
- pageSize : value,
113
- orderIncent : value,
114
- orderingStore : value,
115
- user : value });
116
-
117
- // Async/Await
118
- const data = await configuration.getAppStaffList({ pageNo : value,
119
- pageSize : value,
120
- orderIncent : value,
121
- orderingStore : value,
122
- user : value });
123
- ```
124
-
125
-
126
-
127
-
128
-
129
- | Argument | Type | Required | Description |
130
- | --------- | ----- | -------- | ----------- |
131
- | pageNo | number | no | |
132
- | pageSize | number | no | |
133
- | orderIncent | boolean | no | This is a boolean value. Select `true` to retrieve the staff members eligible for getting incentives on orders. |
134
- | orderingStore | number | no | ID of the ordering store. Helps in retrieving staff members working at a particular ordering store. |
135
- | user | string | no | Mongo ID of the staff. Helps in retrieving the details of a particular staff member. |
136
-
137
-
138
-
139
- 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.
140
-
141
- *Returned Response:*
142
-
143
-
144
-
145
-
146
- [AppStaffListResponse](#AppStaffListResponse)
147
-
148
- Success. Check the example shown below or refer `AppStaffListResponse` for more details.
149
-
150
-
151
-
152
-
153
- <details>
154
- <summary><i>&nbsp; Example:</i></summary>
155
-
156
- ```json
157
-
158
- ```
159
- </details>
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
- ---
170
-
171
-
172
- ### getAppStaffs
173
- Get a list of staff.
174
-
175
-
176
-
177
- ```javascript
178
- // Promise
179
- const promise = configuration.getAppStaffs({ orderIncent : value,
180
- orderingStore : value,
181
- user : value });
182
-
183
- // Async/Await
184
- const data = await configuration.getAppStaffs({ orderIncent : value,
185
- orderingStore : value,
186
- user : value });
187
- ```
188
-
189
-
190
-
191
-
192
-
193
- | Argument | Type | Required | Description |
194
- | --------- | ----- | -------- | ----------- |
195
- | orderIncent | boolean | no | This is a boolean value. Select `true` to retrieve the staff members eligible for getting incentives on orders. |
196
- | orderingStore | number | no | ID of the ordering store. Helps in retrieving staff members working at a particular ordering store. |
197
- | user | string | no | Mongo ID of the staff. Helps in retrieving the details of a particular staff member. |
198
-
199
-
200
-
201
- 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.
202
-
203
- *Returned Response:*
204
-
205
-
206
-
207
-
208
- [AppStaffResponse](#AppStaffResponse)
209
-
210
- Success. Check the example shown below or refer `AppStaffResponse` for more details.
211
-
212
-
213
-
214
-
215
- <details>
216
- <summary><i>&nbsp; Example:</i></summary>
217
-
218
- ```json
219
-
220
- ```
221
- </details>
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
- ---
232
-
233
-
234
- ### getApplication
235
- Get current application details
236
-
237
-
238
-
239
- ```javascript
240
- // Promise
241
- const promise = configuration.getApplication();
242
-
243
- // Async/Await
244
- const data = await configuration.getApplication();
245
- ```
246
-
247
-
248
-
249
-
250
-
251
-
252
- Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
253
-
254
- *Returned Response:*
255
-
256
-
257
-
258
-
259
- [Application](#Application)
260
-
261
- Success. Check the example shown below or refer `Application` for more details.
262
-
263
-
264
-
265
-
266
- <details>
267
- <summary><i>&nbsp; Example:</i></summary>
268
-
269
- ```json
270
- {
271
- "website": {
272
- "enabled": true,
273
- "basepath": "/"
274
- },
275
- "cors": {
276
- "domains": []
277
- },
278
- "auth": {
279
- "enabled": false
280
- },
281
- "description": "Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan",
282
- "channel_type": "uniket",
283
- "cache_ttl": -1,
284
- "internal": false,
285
- "is_active": true,
286
- "_id": "000000000000000000000004",
287
- "name": "Uniket B2B",
288
- "owner": "5e71a60dc671daffd81992ea",
289
- "company_id": 1,
290
- "token": "iTNjY_yAI",
291
- "redirections": [],
292
- "meta": [],
293
- "created_at": "2019-12-26T13:22:23.619Z",
294
- "modified_at": "2020-12-02T05:49:41.610Z",
295
- "__v": 29,
296
- "banner": {
297
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"
298
- },
299
- "logo": {
300
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
301
- },
302
- "favicon": {
303
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"
304
- },
305
- "domains": [
306
- {
307
- "verified": true,
308
- "is_primary": true,
309
- "is_shortlink": true,
310
- "_id": "5eb1177748312a3bd55d0f1e",
311
- "name": "uniket.hostx0.de"
312
- },
313
- {
314
- "verified": true,
315
- "is_primary": false,
316
- "is_shortlink": false,
317
- "_id": "5f0858c5f86e00cd42dccc8d",
318
- "name": "jd.hostx0.de"
319
- }
320
- ],
321
- "app_type": "live",
322
- "mobile_logo": {
323
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
324
- },
325
- "domain": {
326
- "verified": true,
327
- "is_primary": true,
328
- "is_shortlink": true,
329
- "_id": "5eb1177748312a3bd55d0f1e",
330
- "name": "uniket.hostx0.de"
331
- },
332
- "id": "000000000000000000000004"
333
- }
334
- ```
335
- </details>
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
- ---
346
-
347
-
348
- ### getBasicDetails
349
- Get basic application details
350
-
351
-
352
-
353
- ```javascript
354
- // Promise
355
- const promise = configuration.getBasicDetails();
356
-
357
- // Async/Await
358
- const data = await configuration.getBasicDetails();
359
- ```
360
-
361
-
362
-
363
-
364
-
365
-
366
- Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
367
-
368
- *Returned Response:*
369
-
370
-
371
-
372
-
373
- [ApplicationDetail](#ApplicationDetail)
374
-
375
- Success. Check the example shown below or refer `ApplicationDetail` for more details.
376
-
377
-
378
-
379
-
380
- <details>
381
- <summary><i>&nbsp; Example:</i></summary>
382
-
383
- ```json
384
- {
385
- "name": "Uniket B2B",
386
- "description": "Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan",
387
- "logo": {
388
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
389
- },
390
- "mobile_logo": {
391
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"
392
- },
393
- "favicon": {
394
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"
395
- },
396
- "banner": {
397
- "secure_url": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"
398
- },
399
- "domain": {
400
- "verified": true,
401
- "is_primary": true,
402
- "is_shortlink": false,
403
- "_id": "5eb1177748312a3bd55d0f1e",
404
- "name": "uniket.hostx0.de"
405
- },
406
- "domains": [
407
- {
408
- "verified": true,
409
- "is_primary": true,
410
- "is_shortlink": false,
411
- "_id": "5eb1177748312a3bd55d0f1e",
412
- "name": "uniket.hostx0.de"
413
- },
414
- {
415
- "verified": true,
416
- "is_primary": false,
417
- "is_shortlink": true,
418
- "_id": "5f0858c5f86e00cd42dccc8d",
419
- "name": "jd.hostx0.de"
420
- }
421
- ],
422
- "company_id": 1,
423
- "_id": "000000000000000000000004"
424
- }
425
- ```
426
- </details>
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
- ---
437
-
438
-
439
- ### getContactInfo
440
- Get application information
441
-
442
-
443
-
444
- ```javascript
445
- // Promise
446
- const promise = configuration.getContactInfo();
447
-
448
- // Async/Await
449
- const data = await configuration.getContactInfo();
450
- ```
451
-
452
-
453
-
454
-
455
-
456
-
457
- Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application.
458
-
459
- *Returned Response:*
460
-
461
-
462
-
463
-
464
- [ApplicationInformation](#ApplicationInformation)
465
-
466
- Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
467
-
468
-
469
-
470
-
471
- <details>
472
- <summary><i>&nbsp; Example:</i></summary>
473
-
474
- ```json
475
- {
476
- "value": {
477
- "address": {
478
- "loc": null,
479
- "address_line": [
480
- "Warehouse 5, Near Industrial Complex",
481
- "2nd Lane, Andheri"
482
- ],
483
- "phone": [
484
- {
485
- "code": "+91",
486
- "number": "9988776654"
487
- }
488
- ],
489
- "city": "Mumbai , Maharashtra , India",
490
- "country": "India",
491
- "pincode": 400059
492
- },
493
- "support": {
494
- "phone": [],
495
- "email": [],
496
- "timing": "9 AM to 9 PM"
497
- },
498
- "social_links": {
499
- "facebook": {
500
- "title": "Facebook",
501
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg",
502
- "link": ""
503
- },
504
- "instagram": {
505
- "title": "Instagram",
506
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg",
507
- "link": ""
508
- },
509
- "twitter": {
510
- "title": "Twitter",
511
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg",
512
- "link": ""
513
- },
514
- "pinterest": {
515
- "title": "Pinterest",
516
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg",
517
- "link": ""
518
- },
519
- "google_plus": {
520
- "title": "Google+",
521
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png",
522
- "link": ""
523
- },
524
- "youtube": {
525
- "title": "Youtube",
526
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg",
527
- "link": ""
528
- },
529
- "linked_in": {
530
- "title": "LinkedIn",
531
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg",
532
- "link": ""
533
- },
534
- "vimeo": {
535
- "title": "Vimeo",
536
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/Ttc80b3U78-vimeofooternho4br.svg",
537
- "link": ""
538
- },
539
- "blog_link": {
540
- "title": "Blog",
541
- "icon": "https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg",
542
- "link": ""
543
- }
544
- },
545
- "links": [
546
- {
547
- "title": "Shipping",
548
- "link": "www.uniket.store/shipping-details"
549
- },
550
- {
551
- "title": "Returns",
552
- "link": "www.uniket.store/policy/return-policy"
553
- },
554
- {
555
- "title": "Privacy",
556
- "link": "www.uniket.store/policy/privacy-policy"
557
- },
558
- {
559
- "title": "Terms",
560
- "link": "www.uniket.store/policy/terms-conditions"
561
- }
562
- ],
563
- "copyright_text": "#MadeInIndia © 2020 Shopsense Retail Technologies",
564
- "_id": "5e6627bd0732616083e83750",
565
- "business_highlights": [
566
- {
567
- "_id": "5fc901611dfba6c2e87d1ca9",
568
- "title": "100% Genuine Products",
569
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png",
570
- "sub_title": "Directly from brands"
571
- },
572
- {
573
- "_id": "5fc901611dfba64ce57d1caa",
574
- "title": "Credit Facility Available",
575
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png",
576
- "sub_title": "Free 30 Days Credit"
577
- },
578
- {
579
- "_id": "5fc901611dfba64b2e7d1cab",
580
- "title": "Assured Returns",
581
- "icon": "https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png",
582
- "sub_title": "For all damaged/wrong items"
583
- }
584
- ],
585
- "application": "000000000000000000000004",
586
- "created_at": "2020-03-09T11:25:49.921Z",
587
- "modified_at": "2020-12-03T15:16:49.087Z",
588
- "__v": 99
589
- }
590
- }
591
- ```
592
- </details>
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
- ---
603
-
604
-
605
- ### getCurrencies
606
- Get all currencies list
607
-
608
-
609
-
610
- ```javascript
611
- // Promise
612
- const promise = configuration.getCurrencies();
613
-
614
- // Async/Await
615
- const data = await configuration.getCurrencies();
616
- ```
617
-
618
-
619
-
620
-
621
-
622
-
623
- Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
624
-
625
- *Returned Response:*
626
-
627
-
628
-
629
-
630
- [CurrenciesResponse](#CurrenciesResponse)
631
-
632
- Success. Check the example shown below or refer `CurrenciesResponse` for more details.
633
-
634
-
635
-
636
-
637
- <details>
638
- <summary><i>&nbsp; Example:</i></summary>
639
-
640
- ```json
641
- {
642
- "items": [
643
- {
644
- "_id": "5ec75d11f7bfb54d798f3516",
645
- "is_active": true,
646
- "name": "United States Dollar",
647
- "code": "USD",
648
- "created_at": "2020-05-22T05:03:13.354Z",
649
- "modified_at": "2020-06-05T09:12:04.248Z",
650
- "decimal_digits": 2,
651
- "symbol": "$"
652
- }
653
- ]
654
- }
655
- ```
656
- </details>
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
- ---
667
-
668
-
669
- ### getCurrencyById
670
- Get currency by its ID
671
-
672
-
673
-
674
- ```javascript
675
- // Promise
676
- const promise = configuration.getCurrencyById({ id : value });
677
-
678
- // Async/Await
679
- const data = await configuration.getCurrencyById({ id : value });
680
- ```
681
-
682
-
683
-
684
-
685
-
686
- | Argument | Type | Required | Description |
687
- | --------- | ----- | -------- | ----------- |
688
- | id | string | yes | Object ID assigned to the currency |
689
-
690
-
691
-
692
- Use this API to retrieve a currency using its ID.
693
-
694
- *Returned Response:*
695
-
696
-
697
-
698
-
699
- [Currency](#Currency)
700
-
701
- Success. Check the example shown below or refer `Currency` for more details.
702
-
703
-
704
-
705
-
706
- <details>
707
- <summary><i>&nbsp; Example:</i></summary>
708
-
709
- ```json
710
- {
711
- "_id": "5ec75d11f7bfb501d88f3559",
712
- "is_active": true,
713
- "name": "Gold Ounce",
714
- "code": "XAU",
715
- "created_at": "2020-05-22T05:03:13.429Z",
716
- "modified_at": "2020-06-05T09:12:04.248Z",
717
- "decimal_digits": null,
718
- "symbol": null
719
- }
720
- ```
721
- </details>
722
-
723
-
724
-
725
-
726
-
727
-
728
-
729
-
730
-
731
- ---
732
-
733
-
734
- ### getFeatures
735
- Get features of application
736
-
737
-
738
-
739
- ```javascript
740
- // Promise
741
- const promise = configuration.getFeatures();
742
-
743
- // Async/Await
744
- const data = await configuration.getFeatures();
745
- ```
746
-
747
-
748
-
749
-
750
-
751
-
752
- 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.
753
-
754
- *Returned Response:*
755
-
756
-
757
-
758
-
759
- [AppFeatureResponse](#AppFeatureResponse)
760
-
761
- Success. Check the example shown below or refer `AppFeatureResponse` for more details.
762
-
763
-
764
-
765
-
766
- <details>
767
- <summary><i>&nbsp; Example:</i></summary>
768
-
769
- ```json
770
- {
771
- "feature": {
772
- "product_detail": {
773
- "similar": [
774
- "basic",
775
- "visual",
776
- "brand",
777
- "category",
778
- "seller",
779
- "price",
780
- "specs"
781
- ],
782
- "seller_selection": true,
783
- "update_product_meta": true,
784
- "request_product": true
785
- },
786
- "landing_page": {
787
- "launch_page": {
788
- "page_type": "home",
789
- "params": null,
790
- "query": null
791
- },
792
- "continue_as_guest": true,
793
- "login_btn_text": "Click here to sign-in",
794
- "show_domain_textbox": true,
795
- "show_register_btn": true
796
- },
797
- "registration_page": {
798
- "ask_store_address": false
799
- },
800
- "home_page": {
801
- "order_processing": true
802
- },
803
- "common": {
804
- "communication_optin_dialog": {
805
- "visibility": true
806
- },
807
- "deployment_store_selection": {
808
- "enabled": true,
809
- "type": "hard"
810
- },
811
- "listing_price": {
812
- "value": "min",
813
- "sort": "min"
814
- },
815
- "currency": {
816
- "value": [
817
- "INR"
818
- ],
819
- "type": "explicit",
820
- "default_currency": "INR"
821
- },
822
- "revenue_engine": {
823
- "enabled": false
824
- },
825
- "feedback": {
826
- "enabled": true
827
- },
828
- "compare_products": {
829
- "enabled": true
830
- },
831
- "reward_points": {
832
- "credit": {
833
- "enabled": true
834
- },
835
- "debit": {
836
- "enabled": true,
837
- "auto_apply": false,
838
- "strategy_channel": "REWARDS"
839
- }
840
- }
841
- },
842
- "cart": {
843
- "gst_input": true,
844
- "staff_selection": true,
845
- "placing_for_customer": true,
846
- "google_map": true
847
- },
848
- "qr": {
849
- "application": true,
850
- "products": true,
851
- "collections": true
852
- },
853
- "pcr": {
854
- "staff_selection": true
855
- },
856
- "order": {
857
- "buy_again": true
858
- },
859
- "_id": "5e57643c986e4119c973df7d",
860
- "app": "000000000000000000000004",
861
- "created_at": "2020-02-27T06:39:56.088Z",
862
- "modified_at": "2021-02-02T11:04:14.289Z",
863
- "__v": 1
864
- }
865
- }
866
- ```
867
- </details>
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
- ---
878
-
879
-
880
- ### getIntegrationTokens
881
- Get integration tokens
882
-
883
-
884
-
885
- ```javascript
886
- // Promise
887
- const promise = configuration.getIntegrationTokens();
888
-
889
- // Async/Await
890
- const data = await configuration.getIntegrationTokens();
891
- ```
892
-
893
-
894
-
895
-
896
-
897
-
898
- 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.
899
-
900
- *Returned Response:*
901
-
902
-
903
-
904
-
905
- [AppTokenResponse](#AppTokenResponse)
906
-
907
- Success. Check the example shown below or refer `AppTokenResponse` for more details.
908
-
909
-
910
-
911
-
912
- <details>
913
- <summary><i>&nbsp; Example:</i></summary>
914
-
915
- ```json
916
- {
917
- "tokens": {
918
- "firebase": {
919
- "credentials": {
920
- "project_id": "",
921
- "gcm_sender_id": "",
922
- "application_id": "",
923
- "api_key": ""
924
- },
925
- "enabled": false
926
- },
927
- "moengage": {
928
- "credentials": {
929
- "app_id": ""
930
- },
931
- "enabled": false
932
- },
933
- "segment": {
934
- "credentials": {
935
- "write_key": "U2FsdGVkX18E920z+xtaD+GnGWoK/5SNxu61phXf6/o="
936
- },
937
- "enabled": false
938
- },
939
- "gtm": {
940
- "credentials": {
941
- "api_key": ""
942
- },
943
- "enabled": false
944
- },
945
- "freshchat": {
946
- "credentials": {
947
- "app_id": "U2FsdGVkX19+Egjfy8alIB4S+n2IQEXz2X4yxzimxbGzq9M5+iFsvGjrBAyQrDZ/iIXgWQyWOFRHmf9xhFGajQ==",
948
- "app_key": "U2FsdGVkX18OydYSvUBRKJDsLD1KCcwK6+jJVGma4Ck2PVwOv6BW5vyiM2sZ4kEpHbRV38KBPZPqlx3EfZd6mw=="
949
- },
950
- "enabled": true
951
- },
952
- "safetynet": {
953
- "credentials": {
954
- "api_key": "U2FsdGVkX1/Ex0BXvB16B81dwWIfVK8LPwexMMbVC3/nB9Y5n4stcnOMUCDalDs8Z92MecOQKydWg+E17QfZ4Q=="
955
- },
956
- "enabled": true
957
- },
958
- "fynd_rewards": {
959
- "credentials": {
960
- "public_key": "U2FsdGVkX1/C7x0hybxKPpWSMYBEKukQCVjnm7wfW3lrTJPmcr06xvLzVatPQJTKXeXvay0rdvcXuHlp8n/VAX7v9Usobmp1znadnPWt07GOvq5aPK9zDlg05tb+TX8Wx0q2rVonRK0Q6ZyMcn6Oy+Z812TpRAlcU1AmSrDtl/PMjuH1rSRTxKJLD0HzXk9zPl2M6GOKmgzjpHD4ZmtRSfJmm/h+qbZZ4AuD9upTbJzDm/pcp4S4cYu9rSV31JpOtAkrCxZFzCT8seWKa2eU8VdleRltwF5DO1x8Pny/hKNmhrUqxdkevY6lm4aEQjThA/EeBv1UPq52EFDteXLsZ6yBXyNAxcFNuPupour+K8hi0nfgbd/fsFqu5NUBOwz0hsqQh9OsTGt7SdiIyMSQgCttphaqhBbJ926UlG9d/O1W1u+i9rn7pECcH1eyUYlsNbYqghciz9pTrfRdqA8AIa2j7H/3Lxq37arxZCIDlTgl+Kk/8QUTsTefk+seGZsyiDyIkxW+FcmHBZLr3y85ST23szWSnyweV2hQHtPWnCE="
961
- }
962
- },
963
- "auth": {
964
- "google": {
965
- "app_id": "U2FsdGVkX19ZkUS8HAnz17Sbcixaj0N4xDcaxztzAPdkxsc2i56kuEL+hVDv5z47HjiY4jOFN0zd5HbO9vf5/adwr6L8QQVEmz1BEEGEze13a5PgONGZlfQkxeuQLBT9"
966
- },
967
- "facebook": {
968
- "app_id": "U2FsdGVkX1/kPjoWmEvESc276Ect4VZmAFVTkQKKjsxgk6LXWjj73vPrBsnJyPpR"
969
- },
970
- "accountkit": {
971
- "app_id": ""
972
- }
973
- },
974
- "google_map": {
975
- "credentials": {
976
- "api_key": "U2FsdGVkX1+5tBH/3lREPiDwVukCS/Q2ftu/CYD9RdLYK8hGO/XJfrs2zpoGDKCJBhgTDRESItRKR7Lt/w+zeQ=="
977
- }
978
- }
979
- },
980
- "_id": "5e285cb1df7e5b1421d5f840",
981
- "application": "000000000000000000000004",
982
- "created_at": "2020-01-22T14:31:13.192Z",
983
- "modified_at": "2020-05-01T04:14:42.117Z",
984
- "__v": 0
985
- }
986
- ```
987
- </details>
988
-
989
-
990
-
991
-
992
-
993
-
994
-
995
-
996
-
997
- ---
998
-
999
-
1000
- ### getLanguages
1001
- Get list of languages
1002
-
1003
-
1004
-
1005
- ```javascript
1006
- // Promise
1007
- const promise = configuration.getLanguages();
1008
-
1009
- // Async/Await
1010
- const data = await configuration.getLanguages();
1011
- ```
1012
-
1013
-
1014
-
1015
-
1016
-
1017
-
1018
- Use this API to get a list of languages supported in the application.
1019
-
1020
- *Returned Response:*
1021
-
1022
-
1023
-
1024
-
1025
- [LanguageResponse](#LanguageResponse)
1026
-
1027
- Success. Check the example shown below or refer `LanguageResponse` for more details.
1028
-
1029
-
1030
-
1031
-
1032
- <details>
1033
- <summary><i>&nbsp; Example:</i></summary>
1034
-
1035
- ```json
1036
- {
1037
- "items": [
1038
- {
1039
- "name": "हिन्दी",
1040
- "code": "hi-IN"
1041
- },
1042
- {
1043
- "name": "English",
1044
- "code": "en-IN"
1045
- },
1046
- {
1047
- "name": "عربى",
1048
- "code": "ar-AE"
1049
- }
1050
- ]
1051
- }
1052
- ```
1053
- </details>
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
- ---
1064
-
1065
-
1066
- ### getOrderingStoreCookie
1067
- Get an Ordering Store signed cookie on selection of ordering store.
1068
-
1069
-
1070
-
1071
- ```javascript
1072
- // Promise
1073
- const promise = configuration.getOrderingStoreCookie({ body : value });
1074
-
1075
- // Async/Await
1076
- const data = await configuration.getOrderingStoreCookie({ body : value });
1077
- ```
1078
-
1079
-
1080
-
1081
-
1082
-
1083
- | Argument | Type | Required | Description |
1084
- | --------- | ----- | -------- | ----------- |
1085
- | body | [OrderingStoreSelectRequest](#OrderingStoreSelectRequest) | yes | Request body |
1086
-
1087
-
1088
- 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.
1089
-
1090
- *Returned Response:*
1091
-
1092
-
1093
-
1094
-
1095
- [SuccessMessageResponse](#SuccessMessageResponse)
1096
-
1097
- Success
1098
-
1099
-
1100
-
1101
-
1102
- <details>
1103
- <summary><i>&nbsp; Example:</i></summary>
1104
-
1105
- ```json
1106
-
1107
- ```
1108
- </details>
1109
-
1110
-
1111
-
1112
-
1113
-
1114
-
1115
-
1116
-
1117
-
1118
- ---
1119
-
1120
-
1121
- ### getOrderingStores
1122
- Get deployment stores
1123
-
1124
-
1125
-
1126
- ```javascript
1127
- // Promise
1128
- const promise = configuration.getOrderingStores({ pageNo : value,
1129
- pageSize : value,
1130
- q : value });
1131
-
1132
- // Async/Await
1133
- const data = await configuration.getOrderingStores({ pageNo : value,
1134
- pageSize : value,
1135
- q : value });
1136
- ```
1137
-
1138
-
1139
-
1140
-
1141
-
1142
- | Argument | Type | Required | Description |
1143
- | --------- | ----- | -------- | ----------- |
1144
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
1145
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
1146
- | q | string | no | Store code or name of the ordering store. |
1147
-
1148
-
1149
-
1150
- Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
1151
-
1152
- *Returned Response:*
1153
-
1154
-
1155
-
1156
-
1157
- [OrderingStores](#OrderingStores)
1158
-
1159
- Success. Check the example shown below or refer `OrderingStores` for more details.
1160
-
1161
-
1162
-
1163
-
1164
- <details>
1165
- <summary><i>&nbsp; Example:</i></summary>
1166
-
1167
- ```json
1168
-
1169
- ```
1170
- </details>
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
- ---
1181
-
1182
-
1183
- ### getOwnerInfo
1184
- Get application, owner and seller information
1185
-
1186
-
1187
-
1188
- ```javascript
1189
- // Promise
1190
- const promise = configuration.getOwnerInfo();
1191
-
1192
- // Async/Await
1193
- const data = await configuration.getOwnerInfo();
1194
- ```
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
- 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.
1202
-
1203
- *Returned Response:*
1204
-
1205
-
1206
-
1207
-
1208
- [ApplicationAboutResponse](#ApplicationAboutResponse)
1209
-
1210
- Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
1211
-
1212
-
1213
-
1214
-
1215
- <details>
1216
- <summary><i>&nbsp; Example:</i></summary>
1217
-
1218
- ```json
1219
- {
1220
- "application_info": {
1221
- "domains": [
1222
- {
1223
- "verified": true,
1224
- "name": "uniket-testing.addsale.link",
1225
- "custom": false,
1226
- "is_primary": true
1227
- }
1228
- ],
1229
- "website": {
1230
- "enabled": true,
1231
- "basepath": "/"
1232
- },
1233
- "cors": {
1234
- "domains": []
1235
- },
1236
- "description": "R-City Mall,Ghatkoper East,Mumbai",
1237
- "is_active": true,
1238
- "_id": "5cd3db5e9d692cfe5302a7ba",
1239
- "name": "Shivam Clothing Store",
1240
- "meta": [
1241
- {
1242
- "name": "tes",
1243
- "value": "test"
1244
- }
1245
- ],
1246
- "token": "xOfcP-aYE",
1247
- "secret": "",
1248
- "created_at": "2019-05-09T07:48:46.218Z",
1249
- "banner": {
1250
- "secure_url": "https://res.cloudinary.com/jkvora/image/upload/v1561551809/fqt2djkddoe2yjjlln2h.png"
1251
- },
1252
- "logo": {
1253
- "secure_url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1577513094/addsale/applications/app_5cd3db5e9d692cfe5302a7ba/media/store/logo/ayrkk2uzfknst2ohluzc.png"
1254
- },
1255
- "id": "5cd3db5e9d692cfe5302a7ba",
1256
- "company_info": {
1257
- "_id": "5da4274a723af4000188a66c",
1258
- "uid": 873,
1259
- "created_on": "2019-10-14T07:44:10.391Z",
1260
- "is_active": true,
1261
- "name": "SAPPER LIFESTYLE PRIVATE LIMITED",
1262
- "addresses": [
1263
- {
1264
- "pincode": 110042,
1265
- "address1": "412, SISODIA MOHALLA BADALI VILLAGE",
1266
- "city": "NEW DELHI",
1267
- "state": "DELHI",
1268
- "country": "INDIA",
1269
- "address_type": "registered"
1270
- },
1271
- {
1272
- "pincode": 110042,
1273
- "address1": "412, SISODIA MOHALLA BADALI VILLAGE",
1274
- "city": "NEW DELHI",
1275
- "state": "DELHI",
1276
- "country": "INDIA",
1277
- "address_type": "office"
1278
- }
1279
- ],
1280
- "notification_emails": [
1281
- "ecom.sapperlifestyle@f2fretail.com"
1282
- ]
1283
- },
1284
- "owner_info": {
1285
- "_id": "5c77921fa1bf7d8695ed57fd",
1286
- "emails": [
1287
- {
1288
- "active": true,
1289
- "primary": true,
1290
- "verified": true,
1291
- "email": "abc@test.com"
1292
- },
1293
- {
1294
- "active": true,
1295
- "primary": false,
1296
- "verified": true,
1297
- "email": "abc@test.com"
1298
- },
1299
- {
1300
- "active": true,
1301
- "primary": false,
1302
- "verified": true,
1303
- "email": "abc@test.com"
1304
- }
1305
- ],
1306
- "phone_numbers": [
1307
- {
1308
- "active": true,
1309
- "primary": true,
1310
- "verified": true,
1311
- "country_code": 91,
1312
- "phone": "9408282323"
1313
- }
1314
- ],
1315
- "first_name": "Jalak",
1316
- "last_name": "Vora",
1317
- "profile_pic": ""
1318
- }
1319
- }
1320
- }
1321
- ```
1322
- </details>
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
- ---
1333
-
1334
-
1335
- ### getStoreDetailById
1336
- Get ordering store details
1337
-
1338
-
1339
-
1340
- ```javascript
1341
- // Promise
1342
- const promise = configuration.getStoreDetailById({ storeId : value });
1343
-
1344
- // Async/Await
1345
- const data = await configuration.getStoreDetailById({ storeId : value });
1346
- ```
1347
-
1348
-
1349
-
1350
-
1351
-
1352
- | Argument | Type | Required | Description |
1353
- | --------- | ----- | -------- | ----------- |
1354
- | storeId | number | yes | Store uid |
1355
-
1356
-
1357
-
1358
- Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
1359
-
1360
- *Returned Response:*
1361
-
1362
-
1363
-
1364
-
1365
- [OrderingStore](#OrderingStore)
1366
-
1367
- Success. Check the example shown below or refer `OrderingStore` for more details.
1368
-
1369
-
1370
-
1371
-
1372
- <details>
1373
- <summary><i>&nbsp; Example:</i></summary>
1374
-
1375
- ```json
1376
- {
1377
- "uid": 1060,
1378
- "name": "THE MANDHANA PARK KAMLANAGAR DELHI",
1379
- "pincode": 110007,
1380
- "store_code": "MRVLB22",
1381
- "code": "MRVLB22",
1382
- "display_name": "Kamla Nagar",
1383
- "store_type": "mall"
1384
- }
1385
- ```
1386
- </details>
1387
-
1388
-
1389
-
1390
-
1391
-
1392
-
1393
-
1394
-
1395
-
1396
- ---
1397
-
1398
-
1399
- ### removeOrderingStoreCookie
1400
- Unset the Ordering Store signed cookie.
1401
-
1402
-
1403
-
1404
- ```javascript
1405
- // Promise
1406
- const promise = configuration.removeOrderingStoreCookie();
1407
-
1408
- // Async/Await
1409
- const data = await configuration.removeOrderingStoreCookie();
1410
- ```
1411
-
1412
-
1413
-
1414
-
1415
-
1416
-
1417
- Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
1418
-
1419
- *Returned Response:*
1420
-
1421
-
1422
-
1423
-
1424
- [SuccessMessageResponse](#SuccessMessageResponse)
1425
-
1426
- Success
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
- #### [Android](#Android)
1455
-
1456
- | Properties | Type | Nullable | Description |
1457
- | ---------- | ---- | -------- | ----------- || api_key | string | no | || application_id | string | no | |
1458
-
1459
- ---
1460
-
1461
- #### [AppCurrencyResponse](#AppCurrencyResponse)
1462
-
1463
- | Properties | Type | Nullable | Description |
1464
- | ---------- | ---- | -------- | ----------- || application | string | no | || default_currency | [DefaultCurrency](#DefaultCurrency) | no | || supported_currency | [[Currency](#Currency)] | no | |
1465
-
1466
- ---
1467
-
1468
- #### [AppFeature](#AppFeature)
1469
-
1470
- | Properties | Type | Nullable | Description |
1471
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || app | string | no | || cart | [CartFeature](#CartFeature) | no | || common | [CommonFeature](#CommonFeature) | no | || created_at | string | no | || home_page | [HomePageFeature](#HomePageFeature) | no | || landing_page | [LandingPageFeature](#LandingPageFeature) | no | || order | [OrderFeature](#OrderFeature) | no | || pcr | [PcrFeature](#PcrFeature) | no | || product_detail | [ProductDetailFeature](#ProductDetailFeature) | no | || qr | [QrFeature](#QrFeature) | no | || registration_page | [RegistrationPageFeature](#RegistrationPageFeature) | no | || updated_at | string | no | |
1472
-
1473
- ---
1474
-
1475
- #### [AppFeatureRequest](#AppFeatureRequest)
1476
-
1477
- | Properties | Type | Nullable | Description |
1478
- | ---------- | ---- | -------- | ----------- || feature | [AppFeature](#AppFeature) | no | |
1479
-
1480
- ---
1481
-
1482
- #### [AppFeatureResponse](#AppFeatureResponse)
1483
-
1484
- | Properties | Type | Nullable | Description |
1485
- | ---------- | ---- | -------- | ----------- || feature | [AppFeature](#AppFeature) | no | |
1486
-
1487
- ---
1488
-
1489
- #### [Application](#Application)
1490
-
1491
- | Properties | Type | Nullable | Description |
1492
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || app_type | string | no | || auth | [ApplicationAuth](#ApplicationAuth) | no | || banner | [SecureUrl](#SecureUrl) | no | || cache_ttl | number | no | || channel_type | string | no | || company_id | number | no | || cors | [ApplicationCors](#ApplicationCors) | no | || created_at | string | no | || description | string | no | || domain | [Domain](#Domain) | no | || domains | [[Domain](#Domain)] | no | || favicon | [SecureUrl](#SecureUrl) | no | || is_active | boolean | no | || is_internal | boolean | no | || logo | [SecureUrl](#SecureUrl) | no | || meta | [[ApplicationMeta](#ApplicationMeta)] | no | || mobile_logo | [SecureUrl](#SecureUrl) | no | || name | string | no | || owner | string | no | || redirections | [[ApplicationRedirections](#ApplicationRedirections)] | no | || token | string | no | || updated_at | string | no | || website | [ApplicationWebsite](#ApplicationWebsite) | no | |
1493
-
1494
- ---
1495
-
1496
- #### [ApplicationAboutResponse](#ApplicationAboutResponse)
1497
-
1498
- | Properties | Type | Nullable | Description |
1499
- | ---------- | ---- | -------- | ----------- || application_info | [ApplicationInfo](#ApplicationInfo) | no | || company_info | [CompanyInfo](#CompanyInfo) | no | || owner_info | [OwnerInfo](#OwnerInfo) | no | |
1500
-
1501
- ---
1502
-
1503
- #### [ApplicationAuth](#ApplicationAuth)
1504
-
1505
- | Properties | Type | Nullable | Description |
1506
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
1507
-
1508
- ---
1509
-
1510
- #### [ApplicationCors](#ApplicationCors)
1511
-
1512
- | Properties | Type | Nullable | Description |
1513
- | ---------- | ---- | -------- | ----------- || domains | [string] | no | |
1514
-
1515
- ---
1516
-
1517
- #### [ApplicationDetail](#ApplicationDetail)
1518
-
1519
- | Properties | Type | Nullable | Description |
1520
- | ---------- | ---- | -------- | ----------- || _id | string | no | || banner | [SecureUrl](#SecureUrl) | yes | || description | string | yes | || domain | [Domain](#Domain) | no | || domains | [[Domain](#Domain)] | no | || favicon | [SecureUrl](#SecureUrl) | yes | || logo | [SecureUrl](#SecureUrl) | yes | || mobile_logo | [SecureUrl](#SecureUrl) | yes | || name | string | yes | |
1521
-
1522
- ---
1523
-
1524
- #### [ApplicationInfo](#ApplicationInfo)
1525
-
1526
- | Properties | Type | Nullable | Description |
1527
- | ---------- | ---- | -------- | ----------- || _id | string | no | || banner | [SecureUrl](#SecureUrl) | no | || cors | [ApplicationCors](#ApplicationCors) | no | || created_at | string | no | || description | string | no | || domain | [Domain](#Domain) | no | || is_active | boolean | no | || logo | [SecureUrl](#SecureUrl) | no | || meta | [ApplicationMeta](#ApplicationMeta) | no | || name | string | no | || secret | string | no | || token | string | no | || website | [ApplicationWebsite](#ApplicationWebsite) | no | |
1528
-
1529
- ---
1530
-
1531
- #### [ApplicationInformation](#ApplicationInformation)
1532
-
1533
- | Properties | Type | Nullable | Description |
1534
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || address | [InformationAddress](#InformationAddress) | no | || application | string | no | || business_highlights | [BusinessHighlights](#BusinessHighlights) | no | || copyright_text | string | no | || created_at | string | no | || links | [Links](#Links) | no | || social_links | [SocialLinks](#SocialLinks) | no | || support | [InformationSupport](#InformationSupport) | no | || updated_at | string | no | |
1535
-
1536
- ---
1537
-
1538
- #### [ApplicationMeta](#ApplicationMeta)
1539
-
1540
- | Properties | Type | Nullable | Description |
1541
- | ---------- | ---- | -------- | ----------- || name | string | no | || value | string | no | |
1542
-
1543
- ---
1544
-
1545
- #### [ApplicationRedirections](#ApplicationRedirections)
1546
-
1547
- | Properties | Type | Nullable | Description |
1548
- | ---------- | ---- | -------- | ----------- || redirect_from | string | no | || redirect_to | string | no | || type | string | no | |
1549
-
1550
- ---
1551
-
1552
- #### [ApplicationVersionRequest](#ApplicationVersionRequest)
1553
-
1554
- | Properties | Type | Nullable | Description |
1555
- | ---------- | ---- | -------- | ----------- || id | string | no | || name | string | yes | || namespace | string | no | || token | string | no | || version | string | yes | |
1556
-
1557
- ---
1558
-
1559
- #### [ApplicationWebsite](#ApplicationWebsite)
1560
-
1561
- | Properties | Type | Nullable | Description |
1562
- | ---------- | ---- | -------- | ----------- || basepath | string | no | || enabled | boolean | no | |
1563
-
1564
- ---
1565
-
1566
- #### [AppStaff](#AppStaff)
1567
-
1568
- | Properties | Type | Nullable | Description |
1569
- | ---------- | ---- | -------- | ----------- || _id | string | no | || application | string | no | || employee_code | string | no | || first_name | string | no | || last_name | string | no | || order_incent | boolean | no | || profile_pic_url | string | no | || stores | [number] | no | || title | string | no | || user | string | no | |
1570
-
1571
- ---
1572
-
1573
- #### [AppStaffListResponse](#AppStaffListResponse)
1574
-
1575
- | Properties | Type | Nullable | Description |
1576
- | ---------- | ---- | -------- | ----------- || items | [[AppStaff](#AppStaff)] | no | || page | [Page](#Page) | no | |
1577
-
1578
- ---
1579
-
1580
- #### [AppStaffResponse](#AppStaffResponse)
1581
-
1582
- | Properties | Type | Nullable | Description |
1583
- | ---------- | ---- | -------- | ----------- || staff_users | [[AppStaff](#AppStaff)] | no | |
1584
-
1585
- ---
1586
-
1587
- #### [AppTokenResponse](#AppTokenResponse)
1588
-
1589
- | Properties | Type | Nullable | Description |
1590
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || application | string | no | || created_at | string | no | || tokens | [Tokens](#Tokens) | no | || updated_at | string | no | |
1591
-
1592
- ---
1593
-
1594
- #### [AppVersionRequest](#AppVersionRequest)
1595
-
1596
- | Properties | Type | Nullable | Description |
1597
- | ---------- | ---- | -------- | ----------- || application | [ApplicationVersionRequest](#ApplicationVersionRequest) | yes | || device | [Device](#Device) | yes | || locale | string | no | || timezone | string | no | |
1598
-
1599
- ---
1600
-
1601
- #### [ArticleAssignmentRule](#ArticleAssignmentRule)
1602
-
1603
- | Properties | Type | Nullable | Description |
1604
- | ---------- | ---- | -------- | ----------- || store_priority | [StorePriorityRule](#StorePriorityRule) | no | |
1605
-
1606
- ---
1607
-
1608
- #### [BlogLink](#BlogLink)
1609
-
1610
- | Properties | Type | Nullable | Description |
1611
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
1612
-
1613
- ---
1614
-
1615
- #### [BusinessHighlights](#BusinessHighlights)
1616
-
1617
- | Properties | Type | Nullable | Description |
1618
- | ---------- | ---- | -------- | ----------- || _id | string | no | || icon | string | no | || sub_title | string | no | || title | string | no | |
1619
-
1620
- ---
1621
-
1622
- #### [CartFeature](#CartFeature)
1623
-
1624
- | Properties | Type | Nullable | Description |
1625
- | ---------- | ---- | -------- | ----------- || google_map | boolean | no | || gst_input | boolean | no | || placing_for_customer | boolean | no | || revenue_engine_coupon | boolean | no | || staff_selection | boolean | no | |
1626
-
1627
- ---
1628
-
1629
- #### [CommonFeature](#CommonFeature)
1630
-
1631
- | Properties | Type | Nullable | Description |
1632
- | ---------- | ---- | -------- | ----------- || communication_optin_dialog | [CommunicationOptinDialogFeature](#CommunicationOptinDialogFeature) | no | || compare_products | [CompareProductsFeature](#CompareProductsFeature) | no | || currency | [CurrencyFeature](#CurrencyFeature) | no | || deployment_store_selection | [DeploymentStoreSelectionFeature](#DeploymentStoreSelectionFeature) | no | || feedback | [FeedbackFeature](#FeedbackFeature) | no | || listing_price | [ListingPriceFeature](#ListingPriceFeature) | no | || revenue_engine | [RevenueEngineFeature](#RevenueEngineFeature) | no | || reward_points | [RewardPointsConfig](#RewardPointsConfig) | no | |
1633
-
1634
- ---
1635
-
1636
- #### [CommunicationOptinDialogFeature](#CommunicationOptinDialogFeature)
1637
-
1638
- | Properties | Type | Nullable | Description |
1639
- | ---------- | ---- | -------- | ----------- || visibility | boolean | no | |
1640
-
1641
- ---
1642
-
1643
- #### [CompanyAboutAddress](#CompanyAboutAddress)
1644
-
1645
- | Properties | Type | Nullable | Description |
1646
- | ---------- | ---- | -------- | ----------- || address1 | string | no | || address2 | string | no | || address_type | string | no | || city | string | no | || country | string | no | || pincode | number | no | || state | string | no | |
1647
-
1648
- ---
1649
-
1650
- #### [CompanyInfo](#CompanyInfo)
1651
-
1652
- | Properties | Type | Nullable | Description |
1653
- | ---------- | ---- | -------- | ----------- || _id | string | no | || addresses | [[CompanyAboutAddress](#CompanyAboutAddress)] | no | || created_on | string | no | || is_active | boolean | no | || name | string | no | || notification_emails | [string] | no | || uid | number | no | |
1654
-
1655
- ---
1656
-
1657
- #### [CompareProductsFeature](#CompareProductsFeature)
1658
-
1659
- | Properties | Type | Nullable | Description |
1660
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
1661
-
1662
- ---
1663
-
1664
- #### [Credentials](#Credentials)
1665
-
1666
- | Properties | Type | Nullable | Description |
1667
- | ---------- | ---- | -------- | ----------- || android | [Android](#Android) | no | || api_key | string | no | || application_id | string | no | || gcm_sender_id | string | no | || ios | [Ios](#Ios) | no | || project_id | string | no | |
1668
-
1669
- ---
1670
-
1671
- #### [Credit](#Credit)
1672
-
1673
- | Properties | Type | Nullable | Description |
1674
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
1675
-
1676
- ---
1677
-
1678
- #### [CurrenciesResponse](#CurrenciesResponse)
1679
-
1680
- | Properties | Type | Nullable | Description |
1681
- | ---------- | ---- | -------- | ----------- || items | [[Currency](#Currency)] | no | |
1682
-
1683
- ---
1684
-
1685
- #### [Currency](#Currency)
1686
-
1687
- | Properties | Type | Nullable | Description |
1688
- | ---------- | ---- | -------- | ----------- || _id | string | no | || code | string | no | || created_at | string | no | || decimal_digits | number | no | || is_active | boolean | no | || name | string | no | || symbol | string | no | || updated_at | string | no | |
1689
-
1690
- ---
1691
-
1692
- #### [CurrencyFeature](#CurrencyFeature)
1693
-
1694
- | Properties | Type | Nullable | Description |
1695
- | ---------- | ---- | -------- | ----------- || default_currency | string | no | || type | string | no | || value | [string] | no | |
1696
-
1697
- ---
1698
-
1699
- #### [Debit](#Debit)
1700
-
1701
- | Properties | Type | Nullable | Description |
1702
- | ---------- | ---- | -------- | ----------- || auto_apply | boolean | no | || enabled | boolean | no | || strategy_channel | string | no | |
1703
-
1704
- ---
1705
-
1706
- #### [DefaultCurrency](#DefaultCurrency)
1707
-
1708
- | Properties | Type | Nullable | Description |
1709
- | ---------- | ---- | -------- | ----------- || code | string | no | || ref | string | no | |
1710
-
1711
- ---
1712
-
1713
- #### [DeploymentStoreSelectionFeature](#DeploymentStoreSelectionFeature)
1714
-
1715
- | Properties | Type | Nullable | Description |
1716
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | || type | string | no | |
1717
-
1718
- ---
1719
-
1720
- #### [Device](#Device)
1721
-
1722
- | Properties | Type | Nullable | Description |
1723
- | ---------- | ---- | -------- | ----------- || build | number | no | || model | string | no | || os | [OS](#OS) | yes | |
1724
-
1725
- ---
1726
-
1727
- #### [Domain](#Domain)
1728
-
1729
- | Properties | Type | Nullable | Description |
1730
- | ---------- | ---- | -------- | ----------- || _id | string | no | || is_predefined | boolean | no | || is_primary | boolean | no | || is_shortlink | boolean | no | || name | string | no | || verified | boolean | no | |
1731
-
1732
- ---
1733
-
1734
- #### [FacebookLink](#FacebookLink)
1735
-
1736
- | Properties | Type | Nullable | Description |
1737
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
1738
-
1739
- ---
1740
-
1741
- #### [FeedbackFeature](#FeedbackFeature)
1742
-
1743
- | Properties | Type | Nullable | Description |
1744
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
1745
-
1746
- ---
1747
-
1748
- #### [Firebase](#Firebase)
1749
-
1750
- | Properties | Type | Nullable | Description |
1751
- | ---------- | ---- | -------- | ----------- || credentials | [Credentials](#Credentials) | no | || enabled | boolean | no | |
1752
-
1753
- ---
1754
-
1755
- #### [Freshchat](#Freshchat)
1756
-
1757
- | Properties | Type | Nullable | Description |
1758
- | ---------- | ---- | -------- | ----------- || credentials | [FreshchatCredentials](#FreshchatCredentials) | no | || enabled | boolean | no | |
1759
-
1760
- ---
1761
-
1762
- #### [FreshchatCredentials](#FreshchatCredentials)
1763
-
1764
- | Properties | Type | Nullable | Description |
1765
- | ---------- | ---- | -------- | ----------- || app_id | string | no | || app_key | string | no | || web_token | string | no | |
1766
-
1767
- ---
1768
-
1769
- #### [FyndRewards](#FyndRewards)
1770
-
1771
- | Properties | Type | Nullable | Description |
1772
- | ---------- | ---- | -------- | ----------- || credentials | [FyndRewardsCredentials](#FyndRewardsCredentials) | no | |
1773
-
1774
- ---
1775
-
1776
- #### [FyndRewardsCredentials](#FyndRewardsCredentials)
1777
-
1778
- | Properties | Type | Nullable | Description |
1779
- | ---------- | ---- | -------- | ----------- || public_key | string | no | |
1780
-
1781
- ---
1782
-
1783
- #### [GoogleMap](#GoogleMap)
1784
-
1785
- | Properties | Type | Nullable | Description |
1786
- | ---------- | ---- | -------- | ----------- || credentials | [GoogleMapCredentials](#GoogleMapCredentials) | no | |
1787
-
1788
- ---
1789
-
1790
- #### [GoogleMapCredentials](#GoogleMapCredentials)
1791
-
1792
- | Properties | Type | Nullable | Description |
1793
- | ---------- | ---- | -------- | ----------- || api_key | string | no | |
1794
-
1795
- ---
1796
-
1797
- #### [GooglePlusLink](#GooglePlusLink)
1798
-
1799
- | Properties | Type | Nullable | Description |
1800
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
1801
-
1802
- ---
1803
-
1804
- #### [Gtm](#Gtm)
1805
-
1806
- | Properties | Type | Nullable | Description |
1807
- | ---------- | ---- | -------- | ----------- || credentials | [GtmCredentials](#GtmCredentials) | no | || enabled | boolean | no | |
1808
-
1809
- ---
1810
-
1811
- #### [GtmCredentials](#GtmCredentials)
1812
-
1813
- | Properties | Type | Nullable | Description |
1814
- | ---------- | ---- | -------- | ----------- || api_key | string | no | |
1815
-
1816
- ---
1817
-
1818
- #### [HomePageFeature](#HomePageFeature)
1819
-
1820
- | Properties | Type | Nullable | Description |
1821
- | ---------- | ---- | -------- | ----------- || order_processing | boolean | no | |
1822
-
1823
- ---
1824
-
1825
- #### [InformationAddress](#InformationAddress)
1826
-
1827
- | Properties | Type | Nullable | Description |
1828
- | ---------- | ---- | -------- | ----------- || address_line | [string] | no | || city | string | no | || country | string | no | || loc | string | no | || phone | [InformationPhone](#InformationPhone) | no | || pincode | number | no | |
1829
-
1830
- ---
1831
-
1832
- #### [InformationPhone](#InformationPhone)
1833
-
1834
- | Properties | Type | Nullable | Description |
1835
- | ---------- | ---- | -------- | ----------- || code | string | no | || number | string | no | |
1836
-
1837
- ---
1838
-
1839
- #### [InformationSupport](#InformationSupport)
1840
-
1841
- | Properties | Type | Nullable | Description |
1842
- | ---------- | ---- | -------- | ----------- || email | [string] | no | || phone | [string] | no | || timing | string | no | |
1843
-
1844
- ---
1845
-
1846
- #### [InstagramLink](#InstagramLink)
1847
-
1848
- | Properties | Type | Nullable | Description |
1849
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
1850
-
1851
- ---
1852
-
1853
- #### [InvalidPayloadRequest](#InvalidPayloadRequest)
1854
-
1855
- | Properties | Type | Nullable | Description |
1856
- | ---------- | ---- | -------- | ----------- || message | string | no | |
1857
-
1858
- ---
1859
-
1860
- #### [InventoryArticleAssignment](#InventoryArticleAssignment)
1861
-
1862
- | Properties | Type | Nullable | Description |
1863
- | ---------- | ---- | -------- | ----------- || post_order_reassignment | boolean | no | || rules | [ArticleAssignmentRule](#ArticleAssignmentRule) | no | |
1864
-
1865
- ---
1866
-
1867
- #### [InventoryBrandRule](#InventoryBrandRule)
1868
-
1869
- | Properties | Type | Nullable | Description |
1870
- | ---------- | ---- | -------- | ----------- || brands | [number] | no | || criteria | string | no | |
1871
-
1872
- ---
1873
-
1874
- #### [InventoryPaymentConfig](#InventoryPaymentConfig)
1875
-
1876
- | Properties | Type | Nullable | Description |
1877
- | ---------- | ---- | -------- | ----------- || mode_of_payment | string | no | || source | string | no | |
1878
-
1879
- ---
1880
-
1881
- #### [InventoryStoreRule](#InventoryStoreRule)
1882
-
1883
- | Properties | Type | Nullable | Description |
1884
- | ---------- | ---- | -------- | ----------- || criteria | string | no | || rules | [[StoreCriteriaRule](#StoreCriteriaRule)] | no | || stores | [number] | no | |
1885
-
1886
- ---
1887
-
1888
- #### [Ios](#Ios)
1889
-
1890
- | Properties | Type | Nullable | Description |
1891
- | ---------- | ---- | -------- | ----------- || api_key | string | no | || application_id | string | no | |
1892
-
1893
- ---
1894
-
1895
- #### [LandingPageFeature](#LandingPageFeature)
1896
-
1897
- | Properties | Type | Nullable | Description |
1898
- | ---------- | ---- | -------- | ----------- || continue_as_guest | boolean | no | || launch_page | [LaunchPage](#LaunchPage) | no | || login_btn_text | string | no | || show_domain_textbox | boolean | no | || show_register_btn | boolean | no | |
1899
-
1900
- ---
1901
-
1902
- #### [LanguageResponse](#LanguageResponse)
1903
-
1904
- | Properties | Type | Nullable | Description |
1905
- | ---------- | ---- | -------- | ----------- || items | [[SupportedLanguage](#SupportedLanguage)] | no | |
1906
-
1907
- ---
1908
-
1909
- #### [LaunchPage](#LaunchPage)
1910
-
1911
- | Properties | Type | Nullable | Description |
1912
- | ---------- | ---- | -------- | ----------- || page_type | string | no | || params | string | no | || query | string | no | |
1913
-
1914
- ---
1915
-
1916
- #### [LinkedInLink](#LinkedInLink)
1917
-
1918
- | Properties | Type | Nullable | Description |
1919
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
1920
-
1921
- ---
1922
-
1923
- #### [Links](#Links)
1924
-
1925
- | Properties | Type | Nullable | Description |
1926
- | ---------- | ---- | -------- | ----------- || link | string | no | || title | string | no | |
1927
-
1928
- ---
1929
-
1930
- #### [ListingPriceFeature](#ListingPriceFeature)
1931
-
1932
- | Properties | Type | Nullable | Description |
1933
- | ---------- | ---- | -------- | ----------- || value | string | no | |
1934
-
1935
- ---
1936
-
1937
- #### [Moengage](#Moengage)
1938
-
1939
- | Properties | Type | Nullable | Description |
1940
- | ---------- | ---- | -------- | ----------- || credentials | [MoengageCredentials](#MoengageCredentials) | no | || enabled | boolean | no | |
1941
-
1942
- ---
1943
-
1944
- #### [MoengageCredentials](#MoengageCredentials)
1945
-
1946
- | Properties | Type | Nullable | Description |
1947
- | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1948
-
1949
- ---
1950
-
1951
- #### [NotFound](#NotFound)
1952
-
1953
- | Properties | Type | Nullable | Description |
1954
- | ---------- | ---- | -------- | ----------- || message | string | no | |
1955
-
1956
- ---
1957
-
1958
- #### [OptedStoreAddress](#OptedStoreAddress)
1959
-
1960
- | Properties | Type | Nullable | Description |
1961
- | ---------- | ---- | -------- | ----------- || address1 | string | no | || address2 | string | no | || city | string | no | || country | string | no | || lat_long | [StoreLatLong](#StoreLatLong) | no | || pincode | number | no | || state | string | no | |
1962
-
1963
- ---
1964
-
1965
- #### [OrderFeature](#OrderFeature)
1966
-
1967
- | Properties | Type | Nullable | Description |
1968
- | ---------- | ---- | -------- | ----------- || buy_again | boolean | no | |
1969
-
1970
- ---
1971
-
1972
- #### [OrderingStore](#OrderingStore)
1973
-
1974
- | Properties | Type | Nullable | Description |
1975
- | ---------- | ---- | -------- | ----------- || _id | string | no | || address | [OptedStoreAddress](#OptedStoreAddress) | no | || code | string | no | || display_name | string | no | || name | string | no | || pincode | number | no | || store_code | string | no | || store_type | string | no | || uid | number | no | |
1976
-
1977
- ---
1978
-
1979
- #### [OrderingStores](#OrderingStores)
1980
-
1981
- | Properties | Type | Nullable | Description |
1982
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || all_stores | boolean | no | || app | string | no | || deployed_stores | [number] | no | || enabled | boolean | no | || items | [[OrderingStore](#OrderingStore)] | no | || page | [Page](#Page) | no | || type | string | no | |
1983
-
1984
- ---
1985
-
1986
- #### [OrderingStoreSelect](#OrderingStoreSelect)
1987
-
1988
- | Properties | Type | Nullable | Description |
1989
- | ---------- | ---- | -------- | ----------- || uid | number | yes | |
1990
-
1991
- ---
1992
-
1993
- #### [OrderingStoreSelectRequest](#OrderingStoreSelectRequest)
1994
-
1995
- | Properties | Type | Nullable | Description |
1996
- | ---------- | ---- | -------- | ----------- || ordering_store | [OrderingStoreSelect](#OrderingStoreSelect) | yes | |
1997
-
1998
- ---
1999
-
2000
- #### [OrderingStoresResponse](#OrderingStoresResponse)
2001
-
2002
- | Properties | Type | Nullable | Description |
2003
- | ---------- | ---- | -------- | ----------- || items | [[OrderingStore](#OrderingStore)] | no | || page | [Page](#Page) | no | |
2004
-
2005
- ---
2006
-
2007
- #### [OS](#OS)
2008
-
2009
- | Properties | Type | Nullable | Description |
2010
- | ---------- | ---- | -------- | ----------- || name | string | yes | || version | string | no | |
2011
-
2012
- ---
2013
-
2014
- #### [OwnerInfo](#OwnerInfo)
2015
-
2016
- | Properties | Type | Nullable | Description |
2017
- | ---------- | ---- | -------- | ----------- || _id | string | no | || emails | [[UserEmail](#UserEmail)] | no | || first_name | string | no | || last_name | string | no | || phone_numbers | [[UserPhoneNumber](#UserPhoneNumber)] | no | || profile_pic | string | no | |
2018
-
2019
- ---
2020
-
2021
- #### [Page](#Page)
2022
-
2023
- | Properties | Type | Nullable | Description |
2024
- | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || next_id | string | no | || size | number | no | || type | string | yes | |
2025
-
2026
- ---
2027
-
2028
- #### [PcrFeature](#PcrFeature)
2029
-
2030
- | Properties | Type | Nullable | Description |
2031
- | ---------- | ---- | -------- | ----------- || staff_selection | boolean | no | |
2032
-
2033
- ---
2034
-
2035
- #### [PinterestLink](#PinterestLink)
2036
-
2037
- | Properties | Type | Nullable | Description |
2038
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
2039
-
2040
- ---
2041
-
2042
- #### [ProductDetailFeature](#ProductDetailFeature)
2043
-
2044
- | Properties | Type | Nullable | Description |
2045
- | ---------- | ---- | -------- | ----------- || request_product | boolean | no | || seller_selection | boolean | no | || similar | [string] | no | || update_product_meta | boolean | no | |
2046
-
2047
- ---
2048
-
2049
- #### [QrFeature](#QrFeature)
2050
-
2051
- | Properties | Type | Nullable | Description |
2052
- | ---------- | ---- | -------- | ----------- || application | boolean | no | || collections | boolean | no | || products | boolean | no | |
2053
-
2054
- ---
2055
-
2056
- #### [RegistrationPageFeature](#RegistrationPageFeature)
2057
-
2058
- | Properties | Type | Nullable | Description |
2059
- | ---------- | ---- | -------- | ----------- || ask_store_address | boolean | no | |
2060
-
2061
- ---
2062
-
2063
- #### [RevenueEngineFeature](#RevenueEngineFeature)
2064
-
2065
- | Properties | Type | Nullable | Description |
2066
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
2067
-
2068
- ---
2069
-
2070
- #### [RewardPointsConfig](#RewardPointsConfig)
2071
-
2072
- | Properties | Type | Nullable | Description |
2073
- | ---------- | ---- | -------- | ----------- || credit | [Credit](#Credit) | no | || debit | [Debit](#Debit) | no | |
2074
-
2075
- ---
2076
-
2077
- #### [Safetynet](#Safetynet)
2078
-
2079
- | Properties | Type | Nullable | Description |
2080
- | ---------- | ---- | -------- | ----------- || credentials | [SafetynetCredentials](#SafetynetCredentials) | no | || enabled | boolean | no | |
2081
-
2082
- ---
2083
-
2084
- #### [SafetynetCredentials](#SafetynetCredentials)
2085
-
2086
- | Properties | Type | Nullable | Description |
2087
- | ---------- | ---- | -------- | ----------- || api_key | string | no | |
2088
-
2089
- ---
2090
-
2091
- #### [SecureUrl](#SecureUrl)
2092
-
2093
- | Properties | Type | Nullable | Description |
2094
- | ---------- | ---- | -------- | ----------- || secure_url | string | no | |
2095
-
2096
- ---
2097
-
2098
- #### [Segment](#Segment)
2099
-
2100
- | Properties | Type | Nullable | Description |
2101
- | ---------- | ---- | -------- | ----------- || credentials | [SegmentCredentials](#SegmentCredentials) | no | || enabled | boolean | no | |
2102
-
2103
- ---
2104
-
2105
- #### [SegmentCredentials](#SegmentCredentials)
2106
-
2107
- | Properties | Type | Nullable | Description |
2108
- | ---------- | ---- | -------- | ----------- || write_key | string | no | |
2109
-
2110
- ---
2111
-
2112
- #### [SocialLinks](#SocialLinks)
2113
-
2114
- | Properties | Type | Nullable | Description |
2115
- | ---------- | ---- | -------- | ----------- || blog_link | [BlogLink](#BlogLink) | no | || facebook | [FacebookLink](#FacebookLink) | no | || google_plus | [GooglePlusLink](#GooglePlusLink) | no | || instagram | [InstagramLink](#InstagramLink) | no | || linked_in | [LinkedInLink](#LinkedInLink) | no | || pinterest | [PinterestLink](#PinterestLink) | no | || twitter | [TwitterLink](#TwitterLink) | no | || vimeo | [VimeoLink](#VimeoLink) | no | || youtube | [YoutubeLink](#YoutubeLink) | no | |
2116
-
2117
- ---
2118
-
2119
- #### [StoreCriteriaRule](#StoreCriteriaRule)
2120
-
2121
- | Properties | Type | Nullable | Description |
2122
- | ---------- | ---- | -------- | ----------- || brands | [number] | no | || companies | [number] | no | |
2123
-
2124
- ---
2125
-
2126
- #### [StoreLatLong](#StoreLatLong)
2127
-
2128
- | Properties | Type | Nullable | Description |
2129
- | ---------- | ---- | -------- | ----------- || coordinates | [number] | no | || type | string | no | |
2130
-
2131
- ---
2132
-
2133
- #### [StorePriorityRule](#StorePriorityRule)
2134
-
2135
- | Properties | Type | Nullable | Description |
2136
- | ---------- | ---- | -------- | ----------- || enabled | boolean | no | || storetype_order | [string] | no | |
2137
-
2138
- ---
2139
-
2140
- #### [SuccessMessageResponse](#SuccessMessageResponse)
2141
-
2142
- | Properties | Type | Nullable | Description |
2143
- | ---------- | ---- | -------- | ----------- || message | string | no | |
2144
-
2145
- ---
2146
-
2147
- #### [SupportedLanguage](#SupportedLanguage)
2148
-
2149
- | Properties | Type | Nullable | Description |
2150
- | ---------- | ---- | -------- | ----------- || code | string | no | || name | string | no | |
2151
-
2152
- ---
2153
-
2154
- #### [Tokens](#Tokens)
2155
-
2156
- | Properties | Type | Nullable | Description |
2157
- | ---------- | ---- | -------- | ----------- || firebase | [Firebase](#Firebase) | no | || freshchat | [Freshchat](#Freshchat) | no | || fynd_rewards | [FyndRewards](#FyndRewards) | no | || google_map | [GoogleMap](#GoogleMap) | no | || gtm | [Gtm](#Gtm) | no | || moengage | [Moengage](#Moengage) | no | || safetynet | [Safetynet](#Safetynet) | no | || segment | [Segment](#Segment) | no | |
2158
-
2159
- ---
2160
-
2161
- #### [TwitterLink](#TwitterLink)
2162
-
2163
- | Properties | Type | Nullable | Description |
2164
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
2165
-
2166
- ---
2167
-
2168
- #### [UnhandledError](#UnhandledError)
2169
-
2170
- | Properties | Type | Nullable | Description |
2171
- | ---------- | ---- | -------- | ----------- || message | string | no | |
2172
-
2173
- ---
2174
-
2175
- #### [UpdateDialog](#UpdateDialog)
2176
-
2177
- | Properties | Type | Nullable | Description |
2178
- | ---------- | ---- | -------- | ----------- || interval | number | no | || type | string | no | |
2179
-
2180
- ---
2181
-
2182
- #### [UserEmail](#UserEmail)
2183
-
2184
- | Properties | Type | Nullable | Description |
2185
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
2186
-
2187
- ---
2188
-
2189
- #### [UserPhoneNumber](#UserPhoneNumber)
2190
-
2191
- | Properties | Type | Nullable | Description |
2192
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | number | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
2193
-
2194
- ---
2195
-
2196
- #### [VimeoLink](#VimeoLink)
2197
-
2198
- | Properties | Type | Nullable | Description |
2199
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
2200
-
2201
- ---
2202
-
2203
- #### [YoutubeLink](#YoutubeLink)
2204
-
2205
- | Properties | Type | Nullable | Description |
2206
- | ---------- | ---- | -------- | ----------- || icon | string | no | || link | string | no | || title | string | no | |
2207
-
2208
- ---
2209
-
2210
-
2211
-
2212
-