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