@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.
Files changed (126) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
  4. package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
  7. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  8. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  9. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  10. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  11. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
  12. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
  14. package/sdk/application/Content/ContentApplicationModel.js +757 -757
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  16. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  17. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  18. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  19. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
  20. package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
  21. package/sdk/application/Order/OrderApplicationModel.d.ts +852 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +828 -822
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  24. package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
  25. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2176 -2145
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1474 -1453
  27. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  28. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  29. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
  30. package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
  31. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  32. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  33. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  34. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  35. package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
  36. package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
  37. package/sdk/application/User/UserApplicationClient.d.ts +2 -2
  38. package/sdk/application/User/UserApplicationClient.js +4 -7
  39. package/sdk/application/User/UserApplicationModel.d.ts +769 -764
  40. package/sdk/application/User/UserApplicationModel.js +731 -741
  41. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  43. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  44. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  46. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  47. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  48. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  49. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  50. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  52. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  53. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  54. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  55. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  56. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -980
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +977 -933
  63. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  64. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  65. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  66. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  69. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  70. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  71. package/sdk/platform/Content/ContentPlatformModel.d.ts +1842 -1825
  72. package/sdk/platform/Content/ContentPlatformModel.js +1868 -1848
  73. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  74. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  75. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
  76. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
  77. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
  78. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
  79. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
  80. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
  81. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +882 -869
  82. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +894 -878
  83. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  84. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  85. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  86. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  87. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  88. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  89. package/sdk/platform/Order/OrderPlatformModel.d.ts +5192 -5176
  90. package/sdk/platform/Order/OrderPlatformModel.js +4752 -4736
  91. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  92. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  93. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2693 -2657
  94. package/sdk/platform/Payment/PaymentPlatformModel.js +1842 -1819
  95. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  96. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  97. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
  98. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
  99. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1674 -1539
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1663 -1534
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
  103. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  104. package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
  105. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
  106. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
  107. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  108. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  109. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  110. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  111. package/sdk/platform/User/UserPlatformModel.d.ts +823 -753
  112. package/sdk/platform/User/UserPlatformModel.js +731 -661
  113. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  114. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  115. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  116. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  117. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  118. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  119. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  120. package/sdk/public/Content/ContentPublicModel.js +28 -28
  121. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  122. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  123. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  124. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  125. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  126. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,642 +1,506 @@
1
1
  export = PosCartApplicationModel;
2
2
  /**
3
- * @typedef ActionQuery
4
- * @property {string[]} [product_slug] - Contains list of product slug
5
- */
6
- /**
7
- * @typedef AddCartDetailResponse
8
- * @property {CartDetailResponse} [cart]
9
- * @property {string} [message]
10
- * @property {boolean} [partial] - When adding multiple items check if all
11
- * added. True if only few are added.
12
- * @property {boolean} [success] - True if all items are added successfully.
13
- * False if partially added or not added.
14
- */
15
- /**
16
- * @typedef AddCartRequest
17
- * @property {AddProductCart[]} [items]
18
- * @property {boolean} [new_cart]
3
+ * @typedef BuyRules
4
+ * @property {Object} [cart_conditions] - Cart conditions details for promotion
5
+ * @property {Object} [item_criteria] - Item criteria of promotion
19
6
  */
20
7
  /**
21
- * @typedef AddProductCart
22
- * @property {Object} [_custom_json]
23
- * @property {Object} [article_assignment]
24
- * @property {string} [article_id]
25
- * @property {string} [display]
26
- * @property {Object} [extra_meta]
27
- * @property {number} [item_id]
28
- * @property {string} [item_size]
29
- * @property {Object} [meta]
30
- * @property {Object[]} [parent_item_identifiers]
31
- * @property {boolean} [pos]
32
- * @property {string[]} [product_group_tags]
33
- * @property {number} [quantity]
34
- * @property {number} [seller_id]
35
- * @property {number} [store_id]
8
+ * @typedef DiscountRulesApp
9
+ * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
10
+ * @property {Object} [offer] - Offer for promotion
11
+ * @property {Object} [item_criteria] - Item criteria of promotion
12
+ * @property {Object} [raw_offer] - Raw offer details for promotion
36
13
  */
37
14
  /**
38
- * @typedef Address
39
- * @property {Object} [_custom_json]
40
- * @property {string} [address]
41
- * @property {string} [address_type]
42
- * @property {string} [area]
43
- * @property {string} [area_code]
44
- * @property {string} [area_code_slug]
45
- * @property {string} [checkout_mode]
46
- * @property {string} [city]
47
- * @property {string} [country]
48
- * @property {string} [country_code]
49
- * @property {string} [country_iso_code]
50
- * @property {string} [country_phone_code]
51
- * @property {string} [created_by_user_id]
52
- * @property {string} [email]
53
- * @property {GeoLocation} [geo_location]
54
- * @property {Object} [google_map_point]
55
- * @property {string} [id]
56
- * @property {boolean} [is_active]
57
- * @property {boolean} [is_default_address]
58
- * @property {string} [landmark]
59
- * @property {Object} [meta]
60
- * @property {string} [name]
61
- * @property {string} [phone]
62
- * @property {string} [sector]
63
- * @property {string} [state]
64
- * @property {string} [state_code] - State code for international address
65
- * @property {string[]} [tags]
66
- * @property {string} [user_id]
15
+ * @typedef FreeGiftItem
16
+ * @property {string} [item_slug] - Item slug
17
+ * @property {Object} [item_price_details] - Item price details
18
+ * @property {string[]} [item_images_url] - Item images URL
19
+ * @property {string} [item_name] - Item name
20
+ * @property {number} [item_id] - Item id
21
+ * @property {string} [item_brand_name] - Item brand name
67
22
  */
68
23
  /**
69
24
  * @typedef AppliedFreeArticles
25
+ * @property {number} [quantity] - Free article quantity
26
+ * @property {string} [parent_item_identifier] - Parent item identifier for free article
70
27
  * @property {string} [article_id] - Free article id
71
28
  * @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
72
- * @property {string} [parent_item_identifier] - Parent item identifier for free article
73
- * @property {number} [quantity] - Free article quantity
29
+ */
30
+ /**
31
+ * @typedef Ownership
32
+ * @property {string} [payable_category] - Promo amount payable category
33
+ * @property {string} [payable_by] - Promo amount bearable party
74
34
  */
75
35
  /**
76
36
  * @typedef AppliedPromotion
77
- * @property {number} [amount] - Per unit discount amount applied with current promotion
78
- * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
79
- * article for free gift item promotions
37
+ * @property {string} [promotion_name] - Promotion name of current promotion
38
+ * @property {boolean} [mrp_promotion] - If applied promotion is applied on
39
+ * product MRP or ESP
40
+ * @property {BuyRules[]} [buy_rules] - Buy rules for promotions
41
+ * @property {string} [promotion_type] - Promotion type of current promotion
80
42
  * @property {number} [article_quantity] - Quantity of article on which
81
43
  * promotion is applicable
82
- * @property {BuyRules[]} [buy_rules] - Buy rules for promotions
83
- * @property {CartCurrency} [currency]
44
+ * @property {number} [amount] - Per unit discount amount applied with current promotion
84
45
  * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
85
- * @property {boolean} [mrp_promotion] - If applied promotion is applied on
86
- * product MRP or ESP
87
46
  * @property {string} [offer_text] - Offer text of current promotion
88
- * @property {Ownership} [ownership] - Ownership of promotion
89
47
  * @property {string} [promo_id] - Promotion id
48
+ * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
49
+ * article for free gift item promotions
50
+ * @property {Ownership} [ownership] - Ownership of promotion
51
+ * @property {CartCurrency} [currency]
90
52
  * @property {string} [promotion_group] - Promotion group for the promotion
91
- * @property {string} [promotion_name] - Promotion name of current promotion
92
- * @property {string} [promotion_type] - Promotion type of current promotion
93
- */
94
- /**
95
- * @typedef ApplyCouponRequest
96
- * @property {string} coupon_code - Coupon code to be applied
97
- */
98
- /**
99
- * @typedef ArticleGiftDetail
100
- * @property {GiftDetail} [article_id]
101
53
  */
102
54
  /**
103
- * @typedef ArticlePriceInfo
104
- * @property {BasePrice} [base]
105
- * @property {BasePrice} [converted]
55
+ * @typedef LoyaltyPoints
56
+ * @property {string} [description]
57
+ * @property {boolean} [is_applied]
58
+ * @property {number} [applicable]
59
+ * @property {number} [total]
106
60
  */
107
61
  /**
108
- * @typedef BaseInfo
109
- * @property {string} [name]
110
- * @property {number} [uid]
62
+ * @typedef RawBreakup
63
+ * @property {number} [discount]
64
+ * @property {number} [you_saved]
65
+ * @property {number} [mrp_total]
66
+ * @property {number} [gst_charges]
67
+ * @property {number} [total]
68
+ * @property {number} [vog]
69
+ * @property {number} [coupon]
70
+ * @property {number} [subtotal]
71
+ * @property {number} [delivery_charge]
72
+ * @property {number} [cod_charge]
73
+ * @property {number} [fynd_cash]
74
+ * @property {number} [gift_card]
75
+ * @property {number} [convenience_fee]
111
76
  */
112
77
  /**
113
- * @typedef BasePrice
78
+ * @typedef DisplayBreakup
114
79
  * @property {string} [currency_code]
115
80
  * @property {string} [currency_symbol]
116
- * @property {number} [effective]
117
- * @property {number} [marked]
118
- */
119
- /**
120
- * @typedef BulkPriceOffer
121
- * @property {OfferItem[]} [offers]
122
- * @property {OfferSeller} [seller]
123
- */
124
- /**
125
- * @typedef BulkPriceResponse
126
- * @property {BulkPriceOffer[]} [data] - Consist of offers from multiple seller
81
+ * @property {string} [display]
82
+ * @property {string[]} [message]
83
+ * @property {string} [key]
84
+ * @property {number} [value]
127
85
  */
128
86
  /**
129
- * @typedef BuyRules
130
- * @property {Object} [cart_conditions] - Cart conditions details for promotion
131
- * @property {Object} [item_criteria] - Item criteria of promotion
87
+ * @typedef CouponBreakup
88
+ * @property {number} [max_discount_value]
89
+ * @property {string} [message]
90
+ * @property {boolean} [is_applied]
91
+ * @property {string} [uid]
92
+ * @property {string} [type]
93
+ * @property {string} [coupon_type]
94
+ * @property {string} [sub_title]
95
+ * @property {number} [coupon_value]
96
+ * @property {string} [description]
97
+ * @property {string} [code]
98
+ * @property {number} [minimum_cart_value]
99
+ * @property {number} [value]
100
+ * @property {string} [title]
132
101
  */
133
102
  /**
134
103
  * @typedef CartBreakup
135
- * @property {CouponBreakup} [coupon]
136
- * @property {DisplayBreakup[]} [display]
137
104
  * @property {LoyaltyPoints} [loyalty_points]
138
105
  * @property {RawBreakup} [raw]
106
+ * @property {DisplayBreakup[]} [display]
107
+ * @property {CouponBreakup} [coupon]
139
108
  */
140
109
  /**
141
- * @typedef CartCheckoutCustomMeta
142
- * @property {string} key
143
- * @property {string} value
110
+ * @typedef PaymentSelectionLock
111
+ * @property {string} [default_options]
112
+ * @property {boolean} [enabled]
113
+ * @property {string} [payment_identifier]
144
114
  */
145
115
  /**
146
- * @typedef CartCheckoutResponse
147
- * @property {string} [app_intercept_url]
148
- * @property {string} [callback_url]
149
- * @property {CheckCart} [cart]
150
- * @property {Object} [data]
151
- * @property {string} [message]
152
- * @property {string} [order_id]
153
- * @property {string} [payment_confirm_url]
154
- * @property {boolean} [success]
116
+ * @typedef PromiseTimestamp
117
+ * @property {number} [max]
118
+ * @property {number} [min]
155
119
  */
156
120
  /**
157
- * @typedef CartCurrency
158
- * @property {string} [code] - Currency code defined by ISO 4217:2015
159
- * @property {string} [symbol]
121
+ * @typedef PromiseFormatted
122
+ * @property {string} [max]
123
+ * @property {string} [min]
160
124
  */
161
125
  /**
162
- * @typedef CartDeliveryModesResponse
163
- * @property {string[]} [available_modes] - Available delivery modes
164
- * @property {number[]} [pickup_stores] - Store pick up available store uids
126
+ * @typedef PromiseISOFormat
127
+ * @property {string} [max] - Max promise in ISO format.
128
+ * @property {string} [min] - Min Promise in ISO format.
165
129
  */
166
130
  /**
167
- * @typedef CartDetailResponse
168
- * @property {AppliedPromotion[]} [applied_promo_details]
169
- * @property {CartBreakup} [breakup_values]
170
- * @property {boolean} [buy_now]
171
- * @property {string} [checkout_mode]
172
- * @property {string} [comment]
173
- * @property {string} [coupon_text]
174
- * @property {CartCurrency} [currency]
175
- * @property {string} [delivery_charge_info]
176
- * @property {ShipmentPromise} [delivery_promise]
177
- * @property {string} [gstin]
178
- * @property {string} [id]
179
- * @property {boolean} [is_valid]
180
- * @property {CartProductInfo[]} [items]
181
- * @property {string} [last_modified]
182
- * @property {string} [message]
183
- * @property {Object} [pan_config]
184
- * @property {string} [pan_no]
185
- * @property {PaymentSelectionLock} [payment_selection_lock]
186
- * @property {boolean} [restrict_checkout]
131
+ * @typedef ShipmentPromise
132
+ * @property {PromiseTimestamp} [timestamp]
133
+ * @property {PromiseFormatted} [formatted]
134
+ * @property {PromiseISOFormat} [iso]
187
135
  */
188
136
  /**
189
- * @typedef CartItemCountResponse
190
- * @property {number} [user_cart_items_count] - Item count present in cart
137
+ * @typedef StoreInfo
138
+ * @property {number} [uid]
139
+ * @property {string} [store_code]
140
+ * @property {string} [name]
191
141
  */
192
142
  /**
193
- * @typedef CartMetaMissingResponse
194
- * @property {string[]} [errors]
143
+ * @typedef BaseInfo
144
+ * @property {number} [uid]
145
+ * @property {string} [name]
195
146
  */
196
147
  /**
197
- * @typedef CartMetaRequest
198
- * @property {string} [checkout_mode]
199
- * @property {string} [comment]
200
- * @property {Object} [delivery_slots]
201
- * @property {ArticleGiftDetail} [gift_details]
202
- * @property {string} [gstin]
203
- * @property {Object} [pick_up_customer_details] - Customer contact details for
204
- * customer pickup at store
148
+ * @typedef BasePrice
149
+ * @property {number} [effective]
150
+ * @property {string} [currency_code]
151
+ * @property {string} [currency_symbol]
152
+ * @property {number} [marked]
205
153
  */
206
154
  /**
207
- * @typedef CartMetaResponse
208
- * @property {boolean} [is_valid]
209
- * @property {string} [message]
155
+ * @typedef ArticlePriceInfo
156
+ * @property {BasePrice} [converted]
157
+ * @property {BasePrice} [base]
210
158
  */
211
159
  /**
212
- * @typedef CartPosCheckoutDetailRequest
213
- * @property {string} [address_id]
214
- * @property {string} [aggregator]
215
- * @property {Object} [billing_address]
216
- * @property {string} [billing_address_id]
217
- * @property {string} [callback_url]
218
- * @property {CartCheckoutCustomMeta[]} [custom_meta]
219
- * @property {Object} [customer_details] - Customer details
220
- * @property {Object} [delivery_address]
221
- * @property {Object} [extra_meta]
222
- * @property {Files[]} [files] - List of file url
223
- * @property {string} [id]
224
- * @property {string} [merchant_code]
160
+ * @typedef ProductArticle
225
161
  * @property {Object} [meta]
226
- * @property {string} order_type
227
- * @property {number} [ordering_store]
228
- * @property {boolean} [payment_auto_confirm]
229
- * @property {string} [payment_identifier]
230
- * @property {string} payment_mode
231
- * @property {Object} [payment_params]
232
- * @property {number} [pick_at_store_uid]
233
- * @property {boolean} [pos]
234
- * @property {StaffCheckout} [staff]
235
- */
236
- /**
237
- * @typedef CartProduct
162
+ * @property {StoreInfo} [store]
238
163
  * @property {Object} [_custom_json]
239
- * @property {ProductAction} [action]
240
- * @property {BaseInfo} [brand]
241
- * @property {CategoryInfo[]} [categories]
242
- * @property {ProductImage[]} [images]
243
- * @property {string} [item_code]
244
- * @property {string} [name]
245
- * @property {string} [slug] - Unique product url name generated via product
246
- * name and other meta data
247
- * @property {string[]} [tags]
248
- * @property {Tags} [teaser_tag]
164
+ * @property {string} [seller_identifier]
165
+ * @property {Object} [identifier]
166
+ * @property {number} [quantity]
167
+ * @property {BaseInfo} [seller]
168
+ * @property {number} [mto_quantity]
169
+ * @property {string} [uid]
170
+ * @property {Object} [cart_item_meta]
249
171
  * @property {string} [type]
250
- * @property {number} [uid]
251
- */
252
- /**
253
- * @typedef CartProductIdentifer
254
- * @property {string} [identifier] - Article idenfier generated by cart
255
- */
256
- /**
257
- * @typedef CartProductInfo
258
- * @property {ProductArticle} [article]
259
- * @property {ProductAvailability} [availability]
260
- * @property {Object} [bulk_offer]
261
- * @property {CouponDetails} [coupon]
262
- * @property {string} [coupon_message]
263
- * @property {Object} [custom_order]
264
- * @property {ShipmentPromise} [delivery_promise]
265
- * @property {string} [discount]
266
- * @property {CartProductIdentifer} identifiers
267
- * @property {boolean} [is_set]
268
- * @property {string} [key]
269
- * @property {string} [message]
270
- * @property {Object} [moq]
172
+ * @property {ArticlePriceInfo} [price]
271
173
  * @property {Object} [parent_item_identifiers]
272
- * @property {ProductPriceInfo} [price]
273
- * @property {ProductPriceInfo} [price_per_unit]
274
- * @property {CartProduct} [product]
275
- * @property {PromoMeta} [promo_meta]
276
- * @property {AppliedPromotion[]} [promotions_applied]
277
- * @property {number} [quantity]
174
+ * @property {string} [size]
175
+ * @property {Object} [extra_meta]
176
+ * @property {Object} [gift_card]
177
+ * @property {string[]} [product_group_tags]
178
+ * @property {boolean} [is_gift_visible]
179
+ * @property {string[]} [tags] - A list of article tags
278
180
  */
279
181
  /**
280
- * @typedef CartShipmentsResponse
281
- * @property {CartBreakup} [breakup_values]
282
- * @property {boolean} [buy_now]
283
- * @property {number} [cart_id]
284
- * @property {string} [checkout_mode]
285
- * @property {string} [comment]
286
- * @property {string} [coupon_text]
287
- * @property {CartCurrency} [currency]
288
- * @property {string} [delivery_charge_info]
289
- * @property {ShipmentPromise} [delivery_promise]
290
- * @property {boolean} [error]
291
- * @property {string} [gstin]
292
- * @property {string} [id]
293
- * @property {boolean} [is_valid]
294
- * @property {string} [last_modified]
295
- * @property {string} [message]
296
- * @property {PaymentSelectionLock} [payment_selection_lock]
297
- * @property {boolean} [restrict_checkout]
298
- * @property {ShipmentResponse[]} [shipments]
299
- * @property {string} [uid]
182
+ * @typedef Tags
183
+ * @property {Object} [tags]
300
184
  */
301
185
  /**
302
186
  * @typedef CategoryInfo
303
- * @property {string} [name]
304
187
  * @property {number} [uid] - Product Category Id
188
+ * @property {string} [name]
305
189
  */
306
190
  /**
307
- * @typedef CheckCart
308
- * @property {CartBreakup} [breakup_values]
309
- * @property {boolean} [buy_now]
310
- * @property {number} [cart_id]
311
- * @property {string} [checkout_mode]
312
- * @property {boolean} [cod_available]
313
- * @property {number} [cod_charges]
314
- * @property {string} [cod_message]
315
- * @property {string} [comment]
316
- * @property {string} [coupon_text]
317
- * @property {CartCurrency} [currency]
318
- * @property {string} [delivery_charge_info]
319
- * @property {number} [delivery_charge_order_value]
320
- * @property {number} [delivery_charges]
321
- * @property {ShipmentPromise} [delivery_promise]
322
- * @property {string} [error_message]
323
- * @property {string} [gstin]
324
- * @property {string} [id]
325
- * @property {boolean} [is_valid]
326
- * @property {CartProductInfo[]} [items]
327
- * @property {string} [last_modified]
328
- * @property {string} [message]
329
- * @property {string} [order_id]
330
- * @property {PaymentSelectionLock} [payment_selection_lock]
331
- * @property {boolean} [restrict_checkout]
332
- * @property {string} [store_code]
333
- * @property {Object[]} [store_emps]
334
- * @property {boolean} [success]
335
- * @property {string} [uid]
336
- * @property {string} [user_type]
191
+ * @typedef ProductImage
192
+ * @property {string} [aspect_ratio]
193
+ * @property {string} [url]
194
+ * @property {string} [secure_url]
337
195
  */
338
196
  /**
339
- * @typedef Coupon
340
- * @property {string} [coupon_code]
341
- * @property {string} [coupon_type]
342
- * @property {number} [coupon_value]
343
- * @property {string} [description]
344
- * @property {string} [expires_on]
345
- * @property {boolean} [is_applicable]
346
- * @property {boolean} [is_applied]
347
- * @property {number} [max_discount_value]
348
- * @property {string} [message]
349
- * @property {number} [minimum_cart_value]
350
- * @property {string} [sub_title]
351
- * @property {string} [title]
197
+ * @typedef ActionQuery
198
+ * @property {string[]} [product_slug] - Contains list of product slug
352
199
  */
353
200
  /**
354
- * @typedef CouponBreakup
355
- * @property {string} [code]
356
- * @property {string} [coupon_type]
357
- * @property {number} [coupon_value]
358
- * @property {string} [description]
359
- * @property {boolean} [is_applied]
360
- * @property {number} [max_discount_value]
361
- * @property {string} [message]
362
- * @property {number} [minimum_cart_value]
363
- * @property {string} [sub_title]
364
- * @property {string} [title]
201
+ * @typedef ProductAction
202
+ * @property {ActionQuery} [query]
203
+ * @property {string} [url]
365
204
  * @property {string} [type]
366
- * @property {string} [uid]
367
- * @property {number} [value]
368
205
  */
369
206
  /**
370
- * @typedef CouponDetails
371
- * @property {string} [code]
372
- * @property {number} [discount_single_quantity]
373
- * @property {number} [discount_total_quantity]
207
+ * @typedef CartProduct
208
+ * @property {Tags} [teaser_tag]
209
+ * @property {Object} [_custom_json]
210
+ * @property {CategoryInfo[]} [categories]
211
+ * @property {string} [item_code]
212
+ * @property {string[]} [tags]
213
+ * @property {number} [uid]
214
+ * @property {string} [type]
215
+ * @property {ProductImage[]} [images]
216
+ * @property {string} [name]
217
+ * @property {string} [slug] - Unique product url name generated via product
218
+ * name and other meta data
219
+ * @property {ProductAction} [action]
220
+ * @property {BaseInfo} [brand]
374
221
  */
375
222
  /**
376
- * @typedef CouponValidity
377
- * @property {string} [code]
378
- * @property {number} [discount]
379
- * @property {string} [display_message_en]
380
- * @property {boolean} [next_validation_required]
381
- * @property {string} [title]
382
- * @property {boolean} [valid]
223
+ * @typedef ProductPrice
224
+ * @property {number} [effective]
225
+ * @property {string} [currency_code]
226
+ * @property {string} [currency_symbol]
227
+ * @property {number} [marked]
228
+ * @property {number} [selling]
229
+ * @property {number} [add_on]
383
230
  */
384
231
  /**
385
- * @typedef CustomerDetails
386
- * @property {string} [email]
387
- * @property {string} mobile
388
- * @property {string} [name]
232
+ * @typedef ProductPriceInfo
233
+ * @property {ProductPrice} [converted]
234
+ * @property {ProductPrice} [base]
389
235
  */
390
236
  /**
391
- * @typedef DeleteAddressResponse
392
- * @property {string} [id]
393
- * @property {boolean} [is_deleted]
237
+ * @typedef CouponDetails
238
+ * @property {number} [discount_total_quantity]
239
+ * @property {number} [discount_single_quantity]
240
+ * @property {string} [code]
394
241
  */
395
242
  /**
396
- * @typedef DiscountRulesApp
397
- * @property {Object} [item_criteria] - Item criteria of promotion
398
- * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
399
- * @property {Object} [offer] - Offer for promotion
400
- * @property {Object} [raw_offer] - Raw offer details for promotion
243
+ * @typedef PromoMeta
244
+ * @property {string} [message]
401
245
  */
402
246
  /**
403
- * @typedef DisplayBreakup
404
- * @property {string} [currency_code]
405
- * @property {string} [currency_symbol]
247
+ * @typedef ProductAvailabilitySize
248
+ * @property {boolean} [is_available]
249
+ * @property {string} [value]
406
250
  * @property {string} [display]
407
- * @property {string} [key]
408
- * @property {string[]} [message]
409
- * @property {number} [value]
410
251
  */
411
252
  /**
412
- * @typedef Files
413
- * @property {string} key
414
- * @property {string[]} values
253
+ * @typedef ProductAvailability
254
+ * @property {ProductAvailabilitySize[]} [available_sizes]
255
+ * @property {number} [other_store_quantity]
256
+ * @property {boolean} [deliverable]
257
+ * @property {boolean} [out_of_stock]
258
+ * @property {boolean} [is_valid]
259
+ * @property {string[]} [sizes]
415
260
  */
416
261
  /**
417
- * @typedef FreeGiftItem
418
- * @property {string} [item_brand_name] - Item brand name
419
- * @property {number} [item_id] - Item id
420
- * @property {string[]} [item_images_url] - Item images URL
421
- * @property {string} [item_name] - Item name
422
- * @property {Object} [item_price_details] - Item price details
423
- * @property {string} [item_slug] - Item slug
262
+ * @typedef CartProductIdentifer
263
+ * @property {string} [identifier] - Article idenfier generated by cart
424
264
  */
425
265
  /**
426
- * @typedef GeoLocation
427
- * @property {number} [latitude]
428
- * @property {number} [longitude]
429
- */
430
- /**
431
- * @typedef GetAddressesResponse
432
- * @property {Address[]} [address]
433
- * @property {boolean} [pii_masking]
266
+ * @typedef CartProductInfo
267
+ * @property {Object} [custom_order]
268
+ * @property {ProductArticle} [article]
269
+ * @property {CartProduct} [product]
270
+ * @property {number} [quantity]
271
+ * @property {Object} [moq]
272
+ * @property {AppliedPromotion[]} [promotions_applied]
273
+ * @property {ProductPriceInfo} [price_per_unit]
274
+ * @property {string} [key]
275
+ * @property {ProductPriceInfo} [price]
276
+ * @property {Object} [parent_item_identifiers]
277
+ * @property {boolean} [is_set]
278
+ * @property {string} [coupon_message]
279
+ * @property {string} [message]
280
+ * @property {CouponDetails} [coupon]
281
+ * @property {string} [discount]
282
+ * @property {Object} [bulk_offer]
283
+ * @property {PromoMeta} [promo_meta]
284
+ * @property {ShipmentPromise} [delivery_promise]
285
+ * @property {ProductAvailability} [availability]
286
+ * @property {CartProductIdentifer} identifiers
434
287
  */
435
288
  /**
436
- * @typedef GetCouponResponse
437
- * @property {Coupon[]} [available_coupon_list]
438
- * @property {PageCoupon} [page]
289
+ * @typedef CartCurrency
290
+ * @property {string} [symbol]
291
+ * @property {string} [code] - Currency code defined by ISO 4217:2015
439
292
  */
440
293
  /**
441
- * @typedef GetShareCartLinkRequest
442
- * @property {string} [id] - Cart uid for generating sharing
443
- * @property {Object} [meta] - Staff, Ordering store or any other data. This
444
- * data will be used to generate link as well as sent as shared details.
294
+ * @typedef CartDetailResponse
295
+ * @property {string} [comment]
296
+ * @property {string} [coupon_text]
297
+ * @property {string} [last_modified]
298
+ * @property {Object} [pan_config]
299
+ * @property {boolean} [is_valid]
300
+ * @property {string} [id]
301
+ * @property {AppliedPromotion[]} [applied_promo_details]
302
+ * @property {string} [checkout_mode]
303
+ * @property {boolean} [restrict_checkout]
304
+ * @property {string} [message]
305
+ * @property {boolean} [buy_now]
306
+ * @property {CartBreakup} [breakup_values]
307
+ * @property {string} [delivery_charge_info]
308
+ * @property {PaymentSelectionLock} [payment_selection_lock]
309
+ * @property {string} [gstin]
310
+ * @property {ShipmentPromise} [delivery_promise]
311
+ * @property {string} [pan_no]
312
+ * @property {CartProductInfo[]} [items]
313
+ * @property {CartCurrency} [currency]
445
314
  */
446
315
  /**
447
- * @typedef GetShareCartLinkResponse
448
- * @property {string} [share_url] - Short shareable final url
449
- * @property {string} [token] - Short url unique id
316
+ * @typedef AddProductCart
317
+ * @property {number} [seller_id]
318
+ * @property {Object} [_custom_json]
319
+ * @property {Object} [meta]
320
+ * @property {string} [display]
321
+ * @property {number} [quantity]
322
+ * @property {string} [item_size]
323
+ * @property {number} [item_id]
324
+ * @property {number} [store_id]
325
+ * @property {boolean} [pos]
326
+ * @property {Object[]} [parent_item_identifiers]
327
+ * @property {Object} [extra_meta]
328
+ * @property {string[]} [product_group_tags]
329
+ * @property {Object} [article_assignment]
330
+ * @property {string} [article_id]
450
331
  */
451
332
  /**
452
- * @typedef GiftDetail
453
- * @property {string} [gift_message]
454
- * @property {boolean} [is_gift_applied]
333
+ * @typedef AddCartRequest
334
+ * @property {AddProductCart[]} [items]
335
+ * @property {boolean} [new_cart]
455
336
  */
456
337
  /**
457
- * @typedef LoyaltyPoints
458
- * @property {number} [applicable]
459
- * @property {string} [description]
460
- * @property {boolean} [is_applied]
461
- * @property {number} [total]
338
+ * @typedef AddCartDetailResponse
339
+ * @property {CartDetailResponse} [cart]
340
+ * @property {string} [message]
341
+ * @property {boolean} [partial] - When adding multiple items check if all
342
+ * added. True if only few are added.
343
+ * @property {boolean} [success] - True if all items are added successfully.
344
+ * False if partially added or not added.
462
345
  */
463
346
  /**
464
- * @typedef OfferItem
465
- * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart
466
- * @property {boolean} [best] - Is true for best offer from all offers present
467
- * for all sellers
468
- * @property {number} [margin] - Percentage value of discount
469
- * @property {OfferPrice} [price]
470
- * @property {number} [quantity] - Quantity on which offer is applicable
471
- * @property {number} [total] - Total price of offer quantity with discount
472
- * @property {string} [type] - Offer type
347
+ * @typedef UpdateProductCart
348
+ * @property {Object} [meta]
349
+ * @property {Object} [_custom_json]
350
+ * @property {number} [quantity]
351
+ * @property {string} [item_size]
352
+ * @property {number} [item_id]
353
+ * @property {number} [item_index]
354
+ * @property {CartProductIdentifer} identifiers
355
+ * @property {Object} [parent_item_identifiers]
356
+ * @property {Object} [extra_meta]
357
+ * @property {string} [article_id]
473
358
  */
474
359
  /**
475
- * @typedef OfferPrice
476
- * @property {number} [bulk_effective] - Discounted per unit price for current
477
- * offer object
478
- * @property {string} [currency_code] - Currency code for all amounts
479
- * @property {string} [currency_symbol] - Currency symbol for currency
480
- * @property {number} [effective] - Current per unit price of product after
481
- * existing deductions
482
- * @property {number} [marked] - Original price of product
360
+ * @typedef UpdateCartRequest
361
+ * @property {string} operation
362
+ * @property {UpdateProductCart[]} [items]
483
363
  */
484
364
  /**
485
- * @typedef OfferSeller
486
- * @property {string} [name]
487
- * @property {number} [uid] - Seller id
365
+ * @typedef UpdateCartDetailResponse
366
+ * @property {CartDetailResponse} [cart]
367
+ * @property {string} [message]
368
+ * @property {boolean} [success] - True if all items are added successfully.
369
+ * False if partially added or not added.
488
370
  */
489
371
  /**
490
- * @typedef Ownership
491
- * @property {string} [payable_by] - Promo amount bearable party
492
- * @property {string} [payable_category] - Promo amount payable category
372
+ * @typedef CartItemCountResponse
373
+ * @property {number} [user_cart_items_count] - Item count present in cart
493
374
  */
494
375
  /**
495
376
  * @typedef PageCoupon
496
- * @property {number} [current]
497
- * @property {boolean} [has_next]
498
377
  * @property {boolean} [has_previous]
378
+ * @property {number} [current]
499
379
  * @property {number} [total]
500
380
  * @property {number} [total_item_count]
381
+ * @property {boolean} [has_next]
501
382
  */
502
383
  /**
503
- * @typedef PaymentCouponValidate
504
- * @property {CouponValidity} [coupon_validity]
384
+ * @typedef Coupon
385
+ * @property {number} [max_discount_value]
386
+ * @property {string} [coupon_code]
505
387
  * @property {string} [message]
506
- * @property {boolean} success
388
+ * @property {boolean} [is_applied]
389
+ * @property {string} [coupon_type]
390
+ * @property {string} [sub_title]
391
+ * @property {number} [coupon_value]
392
+ * @property {boolean} [is_applicable]
393
+ * @property {string} [description]
394
+ * @property {number} [minimum_cart_value]
395
+ * @property {string} [title]
396
+ * @property {string} [expires_on]
507
397
  */
508
398
  /**
509
- * @typedef PaymentSelectionLock
510
- * @property {string} [default_options]
511
- * @property {boolean} [enabled]
512
- * @property {string} [payment_identifier]
399
+ * @typedef GetCouponResponse
400
+ * @property {PageCoupon} [page]
401
+ * @property {Coupon[]} [available_coupon_list]
513
402
  */
514
403
  /**
515
- * @typedef PickupStoreDetail
516
- * @property {string} [address]
517
- * @property {string} [address_type]
518
- * @property {string} [area]
519
- * @property {string} [area_code]
520
- * @property {string} [area_code_slug]
521
- * @property {string} [city]
522
- * @property {string} [country]
523
- * @property {string} [email]
524
- * @property {number} [id]
525
- * @property {string} [landmark]
404
+ * @typedef ApplyCouponRequest
405
+ * @property {string} coupon_code - Coupon code to be applied
406
+ */
407
+ /**
408
+ * @typedef OfferSeller
409
+ * @property {number} [uid] - Seller id
526
410
  * @property {string} [name]
527
- * @property {string} [phone]
528
- * @property {number} [pincode]
529
- * @property {string} [state]
530
- * @property {string} [store_code]
531
- * @property {number} [uid]
532
411
  */
533
412
  /**
534
- * @typedef ProductAction
535
- * @property {ActionQuery} [query]
536
- * @property {string} [type]
537
- * @property {string} [url]
413
+ * @typedef OfferPrice
414
+ * @property {number} [effective] - Current per unit price of product after
415
+ * existing deductions
416
+ * @property {string} [currency_code] - Currency code for all amounts
417
+ * @property {string} [currency_symbol] - Currency symbol for currency
418
+ * @property {number} [marked] - Original price of product
419
+ * @property {number} [bulk_effective] - Discounted per unit price for current
420
+ * offer object
538
421
  */
539
422
  /**
540
- * @typedef ProductArticle
541
- * @property {Object} [_custom_json]
542
- * @property {Object} [cart_item_meta]
543
- * @property {Object} [extra_meta]
544
- * @property {Object} [gift_card]
545
- * @property {Object} [identifier]
546
- * @property {boolean} [is_gift_visible]
547
- * @property {Object} [meta]
548
- * @property {number} [mto_quantity]
549
- * @property {Object} [parent_item_identifiers]
550
- * @property {ArticlePriceInfo} [price]
551
- * @property {string[]} [product_group_tags]
552
- * @property {number} [quantity]
553
- * @property {BaseInfo} [seller]
554
- * @property {string} [seller_identifier]
555
- * @property {string} [size]
556
- * @property {StoreInfo} [store]
557
- * @property {string[]} [tags] - A list of article tags
558
- * @property {string} [type]
559
- * @property {string} [uid]
423
+ * @typedef OfferItem
424
+ * @property {number} [margin] - Percentage value of discount
425
+ * @property {number} [quantity] - Quantity on which offer is applicable
426
+ * @property {number} [total] - Total price of offer quantity with discount
427
+ * @property {boolean} [best] - Is true for best offer from all offers present
428
+ * for all sellers
429
+ * @property {string} [type] - Offer type
430
+ * @property {OfferPrice} [price]
431
+ * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart
560
432
  */
561
433
  /**
562
- * @typedef ProductAvailability
563
- * @property {ProductAvailabilitySize[]} [available_sizes]
564
- * @property {boolean} [deliverable]
565
- * @property {boolean} [is_valid]
566
- * @property {number} [other_store_quantity]
567
- * @property {boolean} [out_of_stock]
568
- * @property {string[]} [sizes]
434
+ * @typedef BulkPriceOffer
435
+ * @property {OfferSeller} [seller]
436
+ * @property {OfferItem[]} [offers]
569
437
  */
570
438
  /**
571
- * @typedef ProductAvailabilitySize
572
- * @property {string} [display]
573
- * @property {boolean} [is_available]
574
- * @property {string} [value]
439
+ * @typedef BulkPriceResponse
440
+ * @property {BulkPriceOffer[]} [data] - Consist of offers from multiple seller
575
441
  */
576
442
  /**
577
- * @typedef ProductImage
578
- * @property {string} [aspect_ratio]
579
- * @property {string} [secure_url]
580
- * @property {string} [url]
443
+ * @typedef RewardPointRequest
444
+ * @property {boolean} points
581
445
  */
582
446
  /**
583
- * @typedef ProductPrice
584
- * @property {number} [add_on]
585
- * @property {string} [currency_code]
586
- * @property {string} [currency_symbol]
587
- * @property {number} [effective]
588
- * @property {number} [marked]
589
- * @property {number} [selling]
447
+ * @typedef GeoLocation
448
+ * @property {number} [latitude]
449
+ * @property {number} [longitude]
590
450
  */
591
451
  /**
592
- * @typedef ProductPriceInfo
593
- * @property {ProductPrice} [base]
594
- * @property {ProductPrice} [converted]
595
- */
596
- /**
597
- * @typedef PromiseFormatted
598
- * @property {string} [max]
599
- * @property {string} [min]
600
- */
601
- /**
602
- * @typedef PromiseISOFormat
603
- * @property {string} [max] - Max promise in ISO format.
604
- * @property {string} [min] - Min Promise in ISO format.
605
- */
606
- /**
607
- * @typedef PromiseTimestamp
608
- * @property {number} [max]
609
- * @property {number} [min]
452
+ * @typedef Address
453
+ * @property {Object} [meta]
454
+ * @property {string} [country_code]
455
+ * @property {string} [country_iso_code]
456
+ * @property {string} [country]
457
+ * @property {string} [id]
458
+ * @property {string} [checkout_mode]
459
+ * @property {string} [created_by_user_id]
460
+ * @property {string} [area]
461
+ * @property {boolean} [is_active]
462
+ * @property {string} [city]
463
+ * @property {string} [sector]
464
+ * @property {string} [state_code] - State code for international address
465
+ * @property {string} [address_type]
466
+ * @property {string} [state]
467
+ * @property {boolean} [is_default_address]
468
+ * @property {Object} [_custom_json]
469
+ * @property {string} [country_phone_code]
470
+ * @property {string} [area_code_slug]
471
+ * @property {string} [area_code]
472
+ * @property {string} [email]
473
+ * @property {Object} [google_map_point]
474
+ * @property {GeoLocation} [geo_location]
475
+ * @property {string} [address]
476
+ * @property {string[]} [tags]
477
+ * @property {string} [name]
478
+ * @property {string} [landmark]
479
+ * @property {string} [user_id]
480
+ * @property {string} [phone]
610
481
  */
611
482
  /**
612
- * @typedef PromoMeta
613
- * @property {string} [message]
483
+ * @typedef GetAddressesResponse
484
+ * @property {boolean} [pii_masking]
485
+ * @property {Address[]} [address]
614
486
  */
615
487
  /**
616
- * @typedef RawBreakup
617
- * @property {number} [cod_charge]
618
- * @property {number} [convenience_fee]
619
- * @property {number} [coupon]
620
- * @property {number} [delivery_charge]
621
- * @property {number} [discount]
622
- * @property {number} [fynd_cash]
623
- * @property {number} [gift_card]
624
- * @property {number} [gst_charges]
625
- * @property {number} [mrp_total]
626
- * @property {number} [subtotal]
627
- * @property {number} [total]
628
- * @property {number} [vog]
629
- * @property {number} [you_saved]
488
+ * @typedef SaveAddressResponse
489
+ * @property {boolean} [is_default_address]
490
+ * @property {boolean} [success]
491
+ * @property {string} [id]
630
492
  */
631
493
  /**
632
- * @typedef RewardPointRequest
633
- * @property {boolean} points
494
+ * @typedef UpdateAddressResponse
495
+ * @property {boolean} [is_updated]
496
+ * @property {boolean} [is_default_address]
497
+ * @property {boolean} [success]
498
+ * @property {string} [id]
634
499
  */
635
500
  /**
636
- * @typedef SaveAddressResponse
501
+ * @typedef DeleteAddressResponse
502
+ * @property {boolean} [is_deleted]
637
503
  * @property {string} [id]
638
- * @property {boolean} [is_default_address]
639
- * @property {boolean} [success]
640
504
  */
641
505
  /**
642
506
  * @typedef SelectCartAddressRequest
@@ -645,808 +509,897 @@ export = PosCartApplicationModel;
645
509
  * @property {string} [id]
646
510
  */
647
511
  /**
648
- * @typedef SharedCart
649
- * @property {CartBreakup} [breakup_values]
650
- * @property {boolean} [buy_now]
651
- * @property {number} [cart_id]
652
- * @property {string} [checkout_mode]
653
- * @property {string} [comment]
654
- * @property {string} [coupon_text]
655
- * @property {CartCurrency} [currency]
656
- * @property {string} [delivery_charge_info]
657
- * @property {ShipmentPromise} [delivery_promise]
658
- * @property {string} [gstin]
512
+ * @typedef UpdateCartPaymentRequest
513
+ * @property {string} [payment_identifier]
514
+ * @property {string} [aggregator_name]
515
+ * @property {string} [address_id]
516
+ * @property {string} [merchant_code]
517
+ * @property {string} [payment_mode]
659
518
  * @property {string} [id]
660
- * @property {boolean} [is_valid]
661
- * @property {CartProductInfo[]} [items]
662
- * @property {string} [last_modified]
663
- * @property {string} [message]
664
- * @property {PaymentSelectionLock} [payment_selection_lock]
665
- * @property {boolean} [restrict_checkout]
666
- * @property {SharedCartDetails} [shared_cart_details]
667
- * @property {string} [uid]
668
- */
669
- /**
670
- * @typedef SharedCartDetails
671
- * @property {string} [created_on]
672
- * @property {Object} [meta] - Meta data sent while generating share cart link
673
- * @property {Object} [source] - Share link device and other source information
674
- * @property {string} [token] - Short link id
675
- * @property {Object} [user] - User details of who generated share link
676
519
  */
677
520
  /**
678
- * @typedef SharedCartResponse
679
- * @property {SharedCart} [cart]
680
- * @property {string} [error]
521
+ * @typedef CouponValidity
522
+ * @property {number} [discount]
523
+ * @property {boolean} [valid]
524
+ * @property {boolean} [next_validation_required]
525
+ * @property {string} [display_message_en]
526
+ * @property {string} [code]
527
+ * @property {string} [title]
681
528
  */
682
529
  /**
683
- * @typedef ShipmentPromise
684
- * @property {PromiseFormatted} [formatted]
685
- * @property {PromiseISOFormat} [iso]
686
- * @property {PromiseTimestamp} [timestamp]
530
+ * @typedef PaymentCouponValidate
531
+ * @property {string} [message]
532
+ * @property {boolean} success
533
+ * @property {CouponValidity} [coupon_validity]
687
534
  */
688
535
  /**
689
536
  * @typedef ShipmentResponse
690
- * @property {string} [box_type]
537
+ * @property {number} [shipments]
538
+ * @property {string} [fulfillment_type]
539
+ * @property {ShipmentPromise} [promise]
691
540
  * @property {string} [dp_id]
541
+ * @property {string} [box_type]
692
542
  * @property {Object} [dp_options]
693
- * @property {number} [fulfillment_id]
694
- * @property {string} [fulfillment_type]
695
543
  * @property {CartProductInfo[]} [items]
696
544
  * @property {string} [order_type]
697
- * @property {ShipmentPromise} [promise]
698
545
  * @property {string} [shipment_type]
699
- * @property {number} [shipments]
700
- */
701
- /**
702
- * @typedef StaffCheckout
703
- * @property {string} _id
704
- * @property {string} [employee_code]
705
- * @property {string} first_name
706
- * @property {string} last_name
707
- * @property {string} user
708
- */
709
- /**
710
- * @typedef StoreDetailsResponse
711
- * @property {PickupStoreDetail[]} [items]
546
+ * @property {number} [fulfillment_id]
712
547
  */
713
548
  /**
714
- * @typedef StoreInfo
715
- * @property {string} [name]
716
- * @property {string} [store_code]
717
- * @property {number} [uid]
549
+ * @typedef CartShipmentsResponse
550
+ * @property {string} [comment]
551
+ * @property {boolean} [restrict_checkout]
552
+ * @property {string} [message]
553
+ * @property {boolean} [buy_now]
554
+ * @property {string} [coupon_text]
555
+ * @property {string} [last_modified]
556
+ * @property {number} [cart_id]
557
+ * @property {CartBreakup} [breakup_values]
558
+ * @property {boolean} [is_valid]
559
+ * @property {string} [delivery_charge_info]
560
+ * @property {string} [id]
561
+ * @property {PaymentSelectionLock} [payment_selection_lock]
562
+ * @property {string} [gstin]
563
+ * @property {ShipmentResponse[]} [shipments]
564
+ * @property {boolean} [error]
565
+ * @property {ShipmentPromise} [delivery_promise]
566
+ * @property {string} [uid]
567
+ * @property {string} [checkout_mode]
568
+ * @property {CartCurrency} [currency]
718
569
  */
719
570
  /**
720
- * @typedef Tags
721
- * @property {Object} [tags]
571
+ * @typedef UpdateCartShipmentItem
572
+ * @property {number} [quantity] - Quantity of product in shipment
573
+ * @property {string} shipment_type - Shipment delivery type
574
+ * @property {string} article_uid - Article mongo id
722
575
  */
723
576
  /**
724
- * @typedef UpdateAddressResponse
725
- * @property {string} [id]
726
- * @property {boolean} [is_default_address]
727
- * @property {boolean} [is_updated]
728
- * @property {boolean} [success]
577
+ * @typedef UpdateCartShipmentRequest
578
+ * @property {UpdateCartShipmentItem[]} shipments
729
579
  */
730
580
  /**
731
- * @typedef UpdateCartDetailResponse
732
- * @property {CartDetailResponse} [cart]
733
- * @property {string} [message]
734
- * @property {boolean} [success] - True if all items are added successfully.
735
- * False if partially added or not added.
581
+ * @typedef StaffCheckout
582
+ * @property {string} first_name
583
+ * @property {string} user
584
+ * @property {string} [employee_code]
585
+ * @property {string} _id
586
+ * @property {string} last_name
736
587
  */
737
588
  /**
738
- * @typedef UpdateCartPaymentRequest
739
- * @property {string} [address_id]
740
- * @property {string} [aggregator_name]
741
- * @property {string} [id]
742
- * @property {string} [merchant_code]
743
- * @property {string} [payment_identifier]
744
- * @property {string} [payment_mode]
589
+ * @typedef CustomerDetails
590
+ * @property {string} mobile
591
+ * @property {string} [name]
592
+ * @property {string} [email]
745
593
  */
746
594
  /**
747
- * @typedef UpdateCartRequest
748
- * @property {UpdateProductCart[]} [items]
749
- * @property {string} operation
595
+ * @typedef CartCheckoutCustomMeta
596
+ * @property {string} value
597
+ * @property {string} key
750
598
  */
751
599
  /**
752
- * @typedef UpdateCartShipmentItem
753
- * @property {string} article_uid - Article mongo id
754
- * @property {number} [quantity] - Quantity of product in shipment
755
- * @property {string} shipment_type - Shipment delivery type
600
+ * @typedef Files
601
+ * @property {string[]} values
602
+ * @property {string} key
756
603
  */
757
604
  /**
758
- * @typedef UpdateCartShipmentRequest
759
- * @property {UpdateCartShipmentItem[]} shipments
605
+ * @typedef CartPosCheckoutDetailRequest
606
+ * @property {Object} [meta]
607
+ * @property {number} [pick_at_store_uid]
608
+ * @property {Object} [billing_address]
609
+ * @property {boolean} [payment_auto_confirm]
610
+ * @property {string} [callback_url]
611
+ * @property {Object} [delivery_address]
612
+ * @property {string} [merchant_code]
613
+ * @property {string} order_type
614
+ * @property {string} [id]
615
+ * @property {StaffCheckout} [staff]
616
+ * @property {Object} [customer_details] - Customer details
617
+ * @property {string} [address_id]
618
+ * @property {string} [aggregator]
619
+ * @property {Object} [payment_params]
620
+ * @property {string} [billing_address_id]
621
+ * @property {string} payment_mode
622
+ * @property {boolean} [pos]
623
+ * @property {Object} [extra_meta]
624
+ * @property {CartCheckoutCustomMeta[]} [custom_meta]
625
+ * @property {string} [payment_identifier]
626
+ * @property {number} [ordering_store]
627
+ * @property {Files[]} [files] - List of file url
760
628
  */
761
629
  /**
762
- * @typedef UpdateProductCart
763
- * @property {Object} [_custom_json]
764
- * @property {string} [article_id]
765
- * @property {Object} [extra_meta]
766
- * @property {CartProductIdentifer} identifiers
767
- * @property {number} [item_id]
768
- * @property {number} [item_index]
769
- * @property {string} [item_size]
770
- * @property {Object} [meta]
771
- * @property {Object} [parent_item_identifiers]
772
- * @property {number} [quantity]
630
+ * @typedef CheckCart
631
+ * @property {string} [comment]
632
+ * @property {number} [delivery_charges]
633
+ * @property {string} [coupon_text]
634
+ * @property {string} [last_modified]
635
+ * @property {boolean} [is_valid]
636
+ * @property {string} [cod_message]
637
+ * @property {boolean} [success]
638
+ * @property {string} [id]
639
+ * @property {string} [uid]
640
+ * @property {string} [checkout_mode]
641
+ * @property {string} [error_message]
642
+ * @property {Object[]} [store_emps]
643
+ * @property {string} [store_code]
644
+ * @property {boolean} [restrict_checkout]
645
+ * @property {string} [message]
646
+ * @property {boolean} [buy_now]
647
+ * @property {boolean} [cod_available]
648
+ * @property {number} [cart_id]
649
+ * @property {CartBreakup} [breakup_values]
650
+ * @property {string} [order_id]
651
+ * @property {number} [cod_charges]
652
+ * @property {string} [delivery_charge_info]
653
+ * @property {string} [user_type]
654
+ * @property {PaymentSelectionLock} [payment_selection_lock]
655
+ * @property {string} [gstin]
656
+ * @property {ShipmentPromise} [delivery_promise]
657
+ * @property {CartProductInfo[]} [items]
658
+ * @property {CartCurrency} [currency]
659
+ * @property {number} [delivery_charge_order_value]
660
+ */
661
+ /**
662
+ * @typedef CartCheckoutResponse
663
+ * @property {CheckCart} [cart]
664
+ * @property {string} [app_intercept_url]
665
+ * @property {string} [callback_url]
666
+ * @property {string} [message]
667
+ * @property {Object} [data]
668
+ * @property {string} [order_id]
669
+ * @property {boolean} [success]
670
+ * @property {string} [payment_confirm_url]
671
+ */
672
+ /**
673
+ * @typedef GiftDetail
674
+ * @property {string} [gift_message]
675
+ * @property {boolean} [is_gift_applied]
676
+ */
677
+ /**
678
+ * @typedef ArticleGiftDetail
679
+ * @property {GiftDetail} [article_id]
680
+ */
681
+ /**
682
+ * @typedef CartMetaRequest
683
+ * @property {string} [comment]
684
+ * @property {string} [gstin]
685
+ * @property {Object} [pick_up_customer_details] - Customer contact details for
686
+ * customer pickup at store
687
+ * @property {string} [checkout_mode]
688
+ * @property {ArticleGiftDetail} [gift_details]
689
+ * @property {Object} [delivery_slots]
690
+ */
691
+ /**
692
+ * @typedef CartMetaResponse
693
+ * @property {string} [message]
694
+ * @property {boolean} [is_valid]
695
+ */
696
+ /**
697
+ * @typedef CartMetaMissingResponse
698
+ * @property {string[]} [errors]
699
+ */
700
+ /**
701
+ * @typedef CartDeliveryModesResponse
702
+ * @property {string[]} [available_modes] - Available delivery modes
703
+ * @property {number[]} [pickup_stores] - Store pick up available store uids
704
+ */
705
+ /**
706
+ * @typedef PickupStoreDetail
707
+ * @property {string} [city]
708
+ * @property {string} [address_type]
709
+ * @property {string} [address]
710
+ * @property {string} [state]
711
+ * @property {string} [store_code]
712
+ * @property {number} [uid]
713
+ * @property {number} [pincode]
714
+ * @property {string} [area_code_slug]
715
+ * @property {string} [area_code]
716
+ * @property {string} [email]
717
+ * @property {string} [name]
718
+ * @property {string} [landmark]
719
+ * @property {string} [area]
720
+ * @property {string} [country]
721
+ * @property {string} [phone]
722
+ * @property {number} [id]
723
+ */
724
+ /**
725
+ * @typedef StoreDetailsResponse
726
+ * @property {PickupStoreDetail[]} [items]
727
+ */
728
+ /**
729
+ * @typedef GetShareCartLinkRequest
730
+ * @property {Object} [meta] - Staff, Ordering store or any other data. This
731
+ * data will be used to generate link as well as sent as shared details.
732
+ * @property {string} [id] - Cart uid for generating sharing
733
+ */
734
+ /**
735
+ * @typedef GetShareCartLinkResponse
736
+ * @property {string} [share_url] - Short shareable final url
737
+ * @property {string} [token] - Short url unique id
738
+ */
739
+ /**
740
+ * @typedef SharedCartDetails
741
+ * @property {Object} [meta] - Meta data sent while generating share cart link
742
+ * @property {Object} [user] - User details of who generated share link
743
+ * @property {string} [created_on]
744
+ * @property {string} [token] - Short link id
745
+ * @property {Object} [source] - Share link device and other source information
746
+ */
747
+ /**
748
+ * @typedef SharedCart
749
+ * @property {string} [comment]
750
+ * @property {string} [coupon_text]
751
+ * @property {string} [last_modified]
752
+ * @property {SharedCartDetails} [shared_cart_details]
753
+ * @property {boolean} [is_valid]
754
+ * @property {string} [id]
755
+ * @property {string} [uid]
756
+ * @property {string} [checkout_mode]
757
+ * @property {boolean} [restrict_checkout]
758
+ * @property {string} [message]
759
+ * @property {boolean} [buy_now]
760
+ * @property {number} [cart_id]
761
+ * @property {CartBreakup} [breakup_values]
762
+ * @property {string} [delivery_charge_info]
763
+ * @property {PaymentSelectionLock} [payment_selection_lock]
764
+ * @property {string} [gstin]
765
+ * @property {ShipmentPromise} [delivery_promise]
766
+ * @property {CartProductInfo[]} [items]
767
+ * @property {CartCurrency} [currency]
768
+ */
769
+ /**
770
+ * @typedef SharedCartResponse
771
+ * @property {string} [error]
772
+ * @property {SharedCart} [cart]
773
773
  */
774
774
  declare class PosCartApplicationModel {
775
775
  }
776
776
  declare namespace PosCartApplicationModel {
777
- export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutResponse, CartCurrency, CartDeliveryModesResponse, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartPosCheckoutDetailRequest, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CustomerDetails, DeleteAddressResponse, DiscountRulesApp, DisplayBreakup, Files, FreeGiftItem, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, Ownership, PageCoupon, PaymentCouponValidate, PaymentSelectionLock, PickupStoreDetail, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, PromoMeta, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreDetailsResponse, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateCartShipmentItem, UpdateCartShipmentRequest, UpdateProductCart };
777
+ export { BuyRules, DiscountRulesApp, FreeGiftItem, AppliedFreeArticles, Ownership, AppliedPromotion, LoyaltyPoints, RawBreakup, DisplayBreakup, CouponBreakup, CartBreakup, PaymentSelectionLock, PromiseTimestamp, PromiseFormatted, PromiseISOFormat, ShipmentPromise, StoreInfo, BaseInfo, BasePrice, ArticlePriceInfo, ProductArticle, Tags, CategoryInfo, ProductImage, ActionQuery, ProductAction, CartProduct, ProductPrice, ProductPriceInfo, CouponDetails, PromoMeta, ProductAvailabilitySize, ProductAvailability, CartProductIdentifer, CartProductInfo, CartCurrency, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, CartItemCountResponse, PageCoupon, Coupon, GetCouponResponse, ApplyCouponRequest, OfferSeller, OfferPrice, OfferItem, BulkPriceOffer, BulkPriceResponse, RewardPointRequest, GeoLocation, Address, GetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, SelectCartAddressRequest, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, ShipmentResponse, CartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, StaffCheckout, CustomerDetails, CartCheckoutCustomMeta, Files, CartPosCheckoutDetailRequest, CheckCart, CartCheckoutResponse, GiftDetail, ArticleGiftDetail, CartMetaRequest, CartMetaResponse, CartMetaMissingResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse };
778
778
  }
779
- /** @returns {ActionQuery} */
780
- declare function ActionQuery(): ActionQuery;
781
- type ActionQuery = {
782
- /**
783
- * - Contains list of product slug
784
- */
785
- product_slug?: string[];
786
- };
787
- /** @returns {AddCartDetailResponse} */
788
- declare function AddCartDetailResponse(): AddCartDetailResponse;
789
- type AddCartDetailResponse = {
790
- cart?: CartDetailResponse;
791
- message?: string;
792
- /**
793
- * - When adding multiple items check if all
794
- * added. True if only few are added.
795
- */
796
- partial?: boolean;
779
+ /** @returns {BuyRules} */
780
+ declare function BuyRules(): BuyRules;
781
+ type BuyRules = {
797
782
  /**
798
- * - True if all items are added successfully.
799
- * False if partially added or not added.
783
+ * - Cart conditions details for promotion
800
784
  */
801
- success?: boolean;
802
- };
803
- /** @returns {AddCartRequest} */
804
- declare function AddCartRequest(): AddCartRequest;
805
- type AddCartRequest = {
806
- items?: AddProductCart[];
807
- new_cart?: boolean;
808
- };
809
- /** @returns {AddProductCart} */
810
- declare function AddProductCart(): AddProductCart;
811
- type AddProductCart = {
812
- _custom_json?: any;
813
- article_assignment?: any;
814
- article_id?: string;
815
- display?: string;
816
- extra_meta?: any;
817
- item_id?: number;
818
- item_size?: string;
819
- meta?: any;
820
- parent_item_identifiers?: any[];
821
- pos?: boolean;
822
- product_group_tags?: string[];
823
- quantity?: number;
824
- seller_id?: number;
825
- store_id?: number;
826
- };
827
- /** @returns {Address} */
828
- declare function Address(): Address;
829
- type Address = {
830
- _custom_json?: any;
831
- address?: string;
832
- address_type?: string;
833
- area?: string;
834
- area_code?: string;
835
- area_code_slug?: string;
836
- checkout_mode?: string;
837
- city?: string;
838
- country?: string;
839
- country_code?: string;
840
- country_iso_code?: string;
841
- country_phone_code?: string;
842
- created_by_user_id?: string;
843
- email?: string;
844
- geo_location?: GeoLocation;
845
- google_map_point?: any;
846
- id?: string;
847
- is_active?: boolean;
848
- is_default_address?: boolean;
849
- landmark?: string;
850
- meta?: any;
851
- name?: string;
852
- phone?: string;
853
- sector?: string;
854
- state?: string;
785
+ cart_conditions?: any;
855
786
  /**
856
- * - State code for international address
787
+ * - Item criteria of promotion
857
788
  */
858
- state_code?: string;
859
- tags?: string[];
860
- user_id?: string;
789
+ item_criteria?: any;
861
790
  };
862
- /** @returns {AppliedFreeArticles} */
863
- declare function AppliedFreeArticles(): AppliedFreeArticles;
864
- type AppliedFreeArticles = {
791
+ /** @returns {DiscountRulesApp} */
792
+ declare function DiscountRulesApp(): DiscountRulesApp;
793
+ type DiscountRulesApp = {
865
794
  /**
866
- * - Free article id
795
+ * - Matched buy rules for promotion
867
796
  */
868
- article_id?: string;
797
+ matched_buy_rules?: string[];
869
798
  /**
870
- * - Free gift items details
799
+ * - Offer for promotion
871
800
  */
872
- free_gift_item_details?: FreeGiftItem;
801
+ offer?: any;
873
802
  /**
874
- * - Parent item identifier for free article
803
+ * - Item criteria of promotion
875
804
  */
876
- parent_item_identifier?: string;
805
+ item_criteria?: any;
877
806
  /**
878
- * - Free article quantity
807
+ * - Raw offer details for promotion
879
808
  */
880
- quantity?: number;
809
+ raw_offer?: any;
881
810
  };
882
- /** @returns {AppliedPromotion} */
883
- declare function AppliedPromotion(): AppliedPromotion;
884
- type AppliedPromotion = {
885
- /**
886
- * - Per unit discount amount applied with current promotion
887
- */
888
- amount?: number;
889
- /**
890
- * - Applied free
891
- * article for free gift item promotions
892
- */
893
- applied_free_articles?: AppliedFreeArticles[];
894
- /**
895
- * - Quantity of article on which
896
- * promotion is applicable
897
- */
898
- article_quantity?: number;
899
- /**
900
- * - Buy rules for promotions
901
- */
902
- buy_rules?: BuyRules[];
903
- currency?: CartCurrency;
904
- /**
905
- * - Discount rules for promotions
906
- */
907
- discount_rules?: DiscountRulesApp[];
908
- /**
909
- * - If applied promotion is applied on
910
- * product MRP or ESP
911
- */
912
- mrp_promotion?: boolean;
811
+ /** @returns {FreeGiftItem} */
812
+ declare function FreeGiftItem(): FreeGiftItem;
813
+ type FreeGiftItem = {
913
814
  /**
914
- * - Offer text of current promotion
815
+ * - Item slug
915
816
  */
916
- offer_text?: string;
817
+ item_slug?: string;
917
818
  /**
918
- * - Ownership of promotion
819
+ * - Item price details
919
820
  */
920
- ownership?: Ownership;
821
+ item_price_details?: any;
921
822
  /**
922
- * - Promotion id
823
+ * - Item images URL
923
824
  */
924
- promo_id?: string;
825
+ item_images_url?: string[];
925
826
  /**
926
- * - Promotion group for the promotion
827
+ * - Item name
927
828
  */
928
- promotion_group?: string;
829
+ item_name?: string;
929
830
  /**
930
- * - Promotion name of current promotion
831
+ * - Item id
931
832
  */
932
- promotion_name?: string;
833
+ item_id?: number;
933
834
  /**
934
- * - Promotion type of current promotion
835
+ * - Item brand name
935
836
  */
936
- promotion_type?: string;
837
+ item_brand_name?: string;
937
838
  };
938
- /** @returns {ApplyCouponRequest} */
939
- declare function ApplyCouponRequest(): ApplyCouponRequest;
940
- type ApplyCouponRequest = {
839
+ /** @returns {AppliedFreeArticles} */
840
+ declare function AppliedFreeArticles(): AppliedFreeArticles;
841
+ type AppliedFreeArticles = {
941
842
  /**
942
- * - Coupon code to be applied
843
+ * - Free article quantity
943
844
  */
944
- coupon_code: string;
945
- };
946
- /** @returns {ArticleGiftDetail} */
947
- declare function ArticleGiftDetail(): ArticleGiftDetail;
948
- type ArticleGiftDetail = {
949
- article_id?: GiftDetail;
950
- };
951
- /** @returns {ArticlePriceInfo} */
952
- declare function ArticlePriceInfo(): ArticlePriceInfo;
953
- type ArticlePriceInfo = {
954
- base?: BasePrice;
955
- converted?: BasePrice;
956
- };
957
- /** @returns {BaseInfo} */
958
- declare function BaseInfo(): BaseInfo;
959
- type BaseInfo = {
960
- name?: string;
961
- uid?: number;
962
- };
963
- /** @returns {BasePrice} */
964
- declare function BasePrice(): BasePrice;
965
- type BasePrice = {
966
- currency_code?: string;
967
- currency_symbol?: string;
968
- effective?: number;
969
- marked?: number;
970
- };
971
- /** @returns {BulkPriceOffer} */
972
- declare function BulkPriceOffer(): BulkPriceOffer;
973
- type BulkPriceOffer = {
974
- offers?: OfferItem[];
975
- seller?: OfferSeller;
976
- };
977
- /** @returns {BulkPriceResponse} */
978
- declare function BulkPriceResponse(): BulkPriceResponse;
979
- type BulkPriceResponse = {
845
+ quantity?: number;
980
846
  /**
981
- * - Consist of offers from multiple seller
847
+ * - Parent item identifier for free article
982
848
  */
983
- data?: BulkPriceOffer[];
984
- };
985
- /** @returns {BuyRules} */
986
- declare function BuyRules(): BuyRules;
987
- type BuyRules = {
849
+ parent_item_identifier?: string;
988
850
  /**
989
- * - Cart conditions details for promotion
851
+ * - Free article id
990
852
  */
991
- cart_conditions?: any;
853
+ article_id?: string;
992
854
  /**
993
- * - Item criteria of promotion
855
+ * - Free gift items details
994
856
  */
995
- item_criteria?: any;
996
- };
997
- /** @returns {CartBreakup} */
998
- declare function CartBreakup(): CartBreakup;
999
- type CartBreakup = {
1000
- coupon?: CouponBreakup;
1001
- display?: DisplayBreakup[];
1002
- loyalty_points?: LoyaltyPoints;
1003
- raw?: RawBreakup;
1004
- };
1005
- /** @returns {CartCheckoutCustomMeta} */
1006
- declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1007
- type CartCheckoutCustomMeta = {
1008
- key: string;
1009
- value: string;
1010
- };
1011
- /** @returns {CartCheckoutResponse} */
1012
- declare function CartCheckoutResponse(): CartCheckoutResponse;
1013
- type CartCheckoutResponse = {
1014
- app_intercept_url?: string;
1015
- callback_url?: string;
1016
- cart?: CheckCart;
1017
- data?: any;
1018
- message?: string;
1019
- order_id?: string;
1020
- payment_confirm_url?: string;
1021
- success?: boolean;
857
+ free_gift_item_details?: FreeGiftItem;
1022
858
  };
1023
- /** @returns {CartCurrency} */
1024
- declare function CartCurrency(): CartCurrency;
1025
- type CartCurrency = {
859
+ /** @returns {Ownership} */
860
+ declare function Ownership(): Ownership;
861
+ type Ownership = {
1026
862
  /**
1027
- * - Currency code defined by ISO 4217:2015
863
+ * - Promo amount payable category
1028
864
  */
1029
- code?: string;
1030
- symbol?: string;
865
+ payable_category?: string;
866
+ /**
867
+ * - Promo amount bearable party
868
+ */
869
+ payable_by?: string;
1031
870
  };
1032
- /** @returns {CartDeliveryModesResponse} */
1033
- declare function CartDeliveryModesResponse(): CartDeliveryModesResponse;
1034
- type CartDeliveryModesResponse = {
871
+ /** @returns {AppliedPromotion} */
872
+ declare function AppliedPromotion(): AppliedPromotion;
873
+ type AppliedPromotion = {
1035
874
  /**
1036
- * - Available delivery modes
875
+ * - Promotion name of current promotion
1037
876
  */
1038
- available_modes?: string[];
877
+ promotion_name?: string;
1039
878
  /**
1040
- * - Store pick up available store uids
879
+ * - If applied promotion is applied on
880
+ * product MRP or ESP
1041
881
  */
1042
- pickup_stores?: number[];
1043
- };
1044
- /** @returns {CartDetailResponse} */
1045
- declare function CartDetailResponse(): CartDetailResponse;
1046
- type CartDetailResponse = {
1047
- applied_promo_details?: AppliedPromotion[];
1048
- breakup_values?: CartBreakup;
1049
- buy_now?: boolean;
1050
- checkout_mode?: string;
1051
- comment?: string;
1052
- coupon_text?: string;
1053
- currency?: CartCurrency;
1054
- delivery_charge_info?: string;
1055
- delivery_promise?: ShipmentPromise;
1056
- gstin?: string;
1057
- id?: string;
1058
- is_valid?: boolean;
1059
- items?: CartProductInfo[];
1060
- last_modified?: string;
1061
- message?: string;
1062
- pan_config?: any;
1063
- pan_no?: string;
1064
- payment_selection_lock?: PaymentSelectionLock;
1065
- restrict_checkout?: boolean;
1066
- };
1067
- /** @returns {CartItemCountResponse} */
1068
- declare function CartItemCountResponse(): CartItemCountResponse;
1069
- type CartItemCountResponse = {
882
+ mrp_promotion?: boolean;
1070
883
  /**
1071
- * - Item count present in cart
884
+ * - Buy rules for promotions
1072
885
  */
1073
- user_cart_items_count?: number;
1074
- };
1075
- /** @returns {CartMetaMissingResponse} */
1076
- declare function CartMetaMissingResponse(): CartMetaMissingResponse;
1077
- type CartMetaMissingResponse = {
1078
- errors?: string[];
1079
- };
1080
- /** @returns {CartMetaRequest} */
1081
- declare function CartMetaRequest(): CartMetaRequest;
1082
- type CartMetaRequest = {
1083
- checkout_mode?: string;
1084
- comment?: string;
1085
- delivery_slots?: any;
1086
- gift_details?: ArticleGiftDetail;
1087
- gstin?: string;
886
+ buy_rules?: BuyRules[];
1088
887
  /**
1089
- * - Customer contact details for
1090
- * customer pickup at store
888
+ * - Promotion type of current promotion
1091
889
  */
1092
- pick_up_customer_details?: any;
1093
- };
1094
- /** @returns {CartMetaResponse} */
1095
- declare function CartMetaResponse(): CartMetaResponse;
1096
- type CartMetaResponse = {
1097
- is_valid?: boolean;
1098
- message?: string;
1099
- };
1100
- /** @returns {CartPosCheckoutDetailRequest} */
1101
- declare function CartPosCheckoutDetailRequest(): CartPosCheckoutDetailRequest;
1102
- type CartPosCheckoutDetailRequest = {
1103
- address_id?: string;
1104
- aggregator?: string;
1105
- billing_address?: any;
1106
- billing_address_id?: string;
1107
- callback_url?: string;
1108
- custom_meta?: CartCheckoutCustomMeta[];
890
+ promotion_type?: string;
1109
891
  /**
1110
- * - Customer details
892
+ * - Quantity of article on which
893
+ * promotion is applicable
1111
894
  */
1112
- customer_details?: any;
1113
- delivery_address?: any;
1114
- extra_meta?: any;
895
+ article_quantity?: number;
1115
896
  /**
1116
- * - List of file url
897
+ * - Per unit discount amount applied with current promotion
1117
898
  */
1118
- files?: Files[];
1119
- id?: string;
1120
- merchant_code?: string;
1121
- meta?: any;
1122
- order_type: string;
1123
- ordering_store?: number;
1124
- payment_auto_confirm?: boolean;
1125
- payment_identifier?: string;
1126
- payment_mode: string;
1127
- payment_params?: any;
1128
- pick_at_store_uid?: number;
1129
- pos?: boolean;
1130
- staff?: StaffCheckout;
1131
- };
1132
- /** @returns {CartProduct} */
1133
- declare function CartProduct(): CartProduct;
1134
- type CartProduct = {
1135
- _custom_json?: any;
1136
- action?: ProductAction;
1137
- brand?: BaseInfo;
1138
- categories?: CategoryInfo[];
1139
- images?: ProductImage[];
1140
- item_code?: string;
1141
- name?: string;
899
+ amount?: number;
1142
900
  /**
1143
- * - Unique product url name generated via product
1144
- * name and other meta data
901
+ * - Discount rules for promotions
1145
902
  */
1146
- slug?: string;
1147
- tags?: string[];
1148
- teaser_tag?: Tags;
1149
- type?: string;
1150
- uid?: number;
1151
- };
1152
- /** @returns {CartProductIdentifer} */
1153
- declare function CartProductIdentifer(): CartProductIdentifer;
1154
- type CartProductIdentifer = {
903
+ discount_rules?: DiscountRulesApp[];
1155
904
  /**
1156
- * - Article idenfier generated by cart
905
+ * - Offer text of current promotion
1157
906
  */
1158
- identifier?: string;
1159
- };
1160
- /** @returns {CartProductInfo} */
1161
- declare function CartProductInfo(): CartProductInfo;
1162
- type CartProductInfo = {
1163
- article?: ProductArticle;
1164
- availability?: ProductAvailability;
1165
- bulk_offer?: any;
1166
- coupon?: CouponDetails;
1167
- coupon_message?: string;
1168
- custom_order?: any;
1169
- delivery_promise?: ShipmentPromise;
1170
- discount?: string;
1171
- identifiers: CartProductIdentifer;
1172
- is_set?: boolean;
1173
- key?: string;
1174
- message?: string;
1175
- moq?: any;
1176
- parent_item_identifiers?: any;
1177
- price?: ProductPriceInfo;
1178
- price_per_unit?: ProductPriceInfo;
1179
- product?: CartProduct;
1180
- promo_meta?: PromoMeta;
1181
- promotions_applied?: AppliedPromotion[];
1182
- quantity?: number;
1183
- };
1184
- /** @returns {CartShipmentsResponse} */
1185
- declare function CartShipmentsResponse(): CartShipmentsResponse;
1186
- type CartShipmentsResponse = {
1187
- breakup_values?: CartBreakup;
1188
- buy_now?: boolean;
1189
- cart_id?: number;
1190
- checkout_mode?: string;
1191
- comment?: string;
1192
- coupon_text?: string;
1193
- currency?: CartCurrency;
1194
- delivery_charge_info?: string;
1195
- delivery_promise?: ShipmentPromise;
1196
- error?: boolean;
1197
- gstin?: string;
1198
- id?: string;
1199
- is_valid?: boolean;
1200
- last_modified?: string;
1201
- message?: string;
1202
- payment_selection_lock?: PaymentSelectionLock;
1203
- restrict_checkout?: boolean;
1204
- shipments?: ShipmentResponse[];
1205
- uid?: string;
1206
- };
1207
- /** @returns {CategoryInfo} */
1208
- declare function CategoryInfo(): CategoryInfo;
1209
- type CategoryInfo = {
1210
- name?: string;
907
+ offer_text?: string;
1211
908
  /**
1212
- * - Product Category Id
909
+ * - Promotion id
1213
910
  */
1214
- uid?: number;
1215
- };
1216
- /** @returns {CheckCart} */
1217
- declare function CheckCart(): CheckCart;
1218
- type CheckCart = {
1219
- breakup_values?: CartBreakup;
1220
- buy_now?: boolean;
1221
- cart_id?: number;
1222
- checkout_mode?: string;
1223
- cod_available?: boolean;
1224
- cod_charges?: number;
1225
- cod_message?: string;
1226
- comment?: string;
1227
- coupon_text?: string;
911
+ promo_id?: string;
912
+ /**
913
+ * - Applied free
914
+ * article for free gift item promotions
915
+ */
916
+ applied_free_articles?: AppliedFreeArticles[];
917
+ /**
918
+ * - Ownership of promotion
919
+ */
920
+ ownership?: Ownership;
1228
921
  currency?: CartCurrency;
1229
- delivery_charge_info?: string;
1230
- delivery_charge_order_value?: number;
1231
- delivery_charges?: number;
1232
- delivery_promise?: ShipmentPromise;
1233
- error_message?: string;
1234
- gstin?: string;
1235
- id?: string;
1236
- is_valid?: boolean;
1237
- items?: CartProductInfo[];
1238
- last_modified?: string;
1239
- message?: string;
1240
- order_id?: string;
1241
- payment_selection_lock?: PaymentSelectionLock;
1242
- restrict_checkout?: boolean;
1243
- store_code?: string;
1244
- store_emps?: any[];
1245
- success?: boolean;
1246
- uid?: string;
1247
- user_type?: string;
922
+ /**
923
+ * - Promotion group for the promotion
924
+ */
925
+ promotion_group?: string;
1248
926
  };
1249
- /** @returns {Coupon} */
1250
- declare function Coupon(): Coupon;
1251
- type Coupon = {
1252
- coupon_code?: string;
1253
- coupon_type?: string;
1254
- coupon_value?: number;
927
+ /** @returns {LoyaltyPoints} */
928
+ declare function LoyaltyPoints(): LoyaltyPoints;
929
+ type LoyaltyPoints = {
1255
930
  description?: string;
1256
- expires_on?: string;
1257
- is_applicable?: boolean;
1258
931
  is_applied?: boolean;
1259
- max_discount_value?: number;
1260
- message?: string;
1261
- minimum_cart_value?: number;
1262
- sub_title?: string;
1263
- title?: string;
932
+ applicable?: number;
933
+ total?: number;
934
+ };
935
+ /** @returns {RawBreakup} */
936
+ declare function RawBreakup(): RawBreakup;
937
+ type RawBreakup = {
938
+ discount?: number;
939
+ you_saved?: number;
940
+ mrp_total?: number;
941
+ gst_charges?: number;
942
+ total?: number;
943
+ vog?: number;
944
+ coupon?: number;
945
+ subtotal?: number;
946
+ delivery_charge?: number;
947
+ cod_charge?: number;
948
+ fynd_cash?: number;
949
+ gift_card?: number;
950
+ convenience_fee?: number;
951
+ };
952
+ /** @returns {DisplayBreakup} */
953
+ declare function DisplayBreakup(): DisplayBreakup;
954
+ type DisplayBreakup = {
955
+ currency_code?: string;
956
+ currency_symbol?: string;
957
+ display?: string;
958
+ message?: string[];
959
+ key?: string;
960
+ value?: number;
1264
961
  };
1265
962
  /** @returns {CouponBreakup} */
1266
963
  declare function CouponBreakup(): CouponBreakup;
1267
964
  type CouponBreakup = {
1268
- code?: string;
965
+ max_discount_value?: number;
966
+ message?: string;
967
+ is_applied?: boolean;
968
+ uid?: string;
969
+ type?: string;
1269
970
  coupon_type?: string;
971
+ sub_title?: string;
1270
972
  coupon_value?: number;
1271
973
  description?: string;
1272
- is_applied?: boolean;
1273
- max_discount_value?: number;
1274
- message?: string;
974
+ code?: string;
1275
975
  minimum_cart_value?: number;
1276
- sub_title?: string;
1277
- title?: string;
1278
- type?: string;
1279
- uid?: string;
1280
976
  value?: number;
977
+ title?: string;
1281
978
  };
1282
- /** @returns {CouponDetails} */
1283
- declare function CouponDetails(): CouponDetails;
1284
- type CouponDetails = {
1285
- code?: string;
1286
- discount_single_quantity?: number;
1287
- discount_total_quantity?: number;
979
+ /** @returns {CartBreakup} */
980
+ declare function CartBreakup(): CartBreakup;
981
+ type CartBreakup = {
982
+ loyalty_points?: LoyaltyPoints;
983
+ raw?: RawBreakup;
984
+ display?: DisplayBreakup[];
985
+ coupon?: CouponBreakup;
1288
986
  };
1289
- /** @returns {CouponValidity} */
1290
- declare function CouponValidity(): CouponValidity;
1291
- type CouponValidity = {
1292
- code?: string;
1293
- discount?: number;
1294
- display_message_en?: string;
1295
- next_validation_required?: boolean;
1296
- title?: string;
1297
- valid?: boolean;
987
+ /** @returns {PaymentSelectionLock} */
988
+ declare function PaymentSelectionLock(): PaymentSelectionLock;
989
+ type PaymentSelectionLock = {
990
+ default_options?: string;
991
+ enabled?: boolean;
992
+ payment_identifier?: string;
1298
993
  };
1299
- /** @returns {CustomerDetails} */
1300
- declare function CustomerDetails(): CustomerDetails;
1301
- type CustomerDetails = {
1302
- email?: string;
1303
- mobile: string;
994
+ /** @returns {PromiseTimestamp} */
995
+ declare function PromiseTimestamp(): PromiseTimestamp;
996
+ type PromiseTimestamp = {
997
+ max?: number;
998
+ min?: number;
999
+ };
1000
+ /** @returns {PromiseFormatted} */
1001
+ declare function PromiseFormatted(): PromiseFormatted;
1002
+ type PromiseFormatted = {
1003
+ max?: string;
1004
+ min?: string;
1005
+ };
1006
+ /** @returns {PromiseISOFormat} */
1007
+ declare function PromiseISOFormat(): PromiseISOFormat;
1008
+ type PromiseISOFormat = {
1009
+ /**
1010
+ * - Max promise in ISO format.
1011
+ */
1012
+ max?: string;
1013
+ /**
1014
+ * - Min Promise in ISO format.
1015
+ */
1016
+ min?: string;
1017
+ };
1018
+ /** @returns {ShipmentPromise} */
1019
+ declare function ShipmentPromise(): ShipmentPromise;
1020
+ type ShipmentPromise = {
1021
+ timestamp?: PromiseTimestamp;
1022
+ formatted?: PromiseFormatted;
1023
+ iso?: PromiseISOFormat;
1024
+ };
1025
+ /** @returns {StoreInfo} */
1026
+ declare function StoreInfo(): StoreInfo;
1027
+ type StoreInfo = {
1028
+ uid?: number;
1029
+ store_code?: string;
1304
1030
  name?: string;
1305
1031
  };
1306
- /** @returns {DeleteAddressResponse} */
1307
- declare function DeleteAddressResponse(): DeleteAddressResponse;
1308
- type DeleteAddressResponse = {
1309
- id?: string;
1310
- is_deleted?: boolean;
1032
+ /** @returns {BaseInfo} */
1033
+ declare function BaseInfo(): BaseInfo;
1034
+ type BaseInfo = {
1035
+ uid?: number;
1036
+ name?: string;
1311
1037
  };
1312
- /** @returns {DiscountRulesApp} */
1313
- declare function DiscountRulesApp(): DiscountRulesApp;
1314
- type DiscountRulesApp = {
1038
+ /** @returns {BasePrice} */
1039
+ declare function BasePrice(): BasePrice;
1040
+ type BasePrice = {
1041
+ effective?: number;
1042
+ currency_code?: string;
1043
+ currency_symbol?: string;
1044
+ marked?: number;
1045
+ };
1046
+ /** @returns {ArticlePriceInfo} */
1047
+ declare function ArticlePriceInfo(): ArticlePriceInfo;
1048
+ type ArticlePriceInfo = {
1049
+ converted?: BasePrice;
1050
+ base?: BasePrice;
1051
+ };
1052
+ /** @returns {ProductArticle} */
1053
+ declare function ProductArticle(): ProductArticle;
1054
+ type ProductArticle = {
1055
+ meta?: any;
1056
+ store?: StoreInfo;
1057
+ _custom_json?: any;
1058
+ seller_identifier?: string;
1059
+ identifier?: any;
1060
+ quantity?: number;
1061
+ seller?: BaseInfo;
1062
+ mto_quantity?: number;
1063
+ uid?: string;
1064
+ cart_item_meta?: any;
1065
+ type?: string;
1066
+ price?: ArticlePriceInfo;
1067
+ parent_item_identifiers?: any;
1068
+ size?: string;
1069
+ extra_meta?: any;
1070
+ gift_card?: any;
1071
+ product_group_tags?: string[];
1072
+ is_gift_visible?: boolean;
1315
1073
  /**
1316
- * - Item criteria of promotion
1074
+ * - A list of article tags
1317
1075
  */
1318
- item_criteria?: any;
1076
+ tags?: string[];
1077
+ };
1078
+ /** @returns {Tags} */
1079
+ declare function Tags(): Tags;
1080
+ type Tags = {
1081
+ tags?: any;
1082
+ };
1083
+ /** @returns {CategoryInfo} */
1084
+ declare function CategoryInfo(): CategoryInfo;
1085
+ type CategoryInfo = {
1319
1086
  /**
1320
- * - Matched buy rules for promotion
1087
+ * - Product Category Id
1321
1088
  */
1322
- matched_buy_rules?: string[];
1089
+ uid?: number;
1090
+ name?: string;
1091
+ };
1092
+ /** @returns {ProductImage} */
1093
+ declare function ProductImage(): ProductImage;
1094
+ type ProductImage = {
1095
+ aspect_ratio?: string;
1096
+ url?: string;
1097
+ secure_url?: string;
1098
+ };
1099
+ /** @returns {ActionQuery} */
1100
+ declare function ActionQuery(): ActionQuery;
1101
+ type ActionQuery = {
1323
1102
  /**
1324
- * - Offer for promotion
1103
+ * - Contains list of product slug
1325
1104
  */
1326
- offer?: any;
1105
+ product_slug?: string[];
1106
+ };
1107
+ /** @returns {ProductAction} */
1108
+ declare function ProductAction(): ProductAction;
1109
+ type ProductAction = {
1110
+ query?: ActionQuery;
1111
+ url?: string;
1112
+ type?: string;
1113
+ };
1114
+ /** @returns {CartProduct} */
1115
+ declare function CartProduct(): CartProduct;
1116
+ type CartProduct = {
1117
+ teaser_tag?: Tags;
1118
+ _custom_json?: any;
1119
+ categories?: CategoryInfo[];
1120
+ item_code?: string;
1121
+ tags?: string[];
1122
+ uid?: number;
1123
+ type?: string;
1124
+ images?: ProductImage[];
1125
+ name?: string;
1327
1126
  /**
1328
- * - Raw offer details for promotion
1127
+ * - Unique product url name generated via product
1128
+ * name and other meta data
1329
1129
  */
1330
- raw_offer?: any;
1130
+ slug?: string;
1131
+ action?: ProductAction;
1132
+ brand?: BaseInfo;
1331
1133
  };
1332
- /** @returns {DisplayBreakup} */
1333
- declare function DisplayBreakup(): DisplayBreakup;
1334
- type DisplayBreakup = {
1134
+ /** @returns {ProductPrice} */
1135
+ declare function ProductPrice(): ProductPrice;
1136
+ type ProductPrice = {
1137
+ effective?: number;
1335
1138
  currency_code?: string;
1336
1139
  currency_symbol?: string;
1140
+ marked?: number;
1141
+ selling?: number;
1142
+ add_on?: number;
1143
+ };
1144
+ /** @returns {ProductPriceInfo} */
1145
+ declare function ProductPriceInfo(): ProductPriceInfo;
1146
+ type ProductPriceInfo = {
1147
+ converted?: ProductPrice;
1148
+ base?: ProductPrice;
1149
+ };
1150
+ /** @returns {CouponDetails} */
1151
+ declare function CouponDetails(): CouponDetails;
1152
+ type CouponDetails = {
1153
+ discount_total_quantity?: number;
1154
+ discount_single_quantity?: number;
1155
+ code?: string;
1156
+ };
1157
+ /** @returns {PromoMeta} */
1158
+ declare function PromoMeta(): PromoMeta;
1159
+ type PromoMeta = {
1160
+ message?: string;
1161
+ };
1162
+ /** @returns {ProductAvailabilitySize} */
1163
+ declare function ProductAvailabilitySize(): ProductAvailabilitySize;
1164
+ type ProductAvailabilitySize = {
1165
+ is_available?: boolean;
1166
+ value?: string;
1337
1167
  display?: string;
1338
- key?: string;
1339
- message?: string[];
1340
- value?: number;
1341
1168
  };
1342
- /** @returns {Files} */
1343
- declare function Files(): Files;
1344
- type Files = {
1345
- key: string;
1346
- values: string[];
1169
+ /** @returns {ProductAvailability} */
1170
+ declare function ProductAvailability(): ProductAvailability;
1171
+ type ProductAvailability = {
1172
+ available_sizes?: ProductAvailabilitySize[];
1173
+ other_store_quantity?: number;
1174
+ deliverable?: boolean;
1175
+ out_of_stock?: boolean;
1176
+ is_valid?: boolean;
1177
+ sizes?: string[];
1347
1178
  };
1348
- /** @returns {FreeGiftItem} */
1349
- declare function FreeGiftItem(): FreeGiftItem;
1350
- type FreeGiftItem = {
1179
+ /** @returns {CartProductIdentifer} */
1180
+ declare function CartProductIdentifer(): CartProductIdentifer;
1181
+ type CartProductIdentifer = {
1351
1182
  /**
1352
- * - Item brand name
1183
+ * - Article idenfier generated by cart
1353
1184
  */
1354
- item_brand_name?: string;
1185
+ identifier?: string;
1186
+ };
1187
+ /** @returns {CartProductInfo} */
1188
+ declare function CartProductInfo(): CartProductInfo;
1189
+ type CartProductInfo = {
1190
+ custom_order?: any;
1191
+ article?: ProductArticle;
1192
+ product?: CartProduct;
1193
+ quantity?: number;
1194
+ moq?: any;
1195
+ promotions_applied?: AppliedPromotion[];
1196
+ price_per_unit?: ProductPriceInfo;
1197
+ key?: string;
1198
+ price?: ProductPriceInfo;
1199
+ parent_item_identifiers?: any;
1200
+ is_set?: boolean;
1201
+ coupon_message?: string;
1202
+ message?: string;
1203
+ coupon?: CouponDetails;
1204
+ discount?: string;
1205
+ bulk_offer?: any;
1206
+ promo_meta?: PromoMeta;
1207
+ delivery_promise?: ShipmentPromise;
1208
+ availability?: ProductAvailability;
1209
+ identifiers: CartProductIdentifer;
1210
+ };
1211
+ /** @returns {CartCurrency} */
1212
+ declare function CartCurrency(): CartCurrency;
1213
+ type CartCurrency = {
1214
+ symbol?: string;
1355
1215
  /**
1356
- * - Item id
1216
+ * - Currency code defined by ISO 4217:2015
1357
1217
  */
1218
+ code?: string;
1219
+ };
1220
+ /** @returns {CartDetailResponse} */
1221
+ declare function CartDetailResponse(): CartDetailResponse;
1222
+ type CartDetailResponse = {
1223
+ comment?: string;
1224
+ coupon_text?: string;
1225
+ last_modified?: string;
1226
+ pan_config?: any;
1227
+ is_valid?: boolean;
1228
+ id?: string;
1229
+ applied_promo_details?: AppliedPromotion[];
1230
+ checkout_mode?: string;
1231
+ restrict_checkout?: boolean;
1232
+ message?: string;
1233
+ buy_now?: boolean;
1234
+ breakup_values?: CartBreakup;
1235
+ delivery_charge_info?: string;
1236
+ payment_selection_lock?: PaymentSelectionLock;
1237
+ gstin?: string;
1238
+ delivery_promise?: ShipmentPromise;
1239
+ pan_no?: string;
1240
+ items?: CartProductInfo[];
1241
+ currency?: CartCurrency;
1242
+ };
1243
+ /** @returns {AddProductCart} */
1244
+ declare function AddProductCart(): AddProductCart;
1245
+ type AddProductCart = {
1246
+ seller_id?: number;
1247
+ _custom_json?: any;
1248
+ meta?: any;
1249
+ display?: string;
1250
+ quantity?: number;
1251
+ item_size?: string;
1358
1252
  item_id?: number;
1253
+ store_id?: number;
1254
+ pos?: boolean;
1255
+ parent_item_identifiers?: any[];
1256
+ extra_meta?: any;
1257
+ product_group_tags?: string[];
1258
+ article_assignment?: any;
1259
+ article_id?: string;
1260
+ };
1261
+ /** @returns {AddCartRequest} */
1262
+ declare function AddCartRequest(): AddCartRequest;
1263
+ type AddCartRequest = {
1264
+ items?: AddProductCart[];
1265
+ new_cart?: boolean;
1266
+ };
1267
+ /** @returns {AddCartDetailResponse} */
1268
+ declare function AddCartDetailResponse(): AddCartDetailResponse;
1269
+ type AddCartDetailResponse = {
1270
+ cart?: CartDetailResponse;
1271
+ message?: string;
1359
1272
  /**
1360
- * - Item images URL
1273
+ * - When adding multiple items check if all
1274
+ * added. True if only few are added.
1361
1275
  */
1362
- item_images_url?: string[];
1276
+ partial?: boolean;
1363
1277
  /**
1364
- * - Item name
1278
+ * - True if all items are added successfully.
1279
+ * False if partially added or not added.
1365
1280
  */
1366
- item_name?: string;
1281
+ success?: boolean;
1282
+ };
1283
+ /** @returns {UpdateProductCart} */
1284
+ declare function UpdateProductCart(): UpdateProductCart;
1285
+ type UpdateProductCart = {
1286
+ meta?: any;
1287
+ _custom_json?: any;
1288
+ quantity?: number;
1289
+ item_size?: string;
1290
+ item_id?: number;
1291
+ item_index?: number;
1292
+ identifiers: CartProductIdentifer;
1293
+ parent_item_identifiers?: any;
1294
+ extra_meta?: any;
1295
+ article_id?: string;
1296
+ };
1297
+ /** @returns {UpdateCartRequest} */
1298
+ declare function UpdateCartRequest(): UpdateCartRequest;
1299
+ type UpdateCartRequest = {
1300
+ operation: string;
1301
+ items?: UpdateProductCart[];
1302
+ };
1303
+ /** @returns {UpdateCartDetailResponse} */
1304
+ declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
1305
+ type UpdateCartDetailResponse = {
1306
+ cart?: CartDetailResponse;
1307
+ message?: string;
1367
1308
  /**
1368
- * - Item price details
1309
+ * - True if all items are added successfully.
1310
+ * False if partially added or not added.
1369
1311
  */
1370
- item_price_details?: any;
1312
+ success?: boolean;
1313
+ };
1314
+ /** @returns {CartItemCountResponse} */
1315
+ declare function CartItemCountResponse(): CartItemCountResponse;
1316
+ type CartItemCountResponse = {
1371
1317
  /**
1372
- * - Item slug
1318
+ * - Item count present in cart
1373
1319
  */
1374
- item_slug?: string;
1320
+ user_cart_items_count?: number;
1375
1321
  };
1376
- /** @returns {GeoLocation} */
1377
- declare function GeoLocation(): GeoLocation;
1378
- type GeoLocation = {
1379
- latitude?: number;
1380
- longitude?: number;
1322
+ /** @returns {PageCoupon} */
1323
+ declare function PageCoupon(): PageCoupon;
1324
+ type PageCoupon = {
1325
+ has_previous?: boolean;
1326
+ current?: number;
1327
+ total?: number;
1328
+ total_item_count?: number;
1329
+ has_next?: boolean;
1381
1330
  };
1382
- /** @returns {GetAddressesResponse} */
1383
- declare function GetAddressesResponse(): GetAddressesResponse;
1384
- type GetAddressesResponse = {
1385
- address?: Address[];
1386
- pii_masking?: boolean;
1331
+ /** @returns {Coupon} */
1332
+ declare function Coupon(): Coupon;
1333
+ type Coupon = {
1334
+ max_discount_value?: number;
1335
+ coupon_code?: string;
1336
+ message?: string;
1337
+ is_applied?: boolean;
1338
+ coupon_type?: string;
1339
+ sub_title?: string;
1340
+ coupon_value?: number;
1341
+ is_applicable?: boolean;
1342
+ description?: string;
1343
+ minimum_cart_value?: number;
1344
+ title?: string;
1345
+ expires_on?: string;
1387
1346
  };
1388
1347
  /** @returns {GetCouponResponse} */
1389
1348
  declare function GetCouponResponse(): GetCouponResponse;
1390
1349
  type GetCouponResponse = {
1391
- available_coupon_list?: Coupon[];
1392
1350
  page?: PageCoupon;
1351
+ available_coupon_list?: Coupon[];
1352
+ };
1353
+ /** @returns {ApplyCouponRequest} */
1354
+ declare function ApplyCouponRequest(): ApplyCouponRequest;
1355
+ type ApplyCouponRequest = {
1356
+ /**
1357
+ * - Coupon code to be applied
1358
+ */
1359
+ coupon_code: string;
1360
+ };
1361
+ /** @returns {OfferSeller} */
1362
+ declare function OfferSeller(): OfferSeller;
1363
+ type OfferSeller = {
1364
+ /**
1365
+ * - Seller id
1366
+ */
1367
+ uid?: number;
1368
+ name?: string;
1393
1369
  };
1394
- /** @returns {GetShareCartLinkRequest} */
1395
- declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
1396
- type GetShareCartLinkRequest = {
1370
+ /** @returns {OfferPrice} */
1371
+ declare function OfferPrice(): OfferPrice;
1372
+ type OfferPrice = {
1397
1373
  /**
1398
- * - Cart uid for generating sharing
1374
+ * - Current per unit price of product after
1375
+ * existing deductions
1399
1376
  */
1400
- id?: string;
1377
+ effective?: number;
1401
1378
  /**
1402
- * - Staff, Ordering store or any other data. This
1403
- * data will be used to generate link as well as sent as shared details.
1379
+ * - Currency code for all amounts
1404
1380
  */
1405
- meta?: any;
1406
- };
1407
- /** @returns {GetShareCartLinkResponse} */
1408
- declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
1409
- type GetShareCartLinkResponse = {
1381
+ currency_code?: string;
1410
1382
  /**
1411
- * - Short shareable final url
1383
+ * - Currency symbol for currency
1412
1384
  */
1413
- share_url?: string;
1385
+ currency_symbol?: string;
1414
1386
  /**
1415
- * - Short url unique id
1387
+ * - Original price of product
1416
1388
  */
1417
- token?: string;
1418
- };
1419
- /** @returns {GiftDetail} */
1420
- declare function GiftDetail(): GiftDetail;
1421
- type GiftDetail = {
1422
- gift_message?: string;
1423
- is_gift_applied?: boolean;
1424
- };
1425
- /** @returns {LoyaltyPoints} */
1426
- declare function LoyaltyPoints(): LoyaltyPoints;
1427
- type LoyaltyPoints = {
1428
- applicable?: number;
1429
- description?: string;
1430
- is_applied?: boolean;
1431
- total?: number;
1389
+ marked?: number;
1390
+ /**
1391
+ * - Discounted per unit price for current
1392
+ * offer object
1393
+ */
1394
+ bulk_effective?: number;
1432
1395
  };
1433
1396
  /** @returns {OfferItem} */
1434
1397
  declare function OfferItem(): OfferItem;
1435
1398
  type OfferItem = {
1436
- /**
1437
- * - Whether offer discount is auto applied in cart
1438
- */
1439
- auto_applied?: boolean;
1440
- /**
1441
- * - Is true for best offer from all offers present
1442
- * for all sellers
1443
- */
1444
- best?: boolean;
1445
1399
  /**
1446
1400
  * - Percentage value of discount
1447
1401
  */
1448
1402
  margin?: number;
1449
- price?: OfferPrice;
1450
1403
  /**
1451
1404
  * - Quantity on which offer is applicable
1452
1405
  */
@@ -1456,402 +1409,449 @@ type OfferItem = {
1456
1409
  */
1457
1410
  total?: number;
1458
1411
  /**
1459
- * - Offer type
1460
- */
1461
- type?: string;
1462
- };
1463
- /** @returns {OfferPrice} */
1464
- declare function OfferPrice(): OfferPrice;
1465
- type OfferPrice = {
1466
- /**
1467
- * - Discounted per unit price for current
1468
- * offer object
1469
- */
1470
- bulk_effective?: number;
1471
- /**
1472
- * - Currency code for all amounts
1473
- */
1474
- currency_code?: string;
1475
- /**
1476
- * - Currency symbol for currency
1412
+ * - Is true for best offer from all offers present
1413
+ * for all sellers
1477
1414
  */
1478
- currency_symbol?: string;
1415
+ best?: boolean;
1479
1416
  /**
1480
- * - Current per unit price of product after
1481
- * existing deductions
1417
+ * - Offer type
1482
1418
  */
1483
- effective?: number;
1419
+ type?: string;
1420
+ price?: OfferPrice;
1484
1421
  /**
1485
- * - Original price of product
1422
+ * - Whether offer discount is auto applied in cart
1486
1423
  */
1487
- marked?: number;
1424
+ auto_applied?: boolean;
1488
1425
  };
1489
- /** @returns {OfferSeller} */
1490
- declare function OfferSeller(): OfferSeller;
1491
- type OfferSeller = {
1492
- name?: string;
1493
- /**
1494
- * - Seller id
1495
- */
1496
- uid?: number;
1426
+ /** @returns {BulkPriceOffer} */
1427
+ declare function BulkPriceOffer(): BulkPriceOffer;
1428
+ type BulkPriceOffer = {
1429
+ seller?: OfferSeller;
1430
+ offers?: OfferItem[];
1497
1431
  };
1498
- /** @returns {Ownership} */
1499
- declare function Ownership(): Ownership;
1500
- type Ownership = {
1432
+ /** @returns {BulkPriceResponse} */
1433
+ declare function BulkPriceResponse(): BulkPriceResponse;
1434
+ type BulkPriceResponse = {
1501
1435
  /**
1502
- * - Promo amount bearable party
1436
+ * - Consist of offers from multiple seller
1503
1437
  */
1504
- payable_by?: string;
1438
+ data?: BulkPriceOffer[];
1439
+ };
1440
+ /** @returns {RewardPointRequest} */
1441
+ declare function RewardPointRequest(): RewardPointRequest;
1442
+ type RewardPointRequest = {
1443
+ points: boolean;
1444
+ };
1445
+ /** @returns {GeoLocation} */
1446
+ declare function GeoLocation(): GeoLocation;
1447
+ type GeoLocation = {
1448
+ latitude?: number;
1449
+ longitude?: number;
1450
+ };
1451
+ /** @returns {Address} */
1452
+ declare function Address(): Address;
1453
+ type Address = {
1454
+ meta?: any;
1455
+ country_code?: string;
1456
+ country_iso_code?: string;
1457
+ country?: string;
1458
+ id?: string;
1459
+ checkout_mode?: string;
1460
+ created_by_user_id?: string;
1461
+ area?: string;
1462
+ is_active?: boolean;
1463
+ city?: string;
1464
+ sector?: string;
1505
1465
  /**
1506
- * - Promo amount payable category
1466
+ * - State code for international address
1507
1467
  */
1508
- payable_category?: string;
1468
+ state_code?: string;
1469
+ address_type?: string;
1470
+ state?: string;
1471
+ is_default_address?: boolean;
1472
+ _custom_json?: any;
1473
+ country_phone_code?: string;
1474
+ area_code_slug?: string;
1475
+ area_code?: string;
1476
+ email?: string;
1477
+ google_map_point?: any;
1478
+ geo_location?: GeoLocation;
1479
+ address?: string;
1480
+ tags?: string[];
1481
+ name?: string;
1482
+ landmark?: string;
1483
+ user_id?: string;
1484
+ phone?: string;
1509
1485
  };
1510
- /** @returns {PageCoupon} */
1511
- declare function PageCoupon(): PageCoupon;
1512
- type PageCoupon = {
1513
- current?: number;
1514
- has_next?: boolean;
1515
- has_previous?: boolean;
1516
- total?: number;
1517
- total_item_count?: number;
1486
+ /** @returns {GetAddressesResponse} */
1487
+ declare function GetAddressesResponse(): GetAddressesResponse;
1488
+ type GetAddressesResponse = {
1489
+ pii_masking?: boolean;
1490
+ address?: Address[];
1491
+ };
1492
+ /** @returns {SaveAddressResponse} */
1493
+ declare function SaveAddressResponse(): SaveAddressResponse;
1494
+ type SaveAddressResponse = {
1495
+ is_default_address?: boolean;
1496
+ success?: boolean;
1497
+ id?: string;
1498
+ };
1499
+ /** @returns {UpdateAddressResponse} */
1500
+ declare function UpdateAddressResponse(): UpdateAddressResponse;
1501
+ type UpdateAddressResponse = {
1502
+ is_updated?: boolean;
1503
+ is_default_address?: boolean;
1504
+ success?: boolean;
1505
+ id?: string;
1506
+ };
1507
+ /** @returns {DeleteAddressResponse} */
1508
+ declare function DeleteAddressResponse(): DeleteAddressResponse;
1509
+ type DeleteAddressResponse = {
1510
+ is_deleted?: boolean;
1511
+ id?: string;
1512
+ };
1513
+ /** @returns {SelectCartAddressRequest} */
1514
+ declare function SelectCartAddressRequest(): SelectCartAddressRequest;
1515
+ type SelectCartAddressRequest = {
1516
+ billing_address_id?: string;
1517
+ cart_id?: string;
1518
+ id?: string;
1519
+ };
1520
+ /** @returns {UpdateCartPaymentRequest} */
1521
+ declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
1522
+ type UpdateCartPaymentRequest = {
1523
+ payment_identifier?: string;
1524
+ aggregator_name?: string;
1525
+ address_id?: string;
1526
+ merchant_code?: string;
1527
+ payment_mode?: string;
1528
+ id?: string;
1529
+ };
1530
+ /** @returns {CouponValidity} */
1531
+ declare function CouponValidity(): CouponValidity;
1532
+ type CouponValidity = {
1533
+ discount?: number;
1534
+ valid?: boolean;
1535
+ next_validation_required?: boolean;
1536
+ display_message_en?: string;
1537
+ code?: string;
1538
+ title?: string;
1518
1539
  };
1519
1540
  /** @returns {PaymentCouponValidate} */
1520
1541
  declare function PaymentCouponValidate(): PaymentCouponValidate;
1521
1542
  type PaymentCouponValidate = {
1522
- coupon_validity?: CouponValidity;
1523
1543
  message?: string;
1524
1544
  success: boolean;
1545
+ coupon_validity?: CouponValidity;
1525
1546
  };
1526
- /** @returns {PaymentSelectionLock} */
1527
- declare function PaymentSelectionLock(): PaymentSelectionLock;
1528
- type PaymentSelectionLock = {
1529
- default_options?: string;
1530
- enabled?: boolean;
1531
- payment_identifier?: string;
1532
- };
1533
- /** @returns {PickupStoreDetail} */
1534
- declare function PickupStoreDetail(): PickupStoreDetail;
1535
- type PickupStoreDetail = {
1536
- address?: string;
1537
- address_type?: string;
1538
- area?: string;
1539
- area_code?: string;
1540
- area_code_slug?: string;
1541
- city?: string;
1542
- country?: string;
1543
- email?: string;
1544
- id?: number;
1545
- landmark?: string;
1546
- name?: string;
1547
- phone?: string;
1548
- pincode?: number;
1549
- state?: string;
1550
- store_code?: string;
1551
- uid?: number;
1547
+ /** @returns {ShipmentResponse} */
1548
+ declare function ShipmentResponse(): ShipmentResponse;
1549
+ type ShipmentResponse = {
1550
+ shipments?: number;
1551
+ fulfillment_type?: string;
1552
+ promise?: ShipmentPromise;
1553
+ dp_id?: string;
1554
+ box_type?: string;
1555
+ dp_options?: any;
1556
+ items?: CartProductInfo[];
1557
+ order_type?: string;
1558
+ shipment_type?: string;
1559
+ fulfillment_id?: number;
1552
1560
  };
1553
- /** @returns {ProductAction} */
1554
- declare function ProductAction(): ProductAction;
1555
- type ProductAction = {
1556
- query?: ActionQuery;
1557
- type?: string;
1558
- url?: string;
1561
+ /** @returns {CartShipmentsResponse} */
1562
+ declare function CartShipmentsResponse(): CartShipmentsResponse;
1563
+ type CartShipmentsResponse = {
1564
+ comment?: string;
1565
+ restrict_checkout?: boolean;
1566
+ message?: string;
1567
+ buy_now?: boolean;
1568
+ coupon_text?: string;
1569
+ last_modified?: string;
1570
+ cart_id?: number;
1571
+ breakup_values?: CartBreakup;
1572
+ is_valid?: boolean;
1573
+ delivery_charge_info?: string;
1574
+ id?: string;
1575
+ payment_selection_lock?: PaymentSelectionLock;
1576
+ gstin?: string;
1577
+ shipments?: ShipmentResponse[];
1578
+ error?: boolean;
1579
+ delivery_promise?: ShipmentPromise;
1580
+ uid?: string;
1581
+ checkout_mode?: string;
1582
+ currency?: CartCurrency;
1559
1583
  };
1560
- /** @returns {ProductArticle} */
1561
- declare function ProductArticle(): ProductArticle;
1562
- type ProductArticle = {
1563
- _custom_json?: any;
1564
- cart_item_meta?: any;
1565
- extra_meta?: any;
1566
- gift_card?: any;
1567
- identifier?: any;
1568
- is_gift_visible?: boolean;
1569
- meta?: any;
1570
- mto_quantity?: number;
1571
- parent_item_identifiers?: any;
1572
- price?: ArticlePriceInfo;
1573
- product_group_tags?: string[];
1584
+ /** @returns {UpdateCartShipmentItem} */
1585
+ declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
1586
+ type UpdateCartShipmentItem = {
1587
+ /**
1588
+ * - Quantity of product in shipment
1589
+ */
1574
1590
  quantity?: number;
1575
- seller?: BaseInfo;
1576
- seller_identifier?: string;
1577
- size?: string;
1578
- store?: StoreInfo;
1579
1591
  /**
1580
- * - A list of article tags
1592
+ * - Shipment delivery type
1581
1593
  */
1582
- tags?: string[];
1583
- type?: string;
1584
- uid?: string;
1585
- };
1586
- /** @returns {ProductAvailability} */
1587
- declare function ProductAvailability(): ProductAvailability;
1588
- type ProductAvailability = {
1589
- available_sizes?: ProductAvailabilitySize[];
1590
- deliverable?: boolean;
1591
- is_valid?: boolean;
1592
- other_store_quantity?: number;
1593
- out_of_stock?: boolean;
1594
- sizes?: string[];
1594
+ shipment_type: string;
1595
+ /**
1596
+ * - Article mongo id
1597
+ */
1598
+ article_uid: string;
1595
1599
  };
1596
- /** @returns {ProductAvailabilitySize} */
1597
- declare function ProductAvailabilitySize(): ProductAvailabilitySize;
1598
- type ProductAvailabilitySize = {
1599
- display?: string;
1600
- is_available?: boolean;
1601
- value?: string;
1600
+ /** @returns {UpdateCartShipmentRequest} */
1601
+ declare function UpdateCartShipmentRequest(): UpdateCartShipmentRequest;
1602
+ type UpdateCartShipmentRequest = {
1603
+ shipments: UpdateCartShipmentItem[];
1602
1604
  };
1603
- /** @returns {ProductImage} */
1604
- declare function ProductImage(): ProductImage;
1605
- type ProductImage = {
1606
- aspect_ratio?: string;
1607
- secure_url?: string;
1608
- url?: string;
1605
+ /** @returns {StaffCheckout} */
1606
+ declare function StaffCheckout(): StaffCheckout;
1607
+ type StaffCheckout = {
1608
+ first_name: string;
1609
+ user: string;
1610
+ employee_code?: string;
1611
+ _id: string;
1612
+ last_name: string;
1609
1613
  };
1610
- /** @returns {ProductPrice} */
1611
- declare function ProductPrice(): ProductPrice;
1612
- type ProductPrice = {
1613
- add_on?: number;
1614
- currency_code?: string;
1615
- currency_symbol?: string;
1616
- effective?: number;
1617
- marked?: number;
1618
- selling?: number;
1614
+ /** @returns {CustomerDetails} */
1615
+ declare function CustomerDetails(): CustomerDetails;
1616
+ type CustomerDetails = {
1617
+ mobile: string;
1618
+ name?: string;
1619
+ email?: string;
1619
1620
  };
1620
- /** @returns {ProductPriceInfo} */
1621
- declare function ProductPriceInfo(): ProductPriceInfo;
1622
- type ProductPriceInfo = {
1623
- base?: ProductPrice;
1624
- converted?: ProductPrice;
1621
+ /** @returns {CartCheckoutCustomMeta} */
1622
+ declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1623
+ type CartCheckoutCustomMeta = {
1624
+ value: string;
1625
+ key: string;
1625
1626
  };
1626
- /** @returns {PromiseFormatted} */
1627
- declare function PromiseFormatted(): PromiseFormatted;
1628
- type PromiseFormatted = {
1629
- max?: string;
1630
- min?: string;
1627
+ /** @returns {Files} */
1628
+ declare function Files(): Files;
1629
+ type Files = {
1630
+ values: string[];
1631
+ key: string;
1631
1632
  };
1632
- /** @returns {PromiseISOFormat} */
1633
- declare function PromiseISOFormat(): PromiseISOFormat;
1634
- type PromiseISOFormat = {
1633
+ /** @returns {CartPosCheckoutDetailRequest} */
1634
+ declare function CartPosCheckoutDetailRequest(): CartPosCheckoutDetailRequest;
1635
+ type CartPosCheckoutDetailRequest = {
1636
+ meta?: any;
1637
+ pick_at_store_uid?: number;
1638
+ billing_address?: any;
1639
+ payment_auto_confirm?: boolean;
1640
+ callback_url?: string;
1641
+ delivery_address?: any;
1642
+ merchant_code?: string;
1643
+ order_type: string;
1644
+ id?: string;
1645
+ staff?: StaffCheckout;
1635
1646
  /**
1636
- * - Max promise in ISO format.
1647
+ * - Customer details
1637
1648
  */
1638
- max?: string;
1649
+ customer_details?: any;
1650
+ address_id?: string;
1651
+ aggregator?: string;
1652
+ payment_params?: any;
1653
+ billing_address_id?: string;
1654
+ payment_mode: string;
1655
+ pos?: boolean;
1656
+ extra_meta?: any;
1657
+ custom_meta?: CartCheckoutCustomMeta[];
1658
+ payment_identifier?: string;
1659
+ ordering_store?: number;
1639
1660
  /**
1640
- * - Min Promise in ISO format.
1661
+ * - List of file url
1641
1662
  */
1642
- min?: string;
1643
- };
1644
- /** @returns {PromiseTimestamp} */
1645
- declare function PromiseTimestamp(): PromiseTimestamp;
1646
- type PromiseTimestamp = {
1647
- max?: number;
1648
- min?: number;
1663
+ files?: Files[];
1649
1664
  };
1650
- /** @returns {PromoMeta} */
1651
- declare function PromoMeta(): PromoMeta;
1652
- type PromoMeta = {
1665
+ /** @returns {CheckCart} */
1666
+ declare function CheckCart(): CheckCart;
1667
+ type CheckCart = {
1668
+ comment?: string;
1669
+ delivery_charges?: number;
1670
+ coupon_text?: string;
1671
+ last_modified?: string;
1672
+ is_valid?: boolean;
1673
+ cod_message?: string;
1674
+ success?: boolean;
1675
+ id?: string;
1676
+ uid?: string;
1677
+ checkout_mode?: string;
1678
+ error_message?: string;
1679
+ store_emps?: any[];
1680
+ store_code?: string;
1681
+ restrict_checkout?: boolean;
1653
1682
  message?: string;
1683
+ buy_now?: boolean;
1684
+ cod_available?: boolean;
1685
+ cart_id?: number;
1686
+ breakup_values?: CartBreakup;
1687
+ order_id?: string;
1688
+ cod_charges?: number;
1689
+ delivery_charge_info?: string;
1690
+ user_type?: string;
1691
+ payment_selection_lock?: PaymentSelectionLock;
1692
+ gstin?: string;
1693
+ delivery_promise?: ShipmentPromise;
1694
+ items?: CartProductInfo[];
1695
+ currency?: CartCurrency;
1696
+ delivery_charge_order_value?: number;
1654
1697
  };
1655
- /** @returns {RawBreakup} */
1656
- declare function RawBreakup(): RawBreakup;
1657
- type RawBreakup = {
1658
- cod_charge?: number;
1659
- convenience_fee?: number;
1660
- coupon?: number;
1661
- delivery_charge?: number;
1662
- discount?: number;
1663
- fynd_cash?: number;
1664
- gift_card?: number;
1665
- gst_charges?: number;
1666
- mrp_total?: number;
1667
- subtotal?: number;
1668
- total?: number;
1669
- vog?: number;
1670
- you_saved?: number;
1671
- };
1672
- /** @returns {RewardPointRequest} */
1673
- declare function RewardPointRequest(): RewardPointRequest;
1674
- type RewardPointRequest = {
1675
- points: boolean;
1676
- };
1677
- /** @returns {SaveAddressResponse} */
1678
- declare function SaveAddressResponse(): SaveAddressResponse;
1679
- type SaveAddressResponse = {
1680
- id?: string;
1681
- is_default_address?: boolean;
1698
+ /** @returns {CartCheckoutResponse} */
1699
+ declare function CartCheckoutResponse(): CartCheckoutResponse;
1700
+ type CartCheckoutResponse = {
1701
+ cart?: CheckCart;
1702
+ app_intercept_url?: string;
1703
+ callback_url?: string;
1704
+ message?: string;
1705
+ data?: any;
1706
+ order_id?: string;
1682
1707
  success?: boolean;
1708
+ payment_confirm_url?: string;
1709
+ };
1710
+ /** @returns {GiftDetail} */
1711
+ declare function GiftDetail(): GiftDetail;
1712
+ type GiftDetail = {
1713
+ gift_message?: string;
1714
+ is_gift_applied?: boolean;
1683
1715
  };
1684
- /** @returns {SelectCartAddressRequest} */
1685
- declare function SelectCartAddressRequest(): SelectCartAddressRequest;
1686
- type SelectCartAddressRequest = {
1687
- billing_address_id?: string;
1688
- cart_id?: string;
1689
- id?: string;
1716
+ /** @returns {ArticleGiftDetail} */
1717
+ declare function ArticleGiftDetail(): ArticleGiftDetail;
1718
+ type ArticleGiftDetail = {
1719
+ article_id?: GiftDetail;
1690
1720
  };
1691
- /** @returns {SharedCart} */
1692
- declare function SharedCart(): SharedCart;
1693
- type SharedCart = {
1694
- breakup_values?: CartBreakup;
1695
- buy_now?: boolean;
1696
- cart_id?: number;
1697
- checkout_mode?: string;
1721
+ /** @returns {CartMetaRequest} */
1722
+ declare function CartMetaRequest(): CartMetaRequest;
1723
+ type CartMetaRequest = {
1698
1724
  comment?: string;
1699
- coupon_text?: string;
1700
- currency?: CartCurrency;
1701
- delivery_charge_info?: string;
1702
- delivery_promise?: ShipmentPromise;
1703
1725
  gstin?: string;
1704
- id?: string;
1705
- is_valid?: boolean;
1706
- items?: CartProductInfo[];
1707
- last_modified?: string;
1708
- message?: string;
1709
- payment_selection_lock?: PaymentSelectionLock;
1710
- restrict_checkout?: boolean;
1711
- shared_cart_details?: SharedCartDetails;
1712
- uid?: string;
1713
- };
1714
- /** @returns {SharedCartDetails} */
1715
- declare function SharedCartDetails(): SharedCartDetails;
1716
- type SharedCartDetails = {
1717
- created_on?: string;
1718
- /**
1719
- * - Meta data sent while generating share cart link
1720
- */
1721
- meta?: any;
1722
1726
  /**
1723
- * - Share link device and other source information
1727
+ * - Customer contact details for
1728
+ * customer pickup at store
1724
1729
  */
1725
- source?: any;
1730
+ pick_up_customer_details?: any;
1731
+ checkout_mode?: string;
1732
+ gift_details?: ArticleGiftDetail;
1733
+ delivery_slots?: any;
1734
+ };
1735
+ /** @returns {CartMetaResponse} */
1736
+ declare function CartMetaResponse(): CartMetaResponse;
1737
+ type CartMetaResponse = {
1738
+ message?: string;
1739
+ is_valid?: boolean;
1740
+ };
1741
+ /** @returns {CartMetaMissingResponse} */
1742
+ declare function CartMetaMissingResponse(): CartMetaMissingResponse;
1743
+ type CartMetaMissingResponse = {
1744
+ errors?: string[];
1745
+ };
1746
+ /** @returns {CartDeliveryModesResponse} */
1747
+ declare function CartDeliveryModesResponse(): CartDeliveryModesResponse;
1748
+ type CartDeliveryModesResponse = {
1726
1749
  /**
1727
- * - Short link id
1750
+ * - Available delivery modes
1728
1751
  */
1729
- token?: string;
1752
+ available_modes?: string[];
1730
1753
  /**
1731
- * - User details of who generated share link
1754
+ * - Store pick up available store uids
1732
1755
  */
1733
- user?: any;
1734
- };
1735
- /** @returns {SharedCartResponse} */
1736
- declare function SharedCartResponse(): SharedCartResponse;
1737
- type SharedCartResponse = {
1738
- cart?: SharedCart;
1739
- error?: string;
1740
- };
1741
- /** @returns {ShipmentPromise} */
1742
- declare function ShipmentPromise(): ShipmentPromise;
1743
- type ShipmentPromise = {
1744
- formatted?: PromiseFormatted;
1745
- iso?: PromiseISOFormat;
1746
- timestamp?: PromiseTimestamp;
1747
- };
1748
- /** @returns {ShipmentResponse} */
1749
- declare function ShipmentResponse(): ShipmentResponse;
1750
- type ShipmentResponse = {
1751
- box_type?: string;
1752
- dp_id?: string;
1753
- dp_options?: any;
1754
- fulfillment_id?: number;
1755
- fulfillment_type?: string;
1756
- items?: CartProductInfo[];
1757
- order_type?: string;
1758
- promise?: ShipmentPromise;
1759
- shipment_type?: string;
1760
- shipments?: number;
1756
+ pickup_stores?: number[];
1761
1757
  };
1762
- /** @returns {StaffCheckout} */
1763
- declare function StaffCheckout(): StaffCheckout;
1764
- type StaffCheckout = {
1765
- _id: string;
1766
- employee_code?: string;
1767
- first_name: string;
1768
- last_name: string;
1769
- user: string;
1758
+ /** @returns {PickupStoreDetail} */
1759
+ declare function PickupStoreDetail(): PickupStoreDetail;
1760
+ type PickupStoreDetail = {
1761
+ city?: string;
1762
+ address_type?: string;
1763
+ address?: string;
1764
+ state?: string;
1765
+ store_code?: string;
1766
+ uid?: number;
1767
+ pincode?: number;
1768
+ area_code_slug?: string;
1769
+ area_code?: string;
1770
+ email?: string;
1771
+ name?: string;
1772
+ landmark?: string;
1773
+ area?: string;
1774
+ country?: string;
1775
+ phone?: string;
1776
+ id?: number;
1770
1777
  };
1771
1778
  /** @returns {StoreDetailsResponse} */
1772
1779
  declare function StoreDetailsResponse(): StoreDetailsResponse;
1773
1780
  type StoreDetailsResponse = {
1774
1781
  items?: PickupStoreDetail[];
1775
1782
  };
1776
- /** @returns {StoreInfo} */
1777
- declare function StoreInfo(): StoreInfo;
1778
- type StoreInfo = {
1779
- name?: string;
1780
- store_code?: string;
1781
- uid?: number;
1782
- };
1783
- /** @returns {Tags} */
1784
- declare function Tags(): Tags;
1785
- type Tags = {
1786
- tags?: any;
1787
- };
1788
- /** @returns {UpdateAddressResponse} */
1789
- declare function UpdateAddressResponse(): UpdateAddressResponse;
1790
- type UpdateAddressResponse = {
1791
- id?: string;
1792
- is_default_address?: boolean;
1793
- is_updated?: boolean;
1794
- success?: boolean;
1795
- };
1796
- /** @returns {UpdateCartDetailResponse} */
1797
- declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
1798
- type UpdateCartDetailResponse = {
1799
- cart?: CartDetailResponse;
1800
- message?: string;
1783
+ /** @returns {GetShareCartLinkRequest} */
1784
+ declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
1785
+ type GetShareCartLinkRequest = {
1801
1786
  /**
1802
- * - True if all items are added successfully.
1803
- * False if partially added or not added.
1787
+ * - Staff, Ordering store or any other data. This
1788
+ * data will be used to generate link as well as sent as shared details.
1789
+ */
1790
+ meta?: any;
1791
+ /**
1792
+ * - Cart uid for generating sharing
1804
1793
  */
1805
- success?: boolean;
1806
- };
1807
- /** @returns {UpdateCartPaymentRequest} */
1808
- declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
1809
- type UpdateCartPaymentRequest = {
1810
- address_id?: string;
1811
- aggregator_name?: string;
1812
1794
  id?: string;
1813
- merchant_code?: string;
1814
- payment_identifier?: string;
1815
- payment_mode?: string;
1816
1795
  };
1817
- /** @returns {UpdateCartRequest} */
1818
- declare function UpdateCartRequest(): UpdateCartRequest;
1819
- type UpdateCartRequest = {
1820
- items?: UpdateProductCart[];
1821
- operation: string;
1796
+ /** @returns {GetShareCartLinkResponse} */
1797
+ declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
1798
+ type GetShareCartLinkResponse = {
1799
+ /**
1800
+ * - Short shareable final url
1801
+ */
1802
+ share_url?: string;
1803
+ /**
1804
+ * - Short url unique id
1805
+ */
1806
+ token?: string;
1822
1807
  };
1823
- /** @returns {UpdateCartShipmentItem} */
1824
- declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
1825
- type UpdateCartShipmentItem = {
1808
+ /** @returns {SharedCartDetails} */
1809
+ declare function SharedCartDetails(): SharedCartDetails;
1810
+ type SharedCartDetails = {
1826
1811
  /**
1827
- * - Article mongo id
1812
+ * - Meta data sent while generating share cart link
1828
1813
  */
1829
- article_uid: string;
1814
+ meta?: any;
1830
1815
  /**
1831
- * - Quantity of product in shipment
1816
+ * - User details of who generated share link
1832
1817
  */
1833
- quantity?: number;
1818
+ user?: any;
1819
+ created_on?: string;
1834
1820
  /**
1835
- * - Shipment delivery type
1821
+ * - Short link id
1836
1822
  */
1837
- shipment_type: string;
1823
+ token?: string;
1824
+ /**
1825
+ * - Share link device and other source information
1826
+ */
1827
+ source?: any;
1838
1828
  };
1839
- /** @returns {UpdateCartShipmentRequest} */
1840
- declare function UpdateCartShipmentRequest(): UpdateCartShipmentRequest;
1841
- type UpdateCartShipmentRequest = {
1842
- shipments: UpdateCartShipmentItem[];
1829
+ /** @returns {SharedCart} */
1830
+ declare function SharedCart(): SharedCart;
1831
+ type SharedCart = {
1832
+ comment?: string;
1833
+ coupon_text?: string;
1834
+ last_modified?: string;
1835
+ shared_cart_details?: SharedCartDetails;
1836
+ is_valid?: boolean;
1837
+ id?: string;
1838
+ uid?: string;
1839
+ checkout_mode?: string;
1840
+ restrict_checkout?: boolean;
1841
+ message?: string;
1842
+ buy_now?: boolean;
1843
+ cart_id?: number;
1844
+ breakup_values?: CartBreakup;
1845
+ delivery_charge_info?: string;
1846
+ payment_selection_lock?: PaymentSelectionLock;
1847
+ gstin?: string;
1848
+ delivery_promise?: ShipmentPromise;
1849
+ items?: CartProductInfo[];
1850
+ currency?: CartCurrency;
1843
1851
  };
1844
- /** @returns {UpdateProductCart} */
1845
- declare function UpdateProductCart(): UpdateProductCart;
1846
- type UpdateProductCart = {
1847
- _custom_json?: any;
1848
- article_id?: string;
1849
- extra_meta?: any;
1850
- identifiers: CartProductIdentifer;
1851
- item_id?: number;
1852
- item_index?: number;
1853
- item_size?: string;
1854
- meta?: any;
1855
- parent_item_identifiers?: any;
1856
- quantity?: number;
1852
+ /** @returns {SharedCartResponse} */
1853
+ declare function SharedCartResponse(): SharedCartResponse;
1854
+ type SharedCartResponse = {
1855
+ error?: string;
1856
+ cart?: SharedCart;
1857
1857
  };