@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (265) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.js +3 -5
  6. package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
  7. package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
  8. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
  9. package/sdk/application/Cart/CartApplicationValidator.js +0 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
  12. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  13. package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
  14. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
  16. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  17. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  18. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  19. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
  22. package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
  23. package/sdk/application/Content/ContentApplicationClient.js +0 -246
  24. package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
  25. package/sdk/application/Content/ContentApplicationModel.js +565 -817
  26. package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
  27. package/sdk/application/Content/ContentApplicationValidator.js +0 -41
  28. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  29. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  30. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  31. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  32. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
  33. package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
  34. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
  35. package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
  36. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
  37. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
  38. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  39. package/sdk/application/Order/OrderApplicationClient.js +8 -32
  40. package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
  41. package/sdk/application/Order/OrderApplicationModel.js +816 -824
  42. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
  43. package/sdk/application/Order/OrderApplicationValidator.js +0 -8
  44. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
  45. package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
  46. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
  47. package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
  48. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
  49. package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
  50. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
  51. package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
  52. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  53. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  54. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  55. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  56. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  57. package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
  58. package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
  59. package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
  60. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
  62. package/sdk/application/User/UserApplicationClient.d.ts +0 -33
  63. package/sdk/application/User/UserApplicationClient.js +0 -239
  64. package/sdk/application/User/UserApplicationModel.d.ts +753 -768
  65. package/sdk/application/User/UserApplicationModel.js +731 -755
  66. package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
  67. package/sdk/application/User/UserApplicationValidator.js +0 -36
  68. package/sdk/common/Clickstream.d.ts +1 -0
  69. package/sdk/common/Clickstream.js +254 -0
  70. package/sdk/common/Utility.js +1 -4
  71. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
  72. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
  73. package/sdk/partner/PartnerClient.d.ts +0 -6
  74. package/sdk/partner/PartnerClient.js +0 -9
  75. package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
  76. package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
  77. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
  78. package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
  79. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
  80. package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
  81. package/sdk/partner/index.d.ts +0 -3
  82. package/sdk/partner/index.js +0 -6
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  86. package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
  87. package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
  88. package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
  89. package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
  90. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
  91. package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
  92. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
  94. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
  96. package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
  97. package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
  108. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  109. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
  112. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
  114. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
  115. package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  124. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
  125. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
  126. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  127. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  128. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
  129. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
  130. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
  131. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
  132. package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
  133. package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
  145. package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
  147. package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
  150. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  151. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  152. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
  153. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
  154. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
  155. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
  156. package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
  157. package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
  159. package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  161. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  162. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
  163. package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
  164. package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
  165. package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
  166. package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
  167. package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
  168. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  169. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  170. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
  172. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
  174. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  175. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  176. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
  177. package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
  178. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  179. package/sdk/platform/PlatformApplicationClient.js +4 -4
  180. package/sdk/platform/PlatformClient.d.ts +2 -4
  181. package/sdk/platform/PlatformClient.js +4 -8
  182. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  183. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  195. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  196. package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
  197. package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
  198. package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
  199. package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
  200. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
  201. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
  206. package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
  207. package/sdk/platform/User/UserPlatformModel.js +428 -679
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  214. package/sdk/platform/index.d.ts +1 -1
  215. package/sdk/platform/index.js +2 -2
  216. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  217. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  218. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  219. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  220. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  221. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  222. package/sdk/public/PublicClient.d.ts +0 -4
  223. package/sdk/public/PublicClient.js +0 -8
  224. package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
  225. package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
  226. package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
  227. package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
  228. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
  229. package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
  230. package/sdk/public/index.d.ts +0 -2
  231. package/sdk/public/index.js +0 -4
  232. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
  233. package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
  234. package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
  235. package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
  236. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
  237. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
  238. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
  239. package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
  240. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
  241. package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
  242. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
  243. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
  244. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
  245. package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
  246. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
  247. package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
  248. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
  249. package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
  250. package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
  251. package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
  252. package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
  253. package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
  254. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
  255. package/sdk/public/Billing/BillingPublicClient.js +0 -116
  256. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
  257. package/sdk/public/Billing/BillingPublicModel.js +0 -96
  258. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
  259. package/sdk/public/Billing/BillingPublicValidator.js +0 -19
  260. package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
  261. package/sdk/public/Content/ContentPublicClient.js +0 -114
  262. package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
  263. package/sdk/public/Content/ContentPublicModel.js +0 -60
  264. package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
  265. package/sdk/public/Content/ContentPublicValidator.js +0 -19
@@ -1,827 +1,699 @@
1
1
  export = CatalogApplicationModel;
2
2
  /**
3
- * @typedef ApplicationItemMOQ
4
- * @property {number} [increment_unit] - The minimum quantity increment in which
5
- * the item can be purchased.
6
- * @property {number} [maximum] - The maximum quantity allowed for purchase.
7
- * @property {number} [minimum] - The minimum quantity required for purchase.
3
+ * @typedef ProductDetailCustomOrder
4
+ * @property {number} [manufacturing_time]
5
+ * @property {string} [manufacturing_time_unit]
6
+ * @property {boolean} [is_custom_order]
8
7
  */
9
8
  /**
10
- * @typedef ApplicationItemSEO
11
- * @property {Object} [description] - The SEO description of the item
12
- * @property {Object} [title] - The SEO title of the item
9
+ * @typedef Meta
10
+ * @property {string} [source]
13
11
  */
14
12
  /**
15
- * @typedef ApplicationStoreListing
16
- * @property {Object[]} [filters]
17
- * @property {AppStore[]} [items]
18
- * @property {Page} [page]
13
+ * @typedef Media
14
+ * @property {string} [url]
15
+ * @property {string} [type]
16
+ * @property {Meta} [meta]
17
+ * @property {string} [alt]
19
18
  */
20
19
  /**
21
- * @typedef AppStore
22
- * @property {StoreAddressSerializer} [address]
23
- * @property {CompanyStore} [company]
24
- * @property {SellerPhoneNumber[]} [contact_numbers]
25
- * @property {StoreDepartments[]} [departments]
26
- * @property {StoreManagerSerializer} [manager]
27
- * @property {string} [name]
28
- * @property {string} [store_code]
29
- * @property {number} [uid]
20
+ * @typedef ProductListingActionPage
21
+ * @property {string} [type]
22
+ * @property {Object} [query]
23
+ * @property {Object} [params]
30
24
  */
31
25
  /**
32
- * @typedef ArticleAssignmentV3
33
- * @property {string} [level]
34
- * @property {string} [strategy]
26
+ * @typedef ProductListingAction
27
+ * @property {string} [type]
28
+ * @property {ProductListingActionPage} [page]
35
29
  */
36
30
  /**
37
- * @typedef AttributeDetail
31
+ * @typedef ProductBrand
32
+ * @property {number} [uid]
33
+ * @property {Media} [logo]
38
34
  * @property {string} [description]
39
- * @property {string} [display]
40
- * @property {string} [key]
41
- * @property {string} [logo]
35
+ * @property {string} [name]
36
+ * @property {ProductListingAction} [action]
42
37
  */
43
38
  /**
44
- * @typedef AttributeMetadata
45
- * @property {AttributeDetail[]} [details]
46
- * @property {string} [title]
39
+ * @typedef ProductDepartment
40
+ * @property {number} [uid]
41
+ * @property {Media} [logo]
42
+ * @property {string} [slug]
43
+ * @property {string} [name]
47
44
  */
48
45
  /**
49
- * @typedef AutocompleteItem
50
- * @property {Object} [_custom_json]
51
- * @property {ProductListingAction} [action]
52
- * @property {string} [display]
53
- * @property {Media} [logo]
54
- * @property {string} [type]
46
+ * @typedef ProductCategoryMap
47
+ * @property {ProductBrand} [l1]
48
+ * @property {ProductBrand} [l2]
49
+ * @property {ProductBrand} [l3]
55
50
  */
56
51
  /**
57
- * @typedef AutoCompleteResponse
58
- * @property {AutocompleteItem[]} [items]
52
+ * @typedef NetQuantity
53
+ * @property {Object} [unit] - The unit of measurement used for the net quantity
54
+ * of the product.
55
+ * @property {number} [value] - The value of the net quantity of the product.
59
56
  */
60
57
  /**
61
- * @typedef BrandDetailResponse
62
- * @property {Object} [_custom_json]
63
- * @property {ImageUrls} [banners]
64
- * @property {string} [description]
65
- * @property {Media} [logo]
66
- * @property {string} [name]
67
- * @property {number} [uid]
58
+ * @typedef CustomMetaFields
59
+ * @property {string} value - A value to store in the custom field.
60
+ * @property {string} key - A key to store a custom field.
68
61
  */
69
62
  /**
70
- * @typedef BrandItem
71
- * @property {ProductListingAction} [action]
72
- * @property {ImageUrls} [banners]
73
- * @property {string[]} [departments]
74
- * @property {string} [description]
75
- * @property {string} [discount]
76
- * @property {Media} [logo]
77
- * @property {string} [name]
78
- * @property {string} [slug]
79
- * @property {number} [uid]
63
+ * @typedef ApplicationItemSEO
64
+ * @property {Object} [title] - The SEO title of the item
65
+ * @property {Object} [description] - The SEO description of the item
80
66
  */
81
67
  /**
82
- * @typedef BrandListingResponse
83
- * @property {BrandItem[]} [items]
84
- * @property {Page} page
68
+ * @typedef ProductDetailAttribute
69
+ * @property {string} [value]
70
+ * @property {string} [type]
71
+ * @property {string} [key]
85
72
  */
86
73
  /**
87
- * @typedef CategoryBanner
88
- * @property {Media} landscape
89
- * @property {Media} portrait
74
+ * @typedef ProductDetailGroupedAttribute
75
+ * @property {string} [title]
76
+ * @property {ProductDetailAttribute[]} [details]
90
77
  */
91
78
  /**
92
- * @typedef CategoryItems
93
- * @property {ProductListingAction} action
94
- * @property {CategoryBanner} banners
95
- * @property {Child[]} [childs]
96
- * @property {string} name
97
- * @property {string} slug
98
- * @property {number} uid
79
+ * @typedef ApplicationItemMOQ
80
+ * @property {number} [minimum] - The minimum quantity required for purchase.
81
+ * @property {number} [maximum] - The maximum quantity allowed for purchase.
82
+ * @property {number} [increment_unit] - The minimum quantity increment in which
83
+ * the item can be purchased.
99
84
  */
100
85
  /**
101
- * @typedef CategoryListingResponse
102
- * @property {DepartmentCategoryTree[]} [data]
103
- * @property {DepartmentIdentifier[]} [departments]
86
+ * @typedef Price
87
+ * @property {number} [min] - The minimum price for the product across stores.
88
+ * @property {string} [currency_symbol] - The currency symbol for the currency
89
+ * in which the product is available.
90
+ * @property {string} [currency_code] - The currency code for the currency in
91
+ * which the product is available.
92
+ * @property {number} [max] - The maximum price for the product across stores.
104
93
  */
105
94
  /**
106
- * @typedef CategoryMetaResponse
107
- * @property {Object} [_custom_json]
108
- * @property {ImageUrls} [banners]
109
- * @property {Media} [logo]
110
- * @property {string} [name]
111
- * @property {number} [uid]
95
+ * @typedef ProductListingPrice
96
+ * @property {Price} [effective]
97
+ * @property {Price} [marked]
112
98
  */
113
99
  /**
114
- * @typedef Child
115
- * @property {Object} [_custom_json]
116
- * @property {ProductListingAction} [action]
117
- * @property {ImageUrls} [banners]
118
- * @property {SecondLevelChild[]} [childs]
119
- * @property {string} [name]
120
- * @property {string} [slug]
121
- * @property {number} [uid]
100
+ * @typedef ProductSizesPrice
101
+ * @property {Price} [effective]
102
+ * @property {Price} [marked]
103
+ * @property {Price} [selling]
122
104
  */
123
105
  /**
124
- * @typedef CollectionDetailResponse
125
- * @property {Object} [_custom_json]
126
- * @property {Object} [_schedule]
127
- * @property {boolean} [allow_facets]
128
- * @property {boolean} [allow_sort]
129
- * @property {string} [app_id]
130
- * @property {Object} [badge]
131
- * @property {ImageUrls} [banners]
132
- * @property {Object} [cron]
106
+ * @typedef ProductDetail
107
+ * @property {number} [uid]
108
+ * @property {ProductDetailCustomOrder} [custom_order]
109
+ * @property {ProductCategoryMap} [category_map]
110
+ * @property {NetQuantity} [net_quantity]
111
+ * @property {number} [rating_count]
112
+ * @property {CustomMetaFields[]} [_custom_meta]
113
+ * @property {string[]} [similars]
114
+ * @property {string[]} [tags]
115
+ * @property {ApplicationItemSEO} [seo]
116
+ * @property {string} [image_nature]
117
+ * @property {boolean} [has_variant]
118
+ * @property {string} [item_type]
133
119
  * @property {string} [description]
134
- * @property {boolean} [is_active]
135
- * @property {Media} [logo]
136
- * @property {Object} [meta]
137
- * @property {string} [name]
138
- * @property {number} [priority]
139
- * @property {CollectionQuery[]} [query]
140
- * @property {string} [slug]
141
- * @property {string} [sort_on]
142
- * @property {string[]} [tag]
120
+ * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
121
+ * @property {Media[]} [medias]
122
+ * @property {string} [color]
143
123
  * @property {string} [type]
144
- * @property {string[]} [visible_facets_keys]
124
+ * @property {string} [product_online_date]
125
+ * @property {Object} [_custom_json]
126
+ * @property {string} [item_code]
127
+ * @property {string} [name]
128
+ * @property {ApplicationItemMOQ} [moq]
129
+ * @property {string} [short_description]
130
+ * @property {ProductBrand[]} [categories]
131
+ * @property {Object} [attributes]
132
+ * @property {string} [discount]
133
+ * @property {string[]} [tryouts]
134
+ * @property {string} slug
135
+ * @property {ProductListingAction} [action]
136
+ * @property {number} [rating]
137
+ * @property {boolean} [is_dependent]
138
+ * @property {string[]} [product_group_tag]
139
+ * @property {string[]} [highlights]
140
+ * @property {ProductListingPrice} [price]
141
+ * @property {ProductBrand} [brand]
142
+ * @property {ProductDepartment} [department]
143
+ * @property {string} [teaser_tag]
145
144
  */
146
145
  /**
147
- * @typedef CollectionListingFilter
148
- * @property {CollectionListingFilterTag[]} [tags]
149
- * @property {CollectionListingFilterType[]} [type]
146
+ * @typedef ErrorResponse
147
+ * @property {string} [error]
150
148
  */
151
149
  /**
152
- * @typedef CollectionListingFilterTag
153
- * @property {string} [display]
154
- * @property {boolean} [is_selected]
155
- * @property {string} [name]
150
+ * @typedef Dimension
151
+ * @property {string} unit - The unit of dimension
152
+ * @property {number} height - The height of the product
153
+ * @property {number} length - The length of the product
154
+ * @property {number} width - The width of the product
155
+ * @property {boolean} is_default - Whether the dimension is the default one or not
156
156
  */
157
157
  /**
158
- * @typedef CollectionListingFilterType
159
- * @property {string} [display]
160
- * @property {boolean} [is_selected]
161
- * @property {string} [name]
158
+ * @typedef Weight
159
+ * @property {string} unit - The unit of weight
160
+ * @property {number} shipping - The shipping weight of the product
161
+ * @property {boolean} is_default - Whether the weight is the default one or not
162
162
  */
163
163
  /**
164
- * @typedef CollectionQuery
165
- * @property {string} attribute
166
- * @property {string} op
167
- * @property {Object[]} value
164
+ * @typedef DiscountMeta
165
+ * @property {boolean} timer - Determines whether the discount countdown is
166
+ * visible or not.
167
+ * @property {number} [start_timer_in_minutes] - The time in minutes before the
168
+ * discount ends when the countdown timer should start.
169
+ * @property {string} [start] - The start time of the live discount.
170
+ * @property {string} [end] - The end time of the live discount.
168
171
  */
169
172
  /**
170
- * @typedef ColumnHeader
171
- * @property {boolean} [convertable]
173
+ * @typedef ProductSize
174
+ * @property {number} [quantity]
175
+ * @property {Dimension} [dimension]
176
+ * @property {Weight} [weight]
177
+ * @property {boolean} [is_available]
178
+ * @property {string[]} [seller_identifiers]
172
179
  * @property {string} [value]
180
+ * @property {string} [display]
173
181
  */
174
182
  /**
175
- * @typedef ColumnHeaders
176
- * @property {ColumnHeader} [col_1]
177
- * @property {ColumnHeader} [col_2]
178
- * @property {ColumnHeader} [col_3]
179
- * @property {ColumnHeader} [col_4]
180
- * @property {ColumnHeader} [col_5]
181
- * @property {ColumnHeader} [col_6]
182
- */
183
- /**
184
- * @typedef CompanyDetail
185
- * @property {number} [id]
186
- * @property {string} [name]
187
- */
188
- /**
189
- * @typedef CompanyStore
190
- * @property {string} [business_type]
191
- * @property {string} [company_type]
192
- * @property {string} [name]
193
- * @property {number} [uid]
183
+ * @typedef SizeChartValues
184
+ * @property {string} [col_3]
185
+ * @property {string} [col_6]
186
+ * @property {string} [col_2]
187
+ * @property {string} [col_4]
188
+ * @property {string} [col_1]
189
+ * @property {string} [col_5]
194
190
  */
195
191
  /**
196
- * @typedef CustomMetaFields
197
- * @property {string} key - A key to store a custom field.
198
- * @property {string} value - A value to store in the custom field.
192
+ * @typedef ColumnHeader
193
+ * @property {boolean} [convertable]
194
+ * @property {string} [value]
199
195
  */
200
196
  /**
201
- * @typedef Department
202
- * @property {Media} [logo]
203
- * @property {string} [name]
204
- * @property {number} [priority_order]
205
- * @property {string} [slug]
206
- * @property {number} [uid]
197
+ * @typedef ColumnHeaders
198
+ * @property {ColumnHeader} [col_3]
199
+ * @property {ColumnHeader} [col_6]
200
+ * @property {ColumnHeader} [col_2]
201
+ * @property {ColumnHeader} [col_4]
202
+ * @property {ColumnHeader} [col_1]
203
+ * @property {ColumnHeader} [col_5]
207
204
  */
208
205
  /**
209
- * @typedef DepartmentCategoryTree
210
- * @property {string} department
211
- * @property {CategoryItems[]} [items]
206
+ * @typedef SizeChart
207
+ * @property {string} [unit]
208
+ * @property {string} [image]
209
+ * @property {string} [size_tip]
210
+ * @property {SizeChartValues[]} [sizes]
211
+ * @property {string} [description]
212
+ * @property {string} [title]
213
+ * @property {ColumnHeaders} [headers]
212
214
  */
213
215
  /**
214
- * @typedef DepartmentIdentifier
215
- * @property {string} [slug]
216
- * @property {number} [uid]
216
+ * @typedef ProductSizeStores
217
+ * @property {number} [count]
217
218
  */
218
219
  /**
219
- * @typedef DepartmentResponse
220
- * @property {Department[]} [items]
220
+ * @typedef ProductSizes
221
+ * @property {ProductSize[]} [sizes]
222
+ * @property {ProductSizesPrice} [price]
223
+ * @property {SizeChart} [size_chart]
224
+ * @property {boolean} [sellable]
225
+ * @property {boolean} [multi_size]
226
+ * @property {string} [discount]
227
+ * @property {ProductSizeStores} [stores]
228
+ * @property {DiscountMeta} [discount_meta]
221
229
  */
222
230
  /**
223
- * @typedef DetailsSchemaV3
231
+ * @typedef AttributeDetail
232
+ * @property {string} [logo]
233
+ * @property {string} [description]
234
+ * @property {string} [display]
224
235
  * @property {string} [key]
225
- * @property {string} [type]
226
- * @property {string} [value]
227
- */
228
- /**
229
- * @typedef Dimension
230
- * @property {number} height - The height of the product
231
- * @property {boolean} is_default - Whether the dimension is the default one or not
232
- * @property {number} length - The length of the product
233
- * @property {string} unit - The unit of dimension
234
- * @property {number} width - The width of the product
235
- */
236
- /**
237
- * @typedef DiscountMeta
238
- * @property {string} [end] - The end time of the live discount.
239
- * @property {string} [start] - The start time of the live discount.
240
- * @property {number} [start_timer_in_minutes] - The time in minutes before the
241
- * discount ends when the countdown timer should start.
242
- * @property {boolean} timer - Determines whether the discount countdown is
243
- * visible or not.
244
- */
245
- /**
246
- * @typedef ErrorResponse
247
- * @property {string} [error]
248
236
  */
249
237
  /**
250
- * @typedef FollowerCountResponse
251
- * @property {number} [count]
238
+ * @typedef AttributeMetadata
239
+ * @property {string} [title]
240
+ * @property {AttributeDetail[]} [details]
252
241
  */
253
242
  /**
254
- * @typedef FollowIdsData
255
- * @property {number[]} [brands]
256
- * @property {number[]} [collections]
257
- * @property {number[]} [products]
243
+ * @typedef ProductsComparisonResponse
244
+ * @property {ProductDetail[]} [items]
245
+ * @property {AttributeMetadata[]} [attributes_metadata]
258
246
  */
259
247
  /**
260
- * @typedef FollowIdsResponse
261
- * @property {FollowIdsData} [data]
248
+ * @typedef ProductCompareResponse
249
+ * @property {string} [title]
250
+ * @property {ProductDetail[]} [items]
251
+ * @property {AttributeMetadata[]} [attributes_metadata]
252
+ * @property {string} [subtitle]
262
253
  */
263
254
  /**
264
- * @typedef FollowPostResponse
265
- * @property {string} id
266
- * @property {string} message
255
+ * @typedef ProductFrequentlyComparedSimilarResponse
256
+ * @property {ProductCompareResponse} [similars]
267
257
  */
268
258
  /**
269
- * @typedef GetCollectionDetailNest
270
- * @property {Object} [_custom_json]
271
- * @property {Object} [_schedule]
272
- * @property {ProductListingAction} [action]
273
- * @property {boolean} [allow_facets]
274
- * @property {boolean} [allow_sort]
275
- * @property {string} [app_id]
276
- * @property {Object} [badge]
277
- * @property {ImageUrls} [banners]
278
- * @property {Object} [cron]
279
- * @property {string} [description]
280
- * @property {boolean} [is_active]
281
- * @property {Media} [logo]
282
- * @property {Object} [meta]
259
+ * @typedef ProductVariantItemResponse
260
+ * @property {number} [uid]
261
+ * @property {string} [color_name]
262
+ * @property {string} [color]
263
+ * @property {Media[]} [medias]
264
+ * @property {boolean} [is_available]
265
+ * @property {CustomMetaFields[]} [_custom_meta]
283
266
  * @property {string} [name]
284
- * @property {number} [priority]
285
- * @property {CollectionQuery[]} [query]
267
+ * @property {string} [value]
286
268
  * @property {string} [slug]
287
- * @property {string} [sort_on]
288
- * @property {string[]} [tags]
289
- * @property {string} [type]
290
- * @property {string} [uid]
291
- * @property {string[]} [visible_facets_keys]
292
- */
293
- /**
294
- * @typedef GetCollectionListingResponse
295
- * @property {CollectionListingFilter} [filters]
296
- * @property {GetCollectionDetailNest[]} [items]
297
- * @property {Page} page
269
+ * @property {ProductListingAction} [action]
298
270
  */
299
271
  /**
300
- * @typedef GetFollowListingResponse
301
- * @property {ProductListingDetail[]} items
302
- * @property {Page} page
272
+ * @typedef ProductVariantResponse
273
+ * @property {string} [display_type]
274
+ * @property {string} [header]
275
+ * @property {ProductVariantItemResponse[]} [items]
276
+ * @property {string} [key]
303
277
  */
304
278
  /**
305
- * @typedef HomeListingResponse
306
- * @property {ProductListingDetail[]} [items]
307
- * @property {string} [message]
308
- * @property {Page} page
279
+ * @typedef ProductVariantsResponse
280
+ * @property {ProductVariantResponse[]} [variants]
309
281
  */
310
282
  /**
311
- * @typedef ImageUrls
312
- * @property {Media} [landscape]
313
- * @property {Media} [portrait]
283
+ * @typedef StoreDetail
284
+ * @property {string} [name]
285
+ * @property {string} [city]
286
+ * @property {number} [id]
287
+ * @property {string} [code]
314
288
  */
315
289
  /**
316
- * @typedef LatLong
317
- * @property {number[]} [coordinates]
318
- * @property {string} [type]
290
+ * @typedef ProductStockPrice
291
+ * @property {number} [effective]
292
+ * @property {string} [currency]
293
+ * @property {number} [marked]
319
294
  */
320
295
  /**
321
- * @typedef MarketPlaceSttributesSchemaV3
322
- * @property {DetailsSchemaV3[]} [details]
323
- * @property {string} [title]
296
+ * @typedef CompanyDetail
297
+ * @property {string} [name]
298
+ * @property {number} [id]
324
299
  */
325
300
  /**
326
- * @typedef Media
327
- * @property {string} [alt]
328
- * @property {Meta} [meta]
329
- * @property {string} [type]
330
- * @property {string} [url]
301
+ * @typedef Seller
302
+ * @property {number} [uid]
303
+ * @property {string} [name]
304
+ * @property {number} [count]
331
305
  */
332
306
  /**
333
- * @typedef Meta
334
- * @property {string} [source]
307
+ * @typedef ProductStockStatusItem
308
+ * @property {string} [uid]
309
+ * @property {number} [quantity]
310
+ * @property {StoreDetail} [store]
311
+ * @property {string} [size]
312
+ * @property {ProductStockPrice} [price]
313
+ * @property {CompanyDetail} [company]
314
+ * @property {number} [item_id]
315
+ * @property {Seller} [seller]
316
+ * @property {Object} [identifier]
335
317
  */
336
318
  /**
337
- * @typedef NetQuantity
338
- * @property {Object} [unit] - The unit of measurement used for the net quantity
339
- * of the product.
340
- * @property {number} [value] - The value of the net quantity of the product.
319
+ * @typedef ProductStockStatusResponse
320
+ * @property {ProductStockStatusItem[]} [items]
341
321
  */
342
322
  /**
343
323
  * @typedef Page
344
- * @property {number} [current]
345
- * @property {boolean} [has_next]
346
- * @property {boolean} [has_previous]
347
324
  * @property {number} [item_total]
348
325
  * @property {string} [next_id]
349
- * @property {number} [size]
326
+ * @property {boolean} [has_previous]
327
+ * @property {boolean} [has_next]
328
+ * @property {number} [current]
350
329
  * @property {string} type
330
+ * @property {number} [size]
351
331
  */
352
332
  /**
353
- * @typedef Price
354
- * @property {string} [currency_code] - The currency code for the currency in
355
- * which the product is available.
356
- * @property {string} [currency_symbol] - The currency symbol for the currency
357
- * in which the product is available.
358
- * @property {number} [max] - The maximum price for the product across stores.
359
- * @property {number} [min] - The minimum price for the product across stores.
360
- */
361
- /**
362
- * @typedef ProductBrand
363
- * @property {ProductListingAction} [action]
364
- * @property {string} [description]
365
- * @property {Media} [logo]
366
- * @property {string} [name]
367
- * @property {number} [uid]
333
+ * @typedef ProductStockPolling
334
+ * @property {ProductStockStatusItem[]} [items]
335
+ * @property {Page} page
368
336
  */
369
337
  /**
370
- * @typedef ProductBundle
371
- * @property {ProductGroupingModel[]} [items]
338
+ * @typedef ProductVariantListingResponse
339
+ * @property {string} [header]
340
+ * @property {ProductVariantItemResponse[]} [items]
341
+ * @property {number} [total]
342
+ * @property {string} [key]
343
+ * @property {string} [display_type]
372
344
  */
373
345
  /**
374
- * @typedef ProductCategoryMap
375
- * @property {ProductBrand} [l1]
376
- * @property {ProductBrand} [l2]
377
- * @property {ProductBrand} [l3]
378
- */
379
- /**
380
- * @typedef ProductCompareResponse
381
- * @property {AttributeMetadata[]} [attributes_metadata]
382
- * @property {ProductDetail[]} [items]
383
- * @property {string} [subtitle]
384
- * @property {string} [title]
385
- */
386
- /**
387
- * @typedef ProductDepartment
388
- * @property {Media} [logo]
389
- * @property {string} [name]
390
- * @property {string} [slug]
346
+ * @typedef ProductListingDetail
391
347
  * @property {number} [uid]
392
- */
393
- /**
394
- * @typedef ProductDetail
395
- * @property {Object} [_custom_json]
396
- * @property {CustomMetaFields[]} [_custom_meta]
397
- * @property {ProductListingAction} [action]
398
- * @property {Object} [attributes]
399
- * @property {ProductBrand} [brand]
400
- * @property {ProductBrand[]} [categories]
401
- * @property {ProductCategoryMap} [category_map]
402
- * @property {string} [color]
403
348
  * @property {ProductDetailCustomOrder} [custom_order]
404
- * @property {ProductDepartment} [department]
405
- * @property {string} [description]
406
- * @property {string} [discount]
407
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
408
- * @property {boolean} [has_variant]
409
- * @property {string[]} [highlights]
349
+ * @property {string[]} [sizes]
350
+ * @property {ProductCategoryMap} [category_map]
351
+ * @property {NetQuantity} [net_quantity]
352
+ * @property {number} [rating_count]
353
+ * @property {CustomMetaFields[]} [_custom_meta]
354
+ * @property {string[]} [similars]
355
+ * @property {string[]} [tags]
356
+ * @property {ApplicationItemSEO} [seo]
410
357
  * @property {string} [image_nature]
411
- * @property {boolean} [is_dependent]
412
- * @property {string} [item_code]
358
+ * @property {boolean} [has_variant]
413
359
  * @property {string} [item_type]
360
+ * @property {string} [description]
361
+ * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
414
362
  * @property {Media[]} [medias]
415
- * @property {ApplicationItemMOQ} [moq]
416
- * @property {string} [name]
417
- * @property {NetQuantity} [net_quantity]
418
- * @property {ProductListingPrice} [price]
419
- * @property {string[]} [product_group_tag]
363
+ * @property {string} [color]
364
+ * @property {string} [type]
420
365
  * @property {string} [product_online_date]
421
- * @property {number} [rating]
422
- * @property {number} [rating_count]
423
- * @property {ApplicationItemSEO} [seo]
366
+ * @property {Object} [_custom_json]
367
+ * @property {string} [item_code]
368
+ * @property {string} [name]
369
+ * @property {ApplicationItemMOQ} [moq]
424
370
  * @property {string} [short_description]
425
- * @property {string[]} [similars]
371
+ * @property {ProductBrand[]} [categories]
372
+ * @property {boolean} [sellable]
373
+ * @property {Object} [attributes]
374
+ * @property {ProductVariantListingResponse[]} [variants]
375
+ * @property {string} [discount]
376
+ * @property {string[]} [tryouts]
377
+ * @property {string[]} [identifiers]
426
378
  * @property {string} slug
427
- * @property {string[]} [tags]
379
+ * @property {ProductListingAction} [action]
380
+ * @property {number} [rating]
381
+ * @property {boolean} [is_dependent]
382
+ * @property {string[]} [product_group_tag]
383
+ * @property {string[]} [highlights]
384
+ * @property {ProductListingPrice} [price]
385
+ * @property {ProductBrand} [brand]
428
386
  * @property {string} [teaser_tag]
429
- * @property {string[]} [tryouts]
430
- * @property {string} [type]
431
- * @property {number} [uid]
432
387
  */
433
388
  /**
434
- * @typedef ProductDetailAttribute
435
- * @property {string} [key]
436
- * @property {string} [type]
389
+ * @typedef ProductFiltersValue
390
+ * @property {number} [min]
391
+ * @property {string} [display_format]
392
+ * @property {number} [selected_max]
437
393
  * @property {string} [value]
394
+ * @property {string} [query_format]
395
+ * @property {string} [currency_symbol]
396
+ * @property {number} [selected_min]
397
+ * @property {string} [currency_code]
398
+ * @property {boolean} is_selected
399
+ * @property {string} display
400
+ * @property {number} [count]
401
+ * @property {number} [max]
438
402
  */
439
403
  /**
440
- * @typedef ProductDetailCustomOrder
441
- * @property {boolean} [is_custom_order]
442
- * @property {number} [manufacturing_time]
443
- * @property {string} [manufacturing_time_unit]
444
- */
445
- /**
446
- * @typedef ProductDetailGroupedAttribute
447
- * @property {ProductDetailAttribute[]} [details]
448
- * @property {string} [title]
449
- */
450
- /**
451
- * @typedef ProductDetails
452
- * @property {Object} [attributes] - A dictionary of product attributes
453
- * @property {number} [brand_uid] - The unique ID of the product's brand
454
- * @property {Object} [country_of_origin] - The country of origin for the product
455
- * @property {Object} [description] - The long description of the product
456
- * @property {Object} [grouped_attributes] - A dictionary of grouped product attributes
457
- * @property {boolean} [has_variant] - Whether or not the product has a variant
458
- * @property {Object[]} [highlights] - A list of highlights for the product
459
- * @property {number} [hsn_code] - The HSN code of the product
460
- * @property {Object} [identifier] - A dictionary of product identifiers
461
- * @property {Object} [image_nature] - The nature of the product's images
462
- * @property {Object[]} [images] - A list of image URLs for the product
463
- * @property {boolean} [is_set] - Whether or not the product is a set of items
464
- * @property {Object} [item_code] - The item code of the product
465
- * @property {Object[]} [media] - A list of media objects for the product
466
- * @property {Object} [name] - The name of the product
467
- * @property {boolean} [out_of_stock] - Whether or not the product is out of stock
468
- * @property {number} [rating] - The rating of the product
469
- * @property {number} [rating_count] - The number of ratings the product has received
470
- * @property {Object} [short_description] - The short description of the product
471
- * @property {Object} [slug] - The slug of the product
472
- * @property {Object} [template_tag] - The template tag of the product
404
+ * @typedef ProductFiltersKey
405
+ * @property {string} [logo]
406
+ * @property {string} name
407
+ * @property {string} [kind]
408
+ * @property {string} display
473
409
  */
474
410
  /**
475
411
  * @typedef ProductFilters
476
- * @property {ProductFiltersKey} key
477
412
  * @property {ProductFiltersValue[]} values
413
+ * @property {ProductFiltersKey} key
478
414
  */
479
415
  /**
480
- * @typedef ProductFiltersKey
481
- * @property {string} display
482
- * @property {string} [kind]
416
+ * @typedef ProductSortOn
483
417
  * @property {string} [logo]
484
- * @property {string} name
418
+ * @property {boolean} [is_selected]
419
+ * @property {string} [name]
420
+ * @property {string} [value]
421
+ * @property {string} [display]
485
422
  */
486
423
  /**
487
- * @typedef ProductFiltersValue
488
- * @property {number} [count]
489
- * @property {string} [currency_code]
490
- * @property {string} [currency_symbol]
491
- * @property {string} display
492
- * @property {string} [display_format]
493
- * @property {boolean} is_selected
494
- * @property {number} [max]
495
- * @property {number} [min]
496
- * @property {string} [query_format]
497
- * @property {number} [selected_max]
498
- * @property {number} [selected_min]
499
- * @property {string} [value]
424
+ * @typedef ProductListingResponse
425
+ * @property {ProductListingDetail[]} [items]
426
+ * @property {ProductFilters[]} [filters]
427
+ * @property {Page} page
428
+ * @property {ProductSortOn[]} [sort_on]
500
429
  */
501
430
  /**
502
- * @typedef ProductFrequentlyComparedSimilarResponse
503
- * @property {ProductCompareResponse} [similars]
431
+ * @typedef ImageUrls
432
+ * @property {Media} [portrait]
433
+ * @property {Media} [landscape]
504
434
  */
505
435
  /**
506
- * @typedef ProductGroupingModel
507
- * @property {Object} [_id]
508
- * @property {Object} [choice] - The choice of the product grouping.
509
- * @property {number} [company_id] - The ID of the company that owns the product grouping.
510
- * @property {UserDetail} [created_by] - User details of the creator of the document
511
- * @property {string} created_on - Timestamp of the creation of the document
512
- * @property {boolean} [is_active] - Whether the product grouping is active.
513
- * @property {string} [logo] - The URL for the logo of the product grouping.
514
- * @property {Object} [meta] - A dictionary containing metadata information.
515
- * @property {UserDetail} [modified_by] - User details of the last modifier of
516
- * the document
517
- * @property {string} modified_on - Timestamp of the last modification of the document
518
- * @property {Object} name - The name of the product grouping.
519
- * @property {Object[]} [page_visibility] - A list of page visibilities of the
520
- * product grouping.
521
- * @property {ProductInGroup[]} products - A list of products in the grouping.
522
- * @property {boolean} [same_store_assignment] - Whether the products are
523
- * assigned to the same store.
524
- * @property {Object} [slug] - The unique identifier for the product grouping.
525
- * @property {UserDetail} [verified_by] - User details of the verifier of the
526
- * document, if applicable
527
- * @property {string} [verified_on] - Timestamp of when the document was
528
- * verified, if applicable
436
+ * @typedef BrandItem
437
+ * @property {number} [uid]
438
+ * @property {Media} [logo]
439
+ * @property {string} [description]
440
+ * @property {ImageUrls} [banners]
441
+ * @property {string[]} [departments]
442
+ * @property {string} [discount]
443
+ * @property {string} [name]
444
+ * @property {string} [slug]
445
+ * @property {ProductListingAction} [action]
529
446
  */
530
447
  /**
531
- * @typedef ProductGroupPrice
532
- * @property {Object} [currency] - The currency code for the prices.
533
- * @property {number} [max_effective] - The maximum effective price of the product group.
534
- * @property {number} [max_marked] - The maximum marked price of the product group.
535
- * @property {number} [min_effective] - The minimum effective price of the product group.
536
- * @property {number} [min_marked] - The minimum marked price of the product group.
448
+ * @typedef BrandListingResponse
449
+ * @property {BrandItem[]} [items]
450
+ * @property {Page} page
537
451
  */
538
452
  /**
539
- * @typedef ProductInGroup
540
- * @property {boolean} [allow_remove] - A flag indicating whether the product
541
- * can be removed from the cart.
542
- * @property {boolean} [auto_add_to_cart] - A flag indicating whether the
543
- * product should be automatically added to the cart.
544
- * @property {boolean} [auto_select] - A flag indicating whether the product
545
- * should be automatically selected.
546
- * @property {number} max_quantity - The maximum quantity of the product that
547
- * can be added to the cart.
548
- * @property {number} [min_quantity] - The minimum quantity of the product that
549
- * can be added to the cart.
550
- * @property {ProductGroupPrice} [price] - The price details for the product group.
551
- * @property {ProductDetails} [product_details] - The details of the product.
552
- * @property {number} product_uid - The unique ID of the product in the group.
553
- * @property {Size[]} [sizes] - The available sizes for the product.
453
+ * @typedef BrandDetailResponse
454
+ * @property {Media} [logo]
455
+ * @property {number} [uid]
456
+ * @property {string} [description]
457
+ * @property {ImageUrls} [banners]
458
+ * @property {Object} [_custom_json]
459
+ * @property {string} [name]
554
460
  */
555
461
  /**
556
- * @typedef ProductListingAction
557
- * @property {ProductListingActionPage} [page]
558
- * @property {string} [type]
462
+ * @typedef CategoryBanner
463
+ * @property {Media} portrait
464
+ * @property {Media} landscape
559
465
  */
560
466
  /**
561
- * @typedef ProductListingActionPage
562
- * @property {Object} [params]
563
- * @property {Object} [query]
564
- * @property {string} [type]
467
+ * @typedef ThirdLevelChild
468
+ * @property {number} [uid]
469
+ * @property {ImageUrls} [banners]
470
+ * @property {Object[]} [childs]
471
+ * @property {Object} [_custom_json]
472
+ * @property {string} [name]
473
+ * @property {string} [slug]
474
+ * @property {ProductListingAction} [action]
565
475
  */
566
476
  /**
567
- * @typedef ProductListingDetail
477
+ * @typedef SecondLevelChild
478
+ * @property {number} [uid]
479
+ * @property {ImageUrls} [banners]
480
+ * @property {ThirdLevelChild[]} [childs]
568
481
  * @property {Object} [_custom_json]
569
- * @property {CustomMetaFields[]} [_custom_meta]
482
+ * @property {string} [name]
483
+ * @property {string} [slug]
570
484
  * @property {ProductListingAction} [action]
571
- * @property {Object} [attributes]
572
- * @property {ProductBrand} [brand]
573
- * @property {ProductBrand[]} [categories]
574
- * @property {ProductCategoryMap} [category_map]
575
- * @property {string} [color]
576
- * @property {ProductDetailCustomOrder} [custom_order]
577
- * @property {string} [description]
578
- * @property {string} [discount]
579
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
580
- * @property {boolean} [has_variant]
581
- * @property {string[]} [highlights]
582
- * @property {string[]} [identifiers]
583
- * @property {string} [image_nature]
584
- * @property {boolean} [is_dependent]
585
- * @property {string} [item_code]
586
- * @property {string} [item_type]
587
- * @property {Media[]} [medias]
588
- * @property {ApplicationItemMOQ} [moq]
485
+ */
486
+ /**
487
+ * @typedef Child
488
+ * @property {number} [uid]
489
+ * @property {ImageUrls} [banners]
490
+ * @property {SecondLevelChild[]} [childs]
491
+ * @property {Object} [_custom_json]
589
492
  * @property {string} [name]
590
- * @property {NetQuantity} [net_quantity]
591
- * @property {ProductListingPrice} [price]
592
- * @property {string[]} [product_group_tag]
593
- * @property {string} [product_online_date]
594
- * @property {number} [rating]
595
- * @property {number} [rating_count]
596
- * @property {boolean} [sellable]
597
- * @property {ApplicationItemSEO} [seo]
598
- * @property {string} [short_description]
599
- * @property {string[]} [similars]
600
- * @property {string[]} [sizes]
493
+ * @property {string} [slug]
494
+ * @property {ProductListingAction} [action]
495
+ */
496
+ /**
497
+ * @typedef CategoryItems
498
+ * @property {number} uid
499
+ * @property {CategoryBanner} banners
500
+ * @property {Child[]} [childs]
501
+ * @property {string} name
601
502
  * @property {string} slug
602
- * @property {string[]} [tags]
603
- * @property {string} [teaser_tag]
604
- * @property {string[]} [tryouts]
605
- * @property {string} [type]
503
+ * @property {ProductListingAction} action
504
+ */
505
+ /**
506
+ * @typedef DepartmentCategoryTree
507
+ * @property {CategoryItems[]} [items]
508
+ * @property {string} department
509
+ */
510
+ /**
511
+ * @typedef DepartmentIdentifier
606
512
  * @property {number} [uid]
607
- * @property {ProductVariantListingResponse[]} [variants]
513
+ * @property {string} [slug]
608
514
  */
609
515
  /**
610
- * @typedef ProductListingPrice
611
- * @property {Price} [effective]
612
- * @property {Price} [marked]
516
+ * @typedef CategoryListingResponse
517
+ * @property {DepartmentCategoryTree[]} [data]
518
+ * @property {DepartmentIdentifier[]} [departments]
613
519
  */
614
520
  /**
615
- * @typedef ProductListingResponse
616
- * @property {ProductFilters[]} [filters]
521
+ * @typedef CategoryMetaResponse
522
+ * @property {Media} [logo]
523
+ * @property {number} [uid]
524
+ * @property {ImageUrls} [banners]
525
+ * @property {Object} [_custom_json]
526
+ * @property {string} [name]
527
+ */
528
+ /**
529
+ * @typedef HomeListingResponse
617
530
  * @property {ProductListingDetail[]} [items]
618
531
  * @property {Page} page
619
- * @property {ProductSortOn[]} [sort_on]
532
+ * @property {string} [message]
620
533
  */
621
534
  /**
622
- * @typedef ProductsComparisonResponse
623
- * @property {AttributeMetadata[]} [attributes_metadata]
624
- * @property {ProductDetail[]} [items]
535
+ * @typedef Department
536
+ * @property {number} [uid]
537
+ * @property {Media} [logo]
538
+ * @property {number} [priority_order]
539
+ * @property {string} [name]
540
+ * @property {string} [slug]
625
541
  */
626
542
  /**
627
- * @typedef ProductSetDistributionSizeV3
628
- * @property {number} [pieces]
629
- * @property {string} [size]
543
+ * @typedef DepartmentResponse
544
+ * @property {Department[]} [items]
630
545
  */
631
546
  /**
632
- * @typedef ProductSetDistributionV3
633
- * @property {ProductSetDistributionSizeV3[]} [sizes]
547
+ * @typedef AutocompleteItem
548
+ * @property {Media} [logo]
549
+ * @property {string} [display]
550
+ * @property {string} [type]
551
+ * @property {Object} [_custom_json]
552
+ * @property {ProductListingAction} [action]
634
553
  */
635
554
  /**
636
- * @typedef ProductSetV3
637
- * @property {number} [quantity]
638
- * @property {ProductSetDistributionV3} [size_distribution]
555
+ * @typedef AutoCompleteResponse
556
+ * @property {AutocompleteItem[]} [items]
639
557
  */
640
558
  /**
641
- * @typedef ProductSize
642
- * @property {Dimension} [dimension]
643
- * @property {string} [display]
644
- * @property {boolean} [is_available]
645
- * @property {number} [quantity]
646
- * @property {string[]} [seller_identifiers]
647
- * @property {string} [value]
648
- * @property {Weight} [weight]
559
+ * @typedef CollectionQuery
560
+ * @property {string} op
561
+ * @property {Object[]} value
562
+ * @property {string} attribute
649
563
  */
650
564
  /**
651
- * @typedef ProductSizePriceResponseV3
652
- * @property {ArticleAssignmentV3} [article_assignment]
653
- * @property {string} [article_id]
654
- * @property {PromiseSchema} [delivery_promise]
655
- * @property {string} [discount]
656
- * @property {DiscountMeta} [discount_meta]
657
- * @property {SellerGroupAttributes[]} [grouped_attributes]
658
- * @property {boolean} [is_cod]
659
- * @property {boolean} [is_gift]
660
- * @property {string} [item_type]
661
- * @property {number[]} [long_lat]
662
- * @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes]
663
- * @property {number} [pincode]
664
- * @property {ProductStockPriceV3} [price]
665
- * @property {ProductStockPriceV3} [price_per_piece]
666
- * @property {ProductStockUnitPriceV3} [price_per_unit]
667
- * @property {number} [quantity]
668
- * @property {ReturnConfigSchemaV3} [return_config]
669
- * @property {SellerV3} [seller]
670
- * @property {number} [seller_count]
671
- * @property {ProductSetV3} [set]
672
- * @property {string} [special_badge]
673
- * @property {StoreV3} [store]
674
- * @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing]
565
+ * @typedef GetCollectionDetailNest
566
+ * @property {boolean} [is_active]
567
+ * @property {string} [uid]
568
+ * @property {string} [sort_on]
569
+ * @property {Object} [meta]
570
+ * @property {ImageUrls} [banners]
571
+ * @property {Object} [cron]
572
+ * @property {Object} [_schedule]
573
+ * @property {CollectionQuery[]} [query]
574
+ * @property {string} [description]
575
+ * @property {string} [type]
576
+ * @property {Object} [_custom_json]
577
+ * @property {string} [name]
578
+ * @property {boolean} [allow_sort]
579
+ * @property {string[]} [visible_facets_keys]
580
+ * @property {Object} [badge]
581
+ * @property {string} [slug]
582
+ * @property {ProductListingAction} [action]
583
+ * @property {boolean} [allow_facets]
584
+ * @property {Media} [logo]
585
+ * @property {number} [priority]
586
+ * @property {string[]} [tag]
587
+ * @property {string} [app_id]
675
588
  */
676
589
  /**
677
- * @typedef ProductSizes
678
- * @property {string} [discount]
679
- * @property {DiscountMeta} [discount_meta]
680
- * @property {boolean} [multi_size]
681
- * @property {ProductSizesPrice} [price]
682
- * @property {boolean} [sellable]
683
- * @property {SizeChart} [size_chart]
684
- * @property {ProductSize[]} [sizes]
685
- * @property {ProductSizeStores} [stores]
590
+ * @typedef CollectionListingFilterTag
591
+ * @property {string} [name]
592
+ * @property {boolean} [is_selected]
593
+ * @property {string} [display]
686
594
  */
687
595
  /**
688
- * @typedef ProductSizeSellerFilterSchemaV3
689
- * @property {boolean} [is_selected]
596
+ * @typedef CollectionListingFilterType
690
597
  * @property {string} [name]
691
- * @property {string} [value]
598
+ * @property {boolean} [is_selected]
599
+ * @property {string} [display]
692
600
  */
693
601
  /**
694
- * @typedef ProductSizeSellersResponseV3
695
- * @property {ProductSizePriceResponseV3[]} [items]
602
+ * @typedef CollectionListingFilter
603
+ * @property {CollectionListingFilterTag[]} [tags]
604
+ * @property {CollectionListingFilterType[]} [type]
605
+ */
606
+ /**
607
+ * @typedef GetCollectionListingResponse
608
+ * @property {GetCollectionDetailNest[]} [items]
609
+ * @property {CollectionListingFilter} [filters]
696
610
  * @property {Page} page
697
- * @property {ProductSizeSellerFilterSchemaV3[]} [sort_on]
698
611
  */
699
612
  /**
700
- * @typedef ProductSizesPrice
701
- * @property {Price} [effective]
702
- * @property {Price} [marked]
703
- * @property {Price} [selling]
613
+ * @typedef CollectionDetailResponse
614
+ * @property {boolean} [is_active]
615
+ * @property {string} [sort_on]
616
+ * @property {Object} [meta]
617
+ * @property {ImageUrls} [banners]
618
+ * @property {Object} [cron]
619
+ * @property {Object} [_schedule]
620
+ * @property {CollectionQuery[]} [query]
621
+ * @property {string} [description]
622
+ * @property {string} [type]
623
+ * @property {Object} [_custom_json]
624
+ * @property {string} [name]
625
+ * @property {boolean} [allow_sort]
626
+ * @property {string[]} [visible_facets_keys]
627
+ * @property {Object} [badge]
628
+ * @property {string} [slug]
629
+ * @property {boolean} [allow_facets]
630
+ * @property {Media} [logo]
631
+ * @property {number} [priority]
632
+ * @property {string[]} [tag]
633
+ * @property {string} [app_id]
704
634
  */
705
635
  /**
706
- * @typedef ProductSizeStores
707
- * @property {number} [count]
636
+ * @typedef GetFollowListingResponse
637
+ * @property {ProductListingDetail[]} items
638
+ * @property {Page} page
708
639
  */
709
640
  /**
710
- * @typedef ProductSortOn
711
- * @property {string} [display]
712
- * @property {boolean} [is_selected]
713
- * @property {string} [logo]
714
- * @property {string} [name]
715
- * @property {string} [value]
641
+ * @typedef FollowPostResponse
642
+ * @property {string} message
643
+ * @property {string} id
716
644
  */
717
645
  /**
718
- * @typedef ProductStockPolling
719
- * @property {ProductStockStatusItem[]} [items]
720
- * @property {Page} page
646
+ * @typedef FollowerCountResponse
647
+ * @property {number} [count]
721
648
  */
722
649
  /**
723
- * @typedef ProductStockPrice
724
- * @property {string} [currency]
725
- * @property {number} [effective]
726
- * @property {number} [marked]
650
+ * @typedef FollowIdsData
651
+ * @property {number[]} [products]
652
+ * @property {number[]} [collections]
653
+ * @property {number[]} [brands]
727
654
  */
728
655
  /**
729
- * @typedef ProductStockPriceV3
730
- * @property {string} [currency_code] - The currency code for which the product
731
- * is available
732
- * @property {string} [currency_symbol] - The currency symbol for the currency
733
- * in which the product is available.
734
- * @property {number} [effective] - The effective or final price for the product
735
- * at the given pincode.
736
- * @property {number} [marked] - The marked price of the product.
737
- * @property {number} [selling] - The selling price of the product.
656
+ * @typedef FollowIdsResponse
657
+ * @property {FollowIdsData} [data]
738
658
  */
739
659
  /**
740
- * @typedef ProductStockStatusItem
741
- * @property {CompanyDetail} [company]
742
- * @property {Object} [identifier]
743
- * @property {number} [item_id]
744
- * @property {ProductStockPrice} [price]
745
- * @property {number} [quantity]
746
- * @property {Seller} [seller]
747
- * @property {string} [size]
748
- * @property {StoreDetail} [store]
749
- * @property {string} [uid]
750
- */
751
- /**
752
- * @typedef ProductStockStatusResponse
753
- * @property {ProductStockStatusItem[]} [items]
754
- */
755
- /**
756
- * @typedef ProductStockUnitPriceV3
757
- * @property {string} [currency_code]
758
- * @property {string} [currency_symbol]
759
- * @property {number} [price]
760
- * @property {string} [unit]
660
+ * @typedef LatLong
661
+ * @property {number[]} [coordinates]
662
+ * @property {string} [type]
761
663
  */
762
664
  /**
763
- * @typedef ProductVariantItemResponse
764
- * @property {CustomMetaFields[]} [_custom_meta]
765
- * @property {ProductListingAction} [action]
766
- * @property {string} [color]
767
- * @property {string} [color_name]
768
- * @property {boolean} [is_available]
769
- * @property {Media[]} [medias]
770
- * @property {string} [name]
771
- * @property {string} [slug]
665
+ * @typedef Store
772
666
  * @property {number} [uid]
773
- * @property {string} [value]
774
- */
775
- /**
776
- * @typedef ProductVariantListingResponse
777
- * @property {string} [display_type]
778
- * @property {string} [header]
779
- * @property {ProductVariantItemResponse[]} [items]
780
- * @property {string} [key]
781
- * @property {number} [total]
782
- */
783
- /**
784
- * @typedef ProductVariantResponse
785
- * @property {string} [display_type]
786
- * @property {string} [header]
787
- * @property {ProductVariantItemResponse[]} [items]
788
- * @property {string} [key]
789
- */
790
- /**
791
- * @typedef ProductVariantsResponse
792
- * @property {ProductVariantResponse[]} [variants]
793
- */
794
- /**
795
- * @typedef PromiseSchema
796
- * @property {string} [max]
797
- * @property {string} [min]
667
+ * @property {string} [store_email]
668
+ * @property {string} [state]
669
+ * @property {string} [country]
670
+ * @property {number} [pincode]
671
+ * @property {string} [city]
672
+ * @property {string} [address]
673
+ * @property {string} [store_code]
674
+ * @property {LatLong} [lat_long]
675
+ * @property {string} [name]
676
+ * @property {string[]} [tags]
798
677
  */
799
678
  /**
800
- * @typedef ReturnConfigSchemaV3
801
- * @property {boolean} [returnable]
802
- * @property {number} [time]
803
- * @property {string} [unit]
679
+ * @typedef StoreListingResponse
680
+ * @property {Store[]} items
681
+ * @property {Page} page
804
682
  */
805
683
  /**
806
- * @typedef SecondLevelChild
807
- * @property {Object} [_custom_json]
808
- * @property {ProductListingAction} [action]
809
- * @property {ImageUrls} [banners]
810
- * @property {ThirdLevelChild[]} [childs]
684
+ * @typedef StoreDepartments
685
+ * @property {number} [uid]
686
+ * @property {Object} [logo]
687
+ * @property {number} [priority_order]
811
688
  * @property {string} [name]
812
689
  * @property {string} [slug]
813
- * @property {number} [uid]
814
690
  */
815
691
  /**
816
- * @typedef Seller
817
- * @property {number} [count]
818
- * @property {string} [name]
692
+ * @typedef CompanyStore
819
693
  * @property {number} [uid]
820
- */
821
- /**
822
- * @typedef SellerGroupAttributes
823
- * @property {DetailsSchemaV3[]} [details]
824
- * @property {string} [title]
694
+ * @property {string} [name]
695
+ * @property {string} [company_type]
696
+ * @property {string} [business_type]
825
697
  */
826
698
  /**
827
699
  * @typedef SellerPhoneNumber
@@ -829,1312 +701,1140 @@ export = CatalogApplicationModel;
829
701
  * @property {string} number
830
702
  */
831
703
  /**
832
- * @typedef SellerV3
833
- * @property {number} [count]
834
- * @property {string} [name]
835
- * @property {number} [uid]
836
- */
837
- /**
838
- * @typedef Size
839
- * @property {Object} [display] - The display string for the size
840
- * @property {boolean} [is_available] - Whether or not this size is available
841
- * @property {number} [quantity] - The quantity of this size available
842
- * @property {Object} [value] - The value of the size
843
- */
844
- /**
845
- * @typedef SizeChart
846
- * @property {string} [description]
847
- * @property {ColumnHeaders} [headers]
848
- * @property {string} [image]
849
- * @property {string} [size_tip]
850
- * @property {SizeChartValues[]} [sizes]
851
- * @property {string} [title]
852
- * @property {string} [unit]
853
- */
854
- /**
855
- * @typedef SizeChartValues
856
- * @property {string} [col_1]
857
- * @property {string} [col_2]
858
- * @property {string} [col_3]
859
- * @property {string} [col_4]
860
- * @property {string} [col_5]
861
- * @property {string} [col_6]
862
- */
863
- /**
864
- * @typedef Store
865
- * @property {string} [address]
866
- * @property {string} [city]
867
- * @property {string} [country]
868
- * @property {LatLong} [lat_long]
704
+ * @typedef StoreManagerSerializer
869
705
  * @property {string} [name]
870
- * @property {number} [pincode]
871
- * @property {string} [state]
872
- * @property {string} [store_code]
873
- * @property {string} [store_email]
874
- * @property {string[]} [tags]
875
- * @property {number} [uid]
706
+ * @property {string} [email]
707
+ * @property {SellerPhoneNumber} [mobile_no]
876
708
  */
877
709
  /**
878
710
  * @typedef StoreAddressSerializer
879
- * @property {string} [address1]
880
- * @property {string} [address2]
881
- * @property {string} [city]
711
+ * @property {number} [latitude]
712
+ * @property {string} [state]
882
713
  * @property {string} [country]
883
714
  * @property {string} [landmark]
884
- * @property {number} [latitude]
885
- * @property {number} [longitude]
715
+ * @property {string} [address1]
886
716
  * @property {number} [pincode]
887
- * @property {string} [state]
888
- */
889
- /**
890
- * @typedef StoreDepartments
891
- * @property {Object} [logo]
892
- * @property {string} [name]
893
- * @property {number} [priority_order]
894
- * @property {string} [slug]
895
- * @property {number} [uid]
896
- */
897
- /**
898
- * @typedef StoreDetail
899
717
  * @property {string} [city]
900
- * @property {string} [code]
901
- * @property {number} [id]
902
- * @property {string} [name]
718
+ * @property {number} [longitude]
719
+ * @property {string} [address2]
903
720
  */
904
721
  /**
905
- * @typedef StoreDetails
906
- * @property {Object} [_custom_json]
907
- * @property {StoreAddressSerializer} [address]
908
- * @property {CompanyStore} [company]
909
- * @property {SellerPhoneNumber[]} [contact_numbers]
722
+ * @typedef AppStore
723
+ * @property {number} [uid]
910
724
  * @property {StoreDepartments[]} [departments]
725
+ * @property {CompanyStore} [company]
911
726
  * @property {StoreManagerSerializer} [manager]
912
- * @property {string} [name]
913
727
  * @property {string} [store_code]
914
- * @property {StoreTiming[]} [timing]
915
- * @property {number} [uid]
728
+ * @property {StoreAddressSerializer} [address]
729
+ * @property {string} [name]
730
+ * @property {SellerPhoneNumber[]} [contact_numbers]
916
731
  */
917
732
  /**
918
- * @typedef StoreListingResponse
919
- * @property {Store[]} items
920
- * @property {Page} page
733
+ * @typedef ApplicationStoreListing
734
+ * @property {Object[]} [filters]
735
+ * @property {AppStore[]} [items]
736
+ * @property {Page} [page]
921
737
  */
922
738
  /**
923
- * @typedef StoreManagerSerializer
924
- * @property {string} [email]
925
- * @property {SellerPhoneNumber} [mobile_no]
926
- * @property {string} [name]
739
+ * @typedef Time
740
+ * @property {number} [hour]
741
+ * @property {number} [minute]
927
742
  */
928
743
  /**
929
744
  * @typedef StoreTiming
930
- * @property {Time} [closing]
931
745
  * @property {boolean} [open]
932
- * @property {Time} [opening]
746
+ * @property {Time} [closing]
933
747
  * @property {string} [weekday]
748
+ * @property {Time} [opening]
934
749
  */
935
750
  /**
936
- * @typedef StoreV3
937
- * @property {number} [count]
938
- * @property {string} [name]
751
+ * @typedef StoreDetails
939
752
  * @property {number} [uid]
940
- */
941
- /**
942
- * @typedef StrategyWiseListingSchemaV3
943
- * @property {number} [distance]
944
- * @property {number} [pincode]
945
- * @property {number} [quantity]
946
- * @property {number} [tat]
947
- */
948
- /**
949
- * @typedef ThirdLevelChild
753
+ * @property {StoreDepartments[]} [departments]
754
+ * @property {CompanyStore} [company]
755
+ * @property {StoreManagerSerializer} [manager]
756
+ * @property {string} [store_code]
757
+ * @property {StoreTiming[]} [timing]
758
+ * @property {StoreAddressSerializer} [address]
950
759
  * @property {Object} [_custom_json]
951
- * @property {ProductListingAction} [action]
952
- * @property {ImageUrls} [banners]
953
- * @property {Object[]} [childs]
954
760
  * @property {string} [name]
955
- * @property {string} [slug]
956
- * @property {number} [uid]
957
- */
958
- /**
959
- * @typedef Time
960
- * @property {number} [hour]
961
- * @property {number} [minute]
761
+ * @property {SellerPhoneNumber[]} [contact_numbers]
962
762
  */
963
763
  /**
964
764
  * @typedef UserDetail
965
- * @property {string} [contact] - The contact details of the user.
966
765
  * @property {boolean} [super_user] - A flag indicating whether the user is a super user.
967
- * @property {string} user_id - The user ID of the user.
766
+ * @property {string} [contact] - The contact details of the user.
968
767
  * @property {string} username - The username of the user.
768
+ * @property {string} user_id - The user ID of the user.
969
769
  */
970
770
  /**
971
- * @typedef Weight
972
- * @property {boolean} is_default - Whether the weight is the default one or not
973
- * @property {number} shipping - The shipping weight of the product
974
- * @property {string} unit - The unit of weight
771
+ * @typedef Size
772
+ * @property {number} [quantity] - The quantity of this size available
773
+ * @property {Object} [value] - The value of the size
774
+ * @property {Object} [display] - The display string for the size
775
+ * @property {boolean} [is_available] - Whether or not this size is available
975
776
  */
976
- declare class CatalogApplicationModel {
977
- }
978
- declare namespace CatalogApplicationModel {
979
- export { ApplicationItemMOQ, ApplicationItemSEO, ApplicationStoreListing, AppStore, ArticleAssignmentV3, AttributeDetail, AttributeMetadata, AutocompleteItem, AutoCompleteResponse, BrandDetailResponse, BrandItem, BrandListingResponse, CategoryBanner, CategoryItems, CategoryListingResponse, CategoryMetaResponse, Child, CollectionDetailResponse, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, ColumnHeader, ColumnHeaders, CompanyDetail, CompanyStore, CustomMetaFields, Department, DepartmentCategoryTree, DepartmentIdentifier, DepartmentResponse, DetailsSchemaV3, Dimension, DiscountMeta, ErrorResponse, FollowerCountResponse, FollowIdsData, FollowIdsResponse, FollowPostResponse, GetCollectionDetailNest, GetCollectionListingResponse, GetFollowListingResponse, HomeListingResponse, ImageUrls, LatLong, MarketPlaceSttributesSchemaV3, Media, Meta, NetQuantity, Page, Price, ProductBrand, ProductBundle, ProductCategoryMap, ProductCompareResponse, ProductDepartment, ProductDetail, ProductDetailAttribute, ProductDetailCustomOrder, ProductDetailGroupedAttribute, ProductDetails, ProductFilters, ProductFiltersKey, ProductFiltersValue, ProductFrequentlyComparedSimilarResponse, ProductGroupingModel, ProductGroupPrice, ProductInGroup, ProductListingAction, ProductListingActionPage, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductsComparisonResponse, ProductSetDistributionSizeV3, ProductSetDistributionV3, ProductSetV3, ProductSize, ProductSizePriceResponseV3, ProductSizes, ProductSizeSellerFilterSchemaV3, ProductSizeSellersResponseV3, ProductSizesPrice, ProductSizeStores, ProductSortOn, ProductStockPolling, ProductStockPrice, ProductStockPriceV3, ProductStockStatusItem, ProductStockStatusResponse, ProductStockUnitPriceV3, ProductVariantItemResponse, ProductVariantListingResponse, ProductVariantResponse, ProductVariantsResponse, PromiseSchema, ReturnConfigSchemaV3, SecondLevelChild, Seller, SellerGroupAttributes, SellerPhoneNumber, SellerV3, Size, SizeChart, SizeChartValues, Store, StoreAddressSerializer, StoreDepartments, StoreDetail, StoreDetails, StoreListingResponse, StoreManagerSerializer, StoreTiming, StoreV3, StrategyWiseListingSchemaV3, ThirdLevelChild, Time, UserDetail, Weight };
980
- }
981
- /** @returns {ApplicationItemMOQ} */
982
- declare function ApplicationItemMOQ(): ApplicationItemMOQ;
983
- type ApplicationItemMOQ = {
984
- /**
985
- * - The minimum quantity increment in which
986
- * the item can be purchased.
987
- */
988
- increment_unit?: number;
989
- /**
990
- * - The maximum quantity allowed for purchase.
991
- */
992
- maximum?: number;
993
- /**
994
- * - The minimum quantity required for purchase.
995
- */
996
- minimum?: number;
997
- };
998
- /** @returns {ApplicationItemSEO} */
999
- declare function ApplicationItemSEO(): ApplicationItemSEO;
1000
- type ApplicationItemSEO = {
1001
- /**
1002
- * - The SEO description of the item
1003
- */
1004
- description?: any;
1005
- /**
1006
- * - The SEO title of the item
1007
- */
1008
- title?: any;
1009
- };
1010
- /** @returns {ApplicationStoreListing} */
1011
- declare function ApplicationStoreListing(): ApplicationStoreListing;
1012
- type ApplicationStoreListing = {
1013
- filters?: any[];
1014
- items?: AppStore[];
1015
- page?: Page;
1016
- };
1017
- /** @returns {AppStore} */
1018
- declare function AppStore(): AppStore;
1019
- type AppStore = {
1020
- address?: StoreAddressSerializer;
1021
- company?: CompanyStore;
1022
- contact_numbers?: SellerPhoneNumber[];
1023
- departments?: StoreDepartments[];
1024
- manager?: StoreManagerSerializer;
1025
- name?: string;
1026
- store_code?: string;
1027
- uid?: number;
1028
- };
1029
- /** @returns {ArticleAssignmentV3} */
1030
- declare function ArticleAssignmentV3(): ArticleAssignmentV3;
1031
- type ArticleAssignmentV3 = {
1032
- level?: string;
1033
- strategy?: string;
1034
- };
1035
- /** @returns {AttributeDetail} */
1036
- declare function AttributeDetail(): AttributeDetail;
1037
- type AttributeDetail = {
1038
- description?: string;
1039
- display?: string;
1040
- key?: string;
1041
- logo?: string;
1042
- };
1043
- /** @returns {AttributeMetadata} */
1044
- declare function AttributeMetadata(): AttributeMetadata;
1045
- type AttributeMetadata = {
1046
- details?: AttributeDetail[];
1047
- title?: string;
1048
- };
1049
- /** @returns {AutocompleteItem} */
1050
- declare function AutocompleteItem(): AutocompleteItem;
1051
- type AutocompleteItem = {
1052
- _custom_json?: any;
1053
- action?: ProductListingAction;
1054
- display?: string;
1055
- logo?: Media;
1056
- type?: string;
1057
- };
1058
- /** @returns {AutoCompleteResponse} */
1059
- declare function AutoCompleteResponse(): AutoCompleteResponse;
1060
- type AutoCompleteResponse = {
1061
- items?: AutocompleteItem[];
1062
- };
1063
- /** @returns {BrandDetailResponse} */
1064
- declare function BrandDetailResponse(): BrandDetailResponse;
1065
- type BrandDetailResponse = {
1066
- _custom_json?: any;
1067
- banners?: ImageUrls;
1068
- description?: string;
1069
- logo?: Media;
1070
- name?: string;
1071
- uid?: number;
1072
- };
1073
- /** @returns {BrandItem} */
1074
- declare function BrandItem(): BrandItem;
1075
- type BrandItem = {
1076
- action?: ProductListingAction;
1077
- banners?: ImageUrls;
1078
- departments?: string[];
1079
- description?: string;
1080
- discount?: string;
1081
- logo?: Media;
1082
- name?: string;
1083
- slug?: string;
1084
- uid?: number;
1085
- };
1086
- /** @returns {BrandListingResponse} */
1087
- declare function BrandListingResponse(): BrandListingResponse;
1088
- type BrandListingResponse = {
1089
- items?: BrandItem[];
1090
- page: Page;
1091
- };
1092
- /** @returns {CategoryBanner} */
1093
- declare function CategoryBanner(): CategoryBanner;
1094
- type CategoryBanner = {
1095
- landscape: Media;
1096
- portrait: Media;
1097
- };
1098
- /** @returns {CategoryItems} */
1099
- declare function CategoryItems(): CategoryItems;
1100
- type CategoryItems = {
1101
- action: ProductListingAction;
1102
- banners: CategoryBanner;
1103
- childs?: Child[];
1104
- name: string;
1105
- slug: string;
1106
- uid: number;
1107
- };
1108
- /** @returns {CategoryListingResponse} */
1109
- declare function CategoryListingResponse(): CategoryListingResponse;
1110
- type CategoryListingResponse = {
1111
- data?: DepartmentCategoryTree[];
1112
- departments?: DepartmentIdentifier[];
1113
- };
1114
- /** @returns {CategoryMetaResponse} */
1115
- declare function CategoryMetaResponse(): CategoryMetaResponse;
1116
- type CategoryMetaResponse = {
1117
- _custom_json?: any;
1118
- banners?: ImageUrls;
1119
- logo?: Media;
1120
- name?: string;
1121
- uid?: number;
1122
- };
1123
- /** @returns {Child} */
1124
- declare function Child(): Child;
1125
- type Child = {
1126
- _custom_json?: any;
1127
- action?: ProductListingAction;
1128
- banners?: ImageUrls;
1129
- childs?: SecondLevelChild[];
1130
- name?: string;
1131
- slug?: string;
1132
- uid?: number;
1133
- };
1134
- /** @returns {CollectionDetailResponse} */
1135
- declare function CollectionDetailResponse(): CollectionDetailResponse;
1136
- type CollectionDetailResponse = {
1137
- _custom_json?: any;
1138
- _schedule?: any;
1139
- allow_facets?: boolean;
1140
- allow_sort?: boolean;
1141
- app_id?: string;
1142
- badge?: any;
1143
- banners?: ImageUrls;
1144
- cron?: any;
1145
- description?: string;
1146
- is_active?: boolean;
1147
- logo?: Media;
1148
- meta?: any;
1149
- name?: string;
1150
- priority?: number;
1151
- query?: CollectionQuery[];
1152
- slug?: string;
1153
- sort_on?: string;
1154
- tag?: string[];
1155
- type?: string;
1156
- visible_facets_keys?: string[];
1157
- };
1158
- /** @returns {CollectionListingFilter} */
1159
- declare function CollectionListingFilter(): CollectionListingFilter;
1160
- type CollectionListingFilter = {
1161
- tags?: CollectionListingFilterTag[];
1162
- type?: CollectionListingFilterType[];
1163
- };
1164
- /** @returns {CollectionListingFilterTag} */
1165
- declare function CollectionListingFilterTag(): CollectionListingFilterTag;
1166
- type CollectionListingFilterTag = {
1167
- display?: string;
1168
- is_selected?: boolean;
1169
- name?: string;
1170
- };
1171
- /** @returns {CollectionListingFilterType} */
1172
- declare function CollectionListingFilterType(): CollectionListingFilterType;
1173
- type CollectionListingFilterType = {
1174
- display?: string;
1175
- is_selected?: boolean;
1176
- name?: string;
1177
- };
1178
- /** @returns {CollectionQuery} */
1179
- declare function CollectionQuery(): CollectionQuery;
1180
- type CollectionQuery = {
1181
- attribute: string;
1182
- op: string;
1183
- value: any[];
1184
- };
1185
- /** @returns {ColumnHeader} */
1186
- declare function ColumnHeader(): ColumnHeader;
1187
- type ColumnHeader = {
1188
- convertable?: boolean;
1189
- value?: string;
1190
- };
1191
- /** @returns {ColumnHeaders} */
1192
- declare function ColumnHeaders(): ColumnHeaders;
1193
- type ColumnHeaders = {
1194
- col_1?: ColumnHeader;
1195
- col_2?: ColumnHeader;
1196
- col_3?: ColumnHeader;
1197
- col_4?: ColumnHeader;
1198
- col_5?: ColumnHeader;
1199
- col_6?: ColumnHeader;
1200
- };
1201
- /** @returns {CompanyDetail} */
1202
- declare function CompanyDetail(): CompanyDetail;
1203
- type CompanyDetail = {
1204
- id?: number;
1205
- name?: string;
1206
- };
1207
- /** @returns {CompanyStore} */
1208
- declare function CompanyStore(): CompanyStore;
1209
- type CompanyStore = {
1210
- business_type?: string;
1211
- company_type?: string;
1212
- name?: string;
1213
- uid?: number;
1214
- };
1215
- /** @returns {CustomMetaFields} */
1216
- declare function CustomMetaFields(): CustomMetaFields;
1217
- type CustomMetaFields = {
1218
- /**
1219
- * - A key to store a custom field.
1220
- */
1221
- key: string;
1222
- /**
1223
- * - A value to store in the custom field.
1224
- */
1225
- value: string;
1226
- };
1227
- /** @returns {Department} */
1228
- declare function Department(): Department;
1229
- type Department = {
1230
- logo?: Media;
1231
- name?: string;
1232
- priority_order?: number;
1233
- slug?: string;
1234
- uid?: number;
1235
- };
1236
- /** @returns {DepartmentCategoryTree} */
1237
- declare function DepartmentCategoryTree(): DepartmentCategoryTree;
1238
- type DepartmentCategoryTree = {
1239
- department: string;
1240
- items?: CategoryItems[];
1241
- };
1242
- /** @returns {DepartmentIdentifier} */
1243
- declare function DepartmentIdentifier(): DepartmentIdentifier;
1244
- type DepartmentIdentifier = {
1245
- slug?: string;
1246
- uid?: number;
1247
- };
1248
- /** @returns {DepartmentResponse} */
1249
- declare function DepartmentResponse(): DepartmentResponse;
1250
- type DepartmentResponse = {
1251
- items?: Department[];
1252
- };
1253
- /** @returns {DetailsSchemaV3} */
1254
- declare function DetailsSchemaV3(): DetailsSchemaV3;
1255
- type DetailsSchemaV3 = {
1256
- key?: string;
1257
- type?: string;
1258
- value?: string;
1259
- };
1260
- /** @returns {Dimension} */
1261
- declare function Dimension(): Dimension;
1262
- type Dimension = {
1263
- /**
1264
- * - The height of the product
1265
- */
1266
- height: number;
1267
- /**
1268
- * - Whether the dimension is the default one or not
1269
- */
1270
- is_default: boolean;
1271
- /**
1272
- * - The length of the product
1273
- */
1274
- length: number;
1275
- /**
1276
- * - The unit of dimension
1277
- */
1278
- unit: string;
1279
- /**
1280
- * - The width of the product
1281
- */
1282
- width: number;
1283
- };
1284
- /** @returns {DiscountMeta} */
1285
- declare function DiscountMeta(): DiscountMeta;
1286
- type DiscountMeta = {
1287
- /**
1288
- * - The end time of the live discount.
1289
- */
1290
- end?: string;
1291
- /**
1292
- * - The start time of the live discount.
1293
- */
1294
- start?: string;
1295
- /**
1296
- * - The time in minutes before the
1297
- * discount ends when the countdown timer should start.
1298
- */
1299
- start_timer_in_minutes?: number;
1300
- /**
1301
- * - Determines whether the discount countdown is
1302
- * visible or not.
1303
- */
1304
- timer: boolean;
1305
- };
1306
- /** @returns {ErrorResponse} */
1307
- declare function ErrorResponse(): ErrorResponse;
1308
- type ErrorResponse = {
1309
- error?: string;
1310
- };
1311
- /** @returns {FollowerCountResponse} */
1312
- declare function FollowerCountResponse(): FollowerCountResponse;
1313
- type FollowerCountResponse = {
1314
- count?: number;
1315
- };
1316
- /** @returns {FollowIdsData} */
1317
- declare function FollowIdsData(): FollowIdsData;
1318
- type FollowIdsData = {
1319
- brands?: number[];
1320
- collections?: number[];
1321
- products?: number[];
1322
- };
1323
- /** @returns {FollowIdsResponse} */
1324
- declare function FollowIdsResponse(): FollowIdsResponse;
1325
- type FollowIdsResponse = {
1326
- data?: FollowIdsData;
1327
- };
1328
- /** @returns {FollowPostResponse} */
1329
- declare function FollowPostResponse(): FollowPostResponse;
1330
- type FollowPostResponse = {
1331
- id: string;
1332
- message: string;
1333
- };
1334
- /** @returns {GetCollectionDetailNest} */
1335
- declare function GetCollectionDetailNest(): GetCollectionDetailNest;
1336
- type GetCollectionDetailNest = {
1337
- _custom_json?: any;
1338
- _schedule?: any;
1339
- action?: ProductListingAction;
1340
- allow_facets?: boolean;
1341
- allow_sort?: boolean;
1342
- app_id?: string;
1343
- badge?: any;
1344
- banners?: ImageUrls;
1345
- cron?: any;
1346
- description?: string;
1347
- is_active?: boolean;
1348
- logo?: Media;
1349
- meta?: any;
1350
- name?: string;
1351
- priority?: number;
1352
- query?: CollectionQuery[];
1353
- slug?: string;
1354
- sort_on?: string;
1355
- tags?: string[];
1356
- type?: string;
1357
- uid?: string;
1358
- visible_facets_keys?: string[];
1359
- };
1360
- /** @returns {GetCollectionListingResponse} */
1361
- declare function GetCollectionListingResponse(): GetCollectionListingResponse;
1362
- type GetCollectionListingResponse = {
1363
- filters?: CollectionListingFilter;
1364
- items?: GetCollectionDetailNest[];
1365
- page: Page;
1366
- };
1367
- /** @returns {GetFollowListingResponse} */
1368
- declare function GetFollowListingResponse(): GetFollowListingResponse;
1369
- type GetFollowListingResponse = {
1370
- items: ProductListingDetail[];
1371
- page: Page;
1372
- };
1373
- /** @returns {HomeListingResponse} */
1374
- declare function HomeListingResponse(): HomeListingResponse;
1375
- type HomeListingResponse = {
1376
- items?: ProductListingDetail[];
1377
- message?: string;
1378
- page: Page;
1379
- };
1380
- /** @returns {ImageUrls} */
1381
- declare function ImageUrls(): ImageUrls;
1382
- type ImageUrls = {
1383
- landscape?: Media;
1384
- portrait?: Media;
1385
- };
1386
- /** @returns {LatLong} */
1387
- declare function LatLong(): LatLong;
1388
- type LatLong = {
1389
- coordinates?: number[];
1390
- type?: string;
1391
- };
1392
- /** @returns {MarketPlaceSttributesSchemaV3} */
1393
- declare function MarketPlaceSttributesSchemaV3(): MarketPlaceSttributesSchemaV3;
1394
- type MarketPlaceSttributesSchemaV3 = {
1395
- details?: DetailsSchemaV3[];
1396
- title?: string;
1397
- };
1398
- /** @returns {Media} */
1399
- declare function Media(): Media;
1400
- type Media = {
1401
- alt?: string;
1402
- meta?: Meta;
1403
- type?: string;
1404
- url?: string;
777
+ /**
778
+ * @typedef ProductGroupPrice
779
+ * @property {number} [max_effective] - The maximum effective price of the product group.
780
+ * @property {number} [min_effective] - The minimum effective price of the product group.
781
+ * @property {number} [min_marked] - The minimum marked price of the product group.
782
+ * @property {Object} [currency] - The currency code for the prices.
783
+ * @property {number} [max_marked] - The maximum marked price of the product group.
784
+ */
785
+ /**
786
+ * @typedef ProductDetails
787
+ * @property {Object} [template_tag] - The template tag of the product
788
+ * @property {number} [rating_count] - The number of ratings the product has received
789
+ * @property {Object} [image_nature] - The nature of the product's images
790
+ * @property {boolean} [has_variant] - Whether or not the product has a variant
791
+ * @property {Object} [description] - The long description of the product
792
+ * @property {boolean} [out_of_stock] - Whether or not the product is out of stock
793
+ * @property {number} [hsn_code] - The HSN code of the product
794
+ * @property {Object} [grouped_attributes] - A dictionary of grouped product attributes
795
+ * @property {Object} [item_code] - The item code of the product
796
+ * @property {Object} [name] - The name of the product
797
+ * @property {Object} [country_of_origin] - The country of origin for the product
798
+ * @property {Object} [short_description] - The short description of the product
799
+ * @property {Object[]} [media] - A list of media objects for the product
800
+ * @property {Object} [attributes] - A dictionary of product attributes
801
+ * @property {boolean} [is_set] - Whether or not the product is a set of items
802
+ * @property {Object[]} [images] - A list of image URLs for the product
803
+ * @property {Object} [slug] - The slug of the product
804
+ * @property {number} [rating] - The rating of the product
805
+ * @property {Object} [identifier] - A dictionary of product identifiers
806
+ * @property {Object[]} [highlights] - A list of highlights for the product
807
+ * @property {number} [brand_uid] - The unique ID of the product's brand
808
+ */
809
+ /**
810
+ * @typedef ProductInGroup
811
+ * @property {boolean} [auto_add_to_cart] - A flag indicating whether the
812
+ * product should be automatically added to the cart.
813
+ * @property {number} max_quantity - The maximum quantity of the product that
814
+ * can be added to the cart.
815
+ * @property {Size[]} [sizes] - The available sizes for the product.
816
+ * @property {ProductGroupPrice} [price] - The price details for the product group.
817
+ * @property {boolean} [auto_select] - A flag indicating whether the product
818
+ * should be automatically selected.
819
+ * @property {ProductDetails} [product_details] - The details of the product.
820
+ * @property {number} [min_quantity] - The minimum quantity of the product that
821
+ * can be added to the cart.
822
+ * @property {boolean} [allow_remove] - A flag indicating whether the product
823
+ * can be removed from the cart.
824
+ * @property {number} product_uid - The unique ID of the product in the group.
825
+ */
826
+ /**
827
+ * @typedef ProductGroupingModel
828
+ * @property {string} [logo] - The URL for the logo of the product grouping.
829
+ * @property {boolean} [is_active] - Whether the product grouping is active.
830
+ * @property {Object} [meta] - A dictionary containing metadata information.
831
+ * @property {UserDetail} [verified_by] - User details of the verifier of the
832
+ * document, if applicable
833
+ * @property {string} created_on - Timestamp of the creation of the document
834
+ * @property {number} [company_id] - The ID of the company that owns the product grouping.
835
+ * @property {Object[]} [page_visibility] - A list of page visibilities of the
836
+ * product grouping.
837
+ * @property {string} modified_on - Timestamp of the last modification of the document
838
+ * @property {UserDetail} [created_by] - User details of the creator of the document
839
+ * @property {UserDetail} [modified_by] - User details of the last modifier of
840
+ * the document
841
+ * @property {ProductInGroup[]} products - A list of products in the grouping.
842
+ * @property {boolean} [same_store_assignment] - Whether the products are
843
+ * assigned to the same store.
844
+ * @property {Object} [_id]
845
+ * @property {Object} name - The name of the product grouping.
846
+ * @property {Object} [choice] - The choice of the product grouping.
847
+ * @property {Object} [slug] - The unique identifier for the product grouping.
848
+ * @property {string} [verified_on] - Timestamp of when the document was
849
+ * verified, if applicable
850
+ */
851
+ /**
852
+ * @typedef ProductBundle
853
+ * @property {ProductGroupingModel[]} [items]
854
+ */
855
+ /**
856
+ * @typedef StoreV3
857
+ * @property {number} [uid]
858
+ * @property {string} [name]
859
+ * @property {number} [count]
860
+ */
861
+ /**
862
+ * @typedef ArticleAssignmentV3
863
+ * @property {string} [strategy]
864
+ * @property {string} [level]
865
+ */
866
+ /**
867
+ * @typedef StrategyWiseListingSchemaV3
868
+ * @property {number} [distance]
869
+ * @property {number} [pincode]
870
+ * @property {number} [tat]
871
+ * @property {number} [quantity]
872
+ */
873
+ /**
874
+ * @typedef DetailsSchemaV3
875
+ * @property {string} [value]
876
+ * @property {string} [type]
877
+ * @property {string} [key]
878
+ */
879
+ /**
880
+ * @typedef SellerGroupAttributes
881
+ * @property {string} [title]
882
+ * @property {DetailsSchemaV3[]} [details]
883
+ */
884
+ /**
885
+ * @typedef ReturnConfigSchemaV3
886
+ * @property {string} [unit]
887
+ * @property {boolean} [returnable]
888
+ * @property {number} [time]
889
+ */
890
+ /**
891
+ * @typedef ProductSetDistributionSizeV3
892
+ * @property {number} [pieces]
893
+ * @property {string} [size]
894
+ */
895
+ /**
896
+ * @typedef ProductSetDistributionV3
897
+ * @property {ProductSetDistributionSizeV3[]} [sizes]
898
+ */
899
+ /**
900
+ * @typedef ProductSetV3
901
+ * @property {number} [quantity]
902
+ * @property {ProductSetDistributionV3} [size_distribution]
903
+ */
904
+ /**
905
+ * @typedef ProductStockPriceV3
906
+ * @property {number} [effective] - The effective or final price for the product
907
+ * at the given pincode.
908
+ * @property {string} [currency_code] - The currency code for which the product
909
+ * is available
910
+ * @property {string} [currency_symbol] - The currency symbol for the currency
911
+ * in which the product is available.
912
+ * @property {number} [marked] - The marked price of the product.
913
+ * @property {number} [selling] - The selling price of the product.
914
+ */
915
+ /**
916
+ * @typedef ProductStockUnitPriceV3
917
+ * @property {string} [unit]
918
+ * @property {string} [currency_symbol]
919
+ * @property {string} [currency_code]
920
+ * @property {number} [price]
921
+ */
922
+ /**
923
+ * @typedef MarketPlaceSttributesSchemaV3
924
+ * @property {string} [title]
925
+ * @property {DetailsSchemaV3[]} [details]
926
+ */
927
+ /**
928
+ * @typedef SellerV3
929
+ * @property {number} [uid]
930
+ * @property {string} [name]
931
+ * @property {number} [count]
932
+ */
933
+ /**
934
+ * @typedef PromiseSchema
935
+ * @property {string} [min]
936
+ * @property {string} [max]
937
+ */
938
+ /**
939
+ * @typedef ProductSizePriceResponseV3
940
+ * @property {StoreV3} [store]
941
+ * @property {ArticleAssignmentV3} [article_assignment]
942
+ * @property {boolean} [is_cod]
943
+ * @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing]
944
+ * @property {number} [quantity]
945
+ * @property {string} [item_type]
946
+ * @property {SellerGroupAttributes[]} [grouped_attributes]
947
+ * @property {ReturnConfigSchemaV3} [return_config]
948
+ * @property {string} [article_id]
949
+ * @property {boolean} [is_gift]
950
+ * @property {ProductSetV3} [set]
951
+ * @property {number} [seller_count]
952
+ * @property {ProductStockPriceV3} [price_per_piece]
953
+ * @property {DiscountMeta} [discount_meta]
954
+ * @property {string} [discount]
955
+ * @property {number[]} [long_lat]
956
+ * @property {string} [special_badge]
957
+ * @property {ProductStockPriceV3} [price]
958
+ * @property {ProductStockUnitPriceV3} [price_per_unit]
959
+ * @property {number} [pincode]
960
+ * @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes]
961
+ * @property {SellerV3} [seller]
962
+ * @property {PromiseSchema} [delivery_promise]
963
+ */
964
+ /**
965
+ * @typedef ProductSizeSellerFilterSchemaV3
966
+ * @property {string} [name]
967
+ * @property {boolean} [is_selected]
968
+ * @property {string} [value]
969
+ */
970
+ /**
971
+ * @typedef ProductSizeSellersResponseV3
972
+ * @property {ProductSizePriceResponseV3[]} [items]
973
+ * @property {Page} page
974
+ * @property {ProductSizeSellerFilterSchemaV3[]} [sort_on]
975
+ */
976
+ declare class CatalogApplicationModel {
977
+ }
978
+ declare namespace CatalogApplicationModel {
979
+ export { ProductDetailCustomOrder, Meta, Media, ProductListingActionPage, ProductListingAction, ProductBrand, ProductDepartment, ProductCategoryMap, NetQuantity, CustomMetaFields, ApplicationItemSEO, ProductDetailAttribute, ProductDetailGroupedAttribute, ApplicationItemMOQ, Price, ProductListingPrice, ProductSizesPrice, ProductDetail, ErrorResponse, Dimension, Weight, DiscountMeta, ProductSize, SizeChartValues, ColumnHeader, ColumnHeaders, SizeChart, ProductSizeStores, ProductSizes, AttributeDetail, AttributeMetadata, ProductsComparisonResponse, ProductCompareResponse, ProductFrequentlyComparedSimilarResponse, ProductVariantItemResponse, ProductVariantResponse, ProductVariantsResponse, StoreDetail, ProductStockPrice, CompanyDetail, Seller, ProductStockStatusItem, ProductStockStatusResponse, Page, ProductStockPolling, ProductVariantListingResponse, ProductListingDetail, ProductFiltersValue, ProductFiltersKey, ProductFilters, ProductSortOn, ProductListingResponse, ImageUrls, BrandItem, BrandListingResponse, BrandDetailResponse, CategoryBanner, ThirdLevelChild, SecondLevelChild, Child, CategoryItems, DepartmentCategoryTree, DepartmentIdentifier, CategoryListingResponse, CategoryMetaResponse, HomeListingResponse, Department, DepartmentResponse, AutocompleteItem, AutoCompleteResponse, CollectionQuery, GetCollectionDetailNest, CollectionListingFilterTag, CollectionListingFilterType, CollectionListingFilter, GetCollectionListingResponse, CollectionDetailResponse, GetFollowListingResponse, FollowPostResponse, FollowerCountResponse, FollowIdsData, FollowIdsResponse, LatLong, Store, StoreListingResponse, StoreDepartments, CompanyStore, SellerPhoneNumber, StoreManagerSerializer, StoreAddressSerializer, AppStore, ApplicationStoreListing, Time, StoreTiming, StoreDetails, UserDetail, Size, ProductGroupPrice, ProductDetails, ProductInGroup, ProductGroupingModel, ProductBundle, StoreV3, ArticleAssignmentV3, StrategyWiseListingSchemaV3, DetailsSchemaV3, SellerGroupAttributes, ReturnConfigSchemaV3, ProductSetDistributionSizeV3, ProductSetDistributionV3, ProductSetV3, ProductStockPriceV3, ProductStockUnitPriceV3, MarketPlaceSttributesSchemaV3, SellerV3, PromiseSchema, ProductSizePriceResponseV3, ProductSizeSellerFilterSchemaV3, ProductSizeSellersResponseV3 };
980
+ }
981
+ /** @returns {ProductDetailCustomOrder} */
982
+ declare function ProductDetailCustomOrder(): ProductDetailCustomOrder;
983
+ type ProductDetailCustomOrder = {
984
+ manufacturing_time?: number;
985
+ manufacturing_time_unit?: string;
986
+ is_custom_order?: boolean;
1405
987
  };
1406
988
  /** @returns {Meta} */
1407
989
  declare function Meta(): Meta;
1408
990
  type Meta = {
1409
991
  source?: string;
1410
992
  };
1411
- /** @returns {NetQuantity} */
1412
- declare function NetQuantity(): NetQuantity;
1413
- type NetQuantity = {
1414
- /**
1415
- * - The unit of measurement used for the net quantity
1416
- * of the product.
1417
- */
1418
- unit?: any;
1419
- /**
1420
- * - The value of the net quantity of the product.
1421
- */
1422
- value?: number;
1423
- };
1424
- /** @returns {Page} */
1425
- declare function Page(): Page;
1426
- type Page = {
1427
- current?: number;
1428
- has_next?: boolean;
1429
- has_previous?: boolean;
1430
- item_total?: number;
1431
- next_id?: string;
1432
- size?: number;
1433
- type: string;
1434
- };
1435
- /** @returns {Price} */
1436
- declare function Price(): Price;
1437
- type Price = {
1438
- /**
1439
- * - The currency code for the currency in
1440
- * which the product is available.
1441
- */
1442
- currency_code?: string;
1443
- /**
1444
- * - The currency symbol for the currency
1445
- * in which the product is available.
1446
- */
1447
- currency_symbol?: string;
1448
- /**
1449
- * - The maximum price for the product across stores.
1450
- */
1451
- max?: number;
1452
- /**
1453
- * - The minimum price for the product across stores.
1454
- */
1455
- min?: number;
1456
- };
1457
- /** @returns {ProductBrand} */
1458
- declare function ProductBrand(): ProductBrand;
1459
- type ProductBrand = {
1460
- action?: ProductListingAction;
1461
- description?: string;
1462
- logo?: Media;
1463
- name?: string;
1464
- uid?: number;
1465
- };
1466
- /** @returns {ProductBundle} */
1467
- declare function ProductBundle(): ProductBundle;
1468
- type ProductBundle = {
1469
- items?: ProductGroupingModel[];
1470
- };
1471
- /** @returns {ProductCategoryMap} */
1472
- declare function ProductCategoryMap(): ProductCategoryMap;
1473
- type ProductCategoryMap = {
1474
- l1?: ProductBrand;
1475
- l2?: ProductBrand;
1476
- l3?: ProductBrand;
1477
- };
1478
- /** @returns {ProductCompareResponse} */
1479
- declare function ProductCompareResponse(): ProductCompareResponse;
1480
- type ProductCompareResponse = {
1481
- attributes_metadata?: AttributeMetadata[];
1482
- items?: ProductDetail[];
1483
- subtitle?: string;
1484
- title?: string;
993
+ /** @returns {Media} */
994
+ declare function Media(): Media;
995
+ type Media = {
996
+ url?: string;
997
+ type?: string;
998
+ meta?: Meta;
999
+ alt?: string;
1485
1000
  };
1486
- /** @returns {ProductDepartment} */
1487
- declare function ProductDepartment(): ProductDepartment;
1488
- type ProductDepartment = {
1489
- logo?: Media;
1490
- name?: string;
1491
- slug?: string;
1492
- uid?: number;
1001
+ /** @returns {ProductListingActionPage} */
1002
+ declare function ProductListingActionPage(): ProductListingActionPage;
1003
+ type ProductListingActionPage = {
1004
+ type?: string;
1005
+ query?: any;
1006
+ params?: any;
1493
1007
  };
1494
- /** @returns {ProductDetail} */
1495
- declare function ProductDetail(): ProductDetail;
1496
- type ProductDetail = {
1497
- _custom_json?: any;
1498
- _custom_meta?: CustomMetaFields[];
1499
- action?: ProductListingAction;
1500
- attributes?: any;
1501
- brand?: ProductBrand;
1502
- categories?: ProductBrand[];
1503
- category_map?: ProductCategoryMap;
1504
- color?: string;
1505
- custom_order?: ProductDetailCustomOrder;
1506
- department?: ProductDepartment;
1507
- description?: string;
1508
- discount?: string;
1509
- grouped_attributes?: ProductDetailGroupedAttribute[];
1510
- has_variant?: boolean;
1511
- highlights?: string[];
1512
- image_nature?: string;
1513
- is_dependent?: boolean;
1514
- item_code?: string;
1515
- item_type?: string;
1516
- medias?: Media[];
1517
- moq?: ApplicationItemMOQ;
1518
- name?: string;
1519
- net_quantity?: NetQuantity;
1520
- price?: ProductListingPrice;
1521
- product_group_tag?: string[];
1522
- product_online_date?: string;
1523
- rating?: number;
1524
- rating_count?: number;
1525
- seo?: ApplicationItemSEO;
1526
- short_description?: string;
1527
- similars?: string[];
1528
- slug: string;
1529
- tags?: string[];
1530
- teaser_tag?: string;
1531
- tryouts?: string[];
1008
+ /** @returns {ProductListingAction} */
1009
+ declare function ProductListingAction(): ProductListingAction;
1010
+ type ProductListingAction = {
1532
1011
  type?: string;
1533
- uid?: number;
1012
+ page?: ProductListingActionPage;
1534
1013
  };
1535
- /** @returns {ProductDetailAttribute} */
1536
- declare function ProductDetailAttribute(): ProductDetailAttribute;
1537
- type ProductDetailAttribute = {
1538
- key?: string;
1539
- type?: string;
1540
- value?: string;
1014
+ /** @returns {ProductBrand} */
1015
+ declare function ProductBrand(): ProductBrand;
1016
+ type ProductBrand = {
1017
+ uid?: number;
1018
+ logo?: Media;
1019
+ description?: string;
1020
+ name?: string;
1021
+ action?: ProductListingAction;
1541
1022
  };
1542
- /** @returns {ProductDetailCustomOrder} */
1543
- declare function ProductDetailCustomOrder(): ProductDetailCustomOrder;
1544
- type ProductDetailCustomOrder = {
1545
- is_custom_order?: boolean;
1546
- manufacturing_time?: number;
1547
- manufacturing_time_unit?: string;
1023
+ /** @returns {ProductDepartment} */
1024
+ declare function ProductDepartment(): ProductDepartment;
1025
+ type ProductDepartment = {
1026
+ uid?: number;
1027
+ logo?: Media;
1028
+ slug?: string;
1029
+ name?: string;
1548
1030
  };
1549
- /** @returns {ProductDetailGroupedAttribute} */
1550
- declare function ProductDetailGroupedAttribute(): ProductDetailGroupedAttribute;
1551
- type ProductDetailGroupedAttribute = {
1552
- details?: ProductDetailAttribute[];
1553
- title?: string;
1031
+ /** @returns {ProductCategoryMap} */
1032
+ declare function ProductCategoryMap(): ProductCategoryMap;
1033
+ type ProductCategoryMap = {
1034
+ l1?: ProductBrand;
1035
+ l2?: ProductBrand;
1036
+ l3?: ProductBrand;
1554
1037
  };
1555
- /** @returns {ProductDetails} */
1556
- declare function ProductDetails(): ProductDetails;
1557
- type ProductDetails = {
1558
- /**
1559
- * - A dictionary of product attributes
1560
- */
1561
- attributes?: any;
1562
- /**
1563
- * - The unique ID of the product's brand
1564
- */
1565
- brand_uid?: number;
1566
- /**
1567
- * - The country of origin for the product
1568
- */
1569
- country_of_origin?: any;
1570
- /**
1571
- * - The long description of the product
1572
- */
1573
- description?: any;
1574
- /**
1575
- * - A dictionary of grouped product attributes
1576
- */
1577
- grouped_attributes?: any;
1578
- /**
1579
- * - Whether or not the product has a variant
1580
- */
1581
- has_variant?: boolean;
1582
- /**
1583
- * - A list of highlights for the product
1584
- */
1585
- highlights?: any[];
1586
- /**
1587
- * - The HSN code of the product
1588
- */
1589
- hsn_code?: number;
1590
- /**
1591
- * - A dictionary of product identifiers
1592
- */
1593
- identifier?: any;
1594
- /**
1595
- * - The nature of the product's images
1596
- */
1597
- image_nature?: any;
1598
- /**
1599
- * - A list of image URLs for the product
1600
- */
1601
- images?: any[];
1602
- /**
1603
- * - Whether or not the product is a set of items
1604
- */
1605
- is_set?: boolean;
1606
- /**
1607
- * - The item code of the product
1608
- */
1609
- item_code?: any;
1610
- /**
1611
- * - A list of media objects for the product
1612
- */
1613
- media?: any[];
1614
- /**
1615
- * - The name of the product
1616
- */
1617
- name?: any;
1038
+ /** @returns {NetQuantity} */
1039
+ declare function NetQuantity(): NetQuantity;
1040
+ type NetQuantity = {
1618
1041
  /**
1619
- * - Whether or not the product is out of stock
1042
+ * - The unit of measurement used for the net quantity
1043
+ * of the product.
1620
1044
  */
1621
- out_of_stock?: boolean;
1045
+ unit?: any;
1622
1046
  /**
1623
- * - The rating of the product
1047
+ * - The value of the net quantity of the product.
1624
1048
  */
1625
- rating?: number;
1049
+ value?: number;
1050
+ };
1051
+ /** @returns {CustomMetaFields} */
1052
+ declare function CustomMetaFields(): CustomMetaFields;
1053
+ type CustomMetaFields = {
1626
1054
  /**
1627
- * - The number of ratings the product has received
1055
+ * - A value to store in the custom field.
1628
1056
  */
1629
- rating_count?: number;
1057
+ value: string;
1630
1058
  /**
1631
- * - The short description of the product
1059
+ * - A key to store a custom field.
1632
1060
  */
1633
- short_description?: any;
1061
+ key: string;
1062
+ };
1063
+ /** @returns {ApplicationItemSEO} */
1064
+ declare function ApplicationItemSEO(): ApplicationItemSEO;
1065
+ type ApplicationItemSEO = {
1634
1066
  /**
1635
- * - The slug of the product
1067
+ * - The SEO title of the item
1636
1068
  */
1637
- slug?: any;
1069
+ title?: any;
1638
1070
  /**
1639
- * - The template tag of the product
1071
+ * - The SEO description of the item
1640
1072
  */
1641
- template_tag?: any;
1642
- };
1643
- /** @returns {ProductFilters} */
1644
- declare function ProductFilters(): ProductFilters;
1645
- type ProductFilters = {
1646
- key: ProductFiltersKey;
1647
- values: ProductFiltersValue[];
1648
- };
1649
- /** @returns {ProductFiltersKey} */
1650
- declare function ProductFiltersKey(): ProductFiltersKey;
1651
- type ProductFiltersKey = {
1652
- display: string;
1653
- kind?: string;
1654
- logo?: string;
1655
- name: string;
1073
+ description?: any;
1656
1074
  };
1657
- /** @returns {ProductFiltersValue} */
1658
- declare function ProductFiltersValue(): ProductFiltersValue;
1659
- type ProductFiltersValue = {
1660
- count?: number;
1661
- currency_code?: string;
1662
- currency_symbol?: string;
1663
- display: string;
1664
- display_format?: string;
1665
- is_selected: boolean;
1666
- max?: number;
1667
- min?: number;
1668
- query_format?: string;
1669
- selected_max?: number;
1670
- selected_min?: number;
1075
+ /** @returns {ProductDetailAttribute} */
1076
+ declare function ProductDetailAttribute(): ProductDetailAttribute;
1077
+ type ProductDetailAttribute = {
1671
1078
  value?: string;
1079
+ type?: string;
1080
+ key?: string;
1672
1081
  };
1673
- /** @returns {ProductFrequentlyComparedSimilarResponse} */
1674
- declare function ProductFrequentlyComparedSimilarResponse(): ProductFrequentlyComparedSimilarResponse;
1675
- type ProductFrequentlyComparedSimilarResponse = {
1676
- similars?: ProductCompareResponse;
1082
+ /** @returns {ProductDetailGroupedAttribute} */
1083
+ declare function ProductDetailGroupedAttribute(): ProductDetailGroupedAttribute;
1084
+ type ProductDetailGroupedAttribute = {
1085
+ title?: string;
1086
+ details?: ProductDetailAttribute[];
1677
1087
  };
1678
- /** @returns {ProductGroupingModel} */
1679
- declare function ProductGroupingModel(): ProductGroupingModel;
1680
- type ProductGroupingModel = {
1681
- _id?: any;
1682
- /**
1683
- * - The choice of the product grouping.
1684
- */
1685
- choice?: any;
1088
+ /** @returns {ApplicationItemMOQ} */
1089
+ declare function ApplicationItemMOQ(): ApplicationItemMOQ;
1090
+ type ApplicationItemMOQ = {
1686
1091
  /**
1687
- * - The ID of the company that owns the product grouping.
1092
+ * - The minimum quantity required for purchase.
1688
1093
  */
1689
- company_id?: number;
1094
+ minimum?: number;
1690
1095
  /**
1691
- * - User details of the creator of the document
1096
+ * - The maximum quantity allowed for purchase.
1692
1097
  */
1693
- created_by?: UserDetail;
1098
+ maximum?: number;
1694
1099
  /**
1695
- * - Timestamp of the creation of the document
1100
+ * - The minimum quantity increment in which
1101
+ * the item can be purchased.
1696
1102
  */
1697
- created_on: string;
1103
+ increment_unit?: number;
1104
+ };
1105
+ /** @returns {Price} */
1106
+ declare function Price(): Price;
1107
+ type Price = {
1698
1108
  /**
1699
- * - Whether the product grouping is active.
1109
+ * - The minimum price for the product across stores.
1700
1110
  */
1701
- is_active?: boolean;
1111
+ min?: number;
1702
1112
  /**
1703
- * - The URL for the logo of the product grouping.
1113
+ * - The currency symbol for the currency
1114
+ * in which the product is available.
1704
1115
  */
1705
- logo?: string;
1116
+ currency_symbol?: string;
1706
1117
  /**
1707
- * - A dictionary containing metadata information.
1118
+ * - The currency code for the currency in
1119
+ * which the product is available.
1708
1120
  */
1709
- meta?: any;
1121
+ currency_code?: string;
1710
1122
  /**
1711
- * - User details of the last modifier of
1712
- * the document
1123
+ * - The maximum price for the product across stores.
1713
1124
  */
1714
- modified_by?: UserDetail;
1125
+ max?: number;
1126
+ };
1127
+ /** @returns {ProductListingPrice} */
1128
+ declare function ProductListingPrice(): ProductListingPrice;
1129
+ type ProductListingPrice = {
1130
+ effective?: Price;
1131
+ marked?: Price;
1132
+ };
1133
+ /** @returns {ProductSizesPrice} */
1134
+ declare function ProductSizesPrice(): ProductSizesPrice;
1135
+ type ProductSizesPrice = {
1136
+ effective?: Price;
1137
+ marked?: Price;
1138
+ selling?: Price;
1139
+ };
1140
+ /** @returns {ProductDetail} */
1141
+ declare function ProductDetail(): ProductDetail;
1142
+ type ProductDetail = {
1143
+ uid?: number;
1144
+ custom_order?: ProductDetailCustomOrder;
1145
+ category_map?: ProductCategoryMap;
1146
+ net_quantity?: NetQuantity;
1147
+ rating_count?: number;
1148
+ _custom_meta?: CustomMetaFields[];
1149
+ similars?: string[];
1150
+ tags?: string[];
1151
+ seo?: ApplicationItemSEO;
1152
+ image_nature?: string;
1153
+ has_variant?: boolean;
1154
+ item_type?: string;
1155
+ description?: string;
1156
+ grouped_attributes?: ProductDetailGroupedAttribute[];
1157
+ medias?: Media[];
1158
+ color?: string;
1159
+ type?: string;
1160
+ product_online_date?: string;
1161
+ _custom_json?: any;
1162
+ item_code?: string;
1163
+ name?: string;
1164
+ moq?: ApplicationItemMOQ;
1165
+ short_description?: string;
1166
+ categories?: ProductBrand[];
1167
+ attributes?: any;
1168
+ discount?: string;
1169
+ tryouts?: string[];
1170
+ slug: string;
1171
+ action?: ProductListingAction;
1172
+ rating?: number;
1173
+ is_dependent?: boolean;
1174
+ product_group_tag?: string[];
1175
+ highlights?: string[];
1176
+ price?: ProductListingPrice;
1177
+ brand?: ProductBrand;
1178
+ department?: ProductDepartment;
1179
+ teaser_tag?: string;
1180
+ };
1181
+ /** @returns {ErrorResponse} */
1182
+ declare function ErrorResponse(): ErrorResponse;
1183
+ type ErrorResponse = {
1184
+ error?: string;
1185
+ };
1186
+ /** @returns {Dimension} */
1187
+ declare function Dimension(): Dimension;
1188
+ type Dimension = {
1715
1189
  /**
1716
- * - Timestamp of the last modification of the document
1190
+ * - The unit of dimension
1717
1191
  */
1718
- modified_on: string;
1192
+ unit: string;
1719
1193
  /**
1720
- * - The name of the product grouping.
1194
+ * - The height of the product
1721
1195
  */
1722
- name: any;
1196
+ height: number;
1723
1197
  /**
1724
- * - A list of page visibilities of the
1725
- * product grouping.
1198
+ * - The length of the product
1726
1199
  */
1727
- page_visibility?: any[];
1200
+ length: number;
1728
1201
  /**
1729
- * - A list of products in the grouping.
1202
+ * - The width of the product
1730
1203
  */
1731
- products: ProductInGroup[];
1204
+ width: number;
1732
1205
  /**
1733
- * - Whether the products are
1734
- * assigned to the same store.
1206
+ * - Whether the dimension is the default one or not
1735
1207
  */
1736
- same_store_assignment?: boolean;
1208
+ is_default: boolean;
1209
+ };
1210
+ /** @returns {Weight} */
1211
+ declare function Weight(): Weight;
1212
+ type Weight = {
1737
1213
  /**
1738
- * - The unique identifier for the product grouping.
1214
+ * - The unit of weight
1739
1215
  */
1740
- slug?: any;
1216
+ unit: string;
1741
1217
  /**
1742
- * - User details of the verifier of the
1743
- * document, if applicable
1218
+ * - The shipping weight of the product
1744
1219
  */
1745
- verified_by?: UserDetail;
1220
+ shipping: number;
1746
1221
  /**
1747
- * - Timestamp of when the document was
1748
- * verified, if applicable
1222
+ * - Whether the weight is the default one or not
1749
1223
  */
1750
- verified_on?: string;
1224
+ is_default: boolean;
1751
1225
  };
1752
- /** @returns {ProductGroupPrice} */
1753
- declare function ProductGroupPrice(): ProductGroupPrice;
1754
- type ProductGroupPrice = {
1755
- /**
1756
- * - The currency code for the prices.
1757
- */
1758
- currency?: any;
1226
+ /** @returns {DiscountMeta} */
1227
+ declare function DiscountMeta(): DiscountMeta;
1228
+ type DiscountMeta = {
1759
1229
  /**
1760
- * - The maximum effective price of the product group.
1230
+ * - Determines whether the discount countdown is
1231
+ * visible or not.
1761
1232
  */
1762
- max_effective?: number;
1233
+ timer: boolean;
1763
1234
  /**
1764
- * - The maximum marked price of the product group.
1235
+ * - The time in minutes before the
1236
+ * discount ends when the countdown timer should start.
1765
1237
  */
1766
- max_marked?: number;
1238
+ start_timer_in_minutes?: number;
1767
1239
  /**
1768
- * - The minimum effective price of the product group.
1240
+ * - The start time of the live discount.
1769
1241
  */
1770
- min_effective?: number;
1242
+ start?: string;
1771
1243
  /**
1772
- * - The minimum marked price of the product group.
1244
+ * - The end time of the live discount.
1773
1245
  */
1774
- min_marked?: number;
1246
+ end?: string;
1247
+ };
1248
+ /** @returns {ProductSize} */
1249
+ declare function ProductSize(): ProductSize;
1250
+ type ProductSize = {
1251
+ quantity?: number;
1252
+ dimension?: Dimension;
1253
+ weight?: Weight;
1254
+ is_available?: boolean;
1255
+ seller_identifiers?: string[];
1256
+ value?: string;
1257
+ display?: string;
1258
+ };
1259
+ /** @returns {SizeChartValues} */
1260
+ declare function SizeChartValues(): SizeChartValues;
1261
+ type SizeChartValues = {
1262
+ col_3?: string;
1263
+ col_6?: string;
1264
+ col_2?: string;
1265
+ col_4?: string;
1266
+ col_1?: string;
1267
+ col_5?: string;
1268
+ };
1269
+ /** @returns {ColumnHeader} */
1270
+ declare function ColumnHeader(): ColumnHeader;
1271
+ type ColumnHeader = {
1272
+ convertable?: boolean;
1273
+ value?: string;
1274
+ };
1275
+ /** @returns {ColumnHeaders} */
1276
+ declare function ColumnHeaders(): ColumnHeaders;
1277
+ type ColumnHeaders = {
1278
+ col_3?: ColumnHeader;
1279
+ col_6?: ColumnHeader;
1280
+ col_2?: ColumnHeader;
1281
+ col_4?: ColumnHeader;
1282
+ col_1?: ColumnHeader;
1283
+ col_5?: ColumnHeader;
1284
+ };
1285
+ /** @returns {SizeChart} */
1286
+ declare function SizeChart(): SizeChart;
1287
+ type SizeChart = {
1288
+ unit?: string;
1289
+ image?: string;
1290
+ size_tip?: string;
1291
+ sizes?: SizeChartValues[];
1292
+ description?: string;
1293
+ title?: string;
1294
+ headers?: ColumnHeaders;
1295
+ };
1296
+ /** @returns {ProductSizeStores} */
1297
+ declare function ProductSizeStores(): ProductSizeStores;
1298
+ type ProductSizeStores = {
1299
+ count?: number;
1300
+ };
1301
+ /** @returns {ProductSizes} */
1302
+ declare function ProductSizes(): ProductSizes;
1303
+ type ProductSizes = {
1304
+ sizes?: ProductSize[];
1305
+ price?: ProductSizesPrice;
1306
+ size_chart?: SizeChart;
1307
+ sellable?: boolean;
1308
+ multi_size?: boolean;
1309
+ discount?: string;
1310
+ stores?: ProductSizeStores;
1311
+ discount_meta?: DiscountMeta;
1312
+ };
1313
+ /** @returns {AttributeDetail} */
1314
+ declare function AttributeDetail(): AttributeDetail;
1315
+ type AttributeDetail = {
1316
+ logo?: string;
1317
+ description?: string;
1318
+ display?: string;
1319
+ key?: string;
1320
+ };
1321
+ /** @returns {AttributeMetadata} */
1322
+ declare function AttributeMetadata(): AttributeMetadata;
1323
+ type AttributeMetadata = {
1324
+ title?: string;
1325
+ details?: AttributeDetail[];
1326
+ };
1327
+ /** @returns {ProductsComparisonResponse} */
1328
+ declare function ProductsComparisonResponse(): ProductsComparisonResponse;
1329
+ type ProductsComparisonResponse = {
1330
+ items?: ProductDetail[];
1331
+ attributes_metadata?: AttributeMetadata[];
1332
+ };
1333
+ /** @returns {ProductCompareResponse} */
1334
+ declare function ProductCompareResponse(): ProductCompareResponse;
1335
+ type ProductCompareResponse = {
1336
+ title?: string;
1337
+ items?: ProductDetail[];
1338
+ attributes_metadata?: AttributeMetadata[];
1339
+ subtitle?: string;
1340
+ };
1341
+ /** @returns {ProductFrequentlyComparedSimilarResponse} */
1342
+ declare function ProductFrequentlyComparedSimilarResponse(): ProductFrequentlyComparedSimilarResponse;
1343
+ type ProductFrequentlyComparedSimilarResponse = {
1344
+ similars?: ProductCompareResponse;
1345
+ };
1346
+ /** @returns {ProductVariantItemResponse} */
1347
+ declare function ProductVariantItemResponse(): ProductVariantItemResponse;
1348
+ type ProductVariantItemResponse = {
1349
+ uid?: number;
1350
+ color_name?: string;
1351
+ color?: string;
1352
+ medias?: Media[];
1353
+ is_available?: boolean;
1354
+ _custom_meta?: CustomMetaFields[];
1355
+ name?: string;
1356
+ value?: string;
1357
+ slug?: string;
1358
+ action?: ProductListingAction;
1359
+ };
1360
+ /** @returns {ProductVariantResponse} */
1361
+ declare function ProductVariantResponse(): ProductVariantResponse;
1362
+ type ProductVariantResponse = {
1363
+ display_type?: string;
1364
+ header?: string;
1365
+ items?: ProductVariantItemResponse[];
1366
+ key?: string;
1367
+ };
1368
+ /** @returns {ProductVariantsResponse} */
1369
+ declare function ProductVariantsResponse(): ProductVariantsResponse;
1370
+ type ProductVariantsResponse = {
1371
+ variants?: ProductVariantResponse[];
1372
+ };
1373
+ /** @returns {StoreDetail} */
1374
+ declare function StoreDetail(): StoreDetail;
1375
+ type StoreDetail = {
1376
+ name?: string;
1377
+ city?: string;
1378
+ id?: number;
1379
+ code?: string;
1380
+ };
1381
+ /** @returns {ProductStockPrice} */
1382
+ declare function ProductStockPrice(): ProductStockPrice;
1383
+ type ProductStockPrice = {
1384
+ effective?: number;
1385
+ currency?: string;
1386
+ marked?: number;
1387
+ };
1388
+ /** @returns {CompanyDetail} */
1389
+ declare function CompanyDetail(): CompanyDetail;
1390
+ type CompanyDetail = {
1391
+ name?: string;
1392
+ id?: number;
1393
+ };
1394
+ /** @returns {Seller} */
1395
+ declare function Seller(): Seller;
1396
+ type Seller = {
1397
+ uid?: number;
1398
+ name?: string;
1399
+ count?: number;
1775
1400
  };
1776
- /** @returns {ProductInGroup} */
1777
- declare function ProductInGroup(): ProductInGroup;
1778
- type ProductInGroup = {
1779
- /**
1780
- * - A flag indicating whether the product
1781
- * can be removed from the cart.
1782
- */
1783
- allow_remove?: boolean;
1784
- /**
1785
- * - A flag indicating whether the
1786
- * product should be automatically added to the cart.
1787
- */
1788
- auto_add_to_cart?: boolean;
1789
- /**
1790
- * - A flag indicating whether the product
1791
- * should be automatically selected.
1792
- */
1793
- auto_select?: boolean;
1794
- /**
1795
- * - The maximum quantity of the product that
1796
- * can be added to the cart.
1797
- */
1798
- max_quantity: number;
1799
- /**
1800
- * - The minimum quantity of the product that
1801
- * can be added to the cart.
1802
- */
1803
- min_quantity?: number;
1804
- /**
1805
- * - The price details for the product group.
1806
- */
1807
- price?: ProductGroupPrice;
1808
- /**
1809
- * - The details of the product.
1810
- */
1811
- product_details?: ProductDetails;
1812
- /**
1813
- * - The unique ID of the product in the group.
1814
- */
1815
- product_uid: number;
1816
- /**
1817
- * - The available sizes for the product.
1818
- */
1819
- sizes?: Size[];
1401
+ /** @returns {ProductStockStatusItem} */
1402
+ declare function ProductStockStatusItem(): ProductStockStatusItem;
1403
+ type ProductStockStatusItem = {
1404
+ uid?: string;
1405
+ quantity?: number;
1406
+ store?: StoreDetail;
1407
+ size?: string;
1408
+ price?: ProductStockPrice;
1409
+ company?: CompanyDetail;
1410
+ item_id?: number;
1411
+ seller?: Seller;
1412
+ identifier?: any;
1820
1413
  };
1821
- /** @returns {ProductListingAction} */
1822
- declare function ProductListingAction(): ProductListingAction;
1823
- type ProductListingAction = {
1824
- page?: ProductListingActionPage;
1825
- type?: string;
1414
+ /** @returns {ProductStockStatusResponse} */
1415
+ declare function ProductStockStatusResponse(): ProductStockStatusResponse;
1416
+ type ProductStockStatusResponse = {
1417
+ items?: ProductStockStatusItem[];
1826
1418
  };
1827
- /** @returns {ProductListingActionPage} */
1828
- declare function ProductListingActionPage(): ProductListingActionPage;
1829
- type ProductListingActionPage = {
1830
- params?: any;
1831
- query?: any;
1832
- type?: string;
1419
+ /** @returns {Page} */
1420
+ declare function Page(): Page;
1421
+ type Page = {
1422
+ item_total?: number;
1423
+ next_id?: string;
1424
+ has_previous?: boolean;
1425
+ has_next?: boolean;
1426
+ current?: number;
1427
+ type: string;
1428
+ size?: number;
1429
+ };
1430
+ /** @returns {ProductStockPolling} */
1431
+ declare function ProductStockPolling(): ProductStockPolling;
1432
+ type ProductStockPolling = {
1433
+ items?: ProductStockStatusItem[];
1434
+ page: Page;
1435
+ };
1436
+ /** @returns {ProductVariantListingResponse} */
1437
+ declare function ProductVariantListingResponse(): ProductVariantListingResponse;
1438
+ type ProductVariantListingResponse = {
1439
+ header?: string;
1440
+ items?: ProductVariantItemResponse[];
1441
+ total?: number;
1442
+ key?: string;
1443
+ display_type?: string;
1833
1444
  };
1834
1445
  /** @returns {ProductListingDetail} */
1835
1446
  declare function ProductListingDetail(): ProductListingDetail;
1836
1447
  type ProductListingDetail = {
1837
- _custom_json?: any;
1838
- _custom_meta?: CustomMetaFields[];
1839
- action?: ProductListingAction;
1840
- attributes?: any;
1841
- brand?: ProductBrand;
1842
- categories?: ProductBrand[];
1843
- category_map?: ProductCategoryMap;
1844
- color?: string;
1448
+ uid?: number;
1845
1449
  custom_order?: ProductDetailCustomOrder;
1846
- description?: string;
1847
- discount?: string;
1848
- grouped_attributes?: ProductDetailGroupedAttribute[];
1849
- has_variant?: boolean;
1850
- highlights?: string[];
1851
- identifiers?: string[];
1450
+ sizes?: string[];
1451
+ category_map?: ProductCategoryMap;
1452
+ net_quantity?: NetQuantity;
1453
+ rating_count?: number;
1454
+ _custom_meta?: CustomMetaFields[];
1455
+ similars?: string[];
1456
+ tags?: string[];
1457
+ seo?: ApplicationItemSEO;
1852
1458
  image_nature?: string;
1853
- is_dependent?: boolean;
1854
- item_code?: string;
1459
+ has_variant?: boolean;
1855
1460
  item_type?: string;
1461
+ description?: string;
1462
+ grouped_attributes?: ProductDetailGroupedAttribute[];
1856
1463
  medias?: Media[];
1857
- moq?: ApplicationItemMOQ;
1858
- name?: string;
1859
- net_quantity?: NetQuantity;
1860
- price?: ProductListingPrice;
1861
- product_group_tag?: string[];
1464
+ color?: string;
1465
+ type?: string;
1862
1466
  product_online_date?: string;
1863
- rating?: number;
1864
- rating_count?: number;
1865
- sellable?: boolean;
1866
- seo?: ApplicationItemSEO;
1467
+ _custom_json?: any;
1468
+ item_code?: string;
1469
+ name?: string;
1470
+ moq?: ApplicationItemMOQ;
1867
1471
  short_description?: string;
1868
- similars?: string[];
1869
- sizes?: string[];
1472
+ categories?: ProductBrand[];
1473
+ sellable?: boolean;
1474
+ attributes?: any;
1475
+ variants?: ProductVariantListingResponse[];
1476
+ discount?: string;
1477
+ tryouts?: string[];
1478
+ identifiers?: string[];
1870
1479
  slug: string;
1871
- tags?: string[];
1480
+ action?: ProductListingAction;
1481
+ rating?: number;
1482
+ is_dependent?: boolean;
1483
+ product_group_tag?: string[];
1484
+ highlights?: string[];
1485
+ price?: ProductListingPrice;
1486
+ brand?: ProductBrand;
1872
1487
  teaser_tag?: string;
1873
- tryouts?: string[];
1874
- type?: string;
1875
- uid?: number;
1876
- variants?: ProductVariantListingResponse[];
1877
1488
  };
1878
- /** @returns {ProductListingPrice} */
1879
- declare function ProductListingPrice(): ProductListingPrice;
1880
- type ProductListingPrice = {
1881
- effective?: Price;
1882
- marked?: Price;
1489
+ /** @returns {ProductFiltersValue} */
1490
+ declare function ProductFiltersValue(): ProductFiltersValue;
1491
+ type ProductFiltersValue = {
1492
+ min?: number;
1493
+ display_format?: string;
1494
+ selected_max?: number;
1495
+ value?: string;
1496
+ query_format?: string;
1497
+ currency_symbol?: string;
1498
+ selected_min?: number;
1499
+ currency_code?: string;
1500
+ is_selected: boolean;
1501
+ display: string;
1502
+ count?: number;
1503
+ max?: number;
1504
+ };
1505
+ /** @returns {ProductFiltersKey} */
1506
+ declare function ProductFiltersKey(): ProductFiltersKey;
1507
+ type ProductFiltersKey = {
1508
+ logo?: string;
1509
+ name: string;
1510
+ kind?: string;
1511
+ display: string;
1512
+ };
1513
+ /** @returns {ProductFilters} */
1514
+ declare function ProductFilters(): ProductFilters;
1515
+ type ProductFilters = {
1516
+ values: ProductFiltersValue[];
1517
+ key: ProductFiltersKey;
1518
+ };
1519
+ /** @returns {ProductSortOn} */
1520
+ declare function ProductSortOn(): ProductSortOn;
1521
+ type ProductSortOn = {
1522
+ logo?: string;
1523
+ is_selected?: boolean;
1524
+ name?: string;
1525
+ value?: string;
1526
+ display?: string;
1883
1527
  };
1884
1528
  /** @returns {ProductListingResponse} */
1885
1529
  declare function ProductListingResponse(): ProductListingResponse;
1886
1530
  type ProductListingResponse = {
1887
- filters?: ProductFilters[];
1888
1531
  items?: ProductListingDetail[];
1532
+ filters?: ProductFilters[];
1889
1533
  page: Page;
1890
1534
  sort_on?: ProductSortOn[];
1891
1535
  };
1892
- /** @returns {ProductsComparisonResponse} */
1893
- declare function ProductsComparisonResponse(): ProductsComparisonResponse;
1894
- type ProductsComparisonResponse = {
1895
- attributes_metadata?: AttributeMetadata[];
1896
- items?: ProductDetail[];
1536
+ /** @returns {ImageUrls} */
1537
+ declare function ImageUrls(): ImageUrls;
1538
+ type ImageUrls = {
1539
+ portrait?: Media;
1540
+ landscape?: Media;
1897
1541
  };
1898
- /** @returns {ProductSetDistributionSizeV3} */
1899
- declare function ProductSetDistributionSizeV3(): ProductSetDistributionSizeV3;
1900
- type ProductSetDistributionSizeV3 = {
1901
- pieces?: number;
1902
- size?: string;
1542
+ /** @returns {BrandItem} */
1543
+ declare function BrandItem(): BrandItem;
1544
+ type BrandItem = {
1545
+ uid?: number;
1546
+ logo?: Media;
1547
+ description?: string;
1548
+ banners?: ImageUrls;
1549
+ departments?: string[];
1550
+ discount?: string;
1551
+ name?: string;
1552
+ slug?: string;
1553
+ action?: ProductListingAction;
1903
1554
  };
1904
- /** @returns {ProductSetDistributionV3} */
1905
- declare function ProductSetDistributionV3(): ProductSetDistributionV3;
1906
- type ProductSetDistributionV3 = {
1907
- sizes?: ProductSetDistributionSizeV3[];
1555
+ /** @returns {BrandListingResponse} */
1556
+ declare function BrandListingResponse(): BrandListingResponse;
1557
+ type BrandListingResponse = {
1558
+ items?: BrandItem[];
1559
+ page: Page;
1908
1560
  };
1909
- /** @returns {ProductSetV3} */
1910
- declare function ProductSetV3(): ProductSetV3;
1911
- type ProductSetV3 = {
1912
- quantity?: number;
1913
- size_distribution?: ProductSetDistributionV3;
1561
+ /** @returns {BrandDetailResponse} */
1562
+ declare function BrandDetailResponse(): BrandDetailResponse;
1563
+ type BrandDetailResponse = {
1564
+ logo?: Media;
1565
+ uid?: number;
1566
+ description?: string;
1567
+ banners?: ImageUrls;
1568
+ _custom_json?: any;
1569
+ name?: string;
1914
1570
  };
1915
- /** @returns {ProductSize} */
1916
- declare function ProductSize(): ProductSize;
1917
- type ProductSize = {
1918
- dimension?: Dimension;
1919
- display?: string;
1920
- is_available?: boolean;
1921
- quantity?: number;
1922
- seller_identifiers?: string[];
1923
- value?: string;
1924
- weight?: Weight;
1571
+ /** @returns {CategoryBanner} */
1572
+ declare function CategoryBanner(): CategoryBanner;
1573
+ type CategoryBanner = {
1574
+ portrait: Media;
1575
+ landscape: Media;
1925
1576
  };
1926
- /** @returns {ProductSizePriceResponseV3} */
1927
- declare function ProductSizePriceResponseV3(): ProductSizePriceResponseV3;
1928
- type ProductSizePriceResponseV3 = {
1929
- article_assignment?: ArticleAssignmentV3;
1930
- article_id?: string;
1931
- delivery_promise?: PromiseSchema;
1932
- discount?: string;
1933
- discount_meta?: DiscountMeta;
1934
- grouped_attributes?: SellerGroupAttributes[];
1935
- is_cod?: boolean;
1936
- is_gift?: boolean;
1937
- item_type?: string;
1938
- long_lat?: number[];
1939
- marketplace_attributes?: MarketPlaceSttributesSchemaV3[];
1940
- pincode?: number;
1941
- price?: ProductStockPriceV3;
1942
- price_per_piece?: ProductStockPriceV3;
1943
- price_per_unit?: ProductStockUnitPriceV3;
1944
- quantity?: number;
1945
- return_config?: ReturnConfigSchemaV3;
1946
- seller?: SellerV3;
1947
- seller_count?: number;
1948
- set?: ProductSetV3;
1949
- special_badge?: string;
1950
- store?: StoreV3;
1951
- strategy_wise_listing?: StrategyWiseListingSchemaV3[];
1577
+ /** @returns {ThirdLevelChild} */
1578
+ declare function ThirdLevelChild(): ThirdLevelChild;
1579
+ type ThirdLevelChild = {
1580
+ uid?: number;
1581
+ banners?: ImageUrls;
1582
+ childs?: any[];
1583
+ _custom_json?: any;
1584
+ name?: string;
1585
+ slug?: string;
1586
+ action?: ProductListingAction;
1952
1587
  };
1953
- /** @returns {ProductSizes} */
1954
- declare function ProductSizes(): ProductSizes;
1955
- type ProductSizes = {
1956
- discount?: string;
1957
- discount_meta?: DiscountMeta;
1958
- multi_size?: boolean;
1959
- price?: ProductSizesPrice;
1960
- sellable?: boolean;
1961
- size_chart?: SizeChart;
1962
- sizes?: ProductSize[];
1963
- stores?: ProductSizeStores;
1588
+ /** @returns {SecondLevelChild} */
1589
+ declare function SecondLevelChild(): SecondLevelChild;
1590
+ type SecondLevelChild = {
1591
+ uid?: number;
1592
+ banners?: ImageUrls;
1593
+ childs?: ThirdLevelChild[];
1594
+ _custom_json?: any;
1595
+ name?: string;
1596
+ slug?: string;
1597
+ action?: ProductListingAction;
1964
1598
  };
1965
- /** @returns {ProductSizeSellerFilterSchemaV3} */
1966
- declare function ProductSizeSellerFilterSchemaV3(): ProductSizeSellerFilterSchemaV3;
1967
- type ProductSizeSellerFilterSchemaV3 = {
1968
- is_selected?: boolean;
1599
+ /** @returns {Child} */
1600
+ declare function Child(): Child;
1601
+ type Child = {
1602
+ uid?: number;
1603
+ banners?: ImageUrls;
1604
+ childs?: SecondLevelChild[];
1605
+ _custom_json?: any;
1969
1606
  name?: string;
1970
- value?: string;
1607
+ slug?: string;
1608
+ action?: ProductListingAction;
1971
1609
  };
1972
- /** @returns {ProductSizeSellersResponseV3} */
1973
- declare function ProductSizeSellersResponseV3(): ProductSizeSellersResponseV3;
1974
- type ProductSizeSellersResponseV3 = {
1975
- items?: ProductSizePriceResponseV3[];
1976
- page: Page;
1977
- sort_on?: ProductSizeSellerFilterSchemaV3[];
1610
+ /** @returns {CategoryItems} */
1611
+ declare function CategoryItems(): CategoryItems;
1612
+ type CategoryItems = {
1613
+ uid: number;
1614
+ banners: CategoryBanner;
1615
+ childs?: Child[];
1616
+ name: string;
1617
+ slug: string;
1618
+ action: ProductListingAction;
1978
1619
  };
1979
- /** @returns {ProductSizesPrice} */
1980
- declare function ProductSizesPrice(): ProductSizesPrice;
1981
- type ProductSizesPrice = {
1982
- effective?: Price;
1983
- marked?: Price;
1984
- selling?: Price;
1620
+ /** @returns {DepartmentCategoryTree} */
1621
+ declare function DepartmentCategoryTree(): DepartmentCategoryTree;
1622
+ type DepartmentCategoryTree = {
1623
+ items?: CategoryItems[];
1624
+ department: string;
1985
1625
  };
1986
- /** @returns {ProductSizeStores} */
1987
- declare function ProductSizeStores(): ProductSizeStores;
1988
- type ProductSizeStores = {
1989
- count?: number;
1626
+ /** @returns {DepartmentIdentifier} */
1627
+ declare function DepartmentIdentifier(): DepartmentIdentifier;
1628
+ type DepartmentIdentifier = {
1629
+ uid?: number;
1630
+ slug?: string;
1990
1631
  };
1991
- /** @returns {ProductSortOn} */
1992
- declare function ProductSortOn(): ProductSortOn;
1993
- type ProductSortOn = {
1994
- display?: string;
1995
- is_selected?: boolean;
1996
- logo?: string;
1632
+ /** @returns {CategoryListingResponse} */
1633
+ declare function CategoryListingResponse(): CategoryListingResponse;
1634
+ type CategoryListingResponse = {
1635
+ data?: DepartmentCategoryTree[];
1636
+ departments?: DepartmentIdentifier[];
1637
+ };
1638
+ /** @returns {CategoryMetaResponse} */
1639
+ declare function CategoryMetaResponse(): CategoryMetaResponse;
1640
+ type CategoryMetaResponse = {
1641
+ logo?: Media;
1642
+ uid?: number;
1643
+ banners?: ImageUrls;
1644
+ _custom_json?: any;
1997
1645
  name?: string;
1998
- value?: string;
1999
1646
  };
2000
- /** @returns {ProductStockPolling} */
2001
- declare function ProductStockPolling(): ProductStockPolling;
2002
- type ProductStockPolling = {
2003
- items?: ProductStockStatusItem[];
1647
+ /** @returns {HomeListingResponse} */
1648
+ declare function HomeListingResponse(): HomeListingResponse;
1649
+ type HomeListingResponse = {
1650
+ items?: ProductListingDetail[];
2004
1651
  page: Page;
1652
+ message?: string;
2005
1653
  };
2006
- /** @returns {ProductStockPrice} */
2007
- declare function ProductStockPrice(): ProductStockPrice;
2008
- type ProductStockPrice = {
2009
- currency?: string;
2010
- effective?: number;
2011
- marked?: number;
1654
+ /** @returns {Department} */
1655
+ declare function Department(): Department;
1656
+ type Department = {
1657
+ uid?: number;
1658
+ logo?: Media;
1659
+ priority_order?: number;
1660
+ name?: string;
1661
+ slug?: string;
2012
1662
  };
2013
- /** @returns {ProductStockPriceV3} */
2014
- declare function ProductStockPriceV3(): ProductStockPriceV3;
2015
- type ProductStockPriceV3 = {
2016
- /**
2017
- * - The currency code for which the product
2018
- * is available
2019
- */
2020
- currency_code?: string;
2021
- /**
2022
- * - The currency symbol for the currency
2023
- * in which the product is available.
2024
- */
2025
- currency_symbol?: string;
2026
- /**
2027
- * - The effective or final price for the product
2028
- * at the given pincode.
2029
- */
2030
- effective?: number;
2031
- /**
2032
- * - The marked price of the product.
2033
- */
2034
- marked?: number;
2035
- /**
2036
- * - The selling price of the product.
2037
- */
2038
- selling?: number;
1663
+ /** @returns {DepartmentResponse} */
1664
+ declare function DepartmentResponse(): DepartmentResponse;
1665
+ type DepartmentResponse = {
1666
+ items?: Department[];
2039
1667
  };
2040
- /** @returns {ProductStockStatusItem} */
2041
- declare function ProductStockStatusItem(): ProductStockStatusItem;
2042
- type ProductStockStatusItem = {
2043
- company?: CompanyDetail;
2044
- identifier?: any;
2045
- item_id?: number;
2046
- price?: ProductStockPrice;
2047
- quantity?: number;
2048
- seller?: Seller;
2049
- size?: string;
2050
- store?: StoreDetail;
2051
- uid?: string;
1668
+ /** @returns {AutocompleteItem} */
1669
+ declare function AutocompleteItem(): AutocompleteItem;
1670
+ type AutocompleteItem = {
1671
+ logo?: Media;
1672
+ display?: string;
1673
+ type?: string;
1674
+ _custom_json?: any;
1675
+ action?: ProductListingAction;
2052
1676
  };
2053
- /** @returns {ProductStockStatusResponse} */
2054
- declare function ProductStockStatusResponse(): ProductStockStatusResponse;
2055
- type ProductStockStatusResponse = {
2056
- items?: ProductStockStatusItem[];
1677
+ /** @returns {AutoCompleteResponse} */
1678
+ declare function AutoCompleteResponse(): AutoCompleteResponse;
1679
+ type AutoCompleteResponse = {
1680
+ items?: AutocompleteItem[];
2057
1681
  };
2058
- /** @returns {ProductStockUnitPriceV3} */
2059
- declare function ProductStockUnitPriceV3(): ProductStockUnitPriceV3;
2060
- type ProductStockUnitPriceV3 = {
2061
- currency_code?: string;
2062
- currency_symbol?: string;
2063
- price?: number;
2064
- unit?: string;
1682
+ /** @returns {CollectionQuery} */
1683
+ declare function CollectionQuery(): CollectionQuery;
1684
+ type CollectionQuery = {
1685
+ op: string;
1686
+ value: any[];
1687
+ attribute: string;
2065
1688
  };
2066
- /** @returns {ProductVariantItemResponse} */
2067
- declare function ProductVariantItemResponse(): ProductVariantItemResponse;
2068
- type ProductVariantItemResponse = {
2069
- _custom_meta?: CustomMetaFields[];
2070
- action?: ProductListingAction;
2071
- color?: string;
2072
- color_name?: string;
2073
- is_available?: boolean;
2074
- medias?: Media[];
1689
+ /** @returns {GetCollectionDetailNest} */
1690
+ declare function GetCollectionDetailNest(): GetCollectionDetailNest;
1691
+ type GetCollectionDetailNest = {
1692
+ is_active?: boolean;
1693
+ uid?: string;
1694
+ sort_on?: string;
1695
+ meta?: any;
1696
+ banners?: ImageUrls;
1697
+ cron?: any;
1698
+ _schedule?: any;
1699
+ query?: CollectionQuery[];
1700
+ description?: string;
1701
+ type?: string;
1702
+ _custom_json?: any;
2075
1703
  name?: string;
1704
+ allow_sort?: boolean;
1705
+ visible_facets_keys?: string[];
1706
+ badge?: any;
2076
1707
  slug?: string;
2077
- uid?: number;
2078
- value?: string;
2079
- };
2080
- /** @returns {ProductVariantListingResponse} */
2081
- declare function ProductVariantListingResponse(): ProductVariantListingResponse;
2082
- type ProductVariantListingResponse = {
2083
- display_type?: string;
2084
- header?: string;
2085
- items?: ProductVariantItemResponse[];
2086
- key?: string;
2087
- total?: number;
1708
+ action?: ProductListingAction;
1709
+ allow_facets?: boolean;
1710
+ logo?: Media;
1711
+ priority?: number;
1712
+ tag?: string[];
1713
+ app_id?: string;
2088
1714
  };
2089
- /** @returns {ProductVariantResponse} */
2090
- declare function ProductVariantResponse(): ProductVariantResponse;
2091
- type ProductVariantResponse = {
2092
- display_type?: string;
2093
- header?: string;
2094
- items?: ProductVariantItemResponse[];
2095
- key?: string;
1715
+ /** @returns {CollectionListingFilterTag} */
1716
+ declare function CollectionListingFilterTag(): CollectionListingFilterTag;
1717
+ type CollectionListingFilterTag = {
1718
+ name?: string;
1719
+ is_selected?: boolean;
1720
+ display?: string;
2096
1721
  };
2097
- /** @returns {ProductVariantsResponse} */
2098
- declare function ProductVariantsResponse(): ProductVariantsResponse;
2099
- type ProductVariantsResponse = {
2100
- variants?: ProductVariantResponse[];
1722
+ /** @returns {CollectionListingFilterType} */
1723
+ declare function CollectionListingFilterType(): CollectionListingFilterType;
1724
+ type CollectionListingFilterType = {
1725
+ name?: string;
1726
+ is_selected?: boolean;
1727
+ display?: string;
2101
1728
  };
2102
- /** @returns {PromiseSchema} */
2103
- declare function PromiseSchema(): PromiseSchema;
2104
- type PromiseSchema = {
2105
- max?: string;
2106
- min?: string;
1729
+ /** @returns {CollectionListingFilter} */
1730
+ declare function CollectionListingFilter(): CollectionListingFilter;
1731
+ type CollectionListingFilter = {
1732
+ tags?: CollectionListingFilterTag[];
1733
+ type?: CollectionListingFilterType[];
2107
1734
  };
2108
- /** @returns {ReturnConfigSchemaV3} */
2109
- declare function ReturnConfigSchemaV3(): ReturnConfigSchemaV3;
2110
- type ReturnConfigSchemaV3 = {
2111
- returnable?: boolean;
2112
- time?: number;
2113
- unit?: string;
1735
+ /** @returns {GetCollectionListingResponse} */
1736
+ declare function GetCollectionListingResponse(): GetCollectionListingResponse;
1737
+ type GetCollectionListingResponse = {
1738
+ items?: GetCollectionDetailNest[];
1739
+ filters?: CollectionListingFilter;
1740
+ page: Page;
2114
1741
  };
2115
- /** @returns {SecondLevelChild} */
2116
- declare function SecondLevelChild(): SecondLevelChild;
2117
- type SecondLevelChild = {
2118
- _custom_json?: any;
2119
- action?: ProductListingAction;
1742
+ /** @returns {CollectionDetailResponse} */
1743
+ declare function CollectionDetailResponse(): CollectionDetailResponse;
1744
+ type CollectionDetailResponse = {
1745
+ is_active?: boolean;
1746
+ sort_on?: string;
1747
+ meta?: any;
2120
1748
  banners?: ImageUrls;
2121
- childs?: ThirdLevelChild[];
1749
+ cron?: any;
1750
+ _schedule?: any;
1751
+ query?: CollectionQuery[];
1752
+ description?: string;
1753
+ type?: string;
1754
+ _custom_json?: any;
2122
1755
  name?: string;
1756
+ allow_sort?: boolean;
1757
+ visible_facets_keys?: string[];
1758
+ badge?: any;
2123
1759
  slug?: string;
2124
- uid?: number;
1760
+ allow_facets?: boolean;
1761
+ logo?: Media;
1762
+ priority?: number;
1763
+ tag?: string[];
1764
+ app_id?: string;
2125
1765
  };
2126
- /** @returns {Seller} */
2127
- declare function Seller(): Seller;
2128
- type Seller = {
1766
+ /** @returns {GetFollowListingResponse} */
1767
+ declare function GetFollowListingResponse(): GetFollowListingResponse;
1768
+ type GetFollowListingResponse = {
1769
+ items: ProductListingDetail[];
1770
+ page: Page;
1771
+ };
1772
+ /** @returns {FollowPostResponse} */
1773
+ declare function FollowPostResponse(): FollowPostResponse;
1774
+ type FollowPostResponse = {
1775
+ message: string;
1776
+ id: string;
1777
+ };
1778
+ /** @returns {FollowerCountResponse} */
1779
+ declare function FollowerCountResponse(): FollowerCountResponse;
1780
+ type FollowerCountResponse = {
2129
1781
  count?: number;
1782
+ };
1783
+ /** @returns {FollowIdsData} */
1784
+ declare function FollowIdsData(): FollowIdsData;
1785
+ type FollowIdsData = {
1786
+ products?: number[];
1787
+ collections?: number[];
1788
+ brands?: number[];
1789
+ };
1790
+ /** @returns {FollowIdsResponse} */
1791
+ declare function FollowIdsResponse(): FollowIdsResponse;
1792
+ type FollowIdsResponse = {
1793
+ data?: FollowIdsData;
1794
+ };
1795
+ /** @returns {LatLong} */
1796
+ declare function LatLong(): LatLong;
1797
+ type LatLong = {
1798
+ coordinates?: number[];
1799
+ type?: string;
1800
+ };
1801
+ /** @returns {Store} */
1802
+ declare function Store(): Store;
1803
+ type Store = {
1804
+ uid?: number;
1805
+ store_email?: string;
1806
+ state?: string;
1807
+ country?: string;
1808
+ pincode?: number;
1809
+ city?: string;
1810
+ address?: string;
1811
+ store_code?: string;
1812
+ lat_long?: LatLong;
2130
1813
  name?: string;
1814
+ tags?: string[];
1815
+ };
1816
+ /** @returns {StoreListingResponse} */
1817
+ declare function StoreListingResponse(): StoreListingResponse;
1818
+ type StoreListingResponse = {
1819
+ items: Store[];
1820
+ page: Page;
1821
+ };
1822
+ /** @returns {StoreDepartments} */
1823
+ declare function StoreDepartments(): StoreDepartments;
1824
+ type StoreDepartments = {
2131
1825
  uid?: number;
1826
+ logo?: any;
1827
+ priority_order?: number;
1828
+ name?: string;
1829
+ slug?: string;
2132
1830
  };
2133
- /** @returns {SellerGroupAttributes} */
2134
- declare function SellerGroupAttributes(): SellerGroupAttributes;
2135
- type SellerGroupAttributes = {
2136
- details?: DetailsSchemaV3[];
2137
- title?: string;
1831
+ /** @returns {CompanyStore} */
1832
+ declare function CompanyStore(): CompanyStore;
1833
+ type CompanyStore = {
1834
+ uid?: number;
1835
+ name?: string;
1836
+ company_type?: string;
1837
+ business_type?: string;
2138
1838
  };
2139
1839
  /** @returns {SellerPhoneNumber} */
2140
1840
  declare function SellerPhoneNumber(): SellerPhoneNumber;
@@ -2142,16 +1842,104 @@ type SellerPhoneNumber = {
2142
1842
  country_code: number;
2143
1843
  number: string;
2144
1844
  };
2145
- /** @returns {SellerV3} */
2146
- declare function SellerV3(): SellerV3;
2147
- type SellerV3 = {
2148
- count?: number;
1845
+ /** @returns {StoreManagerSerializer} */
1846
+ declare function StoreManagerSerializer(): StoreManagerSerializer;
1847
+ type StoreManagerSerializer = {
1848
+ name?: string;
1849
+ email?: string;
1850
+ mobile_no?: SellerPhoneNumber;
1851
+ };
1852
+ /** @returns {StoreAddressSerializer} */
1853
+ declare function StoreAddressSerializer(): StoreAddressSerializer;
1854
+ type StoreAddressSerializer = {
1855
+ latitude?: number;
1856
+ state?: string;
1857
+ country?: string;
1858
+ landmark?: string;
1859
+ address1?: string;
1860
+ pincode?: number;
1861
+ city?: string;
1862
+ longitude?: number;
1863
+ address2?: string;
1864
+ };
1865
+ /** @returns {AppStore} */
1866
+ declare function AppStore(): AppStore;
1867
+ type AppStore = {
1868
+ uid?: number;
1869
+ departments?: StoreDepartments[];
1870
+ company?: CompanyStore;
1871
+ manager?: StoreManagerSerializer;
1872
+ store_code?: string;
1873
+ address?: StoreAddressSerializer;
2149
1874
  name?: string;
1875
+ contact_numbers?: SellerPhoneNumber[];
1876
+ };
1877
+ /** @returns {ApplicationStoreListing} */
1878
+ declare function ApplicationStoreListing(): ApplicationStoreListing;
1879
+ type ApplicationStoreListing = {
1880
+ filters?: any[];
1881
+ items?: AppStore[];
1882
+ page?: Page;
1883
+ };
1884
+ /** @returns {Time} */
1885
+ declare function Time(): Time;
1886
+ type Time = {
1887
+ hour?: number;
1888
+ minute?: number;
1889
+ };
1890
+ /** @returns {StoreTiming} */
1891
+ declare function StoreTiming(): StoreTiming;
1892
+ type StoreTiming = {
1893
+ open?: boolean;
1894
+ closing?: Time;
1895
+ weekday?: string;
1896
+ opening?: Time;
1897
+ };
1898
+ /** @returns {StoreDetails} */
1899
+ declare function StoreDetails(): StoreDetails;
1900
+ type StoreDetails = {
2150
1901
  uid?: number;
1902
+ departments?: StoreDepartments[];
1903
+ company?: CompanyStore;
1904
+ manager?: StoreManagerSerializer;
1905
+ store_code?: string;
1906
+ timing?: StoreTiming[];
1907
+ address?: StoreAddressSerializer;
1908
+ _custom_json?: any;
1909
+ name?: string;
1910
+ contact_numbers?: SellerPhoneNumber[];
1911
+ };
1912
+ /** @returns {UserDetail} */
1913
+ declare function UserDetail(): UserDetail;
1914
+ type UserDetail = {
1915
+ /**
1916
+ * - A flag indicating whether the user is a super user.
1917
+ */
1918
+ super_user?: boolean;
1919
+ /**
1920
+ * - The contact details of the user.
1921
+ */
1922
+ contact?: string;
1923
+ /**
1924
+ * - The username of the user.
1925
+ */
1926
+ username: string;
1927
+ /**
1928
+ * - The user ID of the user.
1929
+ */
1930
+ user_id: string;
2151
1931
  };
2152
1932
  /** @returns {Size} */
2153
1933
  declare function Size(): Size;
2154
1934
  type Size = {
1935
+ /**
1936
+ * - The quantity of this size available
1937
+ */
1938
+ quantity?: number;
1939
+ /**
1940
+ * - The value of the size
1941
+ */
1942
+ value?: any;
2155
1943
  /**
2156
1944
  * - The display string for the size
2157
1945
  */
@@ -2160,181 +1948,393 @@ type Size = {
2160
1948
  * - Whether or not this size is available
2161
1949
  */
2162
1950
  is_available?: boolean;
1951
+ };
1952
+ /** @returns {ProductGroupPrice} */
1953
+ declare function ProductGroupPrice(): ProductGroupPrice;
1954
+ type ProductGroupPrice = {
2163
1955
  /**
2164
- * - The quantity of this size available
1956
+ * - The maximum effective price of the product group.
2165
1957
  */
2166
- quantity?: number;
1958
+ max_effective?: number;
2167
1959
  /**
2168
- * - The value of the size
1960
+ * - The minimum effective price of the product group.
2169
1961
  */
2170
- value?: any;
2171
- };
2172
- /** @returns {SizeChart} */
2173
- declare function SizeChart(): SizeChart;
2174
- type SizeChart = {
2175
- description?: string;
2176
- headers?: ColumnHeaders;
2177
- image?: string;
2178
- size_tip?: string;
2179
- sizes?: SizeChartValues[];
2180
- title?: string;
2181
- unit?: string;
2182
- };
2183
- /** @returns {SizeChartValues} */
2184
- declare function SizeChartValues(): SizeChartValues;
2185
- type SizeChartValues = {
2186
- col_1?: string;
2187
- col_2?: string;
2188
- col_3?: string;
2189
- col_4?: string;
2190
- col_5?: string;
2191
- col_6?: string;
2192
- };
2193
- /** @returns {Store} */
2194
- declare function Store(): Store;
2195
- type Store = {
2196
- address?: string;
2197
- city?: string;
2198
- country?: string;
2199
- lat_long?: LatLong;
2200
- name?: string;
2201
- pincode?: number;
2202
- state?: string;
2203
- store_code?: string;
2204
- store_email?: string;
2205
- tags?: string[];
2206
- uid?: number;
2207
- };
2208
- /** @returns {StoreAddressSerializer} */
2209
- declare function StoreAddressSerializer(): StoreAddressSerializer;
2210
- type StoreAddressSerializer = {
2211
- address1?: string;
2212
- address2?: string;
2213
- city?: string;
2214
- country?: string;
2215
- landmark?: string;
2216
- latitude?: number;
2217
- longitude?: number;
2218
- pincode?: number;
2219
- state?: string;
2220
- };
2221
- /** @returns {StoreDepartments} */
2222
- declare function StoreDepartments(): StoreDepartments;
2223
- type StoreDepartments = {
2224
- logo?: any;
2225
- name?: string;
2226
- priority_order?: number;
2227
- slug?: string;
2228
- uid?: number;
2229
- };
2230
- /** @returns {StoreDetail} */
2231
- declare function StoreDetail(): StoreDetail;
2232
- type StoreDetail = {
2233
- city?: string;
2234
- code?: string;
2235
- id?: number;
2236
- name?: string;
2237
- };
2238
- /** @returns {StoreDetails} */
2239
- declare function StoreDetails(): StoreDetails;
2240
- type StoreDetails = {
2241
- _custom_json?: any;
2242
- address?: StoreAddressSerializer;
2243
- company?: CompanyStore;
2244
- contact_numbers?: SellerPhoneNumber[];
2245
- departments?: StoreDepartments[];
2246
- manager?: StoreManagerSerializer;
2247
- name?: string;
2248
- store_code?: string;
2249
- timing?: StoreTiming[];
2250
- uid?: number;
1962
+ min_effective?: number;
1963
+ /**
1964
+ * - The minimum marked price of the product group.
1965
+ */
1966
+ min_marked?: number;
1967
+ /**
1968
+ * - The currency code for the prices.
1969
+ */
1970
+ currency?: any;
1971
+ /**
1972
+ * - The maximum marked price of the product group.
1973
+ */
1974
+ max_marked?: number;
2251
1975
  };
2252
- /** @returns {StoreListingResponse} */
2253
- declare function StoreListingResponse(): StoreListingResponse;
2254
- type StoreListingResponse = {
2255
- items: Store[];
2256
- page: Page;
1976
+ /** @returns {ProductDetails} */
1977
+ declare function ProductDetails(): ProductDetails;
1978
+ type ProductDetails = {
1979
+ /**
1980
+ * - The template tag of the product
1981
+ */
1982
+ template_tag?: any;
1983
+ /**
1984
+ * - The number of ratings the product has received
1985
+ */
1986
+ rating_count?: number;
1987
+ /**
1988
+ * - The nature of the product's images
1989
+ */
1990
+ image_nature?: any;
1991
+ /**
1992
+ * - Whether or not the product has a variant
1993
+ */
1994
+ has_variant?: boolean;
1995
+ /**
1996
+ * - The long description of the product
1997
+ */
1998
+ description?: any;
1999
+ /**
2000
+ * - Whether or not the product is out of stock
2001
+ */
2002
+ out_of_stock?: boolean;
2003
+ /**
2004
+ * - The HSN code of the product
2005
+ */
2006
+ hsn_code?: number;
2007
+ /**
2008
+ * - A dictionary of grouped product attributes
2009
+ */
2010
+ grouped_attributes?: any;
2011
+ /**
2012
+ * - The item code of the product
2013
+ */
2014
+ item_code?: any;
2015
+ /**
2016
+ * - The name of the product
2017
+ */
2018
+ name?: any;
2019
+ /**
2020
+ * - The country of origin for the product
2021
+ */
2022
+ country_of_origin?: any;
2023
+ /**
2024
+ * - The short description of the product
2025
+ */
2026
+ short_description?: any;
2027
+ /**
2028
+ * - A list of media objects for the product
2029
+ */
2030
+ media?: any[];
2031
+ /**
2032
+ * - A dictionary of product attributes
2033
+ */
2034
+ attributes?: any;
2035
+ /**
2036
+ * - Whether or not the product is a set of items
2037
+ */
2038
+ is_set?: boolean;
2039
+ /**
2040
+ * - A list of image URLs for the product
2041
+ */
2042
+ images?: any[];
2043
+ /**
2044
+ * - The slug of the product
2045
+ */
2046
+ slug?: any;
2047
+ /**
2048
+ * - The rating of the product
2049
+ */
2050
+ rating?: number;
2051
+ /**
2052
+ * - A dictionary of product identifiers
2053
+ */
2054
+ identifier?: any;
2055
+ /**
2056
+ * - A list of highlights for the product
2057
+ */
2058
+ highlights?: any[];
2059
+ /**
2060
+ * - The unique ID of the product's brand
2061
+ */
2062
+ brand_uid?: number;
2257
2063
  };
2258
- /** @returns {StoreManagerSerializer} */
2259
- declare function StoreManagerSerializer(): StoreManagerSerializer;
2260
- type StoreManagerSerializer = {
2261
- email?: string;
2262
- mobile_no?: SellerPhoneNumber;
2263
- name?: string;
2064
+ /** @returns {ProductInGroup} */
2065
+ declare function ProductInGroup(): ProductInGroup;
2066
+ type ProductInGroup = {
2067
+ /**
2068
+ * - A flag indicating whether the
2069
+ * product should be automatically added to the cart.
2070
+ */
2071
+ auto_add_to_cart?: boolean;
2072
+ /**
2073
+ * - The maximum quantity of the product that
2074
+ * can be added to the cart.
2075
+ */
2076
+ max_quantity: number;
2077
+ /**
2078
+ * - The available sizes for the product.
2079
+ */
2080
+ sizes?: Size[];
2081
+ /**
2082
+ * - The price details for the product group.
2083
+ */
2084
+ price?: ProductGroupPrice;
2085
+ /**
2086
+ * - A flag indicating whether the product
2087
+ * should be automatically selected.
2088
+ */
2089
+ auto_select?: boolean;
2090
+ /**
2091
+ * - The details of the product.
2092
+ */
2093
+ product_details?: ProductDetails;
2094
+ /**
2095
+ * - The minimum quantity of the product that
2096
+ * can be added to the cart.
2097
+ */
2098
+ min_quantity?: number;
2099
+ /**
2100
+ * - A flag indicating whether the product
2101
+ * can be removed from the cart.
2102
+ */
2103
+ allow_remove?: boolean;
2104
+ /**
2105
+ * - The unique ID of the product in the group.
2106
+ */
2107
+ product_uid: number;
2264
2108
  };
2265
- /** @returns {StoreTiming} */
2266
- declare function StoreTiming(): StoreTiming;
2267
- type StoreTiming = {
2268
- closing?: Time;
2269
- open?: boolean;
2270
- opening?: Time;
2271
- weekday?: string;
2109
+ /** @returns {ProductGroupingModel} */
2110
+ declare function ProductGroupingModel(): ProductGroupingModel;
2111
+ type ProductGroupingModel = {
2112
+ /**
2113
+ * - The URL for the logo of the product grouping.
2114
+ */
2115
+ logo?: string;
2116
+ /**
2117
+ * - Whether the product grouping is active.
2118
+ */
2119
+ is_active?: boolean;
2120
+ /**
2121
+ * - A dictionary containing metadata information.
2122
+ */
2123
+ meta?: any;
2124
+ /**
2125
+ * - User details of the verifier of the
2126
+ * document, if applicable
2127
+ */
2128
+ verified_by?: UserDetail;
2129
+ /**
2130
+ * - Timestamp of the creation of the document
2131
+ */
2132
+ created_on: string;
2133
+ /**
2134
+ * - The ID of the company that owns the product grouping.
2135
+ */
2136
+ company_id?: number;
2137
+ /**
2138
+ * - A list of page visibilities of the
2139
+ * product grouping.
2140
+ */
2141
+ page_visibility?: any[];
2142
+ /**
2143
+ * - Timestamp of the last modification of the document
2144
+ */
2145
+ modified_on: string;
2146
+ /**
2147
+ * - User details of the creator of the document
2148
+ */
2149
+ created_by?: UserDetail;
2150
+ /**
2151
+ * - User details of the last modifier of
2152
+ * the document
2153
+ */
2154
+ modified_by?: UserDetail;
2155
+ /**
2156
+ * - A list of products in the grouping.
2157
+ */
2158
+ products: ProductInGroup[];
2159
+ /**
2160
+ * - Whether the products are
2161
+ * assigned to the same store.
2162
+ */
2163
+ same_store_assignment?: boolean;
2164
+ _id?: any;
2165
+ /**
2166
+ * - The name of the product grouping.
2167
+ */
2168
+ name: any;
2169
+ /**
2170
+ * - The choice of the product grouping.
2171
+ */
2172
+ choice?: any;
2173
+ /**
2174
+ * - The unique identifier for the product grouping.
2175
+ */
2176
+ slug?: any;
2177
+ /**
2178
+ * - Timestamp of when the document was
2179
+ * verified, if applicable
2180
+ */
2181
+ verified_on?: string;
2182
+ };
2183
+ /** @returns {ProductBundle} */
2184
+ declare function ProductBundle(): ProductBundle;
2185
+ type ProductBundle = {
2186
+ items?: ProductGroupingModel[];
2272
2187
  };
2273
2188
  /** @returns {StoreV3} */
2274
2189
  declare function StoreV3(): StoreV3;
2275
2190
  type StoreV3 = {
2276
- count?: number;
2277
- name?: string;
2278
2191
  uid?: number;
2192
+ name?: string;
2193
+ count?: number;
2194
+ };
2195
+ /** @returns {ArticleAssignmentV3} */
2196
+ declare function ArticleAssignmentV3(): ArticleAssignmentV3;
2197
+ type ArticleAssignmentV3 = {
2198
+ strategy?: string;
2199
+ level?: string;
2279
2200
  };
2280
2201
  /** @returns {StrategyWiseListingSchemaV3} */
2281
2202
  declare function StrategyWiseListingSchemaV3(): StrategyWiseListingSchemaV3;
2282
2203
  type StrategyWiseListingSchemaV3 = {
2283
2204
  distance?: number;
2284
2205
  pincode?: number;
2285
- quantity?: number;
2286
2206
  tat?: number;
2207
+ quantity?: number;
2287
2208
  };
2288
- /** @returns {ThirdLevelChild} */
2289
- declare function ThirdLevelChild(): ThirdLevelChild;
2290
- type ThirdLevelChild = {
2291
- _custom_json?: any;
2292
- action?: ProductListingAction;
2293
- banners?: ImageUrls;
2294
- childs?: any[];
2295
- name?: string;
2296
- slug?: string;
2297
- uid?: number;
2209
+ /** @returns {DetailsSchemaV3} */
2210
+ declare function DetailsSchemaV3(): DetailsSchemaV3;
2211
+ type DetailsSchemaV3 = {
2212
+ value?: string;
2213
+ type?: string;
2214
+ key?: string;
2298
2215
  };
2299
- /** @returns {Time} */
2300
- declare function Time(): Time;
2301
- type Time = {
2302
- hour?: number;
2303
- minute?: number;
2216
+ /** @returns {SellerGroupAttributes} */
2217
+ declare function SellerGroupAttributes(): SellerGroupAttributes;
2218
+ type SellerGroupAttributes = {
2219
+ title?: string;
2220
+ details?: DetailsSchemaV3[];
2304
2221
  };
2305
- /** @returns {UserDetail} */
2306
- declare function UserDetail(): UserDetail;
2307
- type UserDetail = {
2308
- /**
2309
- * - The contact details of the user.
2310
- */
2311
- contact?: string;
2312
- /**
2313
- * - A flag indicating whether the user is a super user.
2314
- */
2315
- super_user?: boolean;
2222
+ /** @returns {ReturnConfigSchemaV3} */
2223
+ declare function ReturnConfigSchemaV3(): ReturnConfigSchemaV3;
2224
+ type ReturnConfigSchemaV3 = {
2225
+ unit?: string;
2226
+ returnable?: boolean;
2227
+ time?: number;
2228
+ };
2229
+ /** @returns {ProductSetDistributionSizeV3} */
2230
+ declare function ProductSetDistributionSizeV3(): ProductSetDistributionSizeV3;
2231
+ type ProductSetDistributionSizeV3 = {
2232
+ pieces?: number;
2233
+ size?: string;
2234
+ };
2235
+ /** @returns {ProductSetDistributionV3} */
2236
+ declare function ProductSetDistributionV3(): ProductSetDistributionV3;
2237
+ type ProductSetDistributionV3 = {
2238
+ sizes?: ProductSetDistributionSizeV3[];
2239
+ };
2240
+ /** @returns {ProductSetV3} */
2241
+ declare function ProductSetV3(): ProductSetV3;
2242
+ type ProductSetV3 = {
2243
+ quantity?: number;
2244
+ size_distribution?: ProductSetDistributionV3;
2245
+ };
2246
+ /** @returns {ProductStockPriceV3} */
2247
+ declare function ProductStockPriceV3(): ProductStockPriceV3;
2248
+ type ProductStockPriceV3 = {
2316
2249
  /**
2317
- * - The user ID of the user.
2250
+ * - The effective or final price for the product
2251
+ * at the given pincode.
2318
2252
  */
2319
- user_id: string;
2253
+ effective?: number;
2320
2254
  /**
2321
- * - The username of the user.
2255
+ * - The currency code for which the product
2256
+ * is available
2322
2257
  */
2323
- username: string;
2324
- };
2325
- /** @returns {Weight} */
2326
- declare function Weight(): Weight;
2327
- type Weight = {
2258
+ currency_code?: string;
2328
2259
  /**
2329
- * - Whether the weight is the default one or not
2260
+ * - The currency symbol for the currency
2261
+ * in which the product is available.
2330
2262
  */
2331
- is_default: boolean;
2263
+ currency_symbol?: string;
2332
2264
  /**
2333
- * - The shipping weight of the product
2265
+ * - The marked price of the product.
2334
2266
  */
2335
- shipping: number;
2267
+ marked?: number;
2336
2268
  /**
2337
- * - The unit of weight
2269
+ * - The selling price of the product.
2338
2270
  */
2339
- unit: string;
2271
+ selling?: number;
2272
+ };
2273
+ /** @returns {ProductStockUnitPriceV3} */
2274
+ declare function ProductStockUnitPriceV3(): ProductStockUnitPriceV3;
2275
+ type ProductStockUnitPriceV3 = {
2276
+ unit?: string;
2277
+ currency_symbol?: string;
2278
+ currency_code?: string;
2279
+ price?: number;
2280
+ };
2281
+ /** @returns {MarketPlaceSttributesSchemaV3} */
2282
+ declare function MarketPlaceSttributesSchemaV3(): MarketPlaceSttributesSchemaV3;
2283
+ type MarketPlaceSttributesSchemaV3 = {
2284
+ title?: string;
2285
+ details?: DetailsSchemaV3[];
2286
+ };
2287
+ /** @returns {SellerV3} */
2288
+ declare function SellerV3(): SellerV3;
2289
+ type SellerV3 = {
2290
+ uid?: number;
2291
+ name?: string;
2292
+ count?: number;
2293
+ };
2294
+ /** @returns {PromiseSchema} */
2295
+ declare function PromiseSchema(): PromiseSchema;
2296
+ type PromiseSchema = {
2297
+ min?: string;
2298
+ max?: string;
2299
+ };
2300
+ /** @returns {ProductSizePriceResponseV3} */
2301
+ declare function ProductSizePriceResponseV3(): ProductSizePriceResponseV3;
2302
+ type ProductSizePriceResponseV3 = {
2303
+ store?: StoreV3;
2304
+ article_assignment?: ArticleAssignmentV3;
2305
+ is_cod?: boolean;
2306
+ strategy_wise_listing?: StrategyWiseListingSchemaV3[];
2307
+ quantity?: number;
2308
+ item_type?: string;
2309
+ grouped_attributes?: SellerGroupAttributes[];
2310
+ return_config?: ReturnConfigSchemaV3;
2311
+ article_id?: string;
2312
+ is_gift?: boolean;
2313
+ set?: ProductSetV3;
2314
+ seller_count?: number;
2315
+ price_per_piece?: ProductStockPriceV3;
2316
+ discount_meta?: DiscountMeta;
2317
+ discount?: string;
2318
+ long_lat?: number[];
2319
+ special_badge?: string;
2320
+ price?: ProductStockPriceV3;
2321
+ price_per_unit?: ProductStockUnitPriceV3;
2322
+ pincode?: number;
2323
+ marketplace_attributes?: MarketPlaceSttributesSchemaV3[];
2324
+ seller?: SellerV3;
2325
+ delivery_promise?: PromiseSchema;
2326
+ };
2327
+ /** @returns {ProductSizeSellerFilterSchemaV3} */
2328
+ declare function ProductSizeSellerFilterSchemaV3(): ProductSizeSellerFilterSchemaV3;
2329
+ type ProductSizeSellerFilterSchemaV3 = {
2330
+ name?: string;
2331
+ is_selected?: boolean;
2332
+ value?: string;
2333
+ };
2334
+ /** @returns {ProductSizeSellersResponseV3} */
2335
+ declare function ProductSizeSellersResponseV3(): ProductSizeSellersResponseV3;
2336
+ type ProductSizeSellersResponseV3 = {
2337
+ items?: ProductSizePriceResponseV3[];
2338
+ page: Page;
2339
+ sort_on?: ProductSizeSellerFilterSchemaV3[];
2340
2340
  };