@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.11

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 (150) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +3 -4
  7. package/sdk/application/ApplicationClient.js +0 -18
  8. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
  9. package/sdk/application/Cart/CartApplicationClient.js +60 -1185
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +90 -142
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +187 -1293
  12. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  13. package/sdk/application/Common/CommonApplicationClient.js +5 -89
  14. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  15. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  16. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -718
  18. package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
  19. package/sdk/application/Content/ContentApplicationClient.js +77 -914
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -11
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.js +19 -125
  22. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  23. package/sdk/application/Lead/LeadApplicationClient.js +32 -202
  24. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
  25. package/sdk/application/Logistic/LogisticApplicationClient.js +50 -478
  26. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
  27. package/sdk/application/Order/OrderApplicationClient.js +86 -472
  28. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
  29. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2102
  30. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
  31. package/sdk/application/Rewards/RewardsApplicationClient.js +16 -305
  32. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  33. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  34. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  35. package/sdk/application/Theme/ThemeApplicationClient.js +28 -162
  36. package/sdk/application/User/UserApplicationClient.d.ts +85 -136
  37. package/sdk/application/User/UserApplicationClient.js +45 -1815
  38. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
  39. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -47
  40. package/sdk/application/index.d.ts +0 -18
  41. package/sdk/application/index.js +0 -33
  42. package/sdk/common/Utility.d.ts +1 -1
  43. package/sdk/common/Utility.js +10 -7
  44. package/sdk/common/Validator.d.ts +1 -0
  45. package/sdk/common/Validator.js +20 -0
  46. package/sdk/common/utils.d.ts +0 -1
  47. package/sdk/common/utils.js +0 -14
  48. package/sdk/partner/OAuthClient.js +1 -0
  49. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
  50. package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
  51. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +39 -1
  52. package/sdk/platform/Cart/CartPlatformApplicationClient.js +247 -1
  53. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +33 -1
  54. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +37 -0
  55. package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
  56. package/sdk/platform/Cart/CartPlatformModel.js +132 -0
  57. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
  58. package/sdk/platform/Catalog/CatalogPlatformModel.js +1 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +14 -0
  60. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +6 -0
  61. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  62. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  63. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  64. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  65. package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
  66. package/sdk/platform/Order/OrderPlatformClient.js +99 -0
  67. package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
  68. package/sdk/platform/Order/OrderPlatformModel.js +3 -0
  69. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  70. package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
  71. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
  72. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
  73. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +56 -19
  74. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -18
  75. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -3
  76. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  77. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
  78. package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
  79. package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -2
  80. package/sdk/public/Content/ContentPublicClient.d.ts +1 -1
  81. package/sdk/public/Content/ContentPublicClient.js +14 -2
  82. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  83. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  84. package/sdk/public/Webhook/WebhookPublicClient.js +5 -2
  85. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  86. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  87. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  88. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  89. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  90. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  91. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  92. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  93. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  94. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  95. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  96. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  97. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  98. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  99. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  100. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  101. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  102. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  103. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  104. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  105. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  106. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  107. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  108. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  109. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  110. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  111. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  112. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  113. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  114. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  115. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  116. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  117. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  118. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  119. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  120. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  121. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  122. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  123. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  124. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  125. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  126. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  127. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  128. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  129. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  130. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  131. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  132. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  133. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  134. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  135. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  136. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  137. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  138. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  139. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  140. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  141. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  142. package/sdk/application/User/UserApplicationModel.js +0 -1382
  143. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  144. package/sdk/application/User/UserApplicationValidator.js +0 -573
  145. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  146. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  147. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  148. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  149. package/sdk/common/Clickstream.d.ts +0 -1
  150. package/sdk/common/Clickstream.js +0 -464
@@ -1,3857 +0,0 @@
1
- export = CatalogApplicationModel;
2
- /**
3
- * @typedef ProductDetailCustomOrder
4
- * @property {number} [manufacturing_time] - The unit of time taken for manufacturing.
5
- * @property {string} [manufacturing_time_unit] - The unit of time required for
6
- * manufacturing is defined in hours or days.
7
- * @property {boolean} [is_custom_order] - A boolean flag indicating whether MTO
8
- * (Make to Order) is enabled or not.
9
- */
10
- /**
11
- * @typedef Meta
12
- * @property {string} [source] - The source or origin of the media file, which
13
- * could be a URL or a reference to where the media was obtained.
14
- */
15
- /**
16
- * @typedef Media
17
- * @property {string} [url] - Absolute url for Media.
18
- * @property {string} [type] - The type of media, such as image, video.
19
- * @property {Meta} [meta]
20
- * @property {string} [alt] - Alternative text for the media, used for
21
- * accessibility and SEO purposes.
22
- */
23
- /**
24
- * @typedef ProductListingActionPage
25
- * @property {string} [type] - The type of action such as product, products,
26
- * category, brand.
27
- * @property {Object} [query] - Query parameter if any to be added to the action.
28
- * @property {Object} [params] - Parameters that should be considered in path.
29
- */
30
- /**
31
- * @typedef ProductListingAction
32
- * @property {string} [type] - Type of action to be taken e.g, page.
33
- * @property {ProductListingActionPage} [page]
34
- */
35
- /**
36
- * @typedef ProductBrand
37
- * @property {number} [uid] - Unique identifier for the product brand.
38
- * @property {Media} [logo]
39
- * @property {string} [description] - Description of the product brand.
40
- * @property {string} [name] - Name of the product brand.
41
- * @property {ProductListingAction} [action]
42
- */
43
- /**
44
- * @typedef ProductDepartment
45
- * @property {number} [uid] - Unique identifier for the product department.
46
- * @property {Media} [logo]
47
- * @property {string} [slug] - URL-friendly identifier for the product department.
48
- * @property {string} [name] - Name of the product department.
49
- */
50
- /**
51
- * @typedef ProductCategoryMap
52
- * @property {ProductBrand} [l1]
53
- * @property {ProductBrand} [l2]
54
- * @property {ProductBrand} [l3]
55
- */
56
- /**
57
- * @typedef NetQuantity
58
- * @property {Object} [unit] - The unit of measurement used for the net quantity
59
- * of the product.
60
- * @property {number} [value] - The value of the net quantity of the product.
61
- */
62
- /**
63
- * @typedef CustomMetaFields
64
- * @property {string} value - A value to store in the custom field.
65
- * @property {string} key - A key to store a custom field.
66
- */
67
- /**
68
- * @typedef ApplicationItemSEO
69
- * @property {Object} [title] - The SEO title of the item.
70
- * @property {Object} [description] - The SEO description of the item.
71
- */
72
- /**
73
- * @typedef ProductDetailAttribute
74
- * @property {string} [value] - The value of the product attribute.
75
- * @property {string} [type] - The type or category of the product attribute.
76
- * @property {string} [key] - The key or name of the product attribute.
77
- */
78
- /**
79
- * @typedef ProductDetailGroupedAttribute
80
- * @property {string} [title] - The title or name of the attribute group.
81
- * @property {ProductDetailAttribute[]} [details] - A list of product attributes
82
- * within this group.
83
- */
84
- /**
85
- * @typedef ApplicationItemMOQ
86
- * @property {number} [minimum] - The minimum quantity required for purchase.
87
- * @property {number} [maximum] - The maximum quantity allowed for purchase.
88
- * @property {number} [increment_unit] - The minimum quantity increment in which
89
- * the item can be purchased.
90
- */
91
- /**
92
- * @typedef Price
93
- * @property {number} [min] - The minimum price for the product across stores.
94
- * @property {string} [currency_symbol] - The currency symbol for the currency
95
- * in which the product is available.
96
- * @property {string} [currency_code] - The currency code for the currency in
97
- * which the product is available.
98
- * @property {number} [max] - The maximum price for the product across stores.
99
- */
100
- /**
101
- * @typedef ProductListingPrice
102
- * @property {Price} [effective]
103
- * @property {Price} [marked]
104
- */
105
- /**
106
- * @typedef ProductSizesPrice
107
- * @property {Price} [effective]
108
- * @property {Price} [marked]
109
- * @property {Price} [selling]
110
- */
111
- /**
112
- * @typedef ProductDetail
113
- * @property {number} [uid] - Unique identifier for the product.
114
- * @property {ProductDetailCustomOrder} [custom_order]
115
- * @property {ProductCategoryMap} [category_map]
116
- * @property {NetQuantity} [net_quantity]
117
- * @property {number} [rating_count] - Count of ratings the product has received.
118
- * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
119
- * associated with the product.
120
- * @property {string[]} [similars] - List of products marked similar to given product.
121
- * @property {string[]} [tags] - Tags associated with the product for better
122
- * categorization.
123
- * @property {ApplicationItemSEO} [seo]
124
- * @property {string} [image_nature] - Type of the images associated with the
125
- * product such as standard.
126
- * @property {boolean} [has_variant] - Indicates whether the product has variants.
127
- * @property {string} [item_type] - This field describes the type of item,
128
- * indicating the category or nature of the product. Possible values are
129
- * Standard, Composite, Wet, Digital.
130
- * @property {string} [description] - Detailed description of the product.
131
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes] - Grouped
132
- * attributes detailing various characteristics of the product.
133
- * @property {Media[]} [medias] - Media files associated with the product.
134
- * @property {string} [color] - Color of the product, if applicable.
135
- * @property {string} [type] - Product type or classification.
136
- * @property {string} [product_online_date] - Date and time when the product was
137
- * made available online.
138
- * @property {Object} [_custom_json] - Custom JSON object for additional product data.
139
- * @property {string} [item_code] - Item Code defined for the product.
140
- * @property {string} [name] - Name of the product.
141
- * @property {ApplicationItemMOQ} [moq]
142
- * @property {string} [short_description] - Brief description of the product.
143
- * @property {ProductBrand[]} [categories] - List of product categories
144
- * associated with the product.
145
- * @property {Object} [attributes] - Additional attributes or characteristics of
146
- * the product.
147
- * @property {string} [discount] - Discount applied to the product, if any.
148
- * @property {string[]} [tryouts] - Identifiers or names of tryout versions of
149
- * the product.
150
- * @property {string} slug - URL-friendly identifier for the product.
151
- * @property {ProductListingAction} [action]
152
- * @property {number} [rating] - The rating of the product.
153
- * @property {boolean} [is_dependent] - Indicates whether the product can be
154
- * sold as an individual product.
155
- * @property {string[]} [product_group_tag] - List of bundle/product grouping
156
- * slugs mapped to the product.
157
- * @property {string[]} [highlights] - Key highlights or features of the product.
158
- * @property {ProductListingPrice} [price]
159
- * @property {ProductBrand} [brand]
160
- * @property {ProductDepartment} [department]
161
- * @property {string} [teaser_tag] - Teaser tag or short promotional phrase for
162
- * the product.
163
- */
164
- /**
165
- * @typedef ErrorResponse
166
- * @property {string} [error] - A brief description of the error.
167
- */
168
- /**
169
- * @typedef Dimension
170
- * @property {string} unit - The unit of dimension.
171
- * @property {number} height - The height of the product.
172
- * @property {number} length - The length of the product.
173
- * @property {number} width - The width of the product.
174
- * @property {boolean} is_default - Whether the dimension is the default one or not.
175
- */
176
- /**
177
- * @typedef Weight
178
- * @property {string} unit - The unit of weight.
179
- * @property {number} shipping - The shipping weight of the product.
180
- * @property {boolean} is_default - Whether the weight is the default one or not.
181
- */
182
- /**
183
- * @typedef DiscountMeta
184
- * @property {boolean} [timer] - Determines whether the discount countdown is
185
- * visible or not.
186
- * @property {number} [start_timer_in_minutes] - The time in minutes before the
187
- * discount ends when the countdown timer should start.
188
- * @property {string} [start] - The start time of the live discount.
189
- * @property {string} [end] - The end time of the live discount.
190
- */
191
- /**
192
- * @typedef ProductSize
193
- * @property {number} [quantity] - The quantity of the product size available.
194
- * @property {Dimension} [dimension]
195
- * @property {Weight} [weight]
196
- * @property {boolean} [is_available] - Indicates whether the product size is
197
- * available for purchase.
198
- * @property {string[]} [seller_identifiers] - List of identifiers used by
199
- * sellers for the product size.
200
- * @property {string} [value] - The value or label representing the product size.
201
- * @property {string} [display] - Display name of the product size.
202
- */
203
- /**
204
- * @typedef SizeChartValues
205
- * @property {string} [col_3] - Value for column 3.
206
- * @property {string} [col_6] - Value for column 6.
207
- * @property {string} [col_2] - Value for column 2.
208
- * @property {string} [col_4] - Value for column 4.
209
- * @property {string} [col_1] - Value for column 1.
210
- * @property {string} [col_5] - Value for column 5.
211
- */
212
- /**
213
- * @typedef ColumnHeader
214
- * @property {boolean} [convertable] - Indicates if the column value can be
215
- * converted or transformed.
216
- * @property {string} [value] - The value or title of the column header.
217
- */
218
- /**
219
- * @typedef ColumnHeaders
220
- * @property {ColumnHeader} [col_3]
221
- * @property {ColumnHeader} [col_6]
222
- * @property {ColumnHeader} [col_2]
223
- * @property {ColumnHeader} [col_4]
224
- * @property {ColumnHeader} [col_1]
225
- * @property {ColumnHeader} [col_5]
226
- */
227
- /**
228
- * @typedef SizeChart
229
- * @property {string} [unit] - Unit of measurement used in the size chart (e.g., in, cm).
230
- * @property {string} [image] - URL of the image representing the size chart.
231
- * @property {string} [size_tip] - Additional tip or guideline related to sizing.
232
- * @property {SizeChartValues[]} [sizes] - Array of size chart values for different sizes.
233
- * @property {string} [description] - Description related to the size chart.
234
- * @property {string} [title] - Title or name of the size chart.
235
- * @property {ColumnHeaders} [headers]
236
- */
237
- /**
238
- * @typedef ProductSizeStores
239
- * @property {number} [count] - Number of stores where the product size is available.
240
- */
241
- /**
242
- * @typedef ProductSizes
243
- * @property {ProductSize[]} [sizes] - List of available sizes for the product.
244
- * @property {ProductSizesPrice} [price]
245
- * @property {ProductSizesPrice} [price_per_piece]
246
- * @property {SizeChart} [size_chart]
247
- * @property {boolean} [sellable] - Whether the product sizes are available for sale.
248
- * @property {boolean} [multi_size] - Whether the product supports multiple sizes.
249
- * @property {string} [discount] - Discount information applicable to the product sizes.
250
- * @property {ProductSizeStores} [stores]
251
- * @property {DiscountMeta} [discount_meta]
252
- */
253
- /**
254
- * @typedef AttributeDetail
255
- * @property {string} [logo] - URL or path to the logo associated with the attribute.
256
- * @property {string} [description] - A description of the attribute.
257
- * @property {string} [display] - Display name or label for the attribute.
258
- * @property {string} [key] - Unique key or identifier for the attribute.
259
- */
260
- /**
261
- * @typedef AttributeMetadata
262
- * @property {string} [title] - Title or name of the attribute metadata.
263
- * @property {AttributeDetail[]} [details] - List of detailed information about
264
- * attributes.
265
- */
266
- /**
267
- * @typedef ProductsComparisonResponse
268
- * @property {ProductDetail[]} [items] - List of product details for comparison.
269
- * @property {AttributeMetadata[]} [attributes_metadata] - Metadata about
270
- * attributes used for comparing products.
271
- */
272
- /**
273
- * @typedef ProductCompareResponse
274
- * @property {string} [title] - Title or name of the comparison.
275
- * @property {ProductDetail[]} [items] - List of product details for comparison.
276
- * @property {AttributeMetadata[]} [attributes_metadata] - Metadata about
277
- * attributes used for comparing products.
278
- * @property {string} [subtitle] - Subtitle or additional description for the comparison.
279
- */
280
- /**
281
- * @typedef ProductFrequentlyComparedSimilarResponse
282
- * @property {ProductCompareResponse} [similars]
283
- */
284
- /**
285
- * @typedef ProductVariantItemResponse
286
- * @property {number} [uid] - Unique identifier for the product variant.
287
- * @property {string} [color_name] - Name of the color for the variant.
288
- * @property {string} [color] - Color code or representation for the variant.
289
- * @property {Media[]} [medias] - Media files associated with the product variant.
290
- * @property {boolean} [is_available] - Indicates whether the product variant is
291
- * available for purchase.
292
- * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
293
- * associated with the product.
294
- * @property {string} [name] - Name of the product variant.
295
- * @property {string} [value] - Value or label representing the product variant.
296
- * @property {string} [slug] - URL-friendly identifier for the product.
297
- * @property {Object} [_custom_json] - Custom JSON object for additional data
298
- * related to the product.
299
- * @property {ProductListingAction} [action]
300
- */
301
- /**
302
- * @typedef ProductVariantResponse
303
- * @property {string} [display_type] - The type of display for the product
304
- * variant (e.g., image, text, image, color).
305
- * @property {string} [header] - Header or title for the product variant section.
306
- * @property {string} [group_id] - Group ID used to group variants.
307
- * @property {ProductVariantItemResponse[]} [items] - List of product variant items.
308
- * @property {string} [key] - Attribute identifier of the variant.
309
- * @property {string} [logo] - URL or path to the logo associated with the
310
- * product variant.
311
- */
312
- /**
313
- * @typedef ProductVariantsResponse
314
- * @property {ProductVariantResponse[]} [variants] - A list of product variant
315
- * responses, each detailing a specific variant.
316
- */
317
- /**
318
- * @typedef StoreDetail
319
- * @property {string} [name] - NA.
320
- * @property {string} [city] - NA.
321
- * @property {number} [id] - NA.
322
- * @property {string} [code] - NA.
323
- */
324
- /**
325
- * @typedef ProductStockPrice
326
- * @property {number} [effective] - NA.
327
- * @property {string} [currency] - NA.
328
- * @property {number} [marked] - NA.
329
- */
330
- /**
331
- * @typedef CompanyDetail
332
- * @property {string} [name] - NA.
333
- * @property {number} [id] - NA.
334
- */
335
- /**
336
- * @typedef Seller
337
- * @property {number} [uid] - NA.
338
- * @property {string} [name] - NA.
339
- * @property {number} [count] - NA.
340
- */
341
- /**
342
- * @typedef ProductStockStatusItem
343
- * @property {string} [uid] - NA.
344
- * @property {number} [quantity] - NA.
345
- * @property {StoreDetail} [store]
346
- * @property {string} [size] - NA.
347
- * @property {ProductStockPrice} [price]
348
- * @property {CompanyDetail} [company]
349
- * @property {number} [item_id] - NA.
350
- * @property {Seller} [seller]
351
- * @property {Object} [identifier] - NA.
352
- */
353
- /**
354
- * @typedef ProductStockStatusResponse
355
- * @property {ProductStockStatusItem[]} [items] - NA.
356
- */
357
- /**
358
- * @typedef Page
359
- * @property {number} [item_total] - The total number of items on the page.
360
- * @property {string} [next_id] - The identifier for the next page.
361
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
362
- * @property {boolean} [has_next] - Indicates whether there is a next page.
363
- * @property {number} [current] - The current page number.
364
- * @property {string} type - The type of the page, such as 'PageType'.
365
- * @property {number} [size] - The number of items per page.
366
- */
367
- /**
368
- * @typedef ProductStockPolling
369
- * @property {ProductStockStatusItem[]} [items] - NA.
370
- * @property {Page} page
371
- */
372
- /**
373
- * @typedef ProductVariantListingResponse
374
- * @property {string} [header] - Header or title for the product variant section.
375
- * @property {ProductVariantItemResponse[]} [items] - List of Upto 5 product
376
- * variant items.
377
- * @property {number} [total] - The total number of product variants available.
378
- * @property {string} [key] - Attribute identifier of the variant.
379
- * @property {string} [display_type] - The type of display for the product
380
- * variant (e.g., image, text, image, color).
381
- */
382
- /**
383
- * @typedef ProductListingDetail
384
- * @property {number} [uid] - Unique identifier for the product.
385
- * @property {ProductDetailCustomOrder} [custom_order]
386
- * @property {string[]} [sizes] - Available sizes for the product.
387
- * @property {ProductCategoryMap} [category_map]
388
- * @property {NetQuantity} [net_quantity]
389
- * @property {number} [rating_count] - The number of ratings the product has received.
390
- * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
391
- * associated with the product.
392
- * @property {string[]} [similars] - List of products marked similar to given product.
393
- * @property {string[]} [tags] - Tags associated with the product for better
394
- * categorization.
395
- * @property {ApplicationItemSEO} [seo]
396
- * @property {string} [image_nature] - Type of the images associated with the
397
- * product such as standard.
398
- * @property {boolean} [has_variant] - Indicates whether the product has variants.
399
- * @property {string} [item_type] - This field describes the type of item,
400
- * indicating the category or nature of the product. Possible values are
401
- * Standard, Composite, Wet, Digital.
402
- * @property {string} [description] - Detailed description of the product.
403
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes] - Grouped
404
- * attributes detailing various characteristics of the product.
405
- * @property {Media[]} [medias] - Media files associated with the product.
406
- * @property {string} [color] - Color of the product, if applicable.
407
- * @property {string} [type] - Product type or classification.
408
- * @property {string} [product_online_date] - Date and time when the product was
409
- * made available online.
410
- * @property {Object} [_custom_json] - Custom JSON object for additional product data.
411
- * @property {string} [item_code] - Item Code defined for the product.
412
- * @property {string} [name] - Name of the product.
413
- * @property {ApplicationItemMOQ} [moq]
414
- * @property {string} [short_description] - Brief description of the product.
415
- * @property {ProductBrand[]} [categories] - List of product categories
416
- * associated with the product.
417
- * @property {boolean} [sellable] - Indicates whether the product is available for sale.
418
- * @property {Object} [attributes] - Additional attributes or characteristics of
419
- * the product.
420
- * @property {ProductVariantListingResponse[]} [variants] - List of product
421
- * variants available for the product.
422
- * @property {string} [discount] - Discount details or percentage applied to the product.
423
- * @property {string[]} [tryouts] - List of tryout options available for the product.
424
- * @property {string[]} [identifiers] - List of seller identifiers for the product.
425
- * @property {string} slug - URL-friendly identifier for the product.
426
- * @property {ProductListingAction} [action]
427
- * @property {number} [rating] - Rating of the product.
428
- * @property {boolean} [is_dependent] - Indicates whether the product can be
429
- * sold as an individual product.
430
- * @property {string[]} [product_group_tag] - List of bundle/product grouping
431
- * slugs mapped to the product.
432
- * @property {string[]} [highlights] - Key highlights or features of the product.
433
- * @property {ProductListingPrice} [price]
434
- * @property {ProductBrand} [brand]
435
- * @property {string} [teaser_tag] - Teaser tag or short promotional phrase for
436
- * the product.
437
- */
438
- /**
439
- * @typedef ProductFiltersValue
440
- * @property {number} [min] - Minimum value for the range filter.
441
- * @property {string} [display_format] - Format in which the filter value is displayed.
442
- * @property {number} [selected_max] - The maximum value selected by the user
443
- * for range filter.
444
- * @property {string} [value] - Value associated with the filter option.
445
- * @property {string} [query_format] - Format used for the filter value in queries.
446
- * @property {string} [currency_symbol] - Currency symbol for the price type filters.
447
- * @property {number} [selected_min] - The minimum value selected by the user
448
- * for range filter.
449
- * @property {string} [currency_code] - Currency code for the currency used for
450
- * price type filters.
451
- * @property {boolean} is_selected - Whether this filter value is currently selected.
452
- * @property {string} display - Display name or label for the filter value.
453
- * @property {number} [count] - Number of products that match this filter value.
454
- * @property {number} [max] - Maximum value of the filter range.
455
- */
456
- /**
457
- * @typedef ProductFiltersKey
458
- * @property {string} [logo] - URL or path to the logo associated with the filter key.
459
- * @property {string} name - Name or identifier of the filter key.
460
- * @property {string} [kind] - Type or category of the filter key (e.g., range,
461
- * multivalued).
462
- * @property {string} display - Display name or label for the filter key.
463
- */
464
- /**
465
- * @typedef ProductFilters
466
- * @property {ProductFiltersValue[]} values - List of filter values associated
467
- * with the filter key.
468
- * @property {ProductFiltersKey} key
469
- */
470
- /**
471
- * @typedef ProductSortOn
472
- * @property {string} [logo] - URL or path to the logo associated with the sorting option.
473
- * @property {boolean} [is_selected] - Indicates whether this sorting option is
474
- * currently selected.
475
- * @property {string} [name] - Name or identifier of the sorting option.
476
- * @property {string} [value] - Value used to specify the sorting order (e.g.,
477
- * price_asc, discount_dsc).
478
- * @property {string} [display] - Display name or label for the sorting option.
479
- */
480
- /**
481
- * @typedef ProductListingResponse
482
- * @property {ProductListingDetail[]} [items] - List of product details included
483
- * in the response.
484
- * @property {ProductFilters[]} [filters] - List of filters available for
485
- * refining the product listings.
486
- * @property {Page} page
487
- * @property {ProductSortOn[]} [sort_on] - List of sorting options available for
488
- * the product listings.
489
- */
490
- /**
491
- * @typedef ImageUrls
492
- * @property {Media} [portrait]
493
- * @property {Media} [landscape]
494
- */
495
- /**
496
- * @typedef BrandItem
497
- * @property {number} [uid] - The unique identifier for the brand.
498
- * @property {Media} [logo]
499
- * @property {string} [description] - Detailed description of the brand,
500
- * including its history, values, product offerings, and other relevant information.
501
- * @property {ImageUrls} [banners]
502
- * @property {string[]} [departments] - Lists the departments or categories
503
- * under which the brand's products are listed.
504
- * @property {string} [discount] - Details about any discounts currently
505
- * available on the brand's products.
506
- * @property {string} [name] - Name of the brand.
507
- * @property {string} [slug] - URL-friendly version of the brand's name, used in
508
- * the web address to access the brand's page on the platform.
509
- * @property {ProductListingAction} [action]
510
- */
511
- /**
512
- * @typedef BrandListingResponse
513
- * @property {BrandItem[]} [items] - List of brand items included in the response.
514
- * @property {Page} page
515
- */
516
- /**
517
- * @typedef BrandDetailResponse
518
- * @property {Media} [logo]
519
- * @property {number} [uid] - The unique identifier for the brand.
520
- * @property {string} [description] - Detailed description of the brand,
521
- * including its history, values, product offerings, and other relevant information.
522
- * @property {ImageUrls} [banners]
523
- * @property {Object} [_custom_json] - Custom JSON data related to the brand,
524
- * allowing for additional metadata.
525
- * @property {string} [name] - Name of the brand.
526
- */
527
- /**
528
- * @typedef CategoryBanner
529
- * @property {Media} portrait
530
- * @property {Media} landscape
531
- */
532
- /**
533
- * @typedef ThirdLevelChild
534
- * @property {number} [uid] - Unique identifier for the L3 category.
535
- * @property {ImageUrls} [banners]
536
- * @property {Object[]} [childs] - List of categories under the L3 category.
537
- * @property {Object} [_custom_json] - Custom JSON data related to the L3
538
- * category, allowing for additional metadata.
539
- * @property {string} [name] - Name of the L3 category.
540
- * @property {string} [slug] - Slug or URL-friendly identifier for the L3 category.
541
- * @property {ProductListingAction} [action]
542
- */
543
- /**
544
- * @typedef SecondLevelChild
545
- * @property {number} [uid] - Unique identifier for the L2 category.
546
- * @property {ImageUrls} [banners]
547
- * @property {ThirdLevelChild[]} [childs] - List of categories under the L2 category.
548
- * @property {Object} [_custom_json] - Custom JSON data related to the L2
549
- * category, allowing for additional metadata.
550
- * @property {string} [name] - Name of the L2 category.
551
- * @property {string} [slug] - Slug or URL-friendly identifier for the L2 category.
552
- * @property {ProductListingAction} [action]
553
- */
554
- /**
555
- * @typedef Child
556
- * @property {number} [uid] - Unique identifier for the L1 category.
557
- * @property {ImageUrls} [banners]
558
- * @property {SecondLevelChild[]} [childs] - List of categories under the L1 category.
559
- * @property {Object} [_custom_json] - Custom JSON data related to the L1
560
- * category, allowing for additional metadata.
561
- * @property {string} [name] - Name of the L1 category.
562
- * @property {string} [slug] - Slug or URL-friendly identifier for the L1 category.
563
- * @property {ProductListingAction} [action]
564
- */
565
- /**
566
- * @typedef CategoryItems
567
- * @property {number} uid - Unique identifier for the category.
568
- * @property {CategoryBanner} banners
569
- * @property {Child[]} [childs] - List of L1 categories under the main category.
570
- * @property {string} name - Name of the category.
571
- * @property {string} slug - Slug or URL-friendly identifier for the category.
572
- * @property {ProductListingAction} action
573
- */
574
- /**
575
- * @typedef DepartmentCategoryTree
576
- * @property {CategoryItems[]} [items] - List of categories within the department.
577
- * @property {string} department - Name of the department.
578
- */
579
- /**
580
- * @typedef DepartmentIdentifier
581
- * @property {number} [uid] - Unique identifier for the department.
582
- * @property {string} [slug] - Slug or URL-friendly identifier for the department.
583
- */
584
- /**
585
- * @typedef CategoryListingResponse
586
- * @property {DepartmentCategoryTree[]} [data] - List of department category trees.
587
- * @property {DepartmentIdentifier[]} [departments] - List of departments.
588
- */
589
- /**
590
- * @typedef CategoryMetaResponse
591
- * @property {Media} [logo]
592
- * @property {number} [uid] - Unique identifier for the category.
593
- * @property {ImageUrls} [banners]
594
- * @property {Object} [_custom_json] - Custom JSON data related to the category,
595
- * allowing for additional metadata.
596
- * @property {string} [name] - Name of the category.
597
- */
598
- /**
599
- * @typedef HomeListingResponse
600
- * @property {ProductListingDetail[]} [items] - List of product details
601
- * displayed on the home page.
602
- * @property {Page} page
603
- * @property {string} [message] - Message related to the home listing response.
604
- */
605
- /**
606
- * @typedef Department
607
- * @property {number} [uid] - Unique identifier for the department.
608
- * @property {Media} [logo]
609
- * @property {number} [priority_order] - Specifies the display order of the
610
- * department, determining its position in lists and navigation menus based on
611
- * priority.
612
- * @property {string} [name] - Name of the department.
613
- * @property {string} [slug] - URL-friendly version of the department's name,
614
- * used in the web address to access the department's page on the platform.
615
- */
616
- /**
617
- * @typedef DepartmentResponse
618
- * @property {Department[]} [items] - List of department detail objects.
619
- */
620
- /**
621
- * @typedef AutocompleteItem
622
- * @property {Media} [logo]
623
- * @property {string} [display] - Text or value displayed for the autocomplete item.
624
- * @property {string} [type] - The type of action such as product, products,
625
- * category, brand.
626
- * @property {Object} [_custom_json] - Custom JSON data related to the
627
- * autocomplete item, allowing for additional metadata.
628
- * @property {ProductListingAction} [action]
629
- */
630
- /**
631
- * @typedef AutoCompleteResponse
632
- * @property {AutocompleteItem[]} [items] - List of autocomplete items suggested
633
- * based on user input.
634
- */
635
- /**
636
- * @typedef CollectionQuery
637
- * @property {string} op - The operator used for filtering the collection.
638
- * @property {Object[]} value - The values used for filtering based on the attribute.
639
- * @property {string} attribute - The attribute on which the filter is applied.
640
- */
641
- /**
642
- * @typedef GetCollectionDetailNest
643
- * @property {boolean} [is_active] - Indicates whether the collection is currently active.
644
- * @property {string} [uid] - The unique identifier for the collection.
645
- * @property {string} [sort_on] - The attribute by which the collection items are sorted.
646
- * @property {Object} [meta] - Additional metadata related to the collection.
647
- * @property {ImageUrls} [banners]
648
- * @property {Object} [cron] - Cron details for scheduling related to the collection.
649
- * @property {Object} [_schedule] - The `Schedule` schema defines the timing and
650
- * details for recurring or one-time tasks. It includes information on when
651
- * the job should start and end, the frequency of the task, and any additional
652
- * metadata. This schema helps in scheduling jobs or tasks based on specified
653
- * timings and durations.
654
- * @property {CollectionQuery[]} [query] - A list of queries used to filter the
655
- * collection.
656
- * @property {string} [description] - A detailed description of the collection.
657
- * @property {string} [type] - Type of collections e.g query, items.
658
- * @property {Object} [_custom_json] - Custom JSON data associated with the collection.
659
- * @property {string} [name] - The name of the collection.
660
- * @property {boolean} [allow_sort] - Indicates if sorting is allowed for this collection.
661
- * @property {string[]} [visible_facets_keys] - Keys of the facets visible for
662
- * filtering within the collection.
663
- * @property {Object} [badge] - Badge information associated with the collection.
664
- * @property {string} [slug] - The URL-friendly identifier for the collection.
665
- * @property {ProductListingAction} [action]
666
- * @property {boolean} [allow_facets] - Indicates if facets are allowed for
667
- * filtering within the collection.
668
- * @property {Media} [logo]
669
- * @property {number} [priority] - Priority level of the collection for sorting
670
- * or display purposes.
671
- * @property {string[]} [tags] - Tags associated with the collection.
672
- * @property {string} [app_id] - Application ID associated with the collection.
673
- */
674
- /**
675
- * @typedef CollectionListingFilterTag
676
- * @property {string} [name] - The name of the tag. This is typically used as a
677
- * label for filtering purposes.
678
- * @property {boolean} [is_selected] - A flag indicating whether the tag is
679
- * currently selected as a filter option.
680
- * @property {string} [display] - The display name of the tag. This may be a
681
- * user-friendly version of the tag name shown in the UI.
682
- */
683
- /**
684
- * @typedef CollectionListingFilterType
685
- * @property {string} [name] - The name of the filter type. This indicates the
686
- * type of filtering being applied, such as items, query.
687
- * @property {boolean} [is_selected] - A flag indicating whether this filter
688
- * type is currently selected as a filter option.
689
- * @property {string} [display] - The display name of the filter type. This is
690
- * the user-friendly name shown in the UI for the filter type.
691
- */
692
- /**
693
- * @typedef CollectionListingFilter
694
- * @property {CollectionListingFilterTag[]} [tags] - An array of tag filters
695
- * available for the collection listings. Each tag allows for filtering based
696
- * on specific attributes.
697
- * @property {CollectionListingFilterType[]} [type] - An array of filter types
698
- * available for the collection listings. Each type represents a different
699
- * category or attribute for filtering.
700
- */
701
- /**
702
- * @typedef GetCollectionListingResponse
703
- * @property {GetCollectionDetailNest[]} [items] - An array of collection
704
- * details. Each item in the array represents a collection with various
705
- * attributes and configurations.
706
- * @property {CollectionListingFilter} [filters]
707
- * @property {Page} page
708
- */
709
- /**
710
- * @typedef CollectionDetailResponse
711
- * @property {boolean} [is_active] - Indicates whether the collection is active.
712
- * @property {string} [sort_on] - Criteria used to sort the items within the
713
- * collection, such as price, popularity, or newest first.
714
- * @property {Object} [meta] - Metadata associated with the collection.
715
- * @property {ImageUrls} [banners]
716
- * @property {Object} [cron] - Cron schedule details related to the collection,
717
- * if applicable.
718
- * @property {Object} [_schedule] - Schedule details for the collection,
719
- * including timing and duration information.
720
- * @property {CollectionQuery[]} [query] - Search or filter query used to
721
- * dynamically generate the collection based on specific criteria or conditions.
722
- * @property {string} [description] - Detailed description of the collection,.
723
- * @property {string} [type] - Type of collection, specifying the nature or
724
- * category of the collection.
725
- * @property {Object} [_custom_json] - Custom JSON object containing additional
726
- * properties specific to the collection.
727
- * @property {string} [name] - The name of the collection.
728
- * @property {boolean} [allow_sort] - Indicates if sorting is allowed for this collection.
729
- * @property {string[]} [visible_facets_keys] - Keys of the facets visible for
730
- * filtering within the collection.
731
- * @property {Object} [badge] - Badge information associated with the collection.
732
- * @property {string} [slug] - The URL-friendly identifier for the collection.
733
- * @property {boolean} [allow_facets] - Indicates if facets are allowed for
734
- * filtering within the collection.
735
- * @property {Media} [logo]
736
- * @property {number} [priority] - Priority level of the collection for sorting
737
- * or display purposes.
738
- * @property {string[]} [tag] - Tags associated with the collection.
739
- * @property {string} [app_id] - Application ID associated with the collection.
740
- */
741
- /**
742
- * @typedef GetFollowListingResponse
743
- * @property {ProductListingDetail[]} items - An array of product details that
744
- * the user is following. Each item includes information such as the product
745
- * name, price, and other attributes.
746
- * @property {Page} page
747
- */
748
- /**
749
- * @typedef FollowPostResponse
750
- * @property {string} message - A message indicating the result of the follow or
751
- * unfollow operation. This could be a confirmation message or an error message.
752
- * @property {string} id - A unique identifier for the follow operation, which
753
- * can be used to reference or track the follow status.
754
- */
755
- /**
756
- * @typedef FollowerCountResponse
757
- * @property {number} [count] - The number of followers for the item. This count
758
- * indicates how many users are following the specified item.
759
- */
760
- /**
761
- * @typedef FollowIdsData
762
- * @property {number[]} [products] - An array of IDs representing the products
763
- * that the user is following.
764
- * @property {number[]} [collections] - An array of IDs representing the
765
- * collections that the user is following.
766
- * @property {number[]} [brands] - An array of IDs representing the brands that
767
- * the user is following.
768
- */
769
- /**
770
- * @typedef FollowIdsResponse
771
- * @property {FollowIdsData} [data]
772
- */
773
- /**
774
- * @typedef LatLong
775
- * @property {number[]} [coordinates] - An array containing the latitude and
776
- * longitude values of the location.
777
- * @property {string} [type] - The type of geographic coordinate system used.
778
- * For example, "Point" indicates a single point in a geographic coordinate system.
779
- */
780
- /**
781
- * @typedef Store
782
- * @property {number} [uid] - A unique identifier for the store.
783
- * @property {string} [store_email] - The manager's email address for the store.
784
- * @property {string} [state] - The state or province where the store is located.
785
- * @property {string} [country] - The country where the store is located.
786
- * @property {number} [pincode] - The postal code or zip code for the store's location.
787
- * @property {string} [city] - The city where the store is located.
788
- * @property {string} [address] - The street address of the store.
789
- * @property {string} [store_code] - A unique code or identifier for the store,
790
- * often used for internal reference.
791
- * @property {LatLong} [lat_long]
792
- * @property {string} [name] - The name of the store.
793
- * @property {string[]} [tags] - The list of tags mapped to the store.
794
- */
795
- /**
796
- * @typedef StoreListingResponse
797
- * @property {Store[]} items - An array of store details. Each store includes
798
- * information such as name, address, and geographic coordinates.
799
- * @property {Page} page
800
- */
801
- /**
802
- * @typedef StoreDepartments
803
- * @property {number} [uid] - The unique identifier assigned to the store department.
804
- * @property {Object} [logo] - An object containing information about the store
805
- * department's logo, such as the URL or other related media details.
806
- * @property {number} [priority_order] - The priority or ranking of the
807
- * department within the store. This field is used to determine the order in
808
- * which departments are displayed or processed.
809
- * @property {string} [name] - The name of the store department, which is
810
- * typically used for display and identification purposes.
811
- * @property {string} [slug] - A URL-friendly identifier for the store
812
- * department, often used in web addresses and routing to uniquely identify
813
- * the department.
814
- */
815
- /**
816
- * @typedef CompanyStore
817
- * @property {number} [uid] - The unique identifier for the company store.
818
- * @property {string} [name] - The name of the company store.
819
- * @property {string} [company_type] - The type of company, which can be one of
820
- * the following: - `distributor`: Distributor - `franchise`: Franchise -
821
- * `mbo`: MBO (Managed Business Operations) - `manufacturer-owner`: Owner/Manufacturer.
822
- * @property {string} [business_type] - The type of business structure, which
823
- * can be one of the following: - `Private`: Private Limited Company -
824
- * `LLP/Partnership`: Limited Liability Partnership or Partnership -
825
- * `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
826
- */
827
- /**
828
- * @typedef SellerPhoneNumber
829
- * @property {number} country_code - The country code of the seller's phone number.
830
- * @property {string} number - The seller's contact number.
831
- */
832
- /**
833
- * @typedef StoreManagerSerializer
834
- * @property {string} [name] - The name of the store manager.
835
- * @property {string} [email] - The email address of the store manager.
836
- * @property {SellerPhoneNumber} [mobile_no]
837
- */
838
- /**
839
- * @typedef StoreAddressSerializer
840
- * @property {number} [latitude] - The latitude of the store's location.
841
- * @property {string} [state] - The state where the store is located.
842
- * @property {string} [country] - The country where the store is located.
843
- * @property {string} [landmark] - A landmark near the store.
844
- * @property {string} [address1] - The address line 1 of the store.
845
- * @property {number} [pincode] - The postal code for the store's location.
846
- * @property {string} [city] - The city where the store is located.
847
- * @property {number} [longitude] - The longitude of the store's location.
848
- * @property {string} [address2] - The address line2 of the store.
849
- */
850
- /**
851
- * @typedef AppStore
852
- * @property {number} [uid] - The unique identifier for the application store.
853
- * @property {StoreDepartments[]} [departments] - A list of departments within the store.
854
- * @property {CompanyStore} [company]
855
- * @property {StoreManagerSerializer} [manager]
856
- * @property {string} [store_code] - A unique code for identifying the store.
857
- * @property {StoreAddressSerializer} [address]
858
- * @property {string} [name] - The name of the store.
859
- * @property {SellerPhoneNumber[]} [contact_numbers] - A list of contact numbers
860
- * for the store.
861
- */
862
- /**
863
- * @typedef ApplicationStoreListing
864
- * @property {Object[]} [filters] - A list of filters applied to the store listing.
865
- * @property {AppStore[]} [items] - A list of application stores.
866
- * @property {Page} [page]
867
- */
868
- /**
869
- * @typedef Time
870
- * @property {number} [hour] - The hour part of the time.
871
- * @property {number} [minute] - The minute part of the time.
872
- */
873
- /**
874
- * @typedef StoreTiming
875
- * @property {boolean} [open] - Indicates if the store is open on this day.
876
- * @property {Time} [closing]
877
- * @property {string} [weekday] - The day of the week.
878
- * @property {Time} [opening]
879
- */
880
- /**
881
- * @typedef StoreDetails
882
- * @property {number} [uid] - The unique identifier for the store.
883
- * @property {StoreDepartments[]} [departments] - A list of departments within the store.
884
- * @property {CompanyStore} [company]
885
- * @property {StoreManagerSerializer} [manager]
886
- * @property {string} [store_code] - A unique code for identifying the store.
887
- * @property {StoreTiming[]} [timing] - The opening and closing times for the
888
- * store throughout the week.
889
- * @property {StoreAddressSerializer} [address]
890
- * @property {Object} [_custom_json] - Custom JSON data for the store.
891
- * @property {string} [name] - The name of the store.
892
- * @property {SellerPhoneNumber[]} [contact_numbers] - A list of contact numbers
893
- * for the store.
894
- */
895
- /**
896
- * @typedef UserDetail
897
- * @property {boolean} [super_user] - A flag indicating whether the user is a super user.
898
- * @property {string} [contact] - The contact details of the user.
899
- * @property {string} username - The username of the user.
900
- * @property {string} user_id - The user ID of the user.
901
- */
902
- /**
903
- * @typedef Size
904
- * @property {number} [quantity] - The quantity of this size available.
905
- * @property {Object} [value] - The value of the size.
906
- * @property {Object} [display] - The display string for the size.
907
- * @property {boolean} [is_available] - Whether or not this size is available.
908
- */
909
- /**
910
- * @typedef ProductGroupPrice
911
- * @property {number} [max_effective] - The maximum effective price of the product group.
912
- * @property {number} [min_effective] - The minimum effective price of the product group.
913
- * @property {number} [min_marked] - The minimum marked price of the product group.
914
- * @property {Object} [currency] - The currency code for the prices.
915
- * @property {number} [max_marked] - The maximum marked price of the product group.
916
- */
917
- /**
918
- * @typedef ProductDetails
919
- * @property {Object} [template_tag] - The template tag of the product.
920
- * @property {number} [rating_count] - The number of ratings the product has received.
921
- * @property {Object} [image_nature] - The nature of the product's images.
922
- * @property {boolean} [has_variant] - Whether or not the product has a variant.
923
- * @property {Object} [description] - The long description of the product.
924
- * @property {boolean} [out_of_stock] - Whether or not the product is out of stock.
925
- * @property {number} [hsn_code] - The HSN code of the product.
926
- * @property {Object} [grouped_attributes] - A dictionary of grouped product attributes.
927
- * @property {Object} [item_code] - The item code of the product.
928
- * @property {Object} [name] - The name of the product.
929
- * @property {Object} [country_of_origin] - The country of origin for the product.
930
- * @property {Object} [short_description] - The short description of the product.
931
- * @property {Object[]} [media] - A list of media objects for the product.
932
- * @property {Object} [attributes] - A dictionary of product attributes.
933
- * @property {boolean} [is_set] - Whether or not the product is a set of items.
934
- * @property {Object[]} [images] - A list of image URLs for the product.
935
- * @property {Object} [slug] - The slug of the product.
936
- * @property {number} [rating] - The rating of the product.
937
- * @property {Object} [identifier] - A dictionary of product identifiers.
938
- * @property {Object[]} [highlights] - A list of highlights for the product.
939
- * @property {number} [brand_uid] - The unique ID of the product's brand.
940
- */
941
- /**
942
- * @typedef ProductInGroup
943
- * @property {boolean} [auto_add_to_cart] - Whether the product should be
944
- * automatically added to the cart.
945
- * @property {number} max_quantity - The maximum quantity of the product that
946
- * can be added to the cart.
947
- * @property {Size[]} [sizes] - The available sizes for the product.
948
- * @property {ProductGroupPrice} [price] - The price details for the product.
949
- * @property {boolean} [auto_select] - Whether the product should be
950
- * automatically selected.
951
- * @property {ProductDetails} [product_details] - The details of the product.
952
- * @property {number} [min_quantity] - The minimum quantity of the product that
953
- * can be added to the cart.
954
- * @property {boolean} [allow_remove] - Whether the product can be removed from the cart.
955
- * @property {number} product_uid - The unique ID of the product in the group.
956
- */
957
- /**
958
- * @typedef ProductGroupingModel
959
- * @property {string} [logo] - The URL for the logo of the product group.
960
- * @property {boolean} [is_active] - Whether the product grouping is active.
961
- * @property {Object} [meta] - A dictionary containing metadata information.
962
- * @property {UserDetail} [verified_by] - User details of the verifier of the
963
- * document, if applicable.
964
- * @property {string} created_on - Timestamp of the creation of the document.
965
- * @property {number} [company_id] - The ID of the company that owns the product grouping.
966
- * @property {Object[]} [page_visibility] - A list of page visibilities of the
967
- * product grouping.
968
- * @property {string} modified_on - Timestamp of the last modification of the document.
969
- * @property {UserDetail} [created_by] - User details of the creator of the document.
970
- * @property {UserDetail} [modified_by] - User details of the last modifier of
971
- * the document.
972
- * @property {ProductInGroup[]} products - A list of products in the grouping.
973
- * @property {boolean} [same_store_assignment] - Whether the products are
974
- * assigned to the same store.
975
- * @property {Object} [_id] - Unique identifier of the product grouping.
976
- * @property {Object} name - The name of the product grouping.
977
- * @property {Object} [choice] - The choice of the product grouping.
978
- * @property {Object} [slug] - The unique identifier for the product grouping.
979
- * @property {string} [verified_on] - Timestamp of when the document was
980
- * verified, if applicable.
981
- */
982
- /**
983
- * @typedef ProductBundle
984
- * @property {ProductGroupingModel[]} [items] - Represents list of
985
- * bundles/product groupings.
986
- */
987
- /**
988
- * @typedef StoreV3
989
- * @property {number} [uid] - The unique identifier for the store.
990
- * @property {string} [name] - The name of the store.
991
- * @property {number} [count] - The count associated with the store.
992
- */
993
- /**
994
- * @typedef ArticleAssignmentV3
995
- * @property {string} [strategy] - Method used for article assignment, such as
996
- * optimal, fast-delivery, low-price, or manual.
997
- * @property {string} [level] - Scope of assignment, which can be
998
- * multi-companies, single-company, or single-store.
999
- */
1000
- /**
1001
- * @typedef StrategyWiseListingSchemaV3
1002
- * @property {number} [distance] - Distance between bullfight location and
1003
- * customer location in kilometers. .
1004
- * @property {number} [pincode] - Pincode mapped based on strategy.
1005
- * @property {number} [tat] - Turn around Time to deliver the product with this strategy.
1006
- * @property {number} [quantity] - The quantity available for assigned store.
1007
- */
1008
- /**
1009
- * @typedef DetailsSchemaV3
1010
- * @property {string} [value] - The value of the attribute.
1011
- * @property {string} [type] - The type of detail e.g, text.
1012
- * @property {string} [key] - The attribute key associated with the size.
1013
- */
1014
- /**
1015
- * @typedef SellerGroupAttributes
1016
- * @property {string} [title] - The title of the attribute group.
1017
- * @property {DetailsSchemaV3[]} [details] - Detail of the attribute.
1018
- */
1019
- /**
1020
- * @typedef ReturnConfigSchemaV3
1021
- * @property {string} [unit] - The unit for the return configuration.
1022
- * @property {boolean} [returnable] - Indicates if the item is returnable.
1023
- * @property {number} [time] - The time duration for the return policy.
1024
- */
1025
- /**
1026
- * @typedef ProductSetDistributionSizeV3
1027
- * @property {number} [pieces] - The number of pieces available in this size.
1028
- * @property {string} [size] - The size of the product.
1029
- */
1030
- /**
1031
- * @typedef ProductSetDistributionV3
1032
- * @property {ProductSetDistributionSizeV3[]} [sizes] - A list of size
1033
- * distributions in the product set.
1034
- */
1035
- /**
1036
- * @typedef ProductSetV3
1037
- * @property {number} [quantity] - The quantity of products in the set.
1038
- * @property {ProductSetDistributionV3} [size_distribution]
1039
- */
1040
- /**
1041
- * @typedef ProductStockPriceV3
1042
- * @property {number} [effective] - The effective or final price for the product
1043
- * at the given pincode.
1044
- * @property {string} [currency_code] - The currency code for which the product
1045
- * is available.
1046
- * @property {string} [currency_symbol] - The currency symbol for the currency
1047
- * in which the product is available.
1048
- * @property {number} [marked] - The marked price of the product.
1049
- * @property {number} [selling] - The selling price of the product.
1050
- */
1051
- /**
1052
- * @typedef ProductStockUnitPriceV3
1053
- * @property {string} [unit] - The unit of measure for the product.
1054
- * @property {string} [currency_symbol] - The currency symbol for the unit price.
1055
- * @property {string} [currency_code] - The currency code for the unit price.
1056
- * @property {number} [price] - The unit price of the product.
1057
- */
1058
- /**
1059
- * @typedef MarketPlaceSttributesSchemaV3
1060
- * @property {string} [title] - The title of the attribute.
1061
- * @property {DetailsSchemaV3[]} [details] - Detail of the attribute.
1062
- */
1063
- /**
1064
- * @typedef SellerV3
1065
- * @property {number} [uid] - The unique identifier for the seller.
1066
- * @property {string} [name] - The name of the seller.
1067
- * @property {number} [count] - The store count serviceable by this seller.
1068
- */
1069
- /**
1070
- * @typedef PromiseSchema
1071
- * @property {string} [min] - The minimum promise time.
1072
- * @property {string} [max] - The maximum promise time.
1073
- */
1074
- /**
1075
- * @typedef ProductSizePriceResponseV3
1076
- * @property {StoreV3} [store]
1077
- * @property {ArticleAssignmentV3} [article_assignment]
1078
- * @property {boolean} [is_cod] - Whether Cash on Delivery (COD) is available
1079
- * for this product. It is true if COD is available and false otherwise.
1080
- * @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing] - Details
1081
- * about serviceability attributes.
1082
- * @property {number} [quantity] - Available quantity of the product in stock.
1083
- * It shows the number of units available for purchase.
1084
- * @property {string} [item_type] - Type of item, indicating the category or
1085
- * nature of the product. Possible values are Standard, Composite, Wet, Digital.
1086
- * @property {SellerGroupAttributes[]} [grouped_attributes] - Collection of
1087
- * attributes grouped together, which provides detailed characteristics of the
1088
- * product, such as color, size, material, etc.
1089
- * @property {ReturnConfigSchemaV3} [return_config]
1090
- * @property {string} [article_id] - This unique identifier is assigned to the
1091
- * specific article. This represents item x size x location.
1092
- * @property {boolean} [is_gift] - Whether the product can be purchased as a
1093
- * gift. It is true if the product is available for gifting and false otherwise.
1094
- * @property {ProductSetV3} [set]
1095
- * @property {number} [seller_count] - Number of sellers offering this product.
1096
- * It indicates the level of competition and availability from different sellers.
1097
- * @property {ProductStockPriceV3} [price_per_piece]
1098
- * @property {DiscountMeta} [discount_meta]
1099
- * @property {string} [discount] - Amount or percentage of discount applied to
1100
- * the product's price, showing the savings for the customer.
1101
- * @property {number[]} [long_lat] - Longitude and latitude coordinates,
1102
- * possibly indicating the location of the store or warehouse where the
1103
- * product is stocked.
1104
- * @property {string} [special_badge] - Special badges or labels assigned to the
1105
- * product, such as "Bestseller," "New Arrival," or "Limited Edition.".
1106
- * @property {ProductStockPriceV3} [price]
1107
- * @property {ProductStockUnitPriceV3} [price_per_unit]
1108
- * @property {number} [pincode] - Postal code or zip code for which the
1109
- * product's availability and delivery options are being checked.
1110
- * @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes] -
1111
- * Attributes specific to the marketplace, such as ratings, reviews, shipping
1112
- * options, and other marketplace-specific details.
1113
- * @property {SellerV3} [seller]
1114
- * @property {PromiseSchema} [delivery_promise]
1115
- */
1116
- /**
1117
- * @typedef ProductSizeSellerFilterSchemaV3
1118
- * @property {string} [name] - The name of the store/seller.
1119
- * @property {boolean} [is_selected] - Whether this filter criterion is selected.
1120
- * @property {string} [value] - The value associated with this store/seller.
1121
- */
1122
- /**
1123
- * @typedef ProductSizeSellersResponseV3
1124
- * @property {ProductSizePriceResponseV3[]} [items] - A list of products with
1125
- * size and price details available from various sellers.
1126
- * @property {Page} page
1127
- * @property {ProductSizeSellerFilterSchemaV3[]} [sort_on] - A list of sorting
1128
- * and filtering criteria applied to the sellers' data.
1129
- */
1130
- declare class CatalogApplicationModel {
1131
- }
1132
- declare namespace CatalogApplicationModel {
1133
- 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 };
1134
- }
1135
- /** @returns {ProductDetailCustomOrder} */
1136
- declare function ProductDetailCustomOrder(): ProductDetailCustomOrder;
1137
- type ProductDetailCustomOrder = {
1138
- /**
1139
- * - The unit of time taken for manufacturing.
1140
- */
1141
- manufacturing_time?: number;
1142
- /**
1143
- * - The unit of time required for
1144
- * manufacturing is defined in hours or days.
1145
- */
1146
- manufacturing_time_unit?: string;
1147
- /**
1148
- * - A boolean flag indicating whether MTO
1149
- * (Make to Order) is enabled or not.
1150
- */
1151
- is_custom_order?: boolean;
1152
- };
1153
- /** @returns {Meta} */
1154
- declare function Meta(): Meta;
1155
- type Meta = {
1156
- /**
1157
- * - The source or origin of the media file, which
1158
- * could be a URL or a reference to where the media was obtained.
1159
- */
1160
- source?: string;
1161
- };
1162
- /** @returns {Media} */
1163
- declare function Media(): Media;
1164
- type Media = {
1165
- /**
1166
- * - Absolute url for Media.
1167
- */
1168
- url?: string;
1169
- /**
1170
- * - The type of media, such as image, video.
1171
- */
1172
- type?: string;
1173
- meta?: Meta;
1174
- /**
1175
- * - Alternative text for the media, used for
1176
- * accessibility and SEO purposes.
1177
- */
1178
- alt?: string;
1179
- };
1180
- /** @returns {ProductListingActionPage} */
1181
- declare function ProductListingActionPage(): ProductListingActionPage;
1182
- type ProductListingActionPage = {
1183
- /**
1184
- * - The type of action such as product, products,
1185
- * category, brand.
1186
- */
1187
- type?: string;
1188
- /**
1189
- * - Query parameter if any to be added to the action.
1190
- */
1191
- query?: any;
1192
- /**
1193
- * - Parameters that should be considered in path.
1194
- */
1195
- params?: any;
1196
- };
1197
- /** @returns {ProductListingAction} */
1198
- declare function ProductListingAction(): ProductListingAction;
1199
- type ProductListingAction = {
1200
- /**
1201
- * - Type of action to be taken e.g, page.
1202
- */
1203
- type?: string;
1204
- page?: ProductListingActionPage;
1205
- };
1206
- /** @returns {ProductBrand} */
1207
- declare function ProductBrand(): ProductBrand;
1208
- type ProductBrand = {
1209
- /**
1210
- * - Unique identifier for the product brand.
1211
- */
1212
- uid?: number;
1213
- logo?: Media;
1214
- /**
1215
- * - Description of the product brand.
1216
- */
1217
- description?: string;
1218
- /**
1219
- * - Name of the product brand.
1220
- */
1221
- name?: string;
1222
- action?: ProductListingAction;
1223
- };
1224
- /** @returns {ProductDepartment} */
1225
- declare function ProductDepartment(): ProductDepartment;
1226
- type ProductDepartment = {
1227
- /**
1228
- * - Unique identifier for the product department.
1229
- */
1230
- uid?: number;
1231
- logo?: Media;
1232
- /**
1233
- * - URL-friendly identifier for the product department.
1234
- */
1235
- slug?: string;
1236
- /**
1237
- * - Name of the product department.
1238
- */
1239
- name?: string;
1240
- };
1241
- /** @returns {ProductCategoryMap} */
1242
- declare function ProductCategoryMap(): ProductCategoryMap;
1243
- type ProductCategoryMap = {
1244
- l1?: ProductBrand;
1245
- l2?: ProductBrand;
1246
- l3?: ProductBrand;
1247
- };
1248
- /** @returns {NetQuantity} */
1249
- declare function NetQuantity(): NetQuantity;
1250
- type NetQuantity = {
1251
- /**
1252
- * - The unit of measurement used for the net quantity
1253
- * of the product.
1254
- */
1255
- unit?: any;
1256
- /**
1257
- * - The value of the net quantity of the product.
1258
- */
1259
- value?: number;
1260
- };
1261
- /** @returns {CustomMetaFields} */
1262
- declare function CustomMetaFields(): CustomMetaFields;
1263
- type CustomMetaFields = {
1264
- /**
1265
- * - A value to store in the custom field.
1266
- */
1267
- value: string;
1268
- /**
1269
- * - A key to store a custom field.
1270
- */
1271
- key: string;
1272
- };
1273
- /** @returns {ApplicationItemSEO} */
1274
- declare function ApplicationItemSEO(): ApplicationItemSEO;
1275
- type ApplicationItemSEO = {
1276
- /**
1277
- * - The SEO title of the item.
1278
- */
1279
- title?: any;
1280
- /**
1281
- * - The SEO description of the item.
1282
- */
1283
- description?: any;
1284
- };
1285
- /** @returns {ProductDetailAttribute} */
1286
- declare function ProductDetailAttribute(): ProductDetailAttribute;
1287
- type ProductDetailAttribute = {
1288
- /**
1289
- * - The value of the product attribute.
1290
- */
1291
- value?: string;
1292
- /**
1293
- * - The type or category of the product attribute.
1294
- */
1295
- type?: string;
1296
- /**
1297
- * - The key or name of the product attribute.
1298
- */
1299
- key?: string;
1300
- };
1301
- /** @returns {ProductDetailGroupedAttribute} */
1302
- declare function ProductDetailGroupedAttribute(): ProductDetailGroupedAttribute;
1303
- type ProductDetailGroupedAttribute = {
1304
- /**
1305
- * - The title or name of the attribute group.
1306
- */
1307
- title?: string;
1308
- /**
1309
- * - A list of product attributes
1310
- * within this group.
1311
- */
1312
- details?: ProductDetailAttribute[];
1313
- };
1314
- /** @returns {ApplicationItemMOQ} */
1315
- declare function ApplicationItemMOQ(): ApplicationItemMOQ;
1316
- type ApplicationItemMOQ = {
1317
- /**
1318
- * - The minimum quantity required for purchase.
1319
- */
1320
- minimum?: number;
1321
- /**
1322
- * - The maximum quantity allowed for purchase.
1323
- */
1324
- maximum?: number;
1325
- /**
1326
- * - The minimum quantity increment in which
1327
- * the item can be purchased.
1328
- */
1329
- increment_unit?: number;
1330
- };
1331
- /** @returns {Price} */
1332
- declare function Price(): Price;
1333
- type Price = {
1334
- /**
1335
- * - The minimum price for the product across stores.
1336
- */
1337
- min?: number;
1338
- /**
1339
- * - The currency symbol for the currency
1340
- * in which the product is available.
1341
- */
1342
- currency_symbol?: string;
1343
- /**
1344
- * - The currency code for the currency in
1345
- * which the product is available.
1346
- */
1347
- currency_code?: string;
1348
- /**
1349
- * - The maximum price for the product across stores.
1350
- */
1351
- max?: number;
1352
- };
1353
- /** @returns {ProductListingPrice} */
1354
- declare function ProductListingPrice(): ProductListingPrice;
1355
- type ProductListingPrice = {
1356
- effective?: Price;
1357
- marked?: Price;
1358
- };
1359
- /** @returns {ProductSizesPrice} */
1360
- declare function ProductSizesPrice(): ProductSizesPrice;
1361
- type ProductSizesPrice = {
1362
- effective?: Price;
1363
- marked?: Price;
1364
- selling?: Price;
1365
- };
1366
- /** @returns {ProductDetail} */
1367
- declare function ProductDetail(): ProductDetail;
1368
- type ProductDetail = {
1369
- /**
1370
- * - Unique identifier for the product.
1371
- */
1372
- uid?: number;
1373
- custom_order?: ProductDetailCustomOrder;
1374
- category_map?: ProductCategoryMap;
1375
- net_quantity?: NetQuantity;
1376
- /**
1377
- * - Count of ratings the product has received.
1378
- */
1379
- rating_count?: number;
1380
- /**
1381
- * - Custom metadata fields
1382
- * associated with the product.
1383
- */
1384
- _custom_meta?: CustomMetaFields[];
1385
- /**
1386
- * - List of products marked similar to given product.
1387
- */
1388
- similars?: string[];
1389
- /**
1390
- * - Tags associated with the product for better
1391
- * categorization.
1392
- */
1393
- tags?: string[];
1394
- seo?: ApplicationItemSEO;
1395
- /**
1396
- * - Type of the images associated with the
1397
- * product such as standard.
1398
- */
1399
- image_nature?: string;
1400
- /**
1401
- * - Indicates whether the product has variants.
1402
- */
1403
- has_variant?: boolean;
1404
- /**
1405
- * - This field describes the type of item,
1406
- * indicating the category or nature of the product. Possible values are
1407
- * Standard, Composite, Wet, Digital.
1408
- */
1409
- item_type?: string;
1410
- /**
1411
- * - Detailed description of the product.
1412
- */
1413
- description?: string;
1414
- /**
1415
- * - Grouped
1416
- * attributes detailing various characteristics of the product.
1417
- */
1418
- grouped_attributes?: ProductDetailGroupedAttribute[];
1419
- /**
1420
- * - Media files associated with the product.
1421
- */
1422
- medias?: Media[];
1423
- /**
1424
- * - Color of the product, if applicable.
1425
- */
1426
- color?: string;
1427
- /**
1428
- * - Product type or classification.
1429
- */
1430
- type?: string;
1431
- /**
1432
- * - Date and time when the product was
1433
- * made available online.
1434
- */
1435
- product_online_date?: string;
1436
- /**
1437
- * - Custom JSON object for additional product data.
1438
- */
1439
- _custom_json?: any;
1440
- /**
1441
- * - Item Code defined for the product.
1442
- */
1443
- item_code?: string;
1444
- /**
1445
- * - Name of the product.
1446
- */
1447
- name?: string;
1448
- moq?: ApplicationItemMOQ;
1449
- /**
1450
- * - Brief description of the product.
1451
- */
1452
- short_description?: string;
1453
- /**
1454
- * - List of product categories
1455
- * associated with the product.
1456
- */
1457
- categories?: ProductBrand[];
1458
- /**
1459
- * - Additional attributes or characteristics of
1460
- * the product.
1461
- */
1462
- attributes?: any;
1463
- /**
1464
- * - Discount applied to the product, if any.
1465
- */
1466
- discount?: string;
1467
- /**
1468
- * - Identifiers or names of tryout versions of
1469
- * the product.
1470
- */
1471
- tryouts?: string[];
1472
- /**
1473
- * - URL-friendly identifier for the product.
1474
- */
1475
- slug: string;
1476
- action?: ProductListingAction;
1477
- /**
1478
- * - The rating of the product.
1479
- */
1480
- rating?: number;
1481
- /**
1482
- * - Indicates whether the product can be
1483
- * sold as an individual product.
1484
- */
1485
- is_dependent?: boolean;
1486
- /**
1487
- * - List of bundle/product grouping
1488
- * slugs mapped to the product.
1489
- */
1490
- product_group_tag?: string[];
1491
- /**
1492
- * - Key highlights or features of the product.
1493
- */
1494
- highlights?: string[];
1495
- price?: ProductListingPrice;
1496
- brand?: ProductBrand;
1497
- department?: ProductDepartment;
1498
- /**
1499
- * - Teaser tag or short promotional phrase for
1500
- * the product.
1501
- */
1502
- teaser_tag?: string;
1503
- };
1504
- /** @returns {ErrorResponse} */
1505
- declare function ErrorResponse(): ErrorResponse;
1506
- type ErrorResponse = {
1507
- /**
1508
- * - A brief description of the error.
1509
- */
1510
- error?: string;
1511
- };
1512
- /** @returns {Dimension} */
1513
- declare function Dimension(): Dimension;
1514
- type Dimension = {
1515
- /**
1516
- * - The unit of dimension.
1517
- */
1518
- unit: string;
1519
- /**
1520
- * - The height of the product.
1521
- */
1522
- height: number;
1523
- /**
1524
- * - The length of the product.
1525
- */
1526
- length: number;
1527
- /**
1528
- * - The width of the product.
1529
- */
1530
- width: number;
1531
- /**
1532
- * - Whether the dimension is the default one or not.
1533
- */
1534
- is_default: boolean;
1535
- };
1536
- /** @returns {Weight} */
1537
- declare function Weight(): Weight;
1538
- type Weight = {
1539
- /**
1540
- * - The unit of weight.
1541
- */
1542
- unit: string;
1543
- /**
1544
- * - The shipping weight of the product.
1545
- */
1546
- shipping: number;
1547
- /**
1548
- * - Whether the weight is the default one or not.
1549
- */
1550
- is_default: boolean;
1551
- };
1552
- /** @returns {DiscountMeta} */
1553
- declare function DiscountMeta(): DiscountMeta;
1554
- type DiscountMeta = {
1555
- /**
1556
- * - Determines whether the discount countdown is
1557
- * visible or not.
1558
- */
1559
- timer?: boolean;
1560
- /**
1561
- * - The time in minutes before the
1562
- * discount ends when the countdown timer should start.
1563
- */
1564
- start_timer_in_minutes?: number;
1565
- /**
1566
- * - The start time of the live discount.
1567
- */
1568
- start?: string;
1569
- /**
1570
- * - The end time of the live discount.
1571
- */
1572
- end?: string;
1573
- };
1574
- /** @returns {ProductSize} */
1575
- declare function ProductSize(): ProductSize;
1576
- type ProductSize = {
1577
- /**
1578
- * - The quantity of the product size available.
1579
- */
1580
- quantity?: number;
1581
- dimension?: Dimension;
1582
- weight?: Weight;
1583
- /**
1584
- * - Indicates whether the product size is
1585
- * available for purchase.
1586
- */
1587
- is_available?: boolean;
1588
- /**
1589
- * - List of identifiers used by
1590
- * sellers for the product size.
1591
- */
1592
- seller_identifiers?: string[];
1593
- /**
1594
- * - The value or label representing the product size.
1595
- */
1596
- value?: string;
1597
- /**
1598
- * - Display name of the product size.
1599
- */
1600
- display?: string;
1601
- };
1602
- /** @returns {SizeChartValues} */
1603
- declare function SizeChartValues(): SizeChartValues;
1604
- type SizeChartValues = {
1605
- /**
1606
- * - Value for column 3.
1607
- */
1608
- col_3?: string;
1609
- /**
1610
- * - Value for column 6.
1611
- */
1612
- col_6?: string;
1613
- /**
1614
- * - Value for column 2.
1615
- */
1616
- col_2?: string;
1617
- /**
1618
- * - Value for column 4.
1619
- */
1620
- col_4?: string;
1621
- /**
1622
- * - Value for column 1.
1623
- */
1624
- col_1?: string;
1625
- /**
1626
- * - Value for column 5.
1627
- */
1628
- col_5?: string;
1629
- };
1630
- /** @returns {ColumnHeader} */
1631
- declare function ColumnHeader(): ColumnHeader;
1632
- type ColumnHeader = {
1633
- /**
1634
- * - Indicates if the column value can be
1635
- * converted or transformed.
1636
- */
1637
- convertable?: boolean;
1638
- /**
1639
- * - The value or title of the column header.
1640
- */
1641
- value?: string;
1642
- };
1643
- /** @returns {ColumnHeaders} */
1644
- declare function ColumnHeaders(): ColumnHeaders;
1645
- type ColumnHeaders = {
1646
- col_3?: ColumnHeader;
1647
- col_6?: ColumnHeader;
1648
- col_2?: ColumnHeader;
1649
- col_4?: ColumnHeader;
1650
- col_1?: ColumnHeader;
1651
- col_5?: ColumnHeader;
1652
- };
1653
- /** @returns {SizeChart} */
1654
- declare function SizeChart(): SizeChart;
1655
- type SizeChart = {
1656
- /**
1657
- * - Unit of measurement used in the size chart (e.g., in, cm).
1658
- */
1659
- unit?: string;
1660
- /**
1661
- * - URL of the image representing the size chart.
1662
- */
1663
- image?: string;
1664
- /**
1665
- * - Additional tip or guideline related to sizing.
1666
- */
1667
- size_tip?: string;
1668
- /**
1669
- * - Array of size chart values for different sizes.
1670
- */
1671
- sizes?: SizeChartValues[];
1672
- /**
1673
- * - Description related to the size chart.
1674
- */
1675
- description?: string;
1676
- /**
1677
- * - Title or name of the size chart.
1678
- */
1679
- title?: string;
1680
- headers?: ColumnHeaders;
1681
- };
1682
- /** @returns {ProductSizeStores} */
1683
- declare function ProductSizeStores(): ProductSizeStores;
1684
- type ProductSizeStores = {
1685
- /**
1686
- * - Number of stores where the product size is available.
1687
- */
1688
- count?: number;
1689
- };
1690
- /** @returns {ProductSizes} */
1691
- declare function ProductSizes(): ProductSizes;
1692
- type ProductSizes = {
1693
- /**
1694
- * - List of available sizes for the product.
1695
- */
1696
- sizes?: ProductSize[];
1697
- price?: ProductSizesPrice;
1698
- price_per_piece?: ProductSizesPrice;
1699
- size_chart?: SizeChart;
1700
- /**
1701
- * - Whether the product sizes are available for sale.
1702
- */
1703
- sellable?: boolean;
1704
- /**
1705
- * - Whether the product supports multiple sizes.
1706
- */
1707
- multi_size?: boolean;
1708
- /**
1709
- * - Discount information applicable to the product sizes.
1710
- */
1711
- discount?: string;
1712
- stores?: ProductSizeStores;
1713
- discount_meta?: DiscountMeta;
1714
- };
1715
- /** @returns {AttributeDetail} */
1716
- declare function AttributeDetail(): AttributeDetail;
1717
- type AttributeDetail = {
1718
- /**
1719
- * - URL or path to the logo associated with the attribute.
1720
- */
1721
- logo?: string;
1722
- /**
1723
- * - A description of the attribute.
1724
- */
1725
- description?: string;
1726
- /**
1727
- * - Display name or label for the attribute.
1728
- */
1729
- display?: string;
1730
- /**
1731
- * - Unique key or identifier for the attribute.
1732
- */
1733
- key?: string;
1734
- };
1735
- /** @returns {AttributeMetadata} */
1736
- declare function AttributeMetadata(): AttributeMetadata;
1737
- type AttributeMetadata = {
1738
- /**
1739
- * - Title or name of the attribute metadata.
1740
- */
1741
- title?: string;
1742
- /**
1743
- * - List of detailed information about
1744
- * attributes.
1745
- */
1746
- details?: AttributeDetail[];
1747
- };
1748
- /** @returns {ProductsComparisonResponse} */
1749
- declare function ProductsComparisonResponse(): ProductsComparisonResponse;
1750
- type ProductsComparisonResponse = {
1751
- /**
1752
- * - List of product details for comparison.
1753
- */
1754
- items?: ProductDetail[];
1755
- /**
1756
- * - Metadata about
1757
- * attributes used for comparing products.
1758
- */
1759
- attributes_metadata?: AttributeMetadata[];
1760
- };
1761
- /** @returns {ProductCompareResponse} */
1762
- declare function ProductCompareResponse(): ProductCompareResponse;
1763
- type ProductCompareResponse = {
1764
- /**
1765
- * - Title or name of the comparison.
1766
- */
1767
- title?: string;
1768
- /**
1769
- * - List of product details for comparison.
1770
- */
1771
- items?: ProductDetail[];
1772
- /**
1773
- * - Metadata about
1774
- * attributes used for comparing products.
1775
- */
1776
- attributes_metadata?: AttributeMetadata[];
1777
- /**
1778
- * - Subtitle or additional description for the comparison.
1779
- */
1780
- subtitle?: string;
1781
- };
1782
- /** @returns {ProductFrequentlyComparedSimilarResponse} */
1783
- declare function ProductFrequentlyComparedSimilarResponse(): ProductFrequentlyComparedSimilarResponse;
1784
- type ProductFrequentlyComparedSimilarResponse = {
1785
- similars?: ProductCompareResponse;
1786
- };
1787
- /** @returns {ProductVariantItemResponse} */
1788
- declare function ProductVariantItemResponse(): ProductVariantItemResponse;
1789
- type ProductVariantItemResponse = {
1790
- /**
1791
- * - Unique identifier for the product variant.
1792
- */
1793
- uid?: number;
1794
- /**
1795
- * - Name of the color for the variant.
1796
- */
1797
- color_name?: string;
1798
- /**
1799
- * - Color code or representation for the variant.
1800
- */
1801
- color?: string;
1802
- /**
1803
- * - Media files associated with the product variant.
1804
- */
1805
- medias?: Media[];
1806
- /**
1807
- * - Indicates whether the product variant is
1808
- * available for purchase.
1809
- */
1810
- is_available?: boolean;
1811
- /**
1812
- * - Custom metadata fields
1813
- * associated with the product.
1814
- */
1815
- _custom_meta?: CustomMetaFields[];
1816
- /**
1817
- * - Name of the product variant.
1818
- */
1819
- name?: string;
1820
- /**
1821
- * - Value or label representing the product variant.
1822
- */
1823
- value?: string;
1824
- /**
1825
- * - URL-friendly identifier for the product.
1826
- */
1827
- slug?: string;
1828
- /**
1829
- * - Custom JSON object for additional data
1830
- * related to the product.
1831
- */
1832
- _custom_json?: any;
1833
- action?: ProductListingAction;
1834
- };
1835
- /** @returns {ProductVariantResponse} */
1836
- declare function ProductVariantResponse(): ProductVariantResponse;
1837
- type ProductVariantResponse = {
1838
- /**
1839
- * - The type of display for the product
1840
- * variant (e.g., image, text, image, color).
1841
- */
1842
- display_type?: string;
1843
- /**
1844
- * - Header or title for the product variant section.
1845
- */
1846
- header?: string;
1847
- /**
1848
- * - Group ID used to group variants.
1849
- */
1850
- group_id?: string;
1851
- /**
1852
- * - List of product variant items.
1853
- */
1854
- items?: ProductVariantItemResponse[];
1855
- /**
1856
- * - Attribute identifier of the variant.
1857
- */
1858
- key?: string;
1859
- /**
1860
- * - URL or path to the logo associated with the
1861
- * product variant.
1862
- */
1863
- logo?: string;
1864
- };
1865
- /** @returns {ProductVariantsResponse} */
1866
- declare function ProductVariantsResponse(): ProductVariantsResponse;
1867
- type ProductVariantsResponse = {
1868
- /**
1869
- * - A list of product variant
1870
- * responses, each detailing a specific variant.
1871
- */
1872
- variants?: ProductVariantResponse[];
1873
- };
1874
- /** @returns {StoreDetail} */
1875
- declare function StoreDetail(): StoreDetail;
1876
- type StoreDetail = {
1877
- /**
1878
- * - NA.
1879
- */
1880
- name?: string;
1881
- /**
1882
- * - NA.
1883
- */
1884
- city?: string;
1885
- /**
1886
- * - NA.
1887
- */
1888
- id?: number;
1889
- /**
1890
- * - NA.
1891
- */
1892
- code?: string;
1893
- };
1894
- /** @returns {ProductStockPrice} */
1895
- declare function ProductStockPrice(): ProductStockPrice;
1896
- type ProductStockPrice = {
1897
- /**
1898
- * - NA.
1899
- */
1900
- effective?: number;
1901
- /**
1902
- * - NA.
1903
- */
1904
- currency?: string;
1905
- /**
1906
- * - NA.
1907
- */
1908
- marked?: number;
1909
- };
1910
- /** @returns {CompanyDetail} */
1911
- declare function CompanyDetail(): CompanyDetail;
1912
- type CompanyDetail = {
1913
- /**
1914
- * - NA.
1915
- */
1916
- name?: string;
1917
- /**
1918
- * - NA.
1919
- */
1920
- id?: number;
1921
- };
1922
- /** @returns {Seller} */
1923
- declare function Seller(): Seller;
1924
- type Seller = {
1925
- /**
1926
- * - NA.
1927
- */
1928
- uid?: number;
1929
- /**
1930
- * - NA.
1931
- */
1932
- name?: string;
1933
- /**
1934
- * - NA.
1935
- */
1936
- count?: number;
1937
- };
1938
- /** @returns {ProductStockStatusItem} */
1939
- declare function ProductStockStatusItem(): ProductStockStatusItem;
1940
- type ProductStockStatusItem = {
1941
- /**
1942
- * - NA.
1943
- */
1944
- uid?: string;
1945
- /**
1946
- * - NA.
1947
- */
1948
- quantity?: number;
1949
- store?: StoreDetail;
1950
- /**
1951
- * - NA.
1952
- */
1953
- size?: string;
1954
- price?: ProductStockPrice;
1955
- company?: CompanyDetail;
1956
- /**
1957
- * - NA.
1958
- */
1959
- item_id?: number;
1960
- seller?: Seller;
1961
- /**
1962
- * - NA.
1963
- */
1964
- identifier?: any;
1965
- };
1966
- /** @returns {ProductStockStatusResponse} */
1967
- declare function ProductStockStatusResponse(): ProductStockStatusResponse;
1968
- type ProductStockStatusResponse = {
1969
- /**
1970
- * - NA.
1971
- */
1972
- items?: ProductStockStatusItem[];
1973
- };
1974
- /** @returns {Page} */
1975
- declare function Page(): Page;
1976
- type Page = {
1977
- /**
1978
- * - The total number of items on the page.
1979
- */
1980
- item_total?: number;
1981
- /**
1982
- * - The identifier for the next page.
1983
- */
1984
- next_id?: string;
1985
- /**
1986
- * - Indicates whether there is a previous page.
1987
- */
1988
- has_previous?: boolean;
1989
- /**
1990
- * - Indicates whether there is a next page.
1991
- */
1992
- has_next?: boolean;
1993
- /**
1994
- * - The current page number.
1995
- */
1996
- current?: number;
1997
- /**
1998
- * - The type of the page, such as 'PageType'.
1999
- */
2000
- type: string;
2001
- /**
2002
- * - The number of items per page.
2003
- */
2004
- size?: number;
2005
- };
2006
- /** @returns {ProductStockPolling} */
2007
- declare function ProductStockPolling(): ProductStockPolling;
2008
- type ProductStockPolling = {
2009
- /**
2010
- * - NA.
2011
- */
2012
- items?: ProductStockStatusItem[];
2013
- page: Page;
2014
- };
2015
- /** @returns {ProductVariantListingResponse} */
2016
- declare function ProductVariantListingResponse(): ProductVariantListingResponse;
2017
- type ProductVariantListingResponse = {
2018
- /**
2019
- * - Header or title for the product variant section.
2020
- */
2021
- header?: string;
2022
- /**
2023
- * - List of Upto 5 product
2024
- * variant items.
2025
- */
2026
- items?: ProductVariantItemResponse[];
2027
- /**
2028
- * - The total number of product variants available.
2029
- */
2030
- total?: number;
2031
- /**
2032
- * - Attribute identifier of the variant.
2033
- */
2034
- key?: string;
2035
- /**
2036
- * - The type of display for the product
2037
- * variant (e.g., image, text, image, color).
2038
- */
2039
- display_type?: string;
2040
- };
2041
- /** @returns {ProductListingDetail} */
2042
- declare function ProductListingDetail(): ProductListingDetail;
2043
- type ProductListingDetail = {
2044
- /**
2045
- * - Unique identifier for the product.
2046
- */
2047
- uid?: number;
2048
- custom_order?: ProductDetailCustomOrder;
2049
- /**
2050
- * - Available sizes for the product.
2051
- */
2052
- sizes?: string[];
2053
- category_map?: ProductCategoryMap;
2054
- net_quantity?: NetQuantity;
2055
- /**
2056
- * - The number of ratings the product has received.
2057
- */
2058
- rating_count?: number;
2059
- /**
2060
- * - Custom metadata fields
2061
- * associated with the product.
2062
- */
2063
- _custom_meta?: CustomMetaFields[];
2064
- /**
2065
- * - List of products marked similar to given product.
2066
- */
2067
- similars?: string[];
2068
- /**
2069
- * - Tags associated with the product for better
2070
- * categorization.
2071
- */
2072
- tags?: string[];
2073
- seo?: ApplicationItemSEO;
2074
- /**
2075
- * - Type of the images associated with the
2076
- * product such as standard.
2077
- */
2078
- image_nature?: string;
2079
- /**
2080
- * - Indicates whether the product has variants.
2081
- */
2082
- has_variant?: boolean;
2083
- /**
2084
- * - This field describes the type of item,
2085
- * indicating the category or nature of the product. Possible values are
2086
- * Standard, Composite, Wet, Digital.
2087
- */
2088
- item_type?: string;
2089
- /**
2090
- * - Detailed description of the product.
2091
- */
2092
- description?: string;
2093
- /**
2094
- * - Grouped
2095
- * attributes detailing various characteristics of the product.
2096
- */
2097
- grouped_attributes?: ProductDetailGroupedAttribute[];
2098
- /**
2099
- * - Media files associated with the product.
2100
- */
2101
- medias?: Media[];
2102
- /**
2103
- * - Color of the product, if applicable.
2104
- */
2105
- color?: string;
2106
- /**
2107
- * - Product type or classification.
2108
- */
2109
- type?: string;
2110
- /**
2111
- * - Date and time when the product was
2112
- * made available online.
2113
- */
2114
- product_online_date?: string;
2115
- /**
2116
- * - Custom JSON object for additional product data.
2117
- */
2118
- _custom_json?: any;
2119
- /**
2120
- * - Item Code defined for the product.
2121
- */
2122
- item_code?: string;
2123
- /**
2124
- * - Name of the product.
2125
- */
2126
- name?: string;
2127
- moq?: ApplicationItemMOQ;
2128
- /**
2129
- * - Brief description of the product.
2130
- */
2131
- short_description?: string;
2132
- /**
2133
- * - List of product categories
2134
- * associated with the product.
2135
- */
2136
- categories?: ProductBrand[];
2137
- /**
2138
- * - Indicates whether the product is available for sale.
2139
- */
2140
- sellable?: boolean;
2141
- /**
2142
- * - Additional attributes or characteristics of
2143
- * the product.
2144
- */
2145
- attributes?: any;
2146
- /**
2147
- * - List of product
2148
- * variants available for the product.
2149
- */
2150
- variants?: ProductVariantListingResponse[];
2151
- /**
2152
- * - Discount details or percentage applied to the product.
2153
- */
2154
- discount?: string;
2155
- /**
2156
- * - List of tryout options available for the product.
2157
- */
2158
- tryouts?: string[];
2159
- /**
2160
- * - List of seller identifiers for the product.
2161
- */
2162
- identifiers?: string[];
2163
- /**
2164
- * - URL-friendly identifier for the product.
2165
- */
2166
- slug: string;
2167
- action?: ProductListingAction;
2168
- /**
2169
- * - Rating of the product.
2170
- */
2171
- rating?: number;
2172
- /**
2173
- * - Indicates whether the product can be
2174
- * sold as an individual product.
2175
- */
2176
- is_dependent?: boolean;
2177
- /**
2178
- * - List of bundle/product grouping
2179
- * slugs mapped to the product.
2180
- */
2181
- product_group_tag?: string[];
2182
- /**
2183
- * - Key highlights or features of the product.
2184
- */
2185
- highlights?: string[];
2186
- price?: ProductListingPrice;
2187
- brand?: ProductBrand;
2188
- /**
2189
- * - Teaser tag or short promotional phrase for
2190
- * the product.
2191
- */
2192
- teaser_tag?: string;
2193
- };
2194
- /** @returns {ProductFiltersValue} */
2195
- declare function ProductFiltersValue(): ProductFiltersValue;
2196
- type ProductFiltersValue = {
2197
- /**
2198
- * - Minimum value for the range filter.
2199
- */
2200
- min?: number;
2201
- /**
2202
- * - Format in which the filter value is displayed.
2203
- */
2204
- display_format?: string;
2205
- /**
2206
- * - The maximum value selected by the user
2207
- * for range filter.
2208
- */
2209
- selected_max?: number;
2210
- /**
2211
- * - Value associated with the filter option.
2212
- */
2213
- value?: string;
2214
- /**
2215
- * - Format used for the filter value in queries.
2216
- */
2217
- query_format?: string;
2218
- /**
2219
- * - Currency symbol for the price type filters.
2220
- */
2221
- currency_symbol?: string;
2222
- /**
2223
- * - The minimum value selected by the user
2224
- * for range filter.
2225
- */
2226
- selected_min?: number;
2227
- /**
2228
- * - Currency code for the currency used for
2229
- * price type filters.
2230
- */
2231
- currency_code?: string;
2232
- /**
2233
- * - Whether this filter value is currently selected.
2234
- */
2235
- is_selected: boolean;
2236
- /**
2237
- * - Display name or label for the filter value.
2238
- */
2239
- display: string;
2240
- /**
2241
- * - Number of products that match this filter value.
2242
- */
2243
- count?: number;
2244
- /**
2245
- * - Maximum value of the filter range.
2246
- */
2247
- max?: number;
2248
- };
2249
- /** @returns {ProductFiltersKey} */
2250
- declare function ProductFiltersKey(): ProductFiltersKey;
2251
- type ProductFiltersKey = {
2252
- /**
2253
- * - URL or path to the logo associated with the filter key.
2254
- */
2255
- logo?: string;
2256
- /**
2257
- * - Name or identifier of the filter key.
2258
- */
2259
- name: string;
2260
- /**
2261
- * - Type or category of the filter key (e.g., range,
2262
- * multivalued).
2263
- */
2264
- kind?: string;
2265
- /**
2266
- * - Display name or label for the filter key.
2267
- */
2268
- display: string;
2269
- };
2270
- /** @returns {ProductFilters} */
2271
- declare function ProductFilters(): ProductFilters;
2272
- type ProductFilters = {
2273
- /**
2274
- * - List of filter values associated
2275
- * with the filter key.
2276
- */
2277
- values: ProductFiltersValue[];
2278
- key: ProductFiltersKey;
2279
- };
2280
- /** @returns {ProductSortOn} */
2281
- declare function ProductSortOn(): ProductSortOn;
2282
- type ProductSortOn = {
2283
- /**
2284
- * - URL or path to the logo associated with the sorting option.
2285
- */
2286
- logo?: string;
2287
- /**
2288
- * - Indicates whether this sorting option is
2289
- * currently selected.
2290
- */
2291
- is_selected?: boolean;
2292
- /**
2293
- * - Name or identifier of the sorting option.
2294
- */
2295
- name?: string;
2296
- /**
2297
- * - Value used to specify the sorting order (e.g.,
2298
- * price_asc, discount_dsc).
2299
- */
2300
- value?: string;
2301
- /**
2302
- * - Display name or label for the sorting option.
2303
- */
2304
- display?: string;
2305
- };
2306
- /** @returns {ProductListingResponse} */
2307
- declare function ProductListingResponse(): ProductListingResponse;
2308
- type ProductListingResponse = {
2309
- /**
2310
- * - List of product details included
2311
- * in the response.
2312
- */
2313
- items?: ProductListingDetail[];
2314
- /**
2315
- * - List of filters available for
2316
- * refining the product listings.
2317
- */
2318
- filters?: ProductFilters[];
2319
- page: Page;
2320
- /**
2321
- * - List of sorting options available for
2322
- * the product listings.
2323
- */
2324
- sort_on?: ProductSortOn[];
2325
- };
2326
- /** @returns {ImageUrls} */
2327
- declare function ImageUrls(): ImageUrls;
2328
- type ImageUrls = {
2329
- portrait?: Media;
2330
- landscape?: Media;
2331
- };
2332
- /** @returns {BrandItem} */
2333
- declare function BrandItem(): BrandItem;
2334
- type BrandItem = {
2335
- /**
2336
- * - The unique identifier for the brand.
2337
- */
2338
- uid?: number;
2339
- logo?: Media;
2340
- /**
2341
- * - Detailed description of the brand,
2342
- * including its history, values, product offerings, and other relevant information.
2343
- */
2344
- description?: string;
2345
- banners?: ImageUrls;
2346
- /**
2347
- * - Lists the departments or categories
2348
- * under which the brand's products are listed.
2349
- */
2350
- departments?: string[];
2351
- /**
2352
- * - Details about any discounts currently
2353
- * available on the brand's products.
2354
- */
2355
- discount?: string;
2356
- /**
2357
- * - Name of the brand.
2358
- */
2359
- name?: string;
2360
- /**
2361
- * - URL-friendly version of the brand's name, used in
2362
- * the web address to access the brand's page on the platform.
2363
- */
2364
- slug?: string;
2365
- action?: ProductListingAction;
2366
- };
2367
- /** @returns {BrandListingResponse} */
2368
- declare function BrandListingResponse(): BrandListingResponse;
2369
- type BrandListingResponse = {
2370
- /**
2371
- * - List of brand items included in the response.
2372
- */
2373
- items?: BrandItem[];
2374
- page: Page;
2375
- };
2376
- /** @returns {BrandDetailResponse} */
2377
- declare function BrandDetailResponse(): BrandDetailResponse;
2378
- type BrandDetailResponse = {
2379
- logo?: Media;
2380
- /**
2381
- * - The unique identifier for the brand.
2382
- */
2383
- uid?: number;
2384
- /**
2385
- * - Detailed description of the brand,
2386
- * including its history, values, product offerings, and other relevant information.
2387
- */
2388
- description?: string;
2389
- banners?: ImageUrls;
2390
- /**
2391
- * - Custom JSON data related to the brand,
2392
- * allowing for additional metadata.
2393
- */
2394
- _custom_json?: any;
2395
- /**
2396
- * - Name of the brand.
2397
- */
2398
- name?: string;
2399
- };
2400
- /** @returns {CategoryBanner} */
2401
- declare function CategoryBanner(): CategoryBanner;
2402
- type CategoryBanner = {
2403
- portrait: Media;
2404
- landscape: Media;
2405
- };
2406
- /** @returns {ThirdLevelChild} */
2407
- declare function ThirdLevelChild(): ThirdLevelChild;
2408
- type ThirdLevelChild = {
2409
- /**
2410
- * - Unique identifier for the L3 category.
2411
- */
2412
- uid?: number;
2413
- banners?: ImageUrls;
2414
- /**
2415
- * - List of categories under the L3 category.
2416
- */
2417
- childs?: any[];
2418
- /**
2419
- * - Custom JSON data related to the L3
2420
- * category, allowing for additional metadata.
2421
- */
2422
- _custom_json?: any;
2423
- /**
2424
- * - Name of the L3 category.
2425
- */
2426
- name?: string;
2427
- /**
2428
- * - Slug or URL-friendly identifier for the L3 category.
2429
- */
2430
- slug?: string;
2431
- action?: ProductListingAction;
2432
- };
2433
- /** @returns {SecondLevelChild} */
2434
- declare function SecondLevelChild(): SecondLevelChild;
2435
- type SecondLevelChild = {
2436
- /**
2437
- * - Unique identifier for the L2 category.
2438
- */
2439
- uid?: number;
2440
- banners?: ImageUrls;
2441
- /**
2442
- * - List of categories under the L2 category.
2443
- */
2444
- childs?: ThirdLevelChild[];
2445
- /**
2446
- * - Custom JSON data related to the L2
2447
- * category, allowing for additional metadata.
2448
- */
2449
- _custom_json?: any;
2450
- /**
2451
- * - Name of the L2 category.
2452
- */
2453
- name?: string;
2454
- /**
2455
- * - Slug or URL-friendly identifier for the L2 category.
2456
- */
2457
- slug?: string;
2458
- action?: ProductListingAction;
2459
- };
2460
- /** @returns {Child} */
2461
- declare function Child(): Child;
2462
- type Child = {
2463
- /**
2464
- * - Unique identifier for the L1 category.
2465
- */
2466
- uid?: number;
2467
- banners?: ImageUrls;
2468
- /**
2469
- * - List of categories under the L1 category.
2470
- */
2471
- childs?: SecondLevelChild[];
2472
- /**
2473
- * - Custom JSON data related to the L1
2474
- * category, allowing for additional metadata.
2475
- */
2476
- _custom_json?: any;
2477
- /**
2478
- * - Name of the L1 category.
2479
- */
2480
- name?: string;
2481
- /**
2482
- * - Slug or URL-friendly identifier for the L1 category.
2483
- */
2484
- slug?: string;
2485
- action?: ProductListingAction;
2486
- };
2487
- /** @returns {CategoryItems} */
2488
- declare function CategoryItems(): CategoryItems;
2489
- type CategoryItems = {
2490
- /**
2491
- * - Unique identifier for the category.
2492
- */
2493
- uid: number;
2494
- banners: CategoryBanner;
2495
- /**
2496
- * - List of L1 categories under the main category.
2497
- */
2498
- childs?: Child[];
2499
- /**
2500
- * - Name of the category.
2501
- */
2502
- name: string;
2503
- /**
2504
- * - Slug or URL-friendly identifier for the category.
2505
- */
2506
- slug: string;
2507
- action: ProductListingAction;
2508
- };
2509
- /** @returns {DepartmentCategoryTree} */
2510
- declare function DepartmentCategoryTree(): DepartmentCategoryTree;
2511
- type DepartmentCategoryTree = {
2512
- /**
2513
- * - List of categories within the department.
2514
- */
2515
- items?: CategoryItems[];
2516
- /**
2517
- * - Name of the department.
2518
- */
2519
- department: string;
2520
- };
2521
- /** @returns {DepartmentIdentifier} */
2522
- declare function DepartmentIdentifier(): DepartmentIdentifier;
2523
- type DepartmentIdentifier = {
2524
- /**
2525
- * - Unique identifier for the department.
2526
- */
2527
- uid?: number;
2528
- /**
2529
- * - Slug or URL-friendly identifier for the department.
2530
- */
2531
- slug?: string;
2532
- };
2533
- /** @returns {CategoryListingResponse} */
2534
- declare function CategoryListingResponse(): CategoryListingResponse;
2535
- type CategoryListingResponse = {
2536
- /**
2537
- * - List of department category trees.
2538
- */
2539
- data?: DepartmentCategoryTree[];
2540
- /**
2541
- * - List of departments.
2542
- */
2543
- departments?: DepartmentIdentifier[];
2544
- };
2545
- /** @returns {CategoryMetaResponse} */
2546
- declare function CategoryMetaResponse(): CategoryMetaResponse;
2547
- type CategoryMetaResponse = {
2548
- logo?: Media;
2549
- /**
2550
- * - Unique identifier for the category.
2551
- */
2552
- uid?: number;
2553
- banners?: ImageUrls;
2554
- /**
2555
- * - Custom JSON data related to the category,
2556
- * allowing for additional metadata.
2557
- */
2558
- _custom_json?: any;
2559
- /**
2560
- * - Name of the category.
2561
- */
2562
- name?: string;
2563
- };
2564
- /** @returns {HomeListingResponse} */
2565
- declare function HomeListingResponse(): HomeListingResponse;
2566
- type HomeListingResponse = {
2567
- /**
2568
- * - List of product details
2569
- * displayed on the home page.
2570
- */
2571
- items?: ProductListingDetail[];
2572
- page: Page;
2573
- /**
2574
- * - Message related to the home listing response.
2575
- */
2576
- message?: string;
2577
- };
2578
- /** @returns {Department} */
2579
- declare function Department(): Department;
2580
- type Department = {
2581
- /**
2582
- * - Unique identifier for the department.
2583
- */
2584
- uid?: number;
2585
- logo?: Media;
2586
- /**
2587
- * - Specifies the display order of the
2588
- * department, determining its position in lists and navigation menus based on
2589
- * priority.
2590
- */
2591
- priority_order?: number;
2592
- /**
2593
- * - Name of the department.
2594
- */
2595
- name?: string;
2596
- /**
2597
- * - URL-friendly version of the department's name,
2598
- * used in the web address to access the department's page on the platform.
2599
- */
2600
- slug?: string;
2601
- };
2602
- /** @returns {DepartmentResponse} */
2603
- declare function DepartmentResponse(): DepartmentResponse;
2604
- type DepartmentResponse = {
2605
- /**
2606
- * - List of department detail objects.
2607
- */
2608
- items?: Department[];
2609
- };
2610
- /** @returns {AutocompleteItem} */
2611
- declare function AutocompleteItem(): AutocompleteItem;
2612
- type AutocompleteItem = {
2613
- logo?: Media;
2614
- /**
2615
- * - Text or value displayed for the autocomplete item.
2616
- */
2617
- display?: string;
2618
- /**
2619
- * - The type of action such as product, products,
2620
- * category, brand.
2621
- */
2622
- type?: string;
2623
- /**
2624
- * - Custom JSON data related to the
2625
- * autocomplete item, allowing for additional metadata.
2626
- */
2627
- _custom_json?: any;
2628
- action?: ProductListingAction;
2629
- };
2630
- /** @returns {AutoCompleteResponse} */
2631
- declare function AutoCompleteResponse(): AutoCompleteResponse;
2632
- type AutoCompleteResponse = {
2633
- /**
2634
- * - List of autocomplete items suggested
2635
- * based on user input.
2636
- */
2637
- items?: AutocompleteItem[];
2638
- };
2639
- /** @returns {CollectionQuery} */
2640
- declare function CollectionQuery(): CollectionQuery;
2641
- type CollectionQuery = {
2642
- /**
2643
- * - The operator used for filtering the collection.
2644
- */
2645
- op: string;
2646
- /**
2647
- * - The values used for filtering based on the attribute.
2648
- */
2649
- value: any[];
2650
- /**
2651
- * - The attribute on which the filter is applied.
2652
- */
2653
- attribute: string;
2654
- };
2655
- /** @returns {GetCollectionDetailNest} */
2656
- declare function GetCollectionDetailNest(): GetCollectionDetailNest;
2657
- type GetCollectionDetailNest = {
2658
- /**
2659
- * - Indicates whether the collection is currently active.
2660
- */
2661
- is_active?: boolean;
2662
- /**
2663
- * - The unique identifier for the collection.
2664
- */
2665
- uid?: string;
2666
- /**
2667
- * - The attribute by which the collection items are sorted.
2668
- */
2669
- sort_on?: string;
2670
- /**
2671
- * - Additional metadata related to the collection.
2672
- */
2673
- meta?: any;
2674
- banners?: ImageUrls;
2675
- /**
2676
- * - Cron details for scheduling related to the collection.
2677
- */
2678
- cron?: any;
2679
- /**
2680
- * - The `Schedule` schema defines the timing and
2681
- * details for recurring or one-time tasks. It includes information on when
2682
- * the job should start and end, the frequency of the task, and any additional
2683
- * metadata. This schema helps in scheduling jobs or tasks based on specified
2684
- * timings and durations.
2685
- */
2686
- _schedule?: any;
2687
- /**
2688
- * - A list of queries used to filter the
2689
- * collection.
2690
- */
2691
- query?: CollectionQuery[];
2692
- /**
2693
- * - A detailed description of the collection.
2694
- */
2695
- description?: string;
2696
- /**
2697
- * - Type of collections e.g query, items.
2698
- */
2699
- type?: string;
2700
- /**
2701
- * - Custom JSON data associated with the collection.
2702
- */
2703
- _custom_json?: any;
2704
- /**
2705
- * - The name of the collection.
2706
- */
2707
- name?: string;
2708
- /**
2709
- * - Indicates if sorting is allowed for this collection.
2710
- */
2711
- allow_sort?: boolean;
2712
- /**
2713
- * - Keys of the facets visible for
2714
- * filtering within the collection.
2715
- */
2716
- visible_facets_keys?: string[];
2717
- /**
2718
- * - Badge information associated with the collection.
2719
- */
2720
- badge?: any;
2721
- /**
2722
- * - The URL-friendly identifier for the collection.
2723
- */
2724
- slug?: string;
2725
- action?: ProductListingAction;
2726
- /**
2727
- * - Indicates if facets are allowed for
2728
- * filtering within the collection.
2729
- */
2730
- allow_facets?: boolean;
2731
- logo?: Media;
2732
- /**
2733
- * - Priority level of the collection for sorting
2734
- * or display purposes.
2735
- */
2736
- priority?: number;
2737
- /**
2738
- * - Tags associated with the collection.
2739
- */
2740
- tags?: string[];
2741
- /**
2742
- * - Application ID associated with the collection.
2743
- */
2744
- app_id?: string;
2745
- };
2746
- /** @returns {CollectionListingFilterTag} */
2747
- declare function CollectionListingFilterTag(): CollectionListingFilterTag;
2748
- type CollectionListingFilterTag = {
2749
- /**
2750
- * - The name of the tag. This is typically used as a
2751
- * label for filtering purposes.
2752
- */
2753
- name?: string;
2754
- /**
2755
- * - A flag indicating whether the tag is
2756
- * currently selected as a filter option.
2757
- */
2758
- is_selected?: boolean;
2759
- /**
2760
- * - The display name of the tag. This may be a
2761
- * user-friendly version of the tag name shown in the UI.
2762
- */
2763
- display?: string;
2764
- };
2765
- /** @returns {CollectionListingFilterType} */
2766
- declare function CollectionListingFilterType(): CollectionListingFilterType;
2767
- type CollectionListingFilterType = {
2768
- /**
2769
- * - The name of the filter type. This indicates the
2770
- * type of filtering being applied, such as items, query.
2771
- */
2772
- name?: string;
2773
- /**
2774
- * - A flag indicating whether this filter
2775
- * type is currently selected as a filter option.
2776
- */
2777
- is_selected?: boolean;
2778
- /**
2779
- * - The display name of the filter type. This is
2780
- * the user-friendly name shown in the UI for the filter type.
2781
- */
2782
- display?: string;
2783
- };
2784
- /** @returns {CollectionListingFilter} */
2785
- declare function CollectionListingFilter(): CollectionListingFilter;
2786
- type CollectionListingFilter = {
2787
- /**
2788
- * - An array of tag filters
2789
- * available for the collection listings. Each tag allows for filtering based
2790
- * on specific attributes.
2791
- */
2792
- tags?: CollectionListingFilterTag[];
2793
- /**
2794
- * - An array of filter types
2795
- * available for the collection listings. Each type represents a different
2796
- * category or attribute for filtering.
2797
- */
2798
- type?: CollectionListingFilterType[];
2799
- };
2800
- /** @returns {GetCollectionListingResponse} */
2801
- declare function GetCollectionListingResponse(): GetCollectionListingResponse;
2802
- type GetCollectionListingResponse = {
2803
- /**
2804
- * - An array of collection
2805
- * details. Each item in the array represents a collection with various
2806
- * attributes and configurations.
2807
- */
2808
- items?: GetCollectionDetailNest[];
2809
- filters?: CollectionListingFilter;
2810
- page: Page;
2811
- };
2812
- /** @returns {CollectionDetailResponse} */
2813
- declare function CollectionDetailResponse(): CollectionDetailResponse;
2814
- type CollectionDetailResponse = {
2815
- /**
2816
- * - Indicates whether the collection is active.
2817
- */
2818
- is_active?: boolean;
2819
- /**
2820
- * - Criteria used to sort the items within the
2821
- * collection, such as price, popularity, or newest first.
2822
- */
2823
- sort_on?: string;
2824
- /**
2825
- * - Metadata associated with the collection.
2826
- */
2827
- meta?: any;
2828
- banners?: ImageUrls;
2829
- /**
2830
- * - Cron schedule details related to the collection,
2831
- * if applicable.
2832
- */
2833
- cron?: any;
2834
- /**
2835
- * - Schedule details for the collection,
2836
- * including timing and duration information.
2837
- */
2838
- _schedule?: any;
2839
- /**
2840
- * - Search or filter query used to
2841
- * dynamically generate the collection based on specific criteria or conditions.
2842
- */
2843
- query?: CollectionQuery[];
2844
- /**
2845
- * - Detailed description of the collection,.
2846
- */
2847
- description?: string;
2848
- /**
2849
- * - Type of collection, specifying the nature or
2850
- * category of the collection.
2851
- */
2852
- type?: string;
2853
- /**
2854
- * - Custom JSON object containing additional
2855
- * properties specific to the collection.
2856
- */
2857
- _custom_json?: any;
2858
- /**
2859
- * - The name of the collection.
2860
- */
2861
- name?: string;
2862
- /**
2863
- * - Indicates if sorting is allowed for this collection.
2864
- */
2865
- allow_sort?: boolean;
2866
- /**
2867
- * - Keys of the facets visible for
2868
- * filtering within the collection.
2869
- */
2870
- visible_facets_keys?: string[];
2871
- /**
2872
- * - Badge information associated with the collection.
2873
- */
2874
- badge?: any;
2875
- /**
2876
- * - The URL-friendly identifier for the collection.
2877
- */
2878
- slug?: string;
2879
- /**
2880
- * - Indicates if facets are allowed for
2881
- * filtering within the collection.
2882
- */
2883
- allow_facets?: boolean;
2884
- logo?: Media;
2885
- /**
2886
- * - Priority level of the collection for sorting
2887
- * or display purposes.
2888
- */
2889
- priority?: number;
2890
- /**
2891
- * - Tags associated with the collection.
2892
- */
2893
- tag?: string[];
2894
- /**
2895
- * - Application ID associated with the collection.
2896
- */
2897
- app_id?: string;
2898
- };
2899
- /** @returns {GetFollowListingResponse} */
2900
- declare function GetFollowListingResponse(): GetFollowListingResponse;
2901
- type GetFollowListingResponse = {
2902
- /**
2903
- * - An array of product details that
2904
- * the user is following. Each item includes information such as the product
2905
- * name, price, and other attributes.
2906
- */
2907
- items: ProductListingDetail[];
2908
- page: Page;
2909
- };
2910
- /** @returns {FollowPostResponse} */
2911
- declare function FollowPostResponse(): FollowPostResponse;
2912
- type FollowPostResponse = {
2913
- /**
2914
- * - A message indicating the result of the follow or
2915
- * unfollow operation. This could be a confirmation message or an error message.
2916
- */
2917
- message: string;
2918
- /**
2919
- * - A unique identifier for the follow operation, which
2920
- * can be used to reference or track the follow status.
2921
- */
2922
- id: string;
2923
- };
2924
- /** @returns {FollowerCountResponse} */
2925
- declare function FollowerCountResponse(): FollowerCountResponse;
2926
- type FollowerCountResponse = {
2927
- /**
2928
- * - The number of followers for the item. This count
2929
- * indicates how many users are following the specified item.
2930
- */
2931
- count?: number;
2932
- };
2933
- /** @returns {FollowIdsData} */
2934
- declare function FollowIdsData(): FollowIdsData;
2935
- type FollowIdsData = {
2936
- /**
2937
- * - An array of IDs representing the products
2938
- * that the user is following.
2939
- */
2940
- products?: number[];
2941
- /**
2942
- * - An array of IDs representing the
2943
- * collections that the user is following.
2944
- */
2945
- collections?: number[];
2946
- /**
2947
- * - An array of IDs representing the brands that
2948
- * the user is following.
2949
- */
2950
- brands?: number[];
2951
- };
2952
- /** @returns {FollowIdsResponse} */
2953
- declare function FollowIdsResponse(): FollowIdsResponse;
2954
- type FollowIdsResponse = {
2955
- data?: FollowIdsData;
2956
- };
2957
- /** @returns {LatLong} */
2958
- declare function LatLong(): LatLong;
2959
- type LatLong = {
2960
- /**
2961
- * - An array containing the latitude and
2962
- * longitude values of the location.
2963
- */
2964
- coordinates?: number[];
2965
- /**
2966
- * - The type of geographic coordinate system used.
2967
- * For example, "Point" indicates a single point in a geographic coordinate system.
2968
- */
2969
- type?: string;
2970
- };
2971
- /** @returns {Store} */
2972
- declare function Store(): Store;
2973
- type Store = {
2974
- /**
2975
- * - A unique identifier for the store.
2976
- */
2977
- uid?: number;
2978
- /**
2979
- * - The manager's email address for the store.
2980
- */
2981
- store_email?: string;
2982
- /**
2983
- * - The state or province where the store is located.
2984
- */
2985
- state?: string;
2986
- /**
2987
- * - The country where the store is located.
2988
- */
2989
- country?: string;
2990
- /**
2991
- * - The postal code or zip code for the store's location.
2992
- */
2993
- pincode?: number;
2994
- /**
2995
- * - The city where the store is located.
2996
- */
2997
- city?: string;
2998
- /**
2999
- * - The street address of the store.
3000
- */
3001
- address?: string;
3002
- /**
3003
- * - A unique code or identifier for the store,
3004
- * often used for internal reference.
3005
- */
3006
- store_code?: string;
3007
- lat_long?: LatLong;
3008
- /**
3009
- * - The name of the store.
3010
- */
3011
- name?: string;
3012
- /**
3013
- * - The list of tags mapped to the store.
3014
- */
3015
- tags?: string[];
3016
- };
3017
- /** @returns {StoreListingResponse} */
3018
- declare function StoreListingResponse(): StoreListingResponse;
3019
- type StoreListingResponse = {
3020
- /**
3021
- * - An array of store details. Each store includes
3022
- * information such as name, address, and geographic coordinates.
3023
- */
3024
- items: Store[];
3025
- page: Page;
3026
- };
3027
- /** @returns {StoreDepartments} */
3028
- declare function StoreDepartments(): StoreDepartments;
3029
- type StoreDepartments = {
3030
- /**
3031
- * - The unique identifier assigned to the store department.
3032
- */
3033
- uid?: number;
3034
- /**
3035
- * - An object containing information about the store
3036
- * department's logo, such as the URL or other related media details.
3037
- */
3038
- logo?: any;
3039
- /**
3040
- * - The priority or ranking of the
3041
- * department within the store. This field is used to determine the order in
3042
- * which departments are displayed or processed.
3043
- */
3044
- priority_order?: number;
3045
- /**
3046
- * - The name of the store department, which is
3047
- * typically used for display and identification purposes.
3048
- */
3049
- name?: string;
3050
- /**
3051
- * - A URL-friendly identifier for the store
3052
- * department, often used in web addresses and routing to uniquely identify
3053
- * the department.
3054
- */
3055
- slug?: string;
3056
- };
3057
- /** @returns {CompanyStore} */
3058
- declare function CompanyStore(): CompanyStore;
3059
- type CompanyStore = {
3060
- /**
3061
- * - The unique identifier for the company store.
3062
- */
3063
- uid?: number;
3064
- /**
3065
- * - The name of the company store.
3066
- */
3067
- name?: string;
3068
- /**
3069
- * - The type of company, which can be one of
3070
- * the following: - `distributor`: Distributor - `franchise`: Franchise -
3071
- * `mbo`: MBO (Managed Business Operations) - `manufacturer-owner`: Owner/Manufacturer.
3072
- */
3073
- company_type?: string;
3074
- /**
3075
- * - The type of business structure, which
3076
- * can be one of the following: - `Private`: Private Limited Company -
3077
- * `LLP/Partnership`: Limited Liability Partnership or Partnership -
3078
- * `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
3079
- */
3080
- business_type?: string;
3081
- };
3082
- /** @returns {SellerPhoneNumber} */
3083
- declare function SellerPhoneNumber(): SellerPhoneNumber;
3084
- type SellerPhoneNumber = {
3085
- /**
3086
- * - The country code of the seller's phone number.
3087
- */
3088
- country_code: number;
3089
- /**
3090
- * - The seller's contact number.
3091
- */
3092
- number: string;
3093
- };
3094
- /** @returns {StoreManagerSerializer} */
3095
- declare function StoreManagerSerializer(): StoreManagerSerializer;
3096
- type StoreManagerSerializer = {
3097
- /**
3098
- * - The name of the store manager.
3099
- */
3100
- name?: string;
3101
- /**
3102
- * - The email address of the store manager.
3103
- */
3104
- email?: string;
3105
- mobile_no?: SellerPhoneNumber;
3106
- };
3107
- /** @returns {StoreAddressSerializer} */
3108
- declare function StoreAddressSerializer(): StoreAddressSerializer;
3109
- type StoreAddressSerializer = {
3110
- /**
3111
- * - The latitude of the store's location.
3112
- */
3113
- latitude?: number;
3114
- /**
3115
- * - The state where the store is located.
3116
- */
3117
- state?: string;
3118
- /**
3119
- * - The country where the store is located.
3120
- */
3121
- country?: string;
3122
- /**
3123
- * - A landmark near the store.
3124
- */
3125
- landmark?: string;
3126
- /**
3127
- * - The address line 1 of the store.
3128
- */
3129
- address1?: string;
3130
- /**
3131
- * - The postal code for the store's location.
3132
- */
3133
- pincode?: number;
3134
- /**
3135
- * - The city where the store is located.
3136
- */
3137
- city?: string;
3138
- /**
3139
- * - The longitude of the store's location.
3140
- */
3141
- longitude?: number;
3142
- /**
3143
- * - The address line2 of the store.
3144
- */
3145
- address2?: string;
3146
- };
3147
- /** @returns {AppStore} */
3148
- declare function AppStore(): AppStore;
3149
- type AppStore = {
3150
- /**
3151
- * - The unique identifier for the application store.
3152
- */
3153
- uid?: number;
3154
- /**
3155
- * - A list of departments within the store.
3156
- */
3157
- departments?: StoreDepartments[];
3158
- company?: CompanyStore;
3159
- manager?: StoreManagerSerializer;
3160
- /**
3161
- * - A unique code for identifying the store.
3162
- */
3163
- store_code?: string;
3164
- address?: StoreAddressSerializer;
3165
- /**
3166
- * - The name of the store.
3167
- */
3168
- name?: string;
3169
- /**
3170
- * - A list of contact numbers
3171
- * for the store.
3172
- */
3173
- contact_numbers?: SellerPhoneNumber[];
3174
- };
3175
- /** @returns {ApplicationStoreListing} */
3176
- declare function ApplicationStoreListing(): ApplicationStoreListing;
3177
- type ApplicationStoreListing = {
3178
- /**
3179
- * - A list of filters applied to the store listing.
3180
- */
3181
- filters?: any[];
3182
- /**
3183
- * - A list of application stores.
3184
- */
3185
- items?: AppStore[];
3186
- page?: Page;
3187
- };
3188
- /** @returns {Time} */
3189
- declare function Time(): Time;
3190
- type Time = {
3191
- /**
3192
- * - The hour part of the time.
3193
- */
3194
- hour?: number;
3195
- /**
3196
- * - The minute part of the time.
3197
- */
3198
- minute?: number;
3199
- };
3200
- /** @returns {StoreTiming} */
3201
- declare function StoreTiming(): StoreTiming;
3202
- type StoreTiming = {
3203
- /**
3204
- * - Indicates if the store is open on this day.
3205
- */
3206
- open?: boolean;
3207
- closing?: Time;
3208
- /**
3209
- * - The day of the week.
3210
- */
3211
- weekday?: string;
3212
- opening?: Time;
3213
- };
3214
- /** @returns {StoreDetails} */
3215
- declare function StoreDetails(): StoreDetails;
3216
- type StoreDetails = {
3217
- /**
3218
- * - The unique identifier for the store.
3219
- */
3220
- uid?: number;
3221
- /**
3222
- * - A list of departments within the store.
3223
- */
3224
- departments?: StoreDepartments[];
3225
- company?: CompanyStore;
3226
- manager?: StoreManagerSerializer;
3227
- /**
3228
- * - A unique code for identifying the store.
3229
- */
3230
- store_code?: string;
3231
- /**
3232
- * - The opening and closing times for the
3233
- * store throughout the week.
3234
- */
3235
- timing?: StoreTiming[];
3236
- address?: StoreAddressSerializer;
3237
- /**
3238
- * - Custom JSON data for the store.
3239
- */
3240
- _custom_json?: any;
3241
- /**
3242
- * - The name of the store.
3243
- */
3244
- name?: string;
3245
- /**
3246
- * - A list of contact numbers
3247
- * for the store.
3248
- */
3249
- contact_numbers?: SellerPhoneNumber[];
3250
- };
3251
- /** @returns {UserDetail} */
3252
- declare function UserDetail(): UserDetail;
3253
- type UserDetail = {
3254
- /**
3255
- * - A flag indicating whether the user is a super user.
3256
- */
3257
- super_user?: boolean;
3258
- /**
3259
- * - The contact details of the user.
3260
- */
3261
- contact?: string;
3262
- /**
3263
- * - The username of the user.
3264
- */
3265
- username: string;
3266
- /**
3267
- * - The user ID of the user.
3268
- */
3269
- user_id: string;
3270
- };
3271
- /** @returns {Size} */
3272
- declare function Size(): Size;
3273
- type Size = {
3274
- /**
3275
- * - The quantity of this size available.
3276
- */
3277
- quantity?: number;
3278
- /**
3279
- * - The value of the size.
3280
- */
3281
- value?: any;
3282
- /**
3283
- * - The display string for the size.
3284
- */
3285
- display?: any;
3286
- /**
3287
- * - Whether or not this size is available.
3288
- */
3289
- is_available?: boolean;
3290
- };
3291
- /** @returns {ProductGroupPrice} */
3292
- declare function ProductGroupPrice(): ProductGroupPrice;
3293
- type ProductGroupPrice = {
3294
- /**
3295
- * - The maximum effective price of the product group.
3296
- */
3297
- max_effective?: number;
3298
- /**
3299
- * - The minimum effective price of the product group.
3300
- */
3301
- min_effective?: number;
3302
- /**
3303
- * - The minimum marked price of the product group.
3304
- */
3305
- min_marked?: number;
3306
- /**
3307
- * - The currency code for the prices.
3308
- */
3309
- currency?: any;
3310
- /**
3311
- * - The maximum marked price of the product group.
3312
- */
3313
- max_marked?: number;
3314
- };
3315
- /** @returns {ProductDetails} */
3316
- declare function ProductDetails(): ProductDetails;
3317
- type ProductDetails = {
3318
- /**
3319
- * - The template tag of the product.
3320
- */
3321
- template_tag?: any;
3322
- /**
3323
- * - The number of ratings the product has received.
3324
- */
3325
- rating_count?: number;
3326
- /**
3327
- * - The nature of the product's images.
3328
- */
3329
- image_nature?: any;
3330
- /**
3331
- * - Whether or not the product has a variant.
3332
- */
3333
- has_variant?: boolean;
3334
- /**
3335
- * - The long description of the product.
3336
- */
3337
- description?: any;
3338
- /**
3339
- * - Whether or not the product is out of stock.
3340
- */
3341
- out_of_stock?: boolean;
3342
- /**
3343
- * - The HSN code of the product.
3344
- */
3345
- hsn_code?: number;
3346
- /**
3347
- * - A dictionary of grouped product attributes.
3348
- */
3349
- grouped_attributes?: any;
3350
- /**
3351
- * - The item code of the product.
3352
- */
3353
- item_code?: any;
3354
- /**
3355
- * - The name of the product.
3356
- */
3357
- name?: any;
3358
- /**
3359
- * - The country of origin for the product.
3360
- */
3361
- country_of_origin?: any;
3362
- /**
3363
- * - The short description of the product.
3364
- */
3365
- short_description?: any;
3366
- /**
3367
- * - A list of media objects for the product.
3368
- */
3369
- media?: any[];
3370
- /**
3371
- * - A dictionary of product attributes.
3372
- */
3373
- attributes?: any;
3374
- /**
3375
- * - Whether or not the product is a set of items.
3376
- */
3377
- is_set?: boolean;
3378
- /**
3379
- * - A list of image URLs for the product.
3380
- */
3381
- images?: any[];
3382
- /**
3383
- * - The slug of the product.
3384
- */
3385
- slug?: any;
3386
- /**
3387
- * - The rating of the product.
3388
- */
3389
- rating?: number;
3390
- /**
3391
- * - A dictionary of product identifiers.
3392
- */
3393
- identifier?: any;
3394
- /**
3395
- * - A list of highlights for the product.
3396
- */
3397
- highlights?: any[];
3398
- /**
3399
- * - The unique ID of the product's brand.
3400
- */
3401
- brand_uid?: number;
3402
- };
3403
- /** @returns {ProductInGroup} */
3404
- declare function ProductInGroup(): ProductInGroup;
3405
- type ProductInGroup = {
3406
- /**
3407
- * - Whether the product should be
3408
- * automatically added to the cart.
3409
- */
3410
- auto_add_to_cart?: boolean;
3411
- /**
3412
- * - The maximum quantity of the product that
3413
- * can be added to the cart.
3414
- */
3415
- max_quantity: number;
3416
- /**
3417
- * - The available sizes for the product.
3418
- */
3419
- sizes?: Size[];
3420
- /**
3421
- * - The price details for the product.
3422
- */
3423
- price?: ProductGroupPrice;
3424
- /**
3425
- * - Whether the product should be
3426
- * automatically selected.
3427
- */
3428
- auto_select?: boolean;
3429
- /**
3430
- * - The details of the product.
3431
- */
3432
- product_details?: ProductDetails;
3433
- /**
3434
- * - The minimum quantity of the product that
3435
- * can be added to the cart.
3436
- */
3437
- min_quantity?: number;
3438
- /**
3439
- * - Whether the product can be removed from the cart.
3440
- */
3441
- allow_remove?: boolean;
3442
- /**
3443
- * - The unique ID of the product in the group.
3444
- */
3445
- product_uid: number;
3446
- };
3447
- /** @returns {ProductGroupingModel} */
3448
- declare function ProductGroupingModel(): ProductGroupingModel;
3449
- type ProductGroupingModel = {
3450
- /**
3451
- * - The URL for the logo of the product group.
3452
- */
3453
- logo?: string;
3454
- /**
3455
- * - Whether the product grouping is active.
3456
- */
3457
- is_active?: boolean;
3458
- /**
3459
- * - A dictionary containing metadata information.
3460
- */
3461
- meta?: any;
3462
- /**
3463
- * - User details of the verifier of the
3464
- * document, if applicable.
3465
- */
3466
- verified_by?: UserDetail;
3467
- /**
3468
- * - Timestamp of the creation of the document.
3469
- */
3470
- created_on: string;
3471
- /**
3472
- * - The ID of the company that owns the product grouping.
3473
- */
3474
- company_id?: number;
3475
- /**
3476
- * - A list of page visibilities of the
3477
- * product grouping.
3478
- */
3479
- page_visibility?: any[];
3480
- /**
3481
- * - Timestamp of the last modification of the document.
3482
- */
3483
- modified_on: string;
3484
- /**
3485
- * - User details of the creator of the document.
3486
- */
3487
- created_by?: UserDetail;
3488
- /**
3489
- * - User details of the last modifier of
3490
- * the document.
3491
- */
3492
- modified_by?: UserDetail;
3493
- /**
3494
- * - A list of products in the grouping.
3495
- */
3496
- products: ProductInGroup[];
3497
- /**
3498
- * - Whether the products are
3499
- * assigned to the same store.
3500
- */
3501
- same_store_assignment?: boolean;
3502
- /**
3503
- * - Unique identifier of the product grouping.
3504
- */
3505
- _id?: any;
3506
- /**
3507
- * - The name of the product grouping.
3508
- */
3509
- name: any;
3510
- /**
3511
- * - The choice of the product grouping.
3512
- */
3513
- choice?: any;
3514
- /**
3515
- * - The unique identifier for the product grouping.
3516
- */
3517
- slug?: any;
3518
- /**
3519
- * - Timestamp of when the document was
3520
- * verified, if applicable.
3521
- */
3522
- verified_on?: string;
3523
- };
3524
- /** @returns {ProductBundle} */
3525
- declare function ProductBundle(): ProductBundle;
3526
- type ProductBundle = {
3527
- /**
3528
- * - Represents list of
3529
- * bundles/product groupings.
3530
- */
3531
- items?: ProductGroupingModel[];
3532
- };
3533
- /** @returns {StoreV3} */
3534
- declare function StoreV3(): StoreV3;
3535
- type StoreV3 = {
3536
- /**
3537
- * - The unique identifier for the store.
3538
- */
3539
- uid?: number;
3540
- /**
3541
- * - The name of the store.
3542
- */
3543
- name?: string;
3544
- /**
3545
- * - The count associated with the store.
3546
- */
3547
- count?: number;
3548
- };
3549
- /** @returns {ArticleAssignmentV3} */
3550
- declare function ArticleAssignmentV3(): ArticleAssignmentV3;
3551
- type ArticleAssignmentV3 = {
3552
- /**
3553
- * - Method used for article assignment, such as
3554
- * optimal, fast-delivery, low-price, or manual.
3555
- */
3556
- strategy?: string;
3557
- /**
3558
- * - Scope of assignment, which can be
3559
- * multi-companies, single-company, or single-store.
3560
- */
3561
- level?: string;
3562
- };
3563
- /** @returns {StrategyWiseListingSchemaV3} */
3564
- declare function StrategyWiseListingSchemaV3(): StrategyWiseListingSchemaV3;
3565
- type StrategyWiseListingSchemaV3 = {
3566
- /**
3567
- * - Distance between bullfight location and
3568
- * customer location in kilometers. .
3569
- */
3570
- distance?: number;
3571
- /**
3572
- * - Pincode mapped based on strategy.
3573
- */
3574
- pincode?: number;
3575
- /**
3576
- * - Turn around Time to deliver the product with this strategy.
3577
- */
3578
- tat?: number;
3579
- /**
3580
- * - The quantity available for assigned store.
3581
- */
3582
- quantity?: number;
3583
- };
3584
- /** @returns {DetailsSchemaV3} */
3585
- declare function DetailsSchemaV3(): DetailsSchemaV3;
3586
- type DetailsSchemaV3 = {
3587
- /**
3588
- * - The value of the attribute.
3589
- */
3590
- value?: string;
3591
- /**
3592
- * - The type of detail e.g, text.
3593
- */
3594
- type?: string;
3595
- /**
3596
- * - The attribute key associated with the size.
3597
- */
3598
- key?: string;
3599
- };
3600
- /** @returns {SellerGroupAttributes} */
3601
- declare function SellerGroupAttributes(): SellerGroupAttributes;
3602
- type SellerGroupAttributes = {
3603
- /**
3604
- * - The title of the attribute group.
3605
- */
3606
- title?: string;
3607
- /**
3608
- * - Detail of the attribute.
3609
- */
3610
- details?: DetailsSchemaV3[];
3611
- };
3612
- /** @returns {ReturnConfigSchemaV3} */
3613
- declare function ReturnConfigSchemaV3(): ReturnConfigSchemaV3;
3614
- type ReturnConfigSchemaV3 = {
3615
- /**
3616
- * - The unit for the return configuration.
3617
- */
3618
- unit?: string;
3619
- /**
3620
- * - Indicates if the item is returnable.
3621
- */
3622
- returnable?: boolean;
3623
- /**
3624
- * - The time duration for the return policy.
3625
- */
3626
- time?: number;
3627
- };
3628
- /** @returns {ProductSetDistributionSizeV3} */
3629
- declare function ProductSetDistributionSizeV3(): ProductSetDistributionSizeV3;
3630
- type ProductSetDistributionSizeV3 = {
3631
- /**
3632
- * - The number of pieces available in this size.
3633
- */
3634
- pieces?: number;
3635
- /**
3636
- * - The size of the product.
3637
- */
3638
- size?: string;
3639
- };
3640
- /** @returns {ProductSetDistributionV3} */
3641
- declare function ProductSetDistributionV3(): ProductSetDistributionV3;
3642
- type ProductSetDistributionV3 = {
3643
- /**
3644
- * - A list of size
3645
- * distributions in the product set.
3646
- */
3647
- sizes?: ProductSetDistributionSizeV3[];
3648
- };
3649
- /** @returns {ProductSetV3} */
3650
- declare function ProductSetV3(): ProductSetV3;
3651
- type ProductSetV3 = {
3652
- /**
3653
- * - The quantity of products in the set.
3654
- */
3655
- quantity?: number;
3656
- size_distribution?: ProductSetDistributionV3;
3657
- };
3658
- /** @returns {ProductStockPriceV3} */
3659
- declare function ProductStockPriceV3(): ProductStockPriceV3;
3660
- type ProductStockPriceV3 = {
3661
- /**
3662
- * - The effective or final price for the product
3663
- * at the given pincode.
3664
- */
3665
- effective?: number;
3666
- /**
3667
- * - The currency code for which the product
3668
- * is available.
3669
- */
3670
- currency_code?: string;
3671
- /**
3672
- * - The currency symbol for the currency
3673
- * in which the product is available.
3674
- */
3675
- currency_symbol?: string;
3676
- /**
3677
- * - The marked price of the product.
3678
- */
3679
- marked?: number;
3680
- /**
3681
- * - The selling price of the product.
3682
- */
3683
- selling?: number;
3684
- };
3685
- /** @returns {ProductStockUnitPriceV3} */
3686
- declare function ProductStockUnitPriceV3(): ProductStockUnitPriceV3;
3687
- type ProductStockUnitPriceV3 = {
3688
- /**
3689
- * - The unit of measure for the product.
3690
- */
3691
- unit?: string;
3692
- /**
3693
- * - The currency symbol for the unit price.
3694
- */
3695
- currency_symbol?: string;
3696
- /**
3697
- * - The currency code for the unit price.
3698
- */
3699
- currency_code?: string;
3700
- /**
3701
- * - The unit price of the product.
3702
- */
3703
- price?: number;
3704
- };
3705
- /** @returns {MarketPlaceSttributesSchemaV3} */
3706
- declare function MarketPlaceSttributesSchemaV3(): MarketPlaceSttributesSchemaV3;
3707
- type MarketPlaceSttributesSchemaV3 = {
3708
- /**
3709
- * - The title of the attribute.
3710
- */
3711
- title?: string;
3712
- /**
3713
- * - Detail of the attribute.
3714
- */
3715
- details?: DetailsSchemaV3[];
3716
- };
3717
- /** @returns {SellerV3} */
3718
- declare function SellerV3(): SellerV3;
3719
- type SellerV3 = {
3720
- /**
3721
- * - The unique identifier for the seller.
3722
- */
3723
- uid?: number;
3724
- /**
3725
- * - The name of the seller.
3726
- */
3727
- name?: string;
3728
- /**
3729
- * - The store count serviceable by this seller.
3730
- */
3731
- count?: number;
3732
- };
3733
- /** @returns {PromiseSchema} */
3734
- declare function PromiseSchema(): PromiseSchema;
3735
- type PromiseSchema = {
3736
- /**
3737
- * - The minimum promise time.
3738
- */
3739
- min?: string;
3740
- /**
3741
- * - The maximum promise time.
3742
- */
3743
- max?: string;
3744
- };
3745
- /** @returns {ProductSizePriceResponseV3} */
3746
- declare function ProductSizePriceResponseV3(): ProductSizePriceResponseV3;
3747
- type ProductSizePriceResponseV3 = {
3748
- store?: StoreV3;
3749
- article_assignment?: ArticleAssignmentV3;
3750
- /**
3751
- * - Whether Cash on Delivery (COD) is available
3752
- * for this product. It is true if COD is available and false otherwise.
3753
- */
3754
- is_cod?: boolean;
3755
- /**
3756
- * - Details
3757
- * about serviceability attributes.
3758
- */
3759
- strategy_wise_listing?: StrategyWiseListingSchemaV3[];
3760
- /**
3761
- * - Available quantity of the product in stock.
3762
- * It shows the number of units available for purchase.
3763
- */
3764
- quantity?: number;
3765
- /**
3766
- * - Type of item, indicating the category or
3767
- * nature of the product. Possible values are Standard, Composite, Wet, Digital.
3768
- */
3769
- item_type?: string;
3770
- /**
3771
- * - Collection of
3772
- * attributes grouped together, which provides detailed characteristics of the
3773
- * product, such as color, size, material, etc.
3774
- */
3775
- grouped_attributes?: SellerGroupAttributes[];
3776
- return_config?: ReturnConfigSchemaV3;
3777
- /**
3778
- * - This unique identifier is assigned to the
3779
- * specific article. This represents item x size x location.
3780
- */
3781
- article_id?: string;
3782
- /**
3783
- * - Whether the product can be purchased as a
3784
- * gift. It is true if the product is available for gifting and false otherwise.
3785
- */
3786
- is_gift?: boolean;
3787
- set?: ProductSetV3;
3788
- /**
3789
- * - Number of sellers offering this product.
3790
- * It indicates the level of competition and availability from different sellers.
3791
- */
3792
- seller_count?: number;
3793
- price_per_piece?: ProductStockPriceV3;
3794
- discount_meta?: DiscountMeta;
3795
- /**
3796
- * - Amount or percentage of discount applied to
3797
- * the product's price, showing the savings for the customer.
3798
- */
3799
- discount?: string;
3800
- /**
3801
- * - Longitude and latitude coordinates,
3802
- * possibly indicating the location of the store or warehouse where the
3803
- * product is stocked.
3804
- */
3805
- long_lat?: number[];
3806
- /**
3807
- * - Special badges or labels assigned to the
3808
- * product, such as "Bestseller," "New Arrival," or "Limited Edition.".
3809
- */
3810
- special_badge?: string;
3811
- price?: ProductStockPriceV3;
3812
- price_per_unit?: ProductStockUnitPriceV3;
3813
- /**
3814
- * - Postal code or zip code for which the
3815
- * product's availability and delivery options are being checked.
3816
- */
3817
- pincode?: number;
3818
- /**
3819
- * -
3820
- * Attributes specific to the marketplace, such as ratings, reviews, shipping
3821
- * options, and other marketplace-specific details.
3822
- */
3823
- marketplace_attributes?: MarketPlaceSttributesSchemaV3[];
3824
- seller?: SellerV3;
3825
- delivery_promise?: PromiseSchema;
3826
- };
3827
- /** @returns {ProductSizeSellerFilterSchemaV3} */
3828
- declare function ProductSizeSellerFilterSchemaV3(): ProductSizeSellerFilterSchemaV3;
3829
- type ProductSizeSellerFilterSchemaV3 = {
3830
- /**
3831
- * - The name of the store/seller.
3832
- */
3833
- name?: string;
3834
- /**
3835
- * - Whether this filter criterion is selected.
3836
- */
3837
- is_selected?: boolean;
3838
- /**
3839
- * - The value associated with this store/seller.
3840
- */
3841
- value?: string;
3842
- };
3843
- /** @returns {ProductSizeSellersResponseV3} */
3844
- declare function ProductSizeSellersResponseV3(): ProductSizeSellersResponseV3;
3845
- type ProductSizeSellersResponseV3 = {
3846
- /**
3847
- * - A list of products with
3848
- * size and price details available from various sellers.
3849
- */
3850
- items?: ProductSizePriceResponseV3[];
3851
- page: Page;
3852
- /**
3853
- * - A list of sorting
3854
- * and filtering criteria applied to the sellers' data.
3855
- */
3856
- sort_on?: ProductSizeSellerFilterSchemaV3[];
3857
- };