@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3

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 (106) 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 +846 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +822 -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 +2155 -2150
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
  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/UserApplicationModel.d.ts +762 -762
  38. package/sdk/application/User/UserApplicationModel.js +738 -738
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  40. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  42. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  43. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  45. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  46. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  50. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  51. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  52. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  54. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
  57. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  58. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  63. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  64. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  65. package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
  66. package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
  67. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  68. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  69. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
  70. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
  71. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  72. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  73. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  74. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  75. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  76. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  77. package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
  78. package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
  79. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  80. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  81. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
  82. package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
  83. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  84. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  85. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
  86. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
  87. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  88. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  89. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  90. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  91. package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
  92. package/sdk/platform/User/UserPlatformModel.js +643 -643
  93. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  94. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  95. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  96. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  97. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  98. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  99. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  100. package/sdk/public/Content/ContentPublicModel.js +28 -28
  101. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  102. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  103. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  104. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  105. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  106. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,1029 +1,1018 @@
1
1
  export = CartApplicationModel;
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.
3
+ * @typedef BuyRules
4
+ * @property {Object} [item_criteria] - Item criteria of promotion
5
+ * @property {Object} [cart_conditions] - Cart conditions details for promotion
14
6
  */
15
7
  /**
16
- * @typedef AddCartRequest
17
- * @property {AddProductCart[]} [items]
18
- * @property {boolean} [new_cart]
8
+ * @typedef DiscountRulesApp
9
+ * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
10
+ * @property {Object} [raw_offer] - Raw offer details for promotion
11
+ * @property {Object} [offer] - Offer for promotion
12
+ * @property {Object} [item_criteria] - Item criteria of promotion
19
13
  */
20
14
  /**
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 {string} [seller_identifier] - Add items using seller identifier for store os
36
- * @property {number} [store_id]
15
+ * @typedef Ownership
16
+ * @property {string} [payable_category] - Promo amount payable category
17
+ * @property {string} [payable_by] - Promo amount bearable party
37
18
  */
38
19
  /**
39
- * @typedef Address
40
- * @property {Object} [_custom_json]
41
- * @property {string} [address]
42
- * @property {string} [address_type]
43
- * @property {string} [area]
44
- * @property {string} [area_code]
45
- * @property {string} [area_code_slug]
46
- * @property {string} [checkout_mode]
47
- * @property {string} [city]
48
- * @property {string} [country]
49
- * @property {string} [country_code]
50
- * @property {string} [country_iso_code]
51
- * @property {string} [country_phone_code]
52
- * @property {string} [created_by_user_id]
53
- * @property {string} [email]
54
- * @property {GeoLocation} [geo_location]
55
- * @property {Object} [google_map_point]
56
- * @property {string} [id]
57
- * @property {boolean} [is_active]
58
- * @property {boolean} [is_default_address]
59
- * @property {string} [landmark]
60
- * @property {Object} [meta]
61
- * @property {string} [name]
62
- * @property {string} [phone]
63
- * @property {string} [sector]
64
- * @property {string} [state]
65
- * @property {string} [state_code] - State code for international address
66
- * @property {string[]} [tags]
67
- * @property {string} [user_id]
20
+ * @typedef FreeGiftItem
21
+ * @property {string} [item_slug] - Item slug
22
+ * @property {string} [item_name] - Item name
23
+ * @property {Object} [item_price_details] - Item price details
24
+ * @property {string} [item_brand_name] - Item brand name
25
+ * @property {number} [item_id] - Item id
26
+ * @property {string[]} [item_images_url] - Item images URL
68
27
  */
69
28
  /**
70
29
  * @typedef AppliedFreeArticles
71
- * @property {string} [article_id] - Free article id
72
30
  * @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
73
31
  * @property {string} [parent_item_identifier] - Parent item identifier for free article
74
32
  * @property {number} [quantity] - Free article quantity
33
+ * @property {string} [article_id] - Free article id
75
34
  */
76
35
  /**
77
36
  * @typedef AppliedPromotion
78
- * @property {number} [amount] - Per unit discount amount applied with current promotion
79
- * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
80
- * article for free gift item promotions
81
- * @property {number} [article_quantity] - Quantity of article on which
82
- * promotion is applicable
37
+ * @property {string} [promo_id] - Promotion id
83
38
  * @property {BuyRules[]} [buy_rules] - Buy rules for promotions
84
- * @property {string} [code] - Promotion code
85
- * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
86
- * @property {Object} [meta] - Meta object for extra data
87
- * @property {boolean} [mrp_promotion] - If applied promotion is applied on
88
- * product MRP or ESP
89
39
  * @property {string} [offer_text] - Offer text of current promotion
90
- * @property {Ownership} [ownership] - Ownership of promotion
91
- * @property {string} [promo_id] - Promotion id
92
40
  * @property {string} [promotion_group] - Promotion group for the promotion
41
+ * @property {boolean} [mrp_promotion] - If applied promotion is applied on
42
+ * product MRP or ESP
93
43
  * @property {string} [promotion_name] - Promotion name of current promotion
44
+ * @property {number} [amount] - Per unit discount amount applied with current promotion
45
+ * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
46
+ * @property {Ownership} [ownership] - Ownership of promotion
47
+ * @property {number} [article_quantity] - Quantity of article on which
48
+ * promotion is applicable
49
+ * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
50
+ * article for free gift item promotions
94
51
  * @property {string} [promotion_type] - Promotion type of current promotion
52
+ * @property {Object} [meta] - Meta object for extra data
53
+ * @property {string} [code] - Promotion code
95
54
  */
96
55
  /**
97
- * @typedef ApplyCouponRequest
98
- * @property {string} coupon_code - Coupon code to be applied
56
+ * @typedef PaymentSelectionLock
57
+ * @property {boolean} [enabled]
58
+ * @property {string} [default_options]
59
+ * @property {string} [payment_identifier]
99
60
  */
100
61
  /**
101
- * @typedef ArticleGiftDetail
102
- * @property {GiftDetail} [article_id]
62
+ * @typedef PromiseFormatted
63
+ * @property {string} [max]
64
+ * @property {string} [min]
103
65
  */
104
66
  /**
105
- * @typedef ArticlePriceInfo
106
- * @property {BasePrice} [base]
107
- * @property {BasePrice} [converted]
67
+ * @typedef PromiseISOFormat
68
+ * @property {string} [max] - Max promise in ISO format.
69
+ * @property {string} [min] - Min Promise in ISO format.
108
70
  */
109
71
  /**
110
- * @typedef BaseInfo
111
- * @property {string} [name]
112
- * @property {number} [uid]
72
+ * @typedef PromiseTimestamp
73
+ * @property {number} [max]
74
+ * @property {number} [min]
75
+ */
76
+ /**
77
+ * @typedef ShipmentPromise
78
+ * @property {PromiseFormatted} [formatted]
79
+ * @property {PromiseTimestamp} [timestamp]
80
+ * @property {PromiseISOFormat} [iso]
113
81
  */
114
82
  /**
115
83
  * @typedef BasePrice
116
- * @property {string} [currency_code]
117
- * @property {string} [currency_symbol]
118
84
  * @property {number} [effective]
85
+ * @property {string} [currency_symbol]
119
86
  * @property {number} [marked]
87
+ * @property {string} [currency_code]
120
88
  */
121
89
  /**
122
- * @typedef BulkPriceOffer
123
- * @property {OfferItem[]} [offers]
124
- * @property {OfferSeller} [seller]
125
- */
126
- /**
127
- * @typedef BulkPriceResponse
128
- * @property {BulkPriceOffer[]} [data] - Consist of offers from multiple seller
129
- */
130
- /**
131
- * @typedef BuyRules
132
- * @property {Object} [cart_conditions] - Cart conditions details for promotion
133
- * @property {Object} [item_criteria] - Item criteria of promotion
90
+ * @typedef ArticlePriceInfo
91
+ * @property {BasePrice} [base]
92
+ * @property {BasePrice} [converted]
134
93
  */
135
94
  /**
136
- * @typedef CartBreakup
137
- * @property {CouponBreakup} [coupon]
138
- * @property {DisplayBreakup[]} [display]
139
- * @property {LoyaltyPoints} [loyalty_points]
140
- * @property {RawBreakup} [raw]
95
+ * @typedef BaseInfo
96
+ * @property {number} [uid]
97
+ * @property {string} [name]
141
98
  */
142
99
  /**
143
- * @typedef CartCheckoutCustomMeta
144
- * @property {string} key
145
- * @property {string} value
100
+ * @typedef StoreInfo
101
+ * @property {string} [store_code]
102
+ * @property {number} [uid]
103
+ * @property {string} [name]
146
104
  */
147
105
  /**
148
- * @typedef CartCheckoutDetailRequest
149
- * @property {string} [address_id]
150
- * @property {string} [aggregator]
151
- * @property {Object} [billing_address]
152
- * @property {string} [billing_address_id]
153
- * @property {string} [callback_url]
154
- * @property {CartCheckoutCustomMeta[]} [custom_meta]
155
- * @property {Object} [customer_details] - Customer details
156
- * @property {Object} [delivery_address]
106
+ * @typedef ProductArticle
107
+ * @property {ArticlePriceInfo} [price]
108
+ * @property {string[]} [product_group_tags]
157
109
  * @property {Object} [extra_meta]
158
- * @property {string} [id]
159
- * @property {string} [merchant_code]
110
+ * @property {number} [quantity]
111
+ * @property {Object} [_custom_json]
160
112
  * @property {Object} [meta]
161
- * @property {string} [order_type]
162
- * @property {number} [ordering_store]
163
- * @property {boolean} [payment_auto_confirm]
164
- * @property {Object} [payment_extra_identifiers]
165
- * @property {string} [payment_identifier]
166
- * @property {string} payment_mode
167
- * @property {Object} [payment_params]
168
- * @property {StaffCheckout} [staff]
113
+ * @property {string} [size]
114
+ * @property {number} [mto_quantity]
115
+ * @property {BaseInfo} [seller]
116
+ * @property {string} [seller_identifier]
117
+ * @property {Object} [parent_item_identifiers]
118
+ * @property {Object} [identifier]
119
+ * @property {StoreInfo} [store]
120
+ * @property {Object} [cart_item_meta]
121
+ * @property {string} [uid]
122
+ * @property {Object} [gift_card]
123
+ * @property {boolean} [is_gift_visible]
124
+ * @property {string} [type]
125
+ * @property {string[]} [tags] - A list of article tags
169
126
  */
170
127
  /**
171
- * @typedef CartCheckoutDetailV2Request
172
- * @property {string} [address_id]
173
- * @property {string} [aggregator]
174
- * @property {Object} [billing_address]
175
- * @property {string} [billing_address_id]
176
- * @property {string} [callback_url]
177
- * @property {string} [cart_id]
178
- * @property {Object} [custom_meta]
179
- * @property {Object} [customer_details] - Customer details
180
- * @property {Object} [delivery_address]
181
- * @property {Object} [extra_meta]
182
- * @property {string} [id]
183
- * @property {string} [merchant_code]
184
- * @property {Object} [meta]
185
- * @property {string} [order_type]
186
- * @property {number} [ordering_store]
187
- * @property {boolean} [payment_auto_confirm]
188
- * @property {string} [payment_identifier]
189
- * @property {PaymentMethod[]} payment_methods
190
- * @property {string} payment_mode
191
- * @property {Object} [payment_params]
192
- * @property {StaffCheckout} [staff]
128
+ * @typedef CartProductIdentifer
129
+ * @property {string} [identifier] - Article idenfier generated by cart
193
130
  */
194
131
  /**
195
- * @typedef CartCheckoutResponse
196
- * @property {string} [app_intercept_url]
197
- * @property {string} [callback_url]
198
- * @property {CheckCart} [cart]
199
- * @property {Object} [data]
132
+ * @typedef PromoMeta
200
133
  * @property {string} [message]
201
- * @property {string} [order_id]
202
- * @property {string} [payment_confirm_url]
203
- * @property {boolean} [success]
204
134
  */
205
135
  /**
206
- * @typedef CartCommonConfig
207
- * @property {DeliveryChargesConfig} [delivery_charges_config]
136
+ * @typedef ChargesAmount
137
+ * @property {number} [value] - This is the value of amount added
138
+ * @property {string} [currency] - This is destination currency of value
208
139
  */
209
140
  /**
210
- * @typedef CartCurrency
211
- * @property {string} [code] - Currency code defined by ISO 4217:2015
212
- * @property {string} [symbol]
141
+ * @typedef Charges
142
+ * @property {Object} [meta] - This object contains the meta data realted to
143
+ * charges price adjustment
144
+ * @property {ChargesAmount} [amount]
145
+ * @property {string} [name] - This is the name of the charge applied
146
+ * @property {boolean} [allow_refund] - This boolean value defines that refund
147
+ * is allowed or not for the charge
148
+ * @property {string} [code] - This is the code of the charge applied
149
+ * @property {string} [type] - This is the type of the charge applied
213
150
  */
214
151
  /**
215
- * @typedef CartDetailCoupon
216
- * @property {number} [cashback_amount]
217
- * @property {string} [cashback_message_primary]
218
- * @property {string} [cashback_message_secondary]
219
- * @property {string} [coupon_code]
220
- * @property {string} [coupon_description]
221
- * @property {string} [coupon_id]
222
- * @property {string} [coupon_subtitle]
223
- * @property {string} [coupon_title]
224
- * @property {string} [coupon_type]
225
- * @property {number} [coupon_value]
226
- * @property {number} [discount]
227
- * @property {boolean} [is_applied]
228
- * @property {boolean} [is_valid]
229
- * @property {number} [maximum_discount_value]
230
- * @property {string} [message]
231
- * @property {number} [minimum_cart_value]
152
+ * @typedef ProductPrice
153
+ * @property {string} [currency_symbol]
154
+ * @property {number} [selling]
155
+ * @property {string} [currency_code]
156
+ * @property {number} [add_on]
157
+ * @property {number} [effective]
158
+ * @property {number} [marked]
232
159
  */
233
160
  /**
234
- * @typedef CartDetailResponse
235
- * @property {AppliedPromotion[]} [applied_promo_details]
236
- * @property {CartBreakup} [breakup_values]
237
- * @property {boolean} [buy_now]
238
- * @property {number} [cart_id]
239
- * @property {string} [checkout_mode]
240
- * @property {string} [comment]
241
- * @property {CartCommonConfig} [common_config]
242
- * @property {CartDetailCoupon} [coupon]
243
- * @property {string} [coupon_text]
244
- * @property {CartCurrency} [currency]
245
- * @property {string} [delivery_charge_info]
246
- * @property {ShipmentPromise} [delivery_promise]
247
- * @property {string} [gstin]
248
- * @property {string} [id]
249
- * @property {boolean} [is_valid]
250
- * @property {CartProductInfo[]} [items]
251
- * @property {string} [last_modified]
252
- * @property {string} [message]
253
- * @property {Object} [notification]
254
- * @property {Object} [pan_config]
255
- * @property {string} [pan_no]
256
- * @property {PaymentSelectionLock} [payment_selection_lock]
257
- * @property {boolean} [restrict_checkout]
258
- * @property {string} [staff_user_id]
259
- * @property {boolean} [success]
260
- * @property {string} [uid]
161
+ * @typedef ProductPriceInfo
162
+ * @property {ProductPrice} [base]
163
+ * @property {ProductPrice} [converted]
261
164
  */
262
165
  /**
263
- * @typedef CartItemCountResponse
264
- * @property {number} [user_cart_items_count] - Item count present in cart
166
+ * @typedef ProductPricePerUnit
167
+ * @property {string} [currency_symbol]
168
+ * @property {number} [selling_price]
169
+ * @property {string} [currency_code]
170
+ * @property {number} [add_on]
171
+ * @property {number} [effective]
172
+ * @property {number} [marked]
265
173
  */
266
174
  /**
267
- * @typedef CartMetaMissingResponse
268
- * @property {string[]} [errors]
175
+ * @typedef ProductPricePerUnitInfo
176
+ * @property {ProductPricePerUnit} [base]
177
+ * @property {ProductPricePerUnit} [converted]
269
178
  */
270
179
  /**
271
- * @typedef CartMetaRequest
272
- * @property {string} [checkout_mode]
273
- * @property {string} [comment]
274
- * @property {Object} [delivery_slots]
275
- * @property {ArticleGiftDetail} [gift_details]
276
- * @property {string} [gstin]
277
- * @property {Object} [pick_up_customer_details] - Customer contact details for
278
- * customer pickup at store
180
+ * @typedef ProductAvailabilitySize
181
+ * @property {string} [display]
182
+ * @property {string} [value]
183
+ * @property {boolean} [is_available]
279
184
  */
280
185
  /**
281
- * @typedef CartMetaResponse
186
+ * @typedef ProductAvailability
187
+ * @property {boolean} [out_of_stock]
188
+ * @property {boolean} [deliverable]
189
+ * @property {ProductAvailabilitySize[]} [available_sizes]
282
190
  * @property {boolean} [is_valid]
283
- * @property {string} [message]
191
+ * @property {number} [other_store_quantity]
192
+ * @property {string[]} [sizes]
193
+ */
194
+ /**
195
+ * @typedef ActionQuery
196
+ * @property {string[]} [product_slug] - Contains list of product slug
197
+ */
198
+ /**
199
+ * @typedef ProductAction
200
+ * @property {ActionQuery} [query]
201
+ * @property {string} [url]
202
+ * @property {string} [type]
203
+ */
204
+ /**
205
+ * @typedef Tags
206
+ * @property {Object} [tags]
207
+ */
208
+ /**
209
+ * @typedef ProductImage
210
+ * @property {string} [secure_url]
211
+ * @property {string} [aspect_ratio]
212
+ * @property {string} [url]
213
+ */
214
+ /**
215
+ * @typedef CategoryInfo
216
+ * @property {number} [uid] - Product Category Id
217
+ * @property {string} [name]
284
218
  */
285
219
  /**
286
220
  * @typedef CartProduct
287
221
  * @property {Object} [_custom_json]
288
- * @property {ProductAction} [action]
289
- * @property {Object} [attributes]
290
222
  * @property {BaseInfo} [brand]
291
- * @property {CategoryInfo[]} [categories]
292
- * @property {ProductImage[]} [images]
293
- * @property {string} [item_code]
294
- * @property {string} [name]
223
+ * @property {ProductAction} [action]
224
+ * @property {Tags} [teaser_tag]
295
225
  * @property {string} [slug] - Unique product url name generated via product
296
226
  * name and other meta data
227
+ * @property {ProductImage[]} [images]
228
+ * @property {number} [uid]
229
+ * @property {string} [name]
230
+ * @property {string} [item_code]
231
+ * @property {CategoryInfo[]} [categories]
297
232
  * @property {string[]} [tags]
298
- * @property {Tags} [teaser_tag]
299
233
  * @property {string} [type]
300
- * @property {number} [uid]
234
+ * @property {Object} [attributes]
301
235
  */
302
236
  /**
303
- * @typedef CartProductIdentifer
304
- * @property {string} [identifier] - Article idenfier generated by cart
237
+ * @typedef CouponDetails
238
+ * @property {number} [discount_single_quantity]
239
+ * @property {string} [code]
240
+ * @property {number} [discount_total_quantity]
305
241
  */
306
242
  /**
307
243
  * @typedef CartProductInfo
308
244
  * @property {ProductArticle} [article]
245
+ * @property {Object} [moq]
246
+ * @property {CartProductIdentifer} identifiers
247
+ * @property {PromoMeta} [promo_meta]
248
+ * @property {ProductPriceInfo} [price]
249
+ * @property {number} [quantity]
250
+ * @property {Charges[]} [charges]
251
+ * @property {string} [discount]
309
252
  * @property {ProductAvailability} [availability]
253
+ * @property {ShipmentPromise} [delivery_promise]
254
+ * @property {CartProduct} [product]
255
+ * @property {string} [product_ean_id]
310
256
  * @property {Object} [bulk_offer]
311
- * @property {Charges[]} [charges]
257
+ * @property {Object} [parent_item_identifiers]
312
258
  * @property {CouponDetails} [coupon]
313
- * @property {string} [coupon_message]
314
259
  * @property {Object} [custom_order]
315
- * @property {ShipmentPromise} [delivery_promise]
316
- * @property {string} [discount]
317
- * @property {CartProductIdentifer} identifiers
318
- * @property {boolean} [is_set]
260
+ * @property {string} [coupon_message]
319
261
  * @property {string} [key]
320
262
  * @property {string} [message]
321
- * @property {Object} [moq]
322
- * @property {Object} [parent_item_identifiers]
323
- * @property {ProductPriceInfo} [price]
263
+ * @property {boolean} [is_set]
324
264
  * @property {ProductPricePerUnitInfo} [price_per_unit]
325
- * @property {CartProduct} [product]
326
- * @property {string} [product_ean_id]
327
- * @property {PromoMeta} [promo_meta]
328
265
  * @property {AppliedPromotion[]} [promotions_applied]
329
- * @property {number} [quantity]
330
266
  */
331
267
  /**
332
- * @typedef CartShipmentsResponse
333
- * @property {CartBreakup} [breakup_values]
334
- * @property {boolean} [buy_now]
335
- * @property {number} [cart_id]
336
- * @property {string} [checkout_mode]
337
- * @property {string} [comment]
338
- * @property {string} [coupon_text]
339
- * @property {CartCurrency} [currency]
340
- * @property {string} [delivery_charge_info]
341
- * @property {ShipmentPromise} [delivery_promise]
342
- * @property {boolean} [error]
343
- * @property {string} [gstin]
344
- * @property {string} [id]
345
- * @property {boolean} [is_valid]
346
- * @property {string} [last_modified]
347
- * @property {string} [message]
348
- * @property {PaymentSelectionLock} [payment_selection_lock]
349
- * @property {boolean} [restrict_checkout]
350
- * @property {ShipmentResponse[]} [shipments]
351
- * @property {string} [uid]
268
+ * @typedef DisplayBreakup
269
+ * @property {string} [currency_symbol]
270
+ * @property {string} [key]
271
+ * @property {string} [display]
272
+ * @property {string[]} [message]
273
+ * @property {string} [currency_code]
274
+ * @property {number} [value]
275
+ * @property {number} [preset]
352
276
  */
353
277
  /**
354
- * @typedef CategoryInfo
355
- * @property {string} [name]
356
- * @property {number} [uid] - Product Category Id
278
+ * @typedef RawBreakup
279
+ * @property {number} [vog]
280
+ * @property {number} [subtotal]
281
+ * @property {number} [fynd_cash]
282
+ * @property {number} [discount]
283
+ * @property {number} [convenience_fee]
284
+ * @property {number} [delivery_charge]
285
+ * @property {number} [gst_charges]
286
+ * @property {number} [mrp_total]
287
+ * @property {number} [mop_total]
288
+ * @property {number} [total_charge]
289
+ * @property {number} [coupon]
290
+ * @property {number} [total]
291
+ * @property {number} [gift_card]
292
+ * @property {number} [you_saved]
293
+ * @property {number} [cod_charge]
357
294
  */
358
295
  /**
359
- * @typedef Charges
360
- * @property {boolean} [allow_refund] - This boolean value defines that refund
361
- * is allowed or not for the charge
362
- * @property {ChargesAmount} [amount]
363
- * @property {string} [code] - This is the code of the charge applied
364
- * @property {Object} [meta] - This object contains the meta data realted to
365
- * charges price adjustment
366
- * @property {string} [name] - This is the name of the charge applied
367
- * @property {string} [type] - This is the type of the charge applied
296
+ * @typedef CouponBreakup
297
+ * @property {number} [coupon_value]
298
+ * @property {string} [title]
299
+ * @property {string} [sub_title]
300
+ * @property {number} [minimum_cart_value]
301
+ * @property {string} [message]
302
+ * @property {string} [coupon_type]
303
+ * @property {string} [uid]
304
+ * @property {number} [value]
305
+ * @property {number} [max_discount_value]
306
+ * @property {boolean} [is_applied]
307
+ * @property {string} [description]
308
+ * @property {string} [code]
309
+ * @property {string} [type]
368
310
  */
369
311
  /**
370
- * @typedef ChargesAmount
371
- * @property {string} [currency] - This is destination currency of value
372
- * @property {number} [value] - This is the value of amount added
312
+ * @typedef LoyaltyPoints
313
+ * @property {number} [total]
314
+ * @property {string} [description]
315
+ * @property {number} [applicable]
316
+ * @property {boolean} [is_applied]
373
317
  */
374
318
  /**
375
- * @typedef ChargesThreshold
376
- * @property {number} [charges]
377
- * @property {number} [threshold]
319
+ * @typedef CartBreakup
320
+ * @property {DisplayBreakup[]} [display]
321
+ * @property {RawBreakup} [raw]
322
+ * @property {CouponBreakup} [coupon]
323
+ * @property {LoyaltyPoints} [loyalty_points]
378
324
  */
379
325
  /**
380
- * @typedef CheckCart
381
- * @property {CartBreakup} [breakup_values]
382
- * @property {boolean} [buy_now]
383
- * @property {number} [cart_id]
384
- * @property {string} [checkout_mode]
385
- * @property {boolean} [cod_available]
386
- * @property {number} [cod_charges]
387
- * @property {string} [cod_message]
388
- * @property {string} [comment]
389
- * @property {string} [coupon_text]
390
- * @property {CartCurrency} [currency]
391
- * @property {string} [delivery_charge_info]
392
- * @property {number} [delivery_charge_order_value]
393
- * @property {number} [delivery_charges]
394
- * @property {ShipmentPromise} [delivery_promise]
395
- * @property {string} [error_message]
396
- * @property {string} [gstin]
397
- * @property {string} [id]
398
- * @property {boolean} [is_valid]
399
- * @property {CartProductInfo[]} [items]
400
- * @property {string} [last_modified]
401
- * @property {string} [message]
402
- * @property {string} [order_id]
403
- * @property {PaymentSelectionLock} [payment_selection_lock]
404
- * @property {boolean} [restrict_checkout]
405
- * @property {string} [store_code]
406
- * @property {Object[]} [store_emps]
407
- * @property {boolean} [success]
408
- * @property {string} [uid]
409
- * @property {string} [user_type]
326
+ * @typedef CartCurrency
327
+ * @property {string} [code] - Currency code defined by ISO 4217:2015
328
+ * @property {string} [symbol]
410
329
  */
411
330
  /**
412
- * @typedef Coupon
413
- * @property {number} [coupon_amount] - The amount based on cart value
414
- * @property {string} [coupon_applicable_message]
331
+ * @typedef CartDetailCoupon
332
+ * @property {number} [cashback_amount]
333
+ * @property {string} [cashback_message_primary]
334
+ * @property {string} [cashback_message_secondary]
415
335
  * @property {string} [coupon_code]
336
+ * @property {string} [coupon_description]
337
+ * @property {string} [coupon_id]
338
+ * @property {string} [coupon_subtitle]
339
+ * @property {string} [coupon_title]
416
340
  * @property {string} [coupon_type]
417
341
  * @property {number} [coupon_value]
418
- * @property {string} [description]
419
- * @property {string} [end_date]
420
- * @property {string} [expires_on]
421
- * @property {boolean} [is_applicable]
342
+ * @property {number} [discount]
422
343
  * @property {boolean} [is_applied]
423
- * @property {number} [max_discount_value]
344
+ * @property {boolean} [is_valid]
345
+ * @property {number} [maximum_discount_value]
424
346
  * @property {string} [message]
425
347
  * @property {number} [minimum_cart_value]
426
- * @property {string} [start_date]
427
- * @property {string} [sub_title]
428
- * @property {string} [title]
429
348
  */
430
349
  /**
431
- * @typedef CouponBreakup
432
- * @property {string} [code]
433
- * @property {string} [coupon_type]
434
- * @property {number} [coupon_value]
435
- * @property {string} [description]
436
- * @property {boolean} [is_applied]
437
- * @property {number} [max_discount_value]
438
- * @property {string} [message]
439
- * @property {number} [minimum_cart_value]
440
- * @property {string} [sub_title]
441
- * @property {string} [title]
442
- * @property {string} [type]
443
- * @property {string} [uid]
444
- * @property {number} [value]
350
+ * @typedef ChargesThreshold
351
+ * @property {number} [charges]
352
+ * @property {number} [threshold]
445
353
  */
446
354
  /**
447
- * @typedef CouponDetails
448
- * @property {string} [code]
449
- * @property {number} [discount_single_quantity]
450
- * @property {number} [discount_total_quantity]
355
+ * @typedef DeliveryChargesConfig
356
+ * @property {boolean} [enabled]
357
+ * @property {ChargesThreshold[]} [charges]
451
358
  */
452
359
  /**
453
- * @typedef CouponValidity
454
- * @property {string} [code]
455
- * @property {number} [discount]
456
- * @property {string} [display_message_en]
457
- * @property {boolean} [next_validation_required]
458
- * @property {string} [title]
459
- * @property {boolean} [valid]
360
+ * @typedef CartCommonConfig
361
+ * @property {DeliveryChargesConfig} [delivery_charges_config]
460
362
  */
461
363
  /**
462
- * @typedef CurrencyInfo
463
- * @property {string} [code]
464
- * @property {string} [symbol]
364
+ * @typedef CartDetailResponse
365
+ * @property {number} [cart_id]
366
+ * @property {string} [uid]
367
+ * @property {AppliedPromotion[]} [applied_promo_details]
368
+ * @property {string} [checkout_mode]
369
+ * @property {string} [pan_no]
370
+ * @property {boolean} [is_valid]
371
+ * @property {string} [id]
372
+ * @property {PaymentSelectionLock} [payment_selection_lock]
373
+ * @property {ShipmentPromise} [delivery_promise]
374
+ * @property {string} [comment]
375
+ * @property {CartProductInfo[]} [items]
376
+ * @property {string} [delivery_charge_info]
377
+ * @property {CartCommonConfig} [common_config]
378
+ * @property {CartDetailCoupon} [coupon]
379
+ * @property {string} [message]
380
+ * @property {Object} [notification]
381
+ * @property {string} [staff_user_id]
382
+ * @property {boolean} [success]
383
+ * @property {string} [gstin]
384
+ * @property {boolean} [restrict_checkout]
385
+ * @property {string} [last_modified]
386
+ * @property {CartBreakup} [breakup_values]
387
+ * @property {CartCurrency} [currency]
388
+ * @property {string} [coupon_text]
389
+ * @property {boolean} [buy_now]
390
+ * @property {Object} [pan_config]
465
391
  */
466
392
  /**
467
- * @typedef CustomerDetails
468
- * @property {string} [email]
469
- * @property {string} mobile
470
- * @property {string} [name]
393
+ * @typedef AddProductCart
394
+ * @property {Object} [article_assignment]
395
+ * @property {string[]} [product_group_tags]
396
+ * @property {Object} [extra_meta]
397
+ * @property {number} [quantity]
398
+ * @property {Object} [_custom_json]
399
+ * @property {string} [item_size]
400
+ * @property {number} [store_id]
401
+ * @property {string} [display]
402
+ * @property {string} [article_id]
403
+ * @property {Object[]} [parent_item_identifiers]
404
+ * @property {number} [seller_id]
405
+ * @property {boolean} [pos]
406
+ * @property {number} [item_id]
407
+ * @property {Object} [meta]
408
+ * @property {string} [seller_identifier] - Add items using seller identifier for store os
471
409
  */
472
410
  /**
473
- * @typedef DeleteAddressResponse
474
- * @property {string} [id]
475
- * @property {boolean} [is_deleted]
411
+ * @typedef AddCartRequest
412
+ * @property {AddProductCart[]} [items]
413
+ * @property {boolean} [new_cart]
476
414
  */
477
415
  /**
478
- * @typedef DeleteCartDetailResponse
416
+ * @typedef AddCartDetailResponse
479
417
  * @property {string} [message]
480
- * @property {boolean} [success] - True if cart is archived successfully. False
481
- * if not archived.
418
+ * @property {boolean} [partial] - When adding multiple items check if all
419
+ * added. True if only few are added.
420
+ * @property {CartDetailResponse} [cart]
421
+ * @property {boolean} [success] - True if all items are added successfully.
422
+ * False if partially added or not added.
482
423
  */
483
424
  /**
484
- * @typedef DeliveryChargesConfig
485
- * @property {ChargesThreshold[]} [charges]
486
- * @property {boolean} [enabled]
425
+ * @typedef UpdateProductCart
426
+ * @property {Object} [extra_meta]
427
+ * @property {Object} [_custom_json]
428
+ * @property {number} [quantity]
429
+ * @property {string} [item_size]
430
+ * @property {number} [item_index]
431
+ * @property {CartProductIdentifer} identifiers
432
+ * @property {string} [article_id]
433
+ * @property {Object} [parent_item_identifiers]
434
+ * @property {number} [item_id]
435
+ * @property {Object} [meta]
487
436
  */
488
437
  /**
489
- * @typedef DiscountRulesApp
490
- * @property {Object} [item_criteria] - Item criteria of promotion
491
- * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
492
- * @property {Object} [offer] - Offer for promotion
493
- * @property {Object} [raw_offer] - Raw offer details for promotion
438
+ * @typedef UpdateCartRequest
439
+ * @property {UpdateProductCart[]} [items]
440
+ * @property {string} operation
494
441
  */
495
442
  /**
496
- * @typedef DisplayBreakup
497
- * @property {string} [currency_code]
498
- * @property {string} [currency_symbol]
499
- * @property {string} [display]
500
- * @property {string} [key]
501
- * @property {string[]} [message]
502
- * @property {number} [preset]
503
- * @property {number} [value]
443
+ * @typedef UpdateCartDetailResponse
444
+ * @property {string} [message]
445
+ * @property {CartDetailResponse} [cart]
446
+ * @property {boolean} [success] - True if all items are added successfully.
447
+ * False if partially added or not added.
504
448
  */
505
449
  /**
506
- * @typedef FreeGiftItem
507
- * @property {string} [item_brand_name] - Item brand name
508
- * @property {number} [item_id] - Item id
509
- * @property {string[]} [item_images_url] - Item images URL
510
- * @property {string} [item_name] - Item name
511
- * @property {Object} [item_price_details] - Item price details
512
- * @property {string} [item_slug] - Item slug
450
+ * @typedef DeleteCartDetailResponse
451
+ * @property {string} [message]
452
+ * @property {boolean} [success] - True if cart is archived successfully. False
453
+ * if not archived.
513
454
  */
514
455
  /**
515
- * @typedef FreeGiftItems
516
- * @property {string} [item_brand_name] - Item brand name
517
- * @property {number} [item_id] - Item id
518
- * @property {string[]} [item_images_url] - Item images URL
519
- * @property {string} [item_name] - Item name
520
- * @property {Object} [item_price_details] - Item price details
521
- * @property {string} [item_slug] - Item slug
456
+ * @typedef CartItemCountResponse
457
+ * @property {number} [user_cart_items_count] - Item count present in cart
522
458
  */
523
459
  /**
524
- * @typedef GeoLocation
525
- * @property {number} [latitude]
526
- * @property {number} [longitude]
460
+ * @typedef PageCoupon
461
+ * @property {number} [total_item_count]
462
+ * @property {boolean} [has_next]
463
+ * @property {number} [total]
464
+ * @property {number} [current]
465
+ * @property {boolean} [has_previous]
527
466
  */
528
467
  /**
529
- * @typedef GetAddressesResponse
530
- * @property {Address[]} [address]
531
- * @property {boolean} [pii_masking]
468
+ * @typedef Coupon
469
+ * @property {number} [coupon_amount] - The amount based on cart value
470
+ * @property {number} [coupon_value]
471
+ * @property {string} [title]
472
+ * @property {number} [minimum_cart_value]
473
+ * @property {string} [sub_title]
474
+ * @property {string} [expires_on]
475
+ * @property {string} [message]
476
+ * @property {string} [coupon_type]
477
+ * @property {number} [max_discount_value]
478
+ * @property {string} [coupon_code]
479
+ * @property {boolean} [is_applicable]
480
+ * @property {string} [description]
481
+ * @property {boolean} [is_applied]
482
+ * @property {string} [start_date]
483
+ * @property {string} [end_date]
484
+ * @property {string} [coupon_applicable_message]
532
485
  */
533
486
  /**
534
487
  * @typedef GetCouponResponse
535
- * @property {Coupon[]} [available_coupon_list]
536
488
  * @property {PageCoupon} [page]
489
+ * @property {Coupon[]} [available_coupon_list]
537
490
  */
538
491
  /**
539
- * @typedef GetShareCartLinkRequest
540
- * @property {string} [id] - Cart uid for generating sharing
541
- * @property {Object} [meta] - Staff, Ordering store or any other data. This
542
- * data will be used to generate link as well as sent as shared details.
492
+ * @typedef ApplyCouponRequest
493
+ * @property {string} coupon_code - Coupon code to be applied
543
494
  */
544
495
  /**
545
- * @typedef GetShareCartLinkResponse
546
- * @property {string} [share_url] - Short shareable final url
547
- * @property {string} [token] - Short url unique id
496
+ * @typedef OfferPrice
497
+ * @property {string} [currency_symbol] - Currency symbol for currency
498
+ * @property {number} [bulk_effective] - Discounted per unit price for current
499
+ * offer object
500
+ * @property {string} [currency_code] - Currency code for all amounts
501
+ * @property {number} [effective] - Current per unit price of product after
502
+ * existing deductions
503
+ * @property {number} [marked] - Original price of product
548
504
  */
549
505
  /**
550
- * @typedef GiftDetail
551
- * @property {string} [gift_message]
552
- * @property {boolean} [is_gift_applied]
506
+ * @typedef OfferItem
507
+ * @property {OfferPrice} [price]
508
+ * @property {number} [margin] - Percentage value of discount
509
+ * @property {number} [quantity] - Quantity on which offer is applicable
510
+ * @property {boolean} [best] - Is true for best offer from all offers present
511
+ * for all sellers
512
+ * @property {number} [total] - Total price of offer quantity with discount
513
+ * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart
514
+ * @property {string} [type] - Offer type
553
515
  */
554
516
  /**
555
- * @typedef LadderOfferItem
556
- * @property {number} [margin] - Percentage value of discount
557
- * @property {number} [max_quantity] - Minimum quantity upto which offer is
558
- * applicable. If not present that offer is applicable on all quantities
559
- * @property {number} [min_quantity] - Minimum quantity from which offer is applicable
560
- * @property {LadderPrice} [price]
561
- * @property {string} [type] - Offer type
517
+ * @typedef OfferSeller
518
+ * @property {number} [uid] - Seller id
519
+ * @property {string} [name]
562
520
  */
563
521
  /**
564
- * @typedef LadderPrice
565
- * @property {string} [currency_code] - Currency code for all amounts
566
- * @property {string} [currency_symbol] - Currency symbol for currency
567
- * @property {number} [effective] - Current per unit price of product after
568
- * existing deductions
569
- * @property {number} [marked] - Original price of product
570
- * @property {number} [offer_price] - Discounted per unit price for current offer object
522
+ * @typedef BulkPriceOffer
523
+ * @property {OfferItem[]} [offers]
524
+ * @property {OfferSeller} [seller]
571
525
  */
572
526
  /**
573
- * @typedef LadderPriceOffer
574
- * @property {Object} [buy_rules] - Buy rules of promotions
575
- * @property {string} [calculate_on] - If this ladder offer is to be calculated
576
- * on MRP or ESP price
577
- * @property {string} [description] - Offer details including T&C
578
- * @property {Object[]} [discount_rules] - Discount rules of promotions
579
- * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
580
- * @property {string} [id] - Promotion id
581
- * @property {LadderOfferItem[]} [offer_prices]
582
- * @property {string} [offer_text] - Offer title
583
- * @property {string} [promotion_group] - Group of promotion belongs to
584
- * @property {string} [valid_till] - Datetime ISOString for promotion end date
527
+ * @typedef BulkPriceResponse
528
+ * @property {BulkPriceOffer[]} [data] - Consist of offers from multiple seller
585
529
  */
586
530
  /**
587
- * @typedef LadderPriceOffers
588
- * @property {LadderPriceOffer[]} [available_offers]
589
- * @property {CurrencyInfo} [currency]
531
+ * @typedef RewardPointRequest
532
+ * @property {boolean} points
590
533
  */
591
534
  /**
592
- * @typedef LoyaltyPoints
593
- * @property {number} [applicable]
594
- * @property {string} [description]
595
- * @property {boolean} [is_applied]
596
- * @property {number} [total]
535
+ * @typedef GeoLocation
536
+ * @property {number} [latitude]
537
+ * @property {number} [longitude]
597
538
  */
598
539
  /**
599
- * @typedef OfferItem
600
- * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart
601
- * @property {boolean} [best] - Is true for best offer from all offers present
602
- * for all sellers
603
- * @property {number} [margin] - Percentage value of discount
604
- * @property {OfferPrice} [price]
605
- * @property {number} [quantity] - Quantity on which offer is applicable
606
- * @property {number} [total] - Total price of offer quantity with discount
607
- * @property {string} [type] - Offer type
540
+ * @typedef Address
541
+ * @property {string} [country_iso_code]
542
+ * @property {string} [area]
543
+ * @property {string} [phone]
544
+ * @property {string} [country_phone_code]
545
+ * @property {string} [checkout_mode]
546
+ * @property {string} [address]
547
+ * @property {string} [area_code_slug]
548
+ * @property {GeoLocation} [geo_location]
549
+ * @property {string} [id]
550
+ * @property {Object} [_custom_json]
551
+ * @property {string} [city]
552
+ * @property {string} [sector]
553
+ * @property {string} [state_code] - State code for international address
554
+ * @property {string} [created_by_user_id]
555
+ * @property {string} [landmark]
556
+ * @property {string} [user_id]
557
+ * @property {string} [name]
558
+ * @property {Object} [google_map_point]
559
+ * @property {boolean} [is_active]
560
+ * @property {string[]} [tags]
561
+ * @property {string} [country_code]
562
+ * @property {string} [address_type]
563
+ * @property {string} [country]
564
+ * @property {boolean} [is_default_address]
565
+ * @property {string} [area_code]
566
+ * @property {string} [email]
567
+ * @property {string} [state]
568
+ * @property {Object} [meta]
608
569
  */
609
570
  /**
610
- * @typedef OfferPrice
611
- * @property {number} [bulk_effective] - Discounted per unit price for current
612
- * offer object
613
- * @property {string} [currency_code] - Currency code for all amounts
614
- * @property {string} [currency_symbol] - Currency symbol for currency
615
- * @property {number} [effective] - Current per unit price of product after
616
- * existing deductions
617
- * @property {number} [marked] - Original price of product
571
+ * @typedef GetAddressesResponse
572
+ * @property {boolean} [pii_masking]
573
+ * @property {Address[]} [address]
618
574
  */
619
575
  /**
620
- * @typedef OfferSeller
621
- * @property {string} [name]
622
- * @property {number} [uid] - Seller id
576
+ * @typedef SaveAddressResponse
577
+ * @property {string} [id]
578
+ * @property {boolean} [success]
579
+ * @property {boolean} [is_default_address]
623
580
  */
624
581
  /**
625
- * @typedef OperationErrorResponse
626
- * @property {string} [message]
582
+ * @typedef UpdateAddressResponse
583
+ * @property {boolean} [is_updated]
584
+ * @property {string} [id]
627
585
  * @property {boolean} [success]
586
+ * @property {boolean} [is_default_address]
628
587
  */
629
588
  /**
630
- * @typedef Ownership
631
- * @property {string} [payable_by] - Promo amount bearable party
632
- * @property {string} [payable_category] - Promo amount payable category
589
+ * @typedef DeleteAddressResponse
590
+ * @property {string} [id]
591
+ * @property {boolean} [is_deleted]
633
592
  */
634
593
  /**
635
- * @typedef PageCoupon
636
- * @property {number} [current]
637
- * @property {boolean} [has_next]
638
- * @property {boolean} [has_previous]
639
- * @property {number} [total]
640
- * @property {number} [total_item_count]
594
+ * @typedef SelectCartAddressRequest
595
+ * @property {string} [id]
596
+ * @property {string} [billing_address_id]
597
+ * @property {string} [cart_id]
598
+ */
599
+ /**
600
+ * @typedef UpdateCartPaymentRequest
601
+ * @property {string} [id]
602
+ * @property {string} [payment_identifier]
603
+ * @property {string} [address_id]
604
+ * @property {string} [merchant_code]
605
+ * @property {string} [aggregator_name]
606
+ * @property {string} [payment_mode]
607
+ */
608
+ /**
609
+ * @typedef CouponValidity
610
+ * @property {string} [title]
611
+ * @property {number} [discount]
612
+ * @property {boolean} [next_validation_required]
613
+ * @property {boolean} [valid]
614
+ * @property {string} [display_message_en]
615
+ * @property {string} [code]
641
616
  */
642
617
  /**
643
618
  * @typedef PaymentCouponValidate
644
- * @property {CouponValidity} [coupon_validity]
645
619
  * @property {string} [message]
620
+ * @property {CouponValidity} [coupon_validity]
646
621
  * @property {boolean} success
647
622
  */
648
623
  /**
649
- * @typedef PaymentMeta
650
- * @property {string} [merchant_code]
651
- * @property {string} [payment_gateway]
652
- * @property {string} [payment_identifier]
653
- * @property {string} [type]
624
+ * @typedef ShipmentResponse
625
+ * @property {number} [shipments]
626
+ * @property {ShipmentPromise} [promise]
627
+ * @property {string} [order_type]
628
+ * @property {string} [box_type]
629
+ * @property {string} [shipment_type]
630
+ * @property {Object} [dp_options]
631
+ * @property {string} [dp_id]
632
+ * @property {CartProductInfo[]} [items]
633
+ * @property {string} [fulfillment_type]
634
+ * @property {number} [fulfillment_id]
654
635
  */
655
636
  /**
656
- * @typedef PaymentMethod
657
- * @property {number} [amount]
658
- * @property {string} mode
659
- * @property {string} [name]
660
- * @property {string} [payment]
661
- * @property {Object} [payment_extra_identifiers]
662
- * @property {PaymentMeta} payment_meta
637
+ * @typedef CartShipmentsResponse
638
+ * @property {string} [delivery_charge_info]
639
+ * @property {string} [checkout_mode]
640
+ * @property {string} [message]
641
+ * @property {string} [gstin]
642
+ * @property {boolean} [restrict_checkout]
643
+ * @property {string} [last_modified]
644
+ * @property {number} [cart_id]
645
+ * @property {boolean} [is_valid]
646
+ * @property {CartBreakup} [breakup_values]
647
+ * @property {CartCurrency} [currency]
648
+ * @property {string} [id]
649
+ * @property {ShipmentResponse[]} [shipments]
650
+ * @property {PaymentSelectionLock} [payment_selection_lock]
651
+ * @property {string} [coupon_text]
652
+ * @property {ShipmentPromise} [delivery_promise]
653
+ * @property {boolean} [error]
654
+ * @property {string} [comment]
655
+ * @property {boolean} [buy_now]
656
+ * @property {string} [uid]
663
657
  */
664
658
  /**
665
- * @typedef PaymentSelectionLock
666
- * @property {string} [default_options]
667
- * @property {boolean} [enabled]
668
- * @property {string} [payment_identifier]
659
+ * @typedef CartCheckoutCustomMeta
660
+ * @property {string} key
661
+ * @property {string} value
669
662
  */
670
663
  /**
671
- * @typedef ProductAction
672
- * @property {ActionQuery} [query]
673
- * @property {string} [type]
674
- * @property {string} [url]
664
+ * @typedef CustomerDetails
665
+ * @property {string} [email]
666
+ * @property {string} mobile
667
+ * @property {string} [name]
675
668
  */
676
669
  /**
677
- * @typedef ProductArticle
678
- * @property {Object} [_custom_json]
679
- * @property {Object} [cart_item_meta]
670
+ * @typedef StaffCheckout
671
+ * @property {string} [employee_code]
672
+ * @property {string} user
673
+ * @property {string} last_name
674
+ * @property {string} first_name
675
+ * @property {string} _id
676
+ */
677
+ /**
678
+ * @typedef CartCheckoutDetailRequest
679
+ * @property {CartCheckoutCustomMeta[]} [custom_meta]
680
+ * @property {Object} [customer_details] - Customer details
681
+ * @property {string} [merchant_code]
682
+ * @property {string} [id]
683
+ * @property {boolean} [payment_auto_confirm]
684
+ * @property {string} payment_mode
685
+ * @property {string} [aggregator]
686
+ * @property {string} [address_id]
687
+ * @property {string} [callback_url]
688
+ * @property {Object} [delivery_address]
689
+ * @property {StaffCheckout} [staff]
690
+ * @property {string} [order_type]
691
+ * @property {number} [ordering_store]
680
692
  * @property {Object} [extra_meta]
681
- * @property {Object} [gift_card]
682
- * @property {Object} [identifier]
683
- * @property {boolean} [is_gift_visible]
693
+ * @property {string} [payment_identifier]
694
+ * @property {Object} [billing_address]
695
+ * @property {Object} [payment_params]
696
+ * @property {string} [billing_address_id]
684
697
  * @property {Object} [meta]
685
- * @property {number} [mto_quantity]
686
- * @property {Object} [parent_item_identifiers]
687
- * @property {ArticlePriceInfo} [price]
688
- * @property {string[]} [product_group_tags]
689
- * @property {number} [quantity]
690
- * @property {BaseInfo} [seller]
691
- * @property {string} [seller_identifier]
692
- * @property {string} [size]
693
- * @property {StoreInfo} [store]
694
- * @property {string[]} [tags] - A list of article tags
698
+ * @property {Object} [payment_extra_identifiers]
699
+ * @property {string} [iin]
700
+ * @property {string} [network]
695
701
  * @property {string} [type]
696
- * @property {string} [uid]
702
+ * @property {string} [card_id]
697
703
  */
698
704
  /**
699
- * @typedef ProductAvailability
700
- * @property {ProductAvailabilitySize[]} [available_sizes]
701
- * @property {boolean} [deliverable]
705
+ * @typedef CheckCart
706
+ * @property {string} [checkout_mode]
707
+ * @property {string} [user_type]
708
+ * @property {string} [cod_message]
709
+ * @property {number} [cart_id]
702
710
  * @property {boolean} [is_valid]
703
- * @property {number} [other_store_quantity]
704
- * @property {boolean} [out_of_stock]
705
- * @property {string[]} [sizes]
711
+ * @property {number} [delivery_charges]
712
+ * @property {string} [id]
713
+ * @property {PaymentSelectionLock} [payment_selection_lock]
714
+ * @property {string} [error_message]
715
+ * @property {ShipmentPromise} [delivery_promise]
716
+ * @property {string} [comment]
717
+ * @property {CartProductInfo[]} [items]
718
+ * @property {string} [uid]
719
+ * @property {number} [delivery_charge_order_value]
720
+ * @property {string} [delivery_charge_info]
721
+ * @property {boolean} [cod_available]
722
+ * @property {boolean} [success]
723
+ * @property {string} [store_code]
724
+ * @property {string} [message]
725
+ * @property {string} [gstin]
726
+ * @property {boolean} [restrict_checkout]
727
+ * @property {string} [last_modified]
728
+ * @property {string} [order_id]
729
+ * @property {CartBreakup} [breakup_values]
730
+ * @property {CartCurrency} [currency]
731
+ * @property {Object[]} [store_emps]
732
+ * @property {string} [coupon_text]
733
+ * @property {boolean} [buy_now]
734
+ * @property {number} [cod_charges]
706
735
  */
707
736
  /**
708
- * @typedef ProductAvailabilitySize
709
- * @property {string} [display]
710
- * @property {boolean} [is_available]
711
- * @property {string} [value]
737
+ * @typedef CartCheckoutResponse
738
+ * @property {string} [payment_confirm_url]
739
+ * @property {string} [app_intercept_url]
740
+ * @property {boolean} [success]
741
+ * @property {string} [callback_url]
742
+ * @property {string} [message]
743
+ * @property {Object} [data]
744
+ * @property {string} [order_id]
745
+ * @property {CheckCart} [cart]
712
746
  */
713
747
  /**
714
- * @typedef ProductImage
715
- * @property {string} [aspect_ratio]
716
- * @property {string} [secure_url]
717
- * @property {string} [url]
748
+ * @typedef GiftDetail
749
+ * @property {boolean} [is_gift_applied]
750
+ * @property {string} [gift_message]
718
751
  */
719
752
  /**
720
- * @typedef ProductPrice
721
- * @property {number} [add_on]
722
- * @property {string} [currency_code]
723
- * @property {string} [currency_symbol]
724
- * @property {number} [effective]
725
- * @property {number} [marked]
726
- * @property {number} [selling]
753
+ * @typedef ArticleGiftDetail
754
+ * @property {GiftDetail} [article_id]
727
755
  */
728
756
  /**
729
- * @typedef ProductPriceInfo
730
- * @property {ProductPrice} [base]
731
- * @property {ProductPrice} [converted]
757
+ * @typedef CartMetaRequest
758
+ * @property {Object} [delivery_slots]
759
+ * @property {ArticleGiftDetail} [gift_details]
760
+ * @property {Object} [pick_up_customer_details] - Customer contact details for
761
+ * customer pickup at store
762
+ * @property {string} [checkout_mode]
763
+ * @property {string} [comment]
764
+ * @property {string} [gstin]
732
765
  */
733
766
  /**
734
- * @typedef ProductPricePerUnit
735
- * @property {number} [add_on]
736
- * @property {string} [currency_code]
737
- * @property {string} [currency_symbol]
738
- * @property {number} [effective]
739
- * @property {number} [marked]
740
- * @property {number} [selling_price]
767
+ * @typedef CartMetaResponse
768
+ * @property {string} [message]
769
+ * @property {boolean} [is_valid]
741
770
  */
742
771
  /**
743
- * @typedef ProductPricePerUnitInfo
744
- * @property {ProductPricePerUnit} [base]
745
- * @property {ProductPricePerUnit} [converted]
772
+ * @typedef CartMetaMissingResponse
773
+ * @property {string[]} [errors]
746
774
  */
747
775
  /**
748
- * @typedef PromiseFormatted
749
- * @property {string} [max]
750
- * @property {string} [min]
776
+ * @typedef GetShareCartLinkRequest
777
+ * @property {string} [id] - Cart uid for generating sharing
778
+ * @property {Object} [meta] - Staff, Ordering store or any other data. This
779
+ * data will be used to generate link as well as sent as shared details.
751
780
  */
752
781
  /**
753
- * @typedef PromiseISOFormat
754
- * @property {string} [max] - Max promise in ISO format.
755
- * @property {string} [min] - Min Promise in ISO format.
782
+ * @typedef GetShareCartLinkResponse
783
+ * @property {string} [token] - Short url unique id
784
+ * @property {string} [share_url] - Short shareable final url
756
785
  */
757
786
  /**
758
- * @typedef PromiseTimestamp
759
- * @property {number} [max]
760
- * @property {number} [min]
787
+ * @typedef SharedCartDetails
788
+ * @property {string} [token] - Short link id
789
+ * @property {Object} [user] - User details of who generated share link
790
+ * @property {string} [created_on]
791
+ * @property {Object} [source] - Share link device and other source information
792
+ * @property {Object} [meta] - Meta data sent while generating share cart link
761
793
  */
762
794
  /**
763
- * @typedef PromoMeta
795
+ * @typedef SharedCart
796
+ * @property {string} [checkout_mode]
797
+ * @property {number} [cart_id]
798
+ * @property {boolean} [is_valid]
799
+ * @property {string} [id]
800
+ * @property {PaymentSelectionLock} [payment_selection_lock]
801
+ * @property {ShipmentPromise} [delivery_promise]
802
+ * @property {string} [comment]
803
+ * @property {CartProductInfo[]} [items]
804
+ * @property {string} [uid]
805
+ * @property {string} [delivery_charge_info]
764
806
  * @property {string} [message]
807
+ * @property {string} [gstin]
808
+ * @property {SharedCartDetails} [shared_cart_details]
809
+ * @property {boolean} [restrict_checkout]
810
+ * @property {string} [last_modified]
811
+ * @property {CartBreakup} [breakup_values]
812
+ * @property {CartCurrency} [currency]
813
+ * @property {string} [coupon_text]
814
+ * @property {boolean} [buy_now]
815
+ */
816
+ /**
817
+ * @typedef SharedCartResponse
818
+ * @property {string} [error]
819
+ * @property {SharedCart} [cart]
820
+ */
821
+ /**
822
+ * @typedef FreeGiftItems
823
+ * @property {string} [item_slug] - Item slug
824
+ * @property {string} [item_name] - Item name
825
+ * @property {Object} [item_price_details] - Item price details
826
+ * @property {string} [item_brand_name] - Item brand name
827
+ * @property {number} [item_id] - Item id
828
+ * @property {string[]} [item_images_url] - Item images URL
765
829
  */
766
830
  /**
767
831
  * @typedef PromotionOffer
768
- * @property {Object} [buy_rules] - Buy rules of promotions
769
- * @property {string} [description] - Offer details including T&C
770
- * @property {Object[]} [discount_rules] - Discount rules of promotions
771
- * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
772
832
  * @property {string} [id] - Promotion id
833
+ * @property {Object} [buy_rules] - Buy rules of promotions
773
834
  * @property {string} [offer_text] - Offer title
774
835
  * @property {string} [promotion_group] - Group of promotion belongs to
775
836
  * @property {string} [valid_till] - Datetime ISOString for promotion end date
837
+ * @property {Object[]} [discount_rules] - Discount rules of promotions
838
+ * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
839
+ * @property {string} [description] - Offer details including T&C
776
840
  */
777
841
  /**
778
842
  * @typedef PromotionOffersResponse
779
843
  * @property {PromotionOffer[]} [available_promotions]
780
844
  */
781
845
  /**
782
- * @typedef RawBreakup
783
- * @property {number} [cod_charge]
784
- * @property {number} [convenience_fee]
785
- * @property {number} [coupon]
786
- * @property {number} [delivery_charge]
787
- * @property {number} [discount]
788
- * @property {number} [fynd_cash]
789
- * @property {number} [gift_card]
790
- * @property {number} [gst_charges]
791
- * @property {number} [mop_total]
792
- * @property {number} [mrp_total]
793
- * @property {number} [subtotal]
794
- * @property {number} [total]
795
- * @property {number} [total_charge]
796
- * @property {number} [vog]
797
- * @property {number} [you_saved]
846
+ * @typedef OperationErrorResponse
847
+ * @property {string} [message]
848
+ * @property {boolean} [success]
798
849
  */
799
850
  /**
800
- * @typedef RewardPointRequest
801
- * @property {boolean} points
851
+ * @typedef LadderPrice
852
+ * @property {string} [currency_symbol] - Currency symbol for currency
853
+ * @property {number} [offer_price] - Discounted per unit price for current offer object
854
+ * @property {string} [currency_code] - Currency code for all amounts
855
+ * @property {number} [effective] - Current per unit price of product after
856
+ * existing deductions
857
+ * @property {number} [marked] - Original price of product
802
858
  */
803
859
  /**
804
- * @typedef SaveAddressResponse
805
- * @property {string} [id]
806
- * @property {boolean} [is_default_address]
807
- * @property {boolean} [success]
860
+ * @typedef LadderOfferItem
861
+ * @property {LadderPrice} [price]
862
+ * @property {number} [margin] - Percentage value of discount
863
+ * @property {number} [max_quantity] - Minimum quantity upto which offer is
864
+ * applicable. If not present that offer is applicable on all quantities
865
+ * @property {number} [min_quantity] - Minimum quantity from which offer is applicable
866
+ * @property {string} [type] - Offer type
808
867
  */
809
868
  /**
810
- * @typedef SelectCartAddressRequest
811
- * @property {string} [billing_address_id]
812
- * @property {string} [cart_id]
813
- * @property {string} [id]
869
+ * @typedef LadderPriceOffer
870
+ * @property {string} [id] - Promotion id
871
+ * @property {Object} [buy_rules] - Buy rules of promotions
872
+ * @property {string} [calculate_on] - If this ladder offer is to be calculated
873
+ * on MRP or ESP price
874
+ * @property {string} [offer_text] - Offer title
875
+ * @property {string} [promotion_group] - Group of promotion belongs to
876
+ * @property {string} [valid_till] - Datetime ISOString for promotion end date
877
+ * @property {Object[]} [discount_rules] - Discount rules of promotions
878
+ * @property {LadderOfferItem[]} [offer_prices]
879
+ * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
880
+ * @property {string} [description] - Offer details including T&C
814
881
  */
815
882
  /**
816
- * @typedef SharedCart
817
- * @property {CartBreakup} [breakup_values]
818
- * @property {boolean} [buy_now]
819
- * @property {number} [cart_id]
820
- * @property {string} [checkout_mode]
821
- * @property {string} [comment]
822
- * @property {string} [coupon_text]
823
- * @property {CartCurrency} [currency]
824
- * @property {string} [delivery_charge_info]
825
- * @property {ShipmentPromise} [delivery_promise]
826
- * @property {string} [gstin]
827
- * @property {string} [id]
828
- * @property {boolean} [is_valid]
829
- * @property {CartProductInfo[]} [items]
830
- * @property {string} [last_modified]
831
- * @property {string} [message]
832
- * @property {PaymentSelectionLock} [payment_selection_lock]
833
- * @property {boolean} [restrict_checkout]
834
- * @property {SharedCartDetails} [shared_cart_details]
835
- * @property {string} [uid]
883
+ * @typedef CurrencyInfo
884
+ * @property {string} [code]
885
+ * @property {string} [symbol]
836
886
  */
837
887
  /**
838
- * @typedef SharedCartDetails
839
- * @property {string} [created_on]
840
- * @property {Object} [meta] - Meta data sent while generating share cart link
841
- * @property {Object} [source] - Share link device and other source information
842
- * @property {string} [token] - Short link id
843
- * @property {Object} [user] - User details of who generated share link
888
+ * @typedef LadderPriceOffers
889
+ * @property {LadderPriceOffer[]} [available_offers]
890
+ * @property {CurrencyInfo} [currency]
844
891
  */
845
892
  /**
846
- * @typedef SharedCartResponse
847
- * @property {SharedCart} [cart]
848
- * @property {string} [error]
893
+ * @typedef PaymentMeta
894
+ * @property {string} [merchant_code]
895
+ * @property {string} [type]
896
+ * @property {string} [payment_gateway]
897
+ * @property {string} [payment_identifier]
849
898
  */
850
899
  /**
851
- * @typedef ShipmentPromise
852
- * @property {PromiseFormatted} [formatted]
853
- * @property {PromiseISOFormat} [iso]
854
- * @property {PromiseTimestamp} [timestamp]
900
+ * @typedef PaymentMethod
901
+ * @property {PaymentMeta} payment_meta
902
+ * @property {string} mode
903
+ * @property {string} [payment]
904
+ * @property {number} [amount]
905
+ * @property {string} [name]
906
+ * @property {Object} [payment_extra_identifiers]
855
907
  */
856
908
  /**
857
- * @typedef ShipmentResponse
858
- * @property {string} [box_type]
859
- * @property {string} [dp_id]
860
- * @property {Object} [dp_options]
861
- * @property {number} [fulfillment_id]
862
- * @property {string} [fulfillment_type]
863
- * @property {CartProductInfo[]} [items]
864
- * @property {string} [order_type]
865
- * @property {ShipmentPromise} [promise]
866
- * @property {string} [shipment_type]
867
- * @property {number} [shipments]
868
- */
869
- /**
870
- * @typedef StaffCheckout
871
- * @property {string} _id
872
- * @property {string} [employee_code]
873
- * @property {string} first_name
874
- * @property {string} last_name
875
- * @property {string} user
876
- */
877
- /**
878
- * @typedef StoreInfo
879
- * @property {string} [name]
880
- * @property {string} [store_code]
881
- * @property {number} [uid]
882
- */
883
- /**
884
- * @typedef Tags
885
- * @property {Object} [tags]
886
- */
887
- /**
888
- * @typedef UpdateAddressResponse
909
+ * @typedef CartCheckoutDetailV2Request
910
+ * @property {Object} [custom_meta]
911
+ * @property {Object} [customer_details] - Customer details
912
+ * @property {string} [merchant_code]
913
+ * @property {string} [cart_id]
889
914
  * @property {string} [id]
890
- * @property {boolean} [is_default_address]
891
- * @property {boolean} [is_updated]
892
- * @property {boolean} [success]
893
- */
894
- /**
895
- * @typedef UpdateCartDetailResponse
896
- * @property {CartDetailResponse} [cart]
897
- * @property {string} [message]
898
- * @property {boolean} [success] - True if all items are added successfully.
899
- * False if partially added or not added.
900
- */
901
- /**
902
- * @typedef UpdateCartPaymentRequest
915
+ * @property {boolean} [payment_auto_confirm]
916
+ * @property {PaymentMethod[]} payment_methods
917
+ * @property {string} payment_mode
918
+ * @property {string} [aggregator]
903
919
  * @property {string} [address_id]
904
- * @property {string} [aggregator_name]
905
- * @property {string} [id]
906
- * @property {string} [merchant_code]
907
- * @property {string} [payment_identifier]
908
- * @property {string} [payment_mode]
909
- */
910
- /**
911
- * @typedef UpdateCartRequest
912
- * @property {UpdateProductCart[]} [items]
913
- * @property {string} operation
914
- */
915
- /**
916
- * @typedef UpdateProductCart
917
- * @property {Object} [_custom_json]
918
- * @property {string} [article_id]
920
+ * @property {string} [callback_url]
921
+ * @property {Object} [delivery_address]
922
+ * @property {StaffCheckout} [staff]
923
+ * @property {string} [order_type]
924
+ * @property {number} [ordering_store]
919
925
  * @property {Object} [extra_meta]
920
- * @property {CartProductIdentifer} identifiers
921
- * @property {number} [item_id]
922
- * @property {number} [item_index]
923
- * @property {string} [item_size]
926
+ * @property {string} [payment_identifier]
927
+ * @property {Object} [billing_address]
928
+ * @property {Object} [payment_params]
929
+ * @property {string} [billing_address_id]
924
930
  * @property {Object} [meta]
925
- * @property {Object} [parent_item_identifiers]
926
- * @property {number} [quantity]
931
+ * @property {string} [iin]
932
+ * @property {string} [network]
933
+ * @property {string} [type]
934
+ * @property {string} [card_id]
927
935
  */
928
936
  declare class CartApplicationModel {
929
937
  }
930
938
  declare namespace CartApplicationModel {
931
- export { ActionQuery, AddCartDetailResponse, AddCartRequest, AddProductCart, Address, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, ArticleGiftDetail, ArticlePriceInfo, BaseInfo, BasePrice, BulkPriceOffer, BulkPriceResponse, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutDetailRequest, CartCheckoutDetailV2Request, CartCheckoutResponse, CartCommonConfig, CartCurrency, CartDetailCoupon, CartDetailResponse, CartItemCountResponse, CartMetaMissingResponse, CartMetaRequest, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CartShipmentsResponse, CategoryInfo, Charges, ChargesAmount, ChargesThreshold, CheckCart, Coupon, CouponBreakup, CouponDetails, CouponValidity, CurrencyInfo, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DeliveryChargesConfig, DiscountRulesApp, DisplayBreakup, FreeGiftItem, FreeGiftItems, GeoLocation, GetAddressesResponse, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, GiftDetail, LadderOfferItem, LadderPrice, LadderPriceOffer, LadderPriceOffers, LoyaltyPoints, OfferItem, OfferPrice, OfferSeller, OperationErrorResponse, Ownership, PageCoupon, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentSelectionLock, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, PromoMeta, PromotionOffer, PromotionOffersResponse, RawBreakup, RewardPointRequest, SaveAddressResponse, SelectCartAddressRequest, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentPromise, ShipmentResponse, StaffCheckout, StoreInfo, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartRequest, UpdateProductCart };
939
+ export { BuyRules, DiscountRulesApp, Ownership, FreeGiftItem, AppliedFreeArticles, AppliedPromotion, PaymentSelectionLock, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, BasePrice, ArticlePriceInfo, BaseInfo, StoreInfo, ProductArticle, CartProductIdentifer, PromoMeta, ChargesAmount, Charges, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, ProductAvailabilitySize, ProductAvailability, ActionQuery, ProductAction, Tags, ProductImage, CategoryInfo, CartProduct, CouponDetails, CartProductInfo, DisplayBreakup, RawBreakup, CouponBreakup, LoyaltyPoints, CartBreakup, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, DeleteCartDetailResponse, CartItemCountResponse, PageCoupon, Coupon, GetCouponResponse, ApplyCouponRequest, OfferPrice, OfferItem, OfferSeller, BulkPriceOffer, BulkPriceResponse, RewardPointRequest, GeoLocation, Address, GetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, SelectCartAddressRequest, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, ShipmentResponse, CartShipmentsResponse, CartCheckoutCustomMeta, CustomerDetails, StaffCheckout, CartCheckoutDetailRequest, CheckCart, CartCheckoutResponse, GiftDetail, ArticleGiftDetail, CartMetaRequest, CartMetaResponse, CartMetaMissingResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, FreeGiftItems, PromotionOffer, PromotionOffersResponse, OperationErrorResponse, LadderPrice, LadderOfferItem, LadderPriceOffer, CurrencyInfo, LadderPriceOffers, PaymentMeta, PaymentMethod, CartCheckoutDetailV2Request };
932
940
  }
933
- /** @returns {ActionQuery} */
934
- declare function ActionQuery(): ActionQuery;
935
- type ActionQuery = {
941
+ /** @returns {BuyRules} */
942
+ declare function BuyRules(): BuyRules;
943
+ type BuyRules = {
936
944
  /**
937
- * - Contains list of product slug
945
+ * - Item criteria of promotion
938
946
  */
939
- product_slug?: string[];
947
+ item_criteria?: any;
948
+ /**
949
+ * - Cart conditions details for promotion
950
+ */
951
+ cart_conditions?: any;
940
952
  };
941
- /** @returns {AddCartDetailResponse} */
942
- declare function AddCartDetailResponse(): AddCartDetailResponse;
943
- type AddCartDetailResponse = {
944
- cart?: CartDetailResponse;
945
- message?: string;
953
+ /** @returns {DiscountRulesApp} */
954
+ declare function DiscountRulesApp(): DiscountRulesApp;
955
+ type DiscountRulesApp = {
946
956
  /**
947
- * - When adding multiple items check if all
948
- * added. True if only few are added.
957
+ * - Matched buy rules for promotion
949
958
  */
950
- partial?: boolean;
959
+ matched_buy_rules?: string[];
951
960
  /**
952
- * - True if all items are added successfully.
953
- * False if partially added or not added.
961
+ * - Raw offer details for promotion
954
962
  */
955
- success?: boolean;
956
- };
957
- /** @returns {AddCartRequest} */
958
- declare function AddCartRequest(): AddCartRequest;
959
- type AddCartRequest = {
960
- items?: AddProductCart[];
961
- new_cart?: boolean;
963
+ raw_offer?: any;
964
+ /**
965
+ * - Offer for promotion
966
+ */
967
+ offer?: any;
968
+ /**
969
+ * - Item criteria of promotion
970
+ */
971
+ item_criteria?: any;
962
972
  };
963
- /** @returns {AddProductCart} */
964
- declare function AddProductCart(): AddProductCart;
965
- type AddProductCart = {
966
- _custom_json?: any;
967
- article_assignment?: any;
968
- article_id?: string;
969
- display?: string;
970
- extra_meta?: any;
971
- item_id?: number;
972
- item_size?: string;
973
- meta?: any;
974
- parent_item_identifiers?: any[];
975
- pos?: boolean;
976
- product_group_tags?: string[];
977
- quantity?: number;
978
- seller_id?: number;
973
+ /** @returns {Ownership} */
974
+ declare function Ownership(): Ownership;
975
+ type Ownership = {
979
976
  /**
980
- * - Add items using seller identifier for store os
977
+ * - Promo amount payable category
981
978
  */
982
- seller_identifier?: string;
983
- store_id?: number;
979
+ payable_category?: string;
980
+ /**
981
+ * - Promo amount bearable party
982
+ */
983
+ payable_by?: string;
984
984
  };
985
- /** @returns {Address} */
986
- declare function Address(): Address;
987
- type Address = {
988
- _custom_json?: any;
989
- address?: string;
990
- address_type?: string;
991
- area?: string;
992
- area_code?: string;
993
- area_code_slug?: string;
994
- checkout_mode?: string;
995
- city?: string;
996
- country?: string;
997
- country_code?: string;
998
- country_iso_code?: string;
999
- country_phone_code?: string;
1000
- created_by_user_id?: string;
1001
- email?: string;
1002
- geo_location?: GeoLocation;
1003
- google_map_point?: any;
1004
- id?: string;
1005
- is_active?: boolean;
1006
- is_default_address?: boolean;
1007
- landmark?: string;
1008
- meta?: any;
1009
- name?: string;
1010
- phone?: string;
1011
- sector?: string;
1012
- state?: string;
985
+ /** @returns {FreeGiftItem} */
986
+ declare function FreeGiftItem(): FreeGiftItem;
987
+ type FreeGiftItem = {
1013
988
  /**
1014
- * - State code for international address
989
+ * - Item slug
1015
990
  */
1016
- state_code?: string;
1017
- tags?: string[];
1018
- user_id?: string;
991
+ item_slug?: string;
992
+ /**
993
+ * - Item name
994
+ */
995
+ item_name?: string;
996
+ /**
997
+ * - Item price details
998
+ */
999
+ item_price_details?: any;
1000
+ /**
1001
+ * - Item brand name
1002
+ */
1003
+ item_brand_name?: string;
1004
+ /**
1005
+ * - Item id
1006
+ */
1007
+ item_id?: number;
1008
+ /**
1009
+ * - Item images URL
1010
+ */
1011
+ item_images_url?: string[];
1019
1012
  };
1020
1013
  /** @returns {AppliedFreeArticles} */
1021
1014
  declare function AppliedFreeArticles(): AppliedFreeArticles;
1022
1015
  type AppliedFreeArticles = {
1023
- /**
1024
- * - Free article id
1025
- */
1026
- article_id?: string;
1027
1016
  /**
1028
1017
  * - Free gift items details
1029
1018
  */
@@ -1036,82 +1025,119 @@ type AppliedFreeArticles = {
1036
1025
  * - Free article quantity
1037
1026
  */
1038
1027
  quantity?: number;
1028
+ /**
1029
+ * - Free article id
1030
+ */
1031
+ article_id?: string;
1039
1032
  };
1040
1033
  /** @returns {AppliedPromotion} */
1041
1034
  declare function AppliedPromotion(): AppliedPromotion;
1042
1035
  type AppliedPromotion = {
1043
1036
  /**
1044
- * - Per unit discount amount applied with current promotion
1045
- */
1046
- amount?: number;
1047
- /**
1048
- * - Applied free
1049
- * article for free gift item promotions
1050
- */
1051
- applied_free_articles?: AppliedFreeArticles[];
1052
- /**
1053
- * - Quantity of article on which
1054
- * promotion is applicable
1037
+ * - Promotion id
1055
1038
  */
1056
- article_quantity?: number;
1039
+ promo_id?: string;
1057
1040
  /**
1058
1041
  * - Buy rules for promotions
1059
1042
  */
1060
1043
  buy_rules?: BuyRules[];
1061
1044
  /**
1062
- * - Promotion code
1063
- */
1064
- code?: string;
1065
- /**
1066
- * - Discount rules for promotions
1045
+ * - Offer text of current promotion
1067
1046
  */
1068
- discount_rules?: DiscountRulesApp[];
1047
+ offer_text?: string;
1069
1048
  /**
1070
- * - Meta object for extra data
1049
+ * - Promotion group for the promotion
1071
1050
  */
1072
- meta?: any;
1051
+ promotion_group?: string;
1073
1052
  /**
1074
1053
  * - If applied promotion is applied on
1075
1054
  * product MRP or ESP
1076
1055
  */
1077
1056
  mrp_promotion?: boolean;
1078
1057
  /**
1079
- * - Offer text of current promotion
1058
+ * - Promotion name of current promotion
1080
1059
  */
1081
- offer_text?: string;
1060
+ promotion_name?: string;
1082
1061
  /**
1083
- * - Ownership of promotion
1062
+ * - Per unit discount amount applied with current promotion
1084
1063
  */
1085
- ownership?: Ownership;
1064
+ amount?: number;
1086
1065
  /**
1087
- * - Promotion id
1066
+ * - Discount rules for promotions
1088
1067
  */
1089
- promo_id?: string;
1068
+ discount_rules?: DiscountRulesApp[];
1090
1069
  /**
1091
- * - Promotion group for the promotion
1070
+ * - Ownership of promotion
1092
1071
  */
1093
- promotion_group?: string;
1072
+ ownership?: Ownership;
1094
1073
  /**
1095
- * - Promotion name of current promotion
1074
+ * - Quantity of article on which
1075
+ * promotion is applicable
1096
1076
  */
1097
- promotion_name?: string;
1077
+ article_quantity?: number;
1078
+ /**
1079
+ * - Applied free
1080
+ * article for free gift item promotions
1081
+ */
1082
+ applied_free_articles?: AppliedFreeArticles[];
1098
1083
  /**
1099
1084
  * - Promotion type of current promotion
1100
1085
  */
1101
1086
  promotion_type?: string;
1087
+ /**
1088
+ * - Meta object for extra data
1089
+ */
1090
+ meta?: any;
1091
+ /**
1092
+ * - Promotion code
1093
+ */
1094
+ code?: string;
1102
1095
  };
1103
- /** @returns {ApplyCouponRequest} */
1104
- declare function ApplyCouponRequest(): ApplyCouponRequest;
1105
- type ApplyCouponRequest = {
1096
+ /** @returns {PaymentSelectionLock} */
1097
+ declare function PaymentSelectionLock(): PaymentSelectionLock;
1098
+ type PaymentSelectionLock = {
1099
+ enabled?: boolean;
1100
+ default_options?: string;
1101
+ payment_identifier?: string;
1102
+ };
1103
+ /** @returns {PromiseFormatted} */
1104
+ declare function PromiseFormatted(): PromiseFormatted;
1105
+ type PromiseFormatted = {
1106
+ max?: string;
1107
+ min?: string;
1108
+ };
1109
+ /** @returns {PromiseISOFormat} */
1110
+ declare function PromiseISOFormat(): PromiseISOFormat;
1111
+ type PromiseISOFormat = {
1106
1112
  /**
1107
- * - Coupon code to be applied
1113
+ * - Max promise in ISO format.
1108
1114
  */
1109
- coupon_code: string;
1115
+ max?: string;
1116
+ /**
1117
+ * - Min Promise in ISO format.
1118
+ */
1119
+ min?: string;
1110
1120
  };
1111
- /** @returns {ArticleGiftDetail} */
1112
- declare function ArticleGiftDetail(): ArticleGiftDetail;
1113
- type ArticleGiftDetail = {
1114
- article_id?: GiftDetail;
1121
+ /** @returns {PromiseTimestamp} */
1122
+ declare function PromiseTimestamp(): PromiseTimestamp;
1123
+ type PromiseTimestamp = {
1124
+ max?: number;
1125
+ min?: number;
1126
+ };
1127
+ /** @returns {ShipmentPromise} */
1128
+ declare function ShipmentPromise(): ShipmentPromise;
1129
+ type ShipmentPromise = {
1130
+ formatted?: PromiseFormatted;
1131
+ timestamp?: PromiseTimestamp;
1132
+ iso?: PromiseISOFormat;
1133
+ };
1134
+ /** @returns {BasePrice} */
1135
+ declare function BasePrice(): BasePrice;
1136
+ type BasePrice = {
1137
+ effective?: number;
1138
+ currency_symbol?: string;
1139
+ marked?: number;
1140
+ currency_code?: string;
1115
1141
  };
1116
1142
  /** @returns {ArticlePriceInfo} */
1117
1143
  declare function ArticlePriceInfo(): ArticlePriceInfo;
@@ -1122,346 +1148,324 @@ type ArticlePriceInfo = {
1122
1148
  /** @returns {BaseInfo} */
1123
1149
  declare function BaseInfo(): BaseInfo;
1124
1150
  type BaseInfo = {
1125
- name?: string;
1126
1151
  uid?: number;
1152
+ name?: string;
1127
1153
  };
1128
- /** @returns {BasePrice} */
1129
- declare function BasePrice(): BasePrice;
1130
- type BasePrice = {
1131
- currency_code?: string;
1132
- currency_symbol?: string;
1133
- effective?: number;
1134
- marked?: number;
1154
+ /** @returns {StoreInfo} */
1155
+ declare function StoreInfo(): StoreInfo;
1156
+ type StoreInfo = {
1157
+ store_code?: string;
1158
+ uid?: number;
1159
+ name?: string;
1135
1160
  };
1136
- /** @returns {BulkPriceOffer} */
1137
- declare function BulkPriceOffer(): BulkPriceOffer;
1138
- type BulkPriceOffer = {
1139
- offers?: OfferItem[];
1140
- seller?: OfferSeller;
1161
+ /** @returns {ProductArticle} */
1162
+ declare function ProductArticle(): ProductArticle;
1163
+ type ProductArticle = {
1164
+ price?: ArticlePriceInfo;
1165
+ product_group_tags?: string[];
1166
+ extra_meta?: any;
1167
+ quantity?: number;
1168
+ _custom_json?: any;
1169
+ meta?: any;
1170
+ size?: string;
1171
+ mto_quantity?: number;
1172
+ seller?: BaseInfo;
1173
+ seller_identifier?: string;
1174
+ parent_item_identifiers?: any;
1175
+ identifier?: any;
1176
+ store?: StoreInfo;
1177
+ cart_item_meta?: any;
1178
+ uid?: string;
1179
+ gift_card?: any;
1180
+ is_gift_visible?: boolean;
1181
+ type?: string;
1182
+ /**
1183
+ * - A list of article tags
1184
+ */
1185
+ tags?: string[];
1141
1186
  };
1142
- /** @returns {BulkPriceResponse} */
1143
- declare function BulkPriceResponse(): BulkPriceResponse;
1144
- type BulkPriceResponse = {
1187
+ /** @returns {CartProductIdentifer} */
1188
+ declare function CartProductIdentifer(): CartProductIdentifer;
1189
+ type CartProductIdentifer = {
1145
1190
  /**
1146
- * - Consist of offers from multiple seller
1191
+ * - Article idenfier generated by cart
1147
1192
  */
1148
- data?: BulkPriceOffer[];
1193
+ identifier?: string;
1149
1194
  };
1150
- /** @returns {BuyRules} */
1151
- declare function BuyRules(): BuyRules;
1152
- type BuyRules = {
1195
+ /** @returns {PromoMeta} */
1196
+ declare function PromoMeta(): PromoMeta;
1197
+ type PromoMeta = {
1198
+ message?: string;
1199
+ };
1200
+ /** @returns {ChargesAmount} */
1201
+ declare function ChargesAmount(): ChargesAmount;
1202
+ type ChargesAmount = {
1153
1203
  /**
1154
- * - Cart conditions details for promotion
1204
+ * - This is the value of amount added
1155
1205
  */
1156
- cart_conditions?: any;
1206
+ value?: number;
1157
1207
  /**
1158
- * - Item criteria of promotion
1208
+ * - This is destination currency of value
1159
1209
  */
1160
- item_criteria?: any;
1161
- };
1162
- /** @returns {CartBreakup} */
1163
- declare function CartBreakup(): CartBreakup;
1164
- type CartBreakup = {
1165
- coupon?: CouponBreakup;
1166
- display?: DisplayBreakup[];
1167
- loyalty_points?: LoyaltyPoints;
1168
- raw?: RawBreakup;
1169
- };
1170
- /** @returns {CartCheckoutCustomMeta} */
1171
- declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1172
- type CartCheckoutCustomMeta = {
1173
- key: string;
1174
- value: string;
1210
+ currency?: string;
1175
1211
  };
1176
- /** @returns {CartCheckoutDetailRequest} */
1177
- declare function CartCheckoutDetailRequest(): CartCheckoutDetailRequest;
1178
- type CartCheckoutDetailRequest = {
1179
- address_id?: string;
1180
- aggregator?: string;
1181
- billing_address?: any;
1182
- billing_address_id?: string;
1183
- callback_url?: string;
1184
- custom_meta?: CartCheckoutCustomMeta[];
1212
+ /** @returns {Charges} */
1213
+ declare function Charges(): Charges;
1214
+ type Charges = {
1185
1215
  /**
1186
- * - Customer details
1216
+ * - This object contains the meta data realted to
1217
+ * charges price adjustment
1187
1218
  */
1188
- customer_details?: any;
1189
- delivery_address?: any;
1190
- extra_meta?: any;
1191
- id?: string;
1192
- merchant_code?: string;
1193
1219
  meta?: any;
1194
- order_type?: string;
1195
- ordering_store?: number;
1196
- payment_auto_confirm?: boolean;
1197
- payment_extra_identifiers?: any;
1198
- payment_identifier?: string;
1199
- payment_mode: string;
1200
- payment_params?: any;
1201
- staff?: StaffCheckout;
1202
- };
1203
- /** @returns {CartCheckoutDetailV2Request} */
1204
- declare function CartCheckoutDetailV2Request(): CartCheckoutDetailV2Request;
1205
- type CartCheckoutDetailV2Request = {
1206
- address_id?: string;
1207
- aggregator?: string;
1208
- billing_address?: any;
1209
- billing_address_id?: string;
1210
- callback_url?: string;
1211
- cart_id?: string;
1212
- custom_meta?: any;
1220
+ amount?: ChargesAmount;
1213
1221
  /**
1214
- * - Customer details
1222
+ * - This is the name of the charge applied
1215
1223
  */
1216
- customer_details?: any;
1217
- delivery_address?: any;
1218
- extra_meta?: any;
1219
- id?: string;
1220
- merchant_code?: string;
1221
- meta?: any;
1222
- order_type?: string;
1223
- ordering_store?: number;
1224
- payment_auto_confirm?: boolean;
1225
- payment_identifier?: string;
1226
- payment_methods: PaymentMethod[];
1227
- payment_mode: string;
1228
- payment_params?: any;
1229
- staff?: StaffCheckout;
1230
- };
1231
- /** @returns {CartCheckoutResponse} */
1232
- declare function CartCheckoutResponse(): CartCheckoutResponse;
1233
- type CartCheckoutResponse = {
1234
- app_intercept_url?: string;
1235
- callback_url?: string;
1236
- cart?: CheckCart;
1237
- data?: any;
1238
- message?: string;
1239
- order_id?: string;
1240
- payment_confirm_url?: string;
1241
- success?: boolean;
1242
- };
1243
- /** @returns {CartCommonConfig} */
1244
- declare function CartCommonConfig(): CartCommonConfig;
1245
- type CartCommonConfig = {
1246
- delivery_charges_config?: DeliveryChargesConfig;
1247
- };
1248
- /** @returns {CartCurrency} */
1249
- declare function CartCurrency(): CartCurrency;
1250
- type CartCurrency = {
1224
+ name?: string;
1251
1225
  /**
1252
- * - Currency code defined by ISO 4217:2015
1226
+ * - This boolean value defines that refund
1227
+ * is allowed or not for the charge
1228
+ */
1229
+ allow_refund?: boolean;
1230
+ /**
1231
+ * - This is the code of the charge applied
1253
1232
  */
1254
1233
  code?: string;
1255
- symbol?: string;
1234
+ /**
1235
+ * - This is the type of the charge applied
1236
+ */
1237
+ type?: string;
1256
1238
  };
1257
- /** @returns {CartDetailCoupon} */
1258
- declare function CartDetailCoupon(): CartDetailCoupon;
1259
- type CartDetailCoupon = {
1260
- cashback_amount?: number;
1261
- cashback_message_primary?: string;
1262
- cashback_message_secondary?: string;
1263
- coupon_code?: string;
1264
- coupon_description?: string;
1265
- coupon_id?: string;
1266
- coupon_subtitle?: string;
1267
- coupon_title?: string;
1268
- coupon_type?: string;
1269
- coupon_value?: number;
1270
- discount?: number;
1271
- is_applied?: boolean;
1272
- is_valid?: boolean;
1273
- maximum_discount_value?: number;
1274
- message?: string;
1275
- minimum_cart_value?: number;
1239
+ /** @returns {ProductPrice} */
1240
+ declare function ProductPrice(): ProductPrice;
1241
+ type ProductPrice = {
1242
+ currency_symbol?: string;
1243
+ selling?: number;
1244
+ currency_code?: string;
1245
+ add_on?: number;
1246
+ effective?: number;
1247
+ marked?: number;
1276
1248
  };
1277
- /** @returns {CartDetailResponse} */
1278
- declare function CartDetailResponse(): CartDetailResponse;
1279
- type CartDetailResponse = {
1280
- applied_promo_details?: AppliedPromotion[];
1281
- breakup_values?: CartBreakup;
1282
- buy_now?: boolean;
1283
- cart_id?: number;
1284
- checkout_mode?: string;
1285
- comment?: string;
1286
- common_config?: CartCommonConfig;
1287
- coupon?: CartDetailCoupon;
1288
- coupon_text?: string;
1289
- currency?: CartCurrency;
1290
- delivery_charge_info?: string;
1291
- delivery_promise?: ShipmentPromise;
1292
- gstin?: string;
1293
- id?: string;
1249
+ /** @returns {ProductPriceInfo} */
1250
+ declare function ProductPriceInfo(): ProductPriceInfo;
1251
+ type ProductPriceInfo = {
1252
+ base?: ProductPrice;
1253
+ converted?: ProductPrice;
1254
+ };
1255
+ /** @returns {ProductPricePerUnit} */
1256
+ declare function ProductPricePerUnit(): ProductPricePerUnit;
1257
+ type ProductPricePerUnit = {
1258
+ currency_symbol?: string;
1259
+ selling_price?: number;
1260
+ currency_code?: string;
1261
+ add_on?: number;
1262
+ effective?: number;
1263
+ marked?: number;
1264
+ };
1265
+ /** @returns {ProductPricePerUnitInfo} */
1266
+ declare function ProductPricePerUnitInfo(): ProductPricePerUnitInfo;
1267
+ type ProductPricePerUnitInfo = {
1268
+ base?: ProductPricePerUnit;
1269
+ converted?: ProductPricePerUnit;
1270
+ };
1271
+ /** @returns {ProductAvailabilitySize} */
1272
+ declare function ProductAvailabilitySize(): ProductAvailabilitySize;
1273
+ type ProductAvailabilitySize = {
1274
+ display?: string;
1275
+ value?: string;
1276
+ is_available?: boolean;
1277
+ };
1278
+ /** @returns {ProductAvailability} */
1279
+ declare function ProductAvailability(): ProductAvailability;
1280
+ type ProductAvailability = {
1281
+ out_of_stock?: boolean;
1282
+ deliverable?: boolean;
1283
+ available_sizes?: ProductAvailabilitySize[];
1294
1284
  is_valid?: boolean;
1295
- items?: CartProductInfo[];
1296
- last_modified?: string;
1297
- message?: string;
1298
- notification?: any;
1299
- pan_config?: any;
1300
- pan_no?: string;
1301
- payment_selection_lock?: PaymentSelectionLock;
1302
- restrict_checkout?: boolean;
1303
- staff_user_id?: string;
1304
- success?: boolean;
1305
- uid?: string;
1285
+ other_store_quantity?: number;
1286
+ sizes?: string[];
1306
1287
  };
1307
- /** @returns {CartItemCountResponse} */
1308
- declare function CartItemCountResponse(): CartItemCountResponse;
1309
- type CartItemCountResponse = {
1288
+ /** @returns {ActionQuery} */
1289
+ declare function ActionQuery(): ActionQuery;
1290
+ type ActionQuery = {
1310
1291
  /**
1311
- * - Item count present in cart
1292
+ * - Contains list of product slug
1312
1293
  */
1313
- user_cart_items_count?: number;
1294
+ product_slug?: string[];
1314
1295
  };
1315
- /** @returns {CartMetaMissingResponse} */
1316
- declare function CartMetaMissingResponse(): CartMetaMissingResponse;
1317
- type CartMetaMissingResponse = {
1318
- errors?: string[];
1296
+ /** @returns {ProductAction} */
1297
+ declare function ProductAction(): ProductAction;
1298
+ type ProductAction = {
1299
+ query?: ActionQuery;
1300
+ url?: string;
1301
+ type?: string;
1319
1302
  };
1320
- /** @returns {CartMetaRequest} */
1321
- declare function CartMetaRequest(): CartMetaRequest;
1322
- type CartMetaRequest = {
1323
- checkout_mode?: string;
1324
- comment?: string;
1325
- delivery_slots?: any;
1326
- gift_details?: ArticleGiftDetail;
1327
- gstin?: string;
1303
+ /** @returns {Tags} */
1304
+ declare function Tags(): Tags;
1305
+ type Tags = {
1306
+ tags?: any;
1307
+ };
1308
+ /** @returns {ProductImage} */
1309
+ declare function ProductImage(): ProductImage;
1310
+ type ProductImage = {
1311
+ secure_url?: string;
1312
+ aspect_ratio?: string;
1313
+ url?: string;
1314
+ };
1315
+ /** @returns {CategoryInfo} */
1316
+ declare function CategoryInfo(): CategoryInfo;
1317
+ type CategoryInfo = {
1328
1318
  /**
1329
- * - Customer contact details for
1330
- * customer pickup at store
1319
+ * - Product Category Id
1331
1320
  */
1332
- pick_up_customer_details?: any;
1333
- };
1334
- /** @returns {CartMetaResponse} */
1335
- declare function CartMetaResponse(): CartMetaResponse;
1336
- type CartMetaResponse = {
1337
- is_valid?: boolean;
1338
- message?: string;
1321
+ uid?: number;
1322
+ name?: string;
1339
1323
  };
1340
1324
  /** @returns {CartProduct} */
1341
1325
  declare function CartProduct(): CartProduct;
1342
1326
  type CartProduct = {
1343
1327
  _custom_json?: any;
1344
- action?: ProductAction;
1345
- attributes?: any;
1346
1328
  brand?: BaseInfo;
1347
- categories?: CategoryInfo[];
1348
- images?: ProductImage[];
1349
- item_code?: string;
1350
- name?: string;
1329
+ action?: ProductAction;
1330
+ teaser_tag?: Tags;
1351
1331
  /**
1352
1332
  * - Unique product url name generated via product
1353
1333
  * name and other meta data
1354
1334
  */
1355
1335
  slug?: string;
1336
+ images?: ProductImage[];
1337
+ uid?: number;
1338
+ name?: string;
1339
+ item_code?: string;
1340
+ categories?: CategoryInfo[];
1356
1341
  tags?: string[];
1357
- teaser_tag?: Tags;
1358
1342
  type?: string;
1359
- uid?: number;
1343
+ attributes?: any;
1360
1344
  };
1361
- /** @returns {CartProductIdentifer} */
1362
- declare function CartProductIdentifer(): CartProductIdentifer;
1363
- type CartProductIdentifer = {
1364
- /**
1365
- * - Article idenfier generated by cart
1366
- */
1367
- identifier?: string;
1345
+ /** @returns {CouponDetails} */
1346
+ declare function CouponDetails(): CouponDetails;
1347
+ type CouponDetails = {
1348
+ discount_single_quantity?: number;
1349
+ code?: string;
1350
+ discount_total_quantity?: number;
1368
1351
  };
1369
1352
  /** @returns {CartProductInfo} */
1370
1353
  declare function CartProductInfo(): CartProductInfo;
1371
1354
  type CartProductInfo = {
1372
1355
  article?: ProductArticle;
1356
+ moq?: any;
1357
+ identifiers: CartProductIdentifer;
1358
+ promo_meta?: PromoMeta;
1359
+ price?: ProductPriceInfo;
1360
+ quantity?: number;
1361
+ charges?: Charges[];
1362
+ discount?: string;
1373
1363
  availability?: ProductAvailability;
1364
+ delivery_promise?: ShipmentPromise;
1365
+ product?: CartProduct;
1366
+ product_ean_id?: string;
1374
1367
  bulk_offer?: any;
1375
- charges?: Charges[];
1368
+ parent_item_identifiers?: any;
1376
1369
  coupon?: CouponDetails;
1377
- coupon_message?: string;
1378
1370
  custom_order?: any;
1379
- delivery_promise?: ShipmentPromise;
1380
- discount?: string;
1381
- identifiers: CartProductIdentifer;
1382
- is_set?: boolean;
1371
+ coupon_message?: string;
1383
1372
  key?: string;
1384
1373
  message?: string;
1385
- moq?: any;
1386
- parent_item_identifiers?: any;
1387
- price?: ProductPriceInfo;
1374
+ is_set?: boolean;
1388
1375
  price_per_unit?: ProductPricePerUnitInfo;
1389
- product?: CartProduct;
1390
- product_ean_id?: string;
1391
- promo_meta?: PromoMeta;
1392
1376
  promotions_applied?: AppliedPromotion[];
1393
- quantity?: number;
1394
- };
1395
- /** @returns {CartShipmentsResponse} */
1396
- declare function CartShipmentsResponse(): CartShipmentsResponse;
1397
- type CartShipmentsResponse = {
1398
- breakup_values?: CartBreakup;
1399
- buy_now?: boolean;
1400
- cart_id?: number;
1401
- checkout_mode?: string;
1402
- comment?: string;
1403
- coupon_text?: string;
1404
- currency?: CartCurrency;
1405
- delivery_charge_info?: string;
1406
- delivery_promise?: ShipmentPromise;
1407
- error?: boolean;
1408
- gstin?: string;
1409
- id?: string;
1410
- is_valid?: boolean;
1411
- last_modified?: string;
1412
- message?: string;
1413
- payment_selection_lock?: PaymentSelectionLock;
1414
- restrict_checkout?: boolean;
1415
- shipments?: ShipmentResponse[];
1416
- uid?: string;
1417
1377
  };
1418
- /** @returns {CategoryInfo} */
1419
- declare function CategoryInfo(): CategoryInfo;
1420
- type CategoryInfo = {
1421
- name?: string;
1422
- /**
1423
- * - Product Category Id
1424
- */
1425
- uid?: number;
1378
+ /** @returns {DisplayBreakup} */
1379
+ declare function DisplayBreakup(): DisplayBreakup;
1380
+ type DisplayBreakup = {
1381
+ currency_symbol?: string;
1382
+ key?: string;
1383
+ display?: string;
1384
+ message?: string[];
1385
+ currency_code?: string;
1386
+ value?: number;
1387
+ preset?: number;
1426
1388
  };
1427
- /** @returns {Charges} */
1428
- declare function Charges(): Charges;
1429
- type Charges = {
1430
- /**
1431
- * - This boolean value defines that refund
1432
- * is allowed or not for the charge
1433
- */
1434
- allow_refund?: boolean;
1435
- amount?: ChargesAmount;
1436
- /**
1437
- * - This is the code of the charge applied
1438
- */
1439
- code?: string;
1440
- /**
1441
- * - This object contains the meta data realted to
1442
- * charges price adjustment
1443
- */
1444
- meta?: any;
1445
- /**
1446
- * - This is the name of the charge applied
1447
- */
1448
- name?: string;
1449
- /**
1450
- * - This is the type of the charge applied
1451
- */
1389
+ /** @returns {RawBreakup} */
1390
+ declare function RawBreakup(): RawBreakup;
1391
+ type RawBreakup = {
1392
+ vog?: number;
1393
+ subtotal?: number;
1394
+ fynd_cash?: number;
1395
+ discount?: number;
1396
+ convenience_fee?: number;
1397
+ delivery_charge?: number;
1398
+ gst_charges?: number;
1399
+ mrp_total?: number;
1400
+ mop_total?: number;
1401
+ total_charge?: number;
1402
+ coupon?: number;
1403
+ total?: number;
1404
+ gift_card?: number;
1405
+ you_saved?: number;
1406
+ cod_charge?: number;
1407
+ };
1408
+ /** @returns {CouponBreakup} */
1409
+ declare function CouponBreakup(): CouponBreakup;
1410
+ type CouponBreakup = {
1411
+ coupon_value?: number;
1412
+ title?: string;
1413
+ sub_title?: string;
1414
+ minimum_cart_value?: number;
1415
+ message?: string;
1416
+ coupon_type?: string;
1417
+ uid?: string;
1418
+ value?: number;
1419
+ max_discount_value?: number;
1420
+ is_applied?: boolean;
1421
+ description?: string;
1422
+ code?: string;
1452
1423
  type?: string;
1453
1424
  };
1454
- /** @returns {ChargesAmount} */
1455
- declare function ChargesAmount(): ChargesAmount;
1456
- type ChargesAmount = {
1457
- /**
1458
- * - This is destination currency of value
1459
- */
1460
- currency?: string;
1425
+ /** @returns {LoyaltyPoints} */
1426
+ declare function LoyaltyPoints(): LoyaltyPoints;
1427
+ type LoyaltyPoints = {
1428
+ total?: number;
1429
+ description?: string;
1430
+ applicable?: number;
1431
+ is_applied?: boolean;
1432
+ };
1433
+ /** @returns {CartBreakup} */
1434
+ declare function CartBreakup(): CartBreakup;
1435
+ type CartBreakup = {
1436
+ display?: DisplayBreakup[];
1437
+ raw?: RawBreakup;
1438
+ coupon?: CouponBreakup;
1439
+ loyalty_points?: LoyaltyPoints;
1440
+ };
1441
+ /** @returns {CartCurrency} */
1442
+ declare function CartCurrency(): CartCurrency;
1443
+ type CartCurrency = {
1461
1444
  /**
1462
- * - This is the value of amount added
1445
+ * - Currency code defined by ISO 4217:2015
1463
1446
  */
1464
- value?: number;
1447
+ code?: string;
1448
+ symbol?: string;
1449
+ };
1450
+ /** @returns {CartDetailCoupon} */
1451
+ declare function CartDetailCoupon(): CartDetailCoupon;
1452
+ type CartDetailCoupon = {
1453
+ cashback_amount?: number;
1454
+ cashback_message_primary?: string;
1455
+ cashback_message_secondary?: string;
1456
+ coupon_code?: string;
1457
+ coupon_description?: string;
1458
+ coupon_id?: string;
1459
+ coupon_subtitle?: string;
1460
+ coupon_title?: string;
1461
+ coupon_type?: string;
1462
+ coupon_value?: number;
1463
+ discount?: number;
1464
+ is_applied?: boolean;
1465
+ is_valid?: boolean;
1466
+ maximum_discount_value?: number;
1467
+ message?: string;
1468
+ minimum_cart_value?: number;
1465
1469
  };
1466
1470
  /** @returns {ChargesThreshold} */
1467
1471
  declare function ChargesThreshold(): ChargesThreshold;
@@ -1469,38 +1473,148 @@ type ChargesThreshold = {
1469
1473
  charges?: number;
1470
1474
  threshold?: number;
1471
1475
  };
1472
- /** @returns {CheckCart} */
1473
- declare function CheckCart(): CheckCart;
1474
- type CheckCart = {
1475
- breakup_values?: CartBreakup;
1476
- buy_now?: boolean;
1476
+ /** @returns {DeliveryChargesConfig} */
1477
+ declare function DeliveryChargesConfig(): DeliveryChargesConfig;
1478
+ type DeliveryChargesConfig = {
1479
+ enabled?: boolean;
1480
+ charges?: ChargesThreshold[];
1481
+ };
1482
+ /** @returns {CartCommonConfig} */
1483
+ declare function CartCommonConfig(): CartCommonConfig;
1484
+ type CartCommonConfig = {
1485
+ delivery_charges_config?: DeliveryChargesConfig;
1486
+ };
1487
+ /** @returns {CartDetailResponse} */
1488
+ declare function CartDetailResponse(): CartDetailResponse;
1489
+ type CartDetailResponse = {
1477
1490
  cart_id?: number;
1491
+ uid?: string;
1492
+ applied_promo_details?: AppliedPromotion[];
1478
1493
  checkout_mode?: string;
1479
- cod_available?: boolean;
1480
- cod_charges?: number;
1481
- cod_message?: string;
1494
+ pan_no?: string;
1495
+ is_valid?: boolean;
1496
+ id?: string;
1497
+ payment_selection_lock?: PaymentSelectionLock;
1498
+ delivery_promise?: ShipmentPromise;
1482
1499
  comment?: string;
1483
- coupon_text?: string;
1484
- currency?: CartCurrency;
1500
+ items?: CartProductInfo[];
1485
1501
  delivery_charge_info?: string;
1486
- delivery_charge_order_value?: number;
1487
- delivery_charges?: number;
1488
- delivery_promise?: ShipmentPromise;
1489
- error_message?: string;
1502
+ common_config?: CartCommonConfig;
1503
+ coupon?: CartDetailCoupon;
1504
+ message?: string;
1505
+ notification?: any;
1506
+ staff_user_id?: string;
1507
+ success?: boolean;
1490
1508
  gstin?: string;
1491
- id?: string;
1492
- is_valid?: boolean;
1493
- items?: CartProductInfo[];
1509
+ restrict_checkout?: boolean;
1494
1510
  last_modified?: string;
1511
+ breakup_values?: CartBreakup;
1512
+ currency?: CartCurrency;
1513
+ coupon_text?: string;
1514
+ buy_now?: boolean;
1515
+ pan_config?: any;
1516
+ };
1517
+ /** @returns {AddProductCart} */
1518
+ declare function AddProductCart(): AddProductCart;
1519
+ type AddProductCart = {
1520
+ article_assignment?: any;
1521
+ product_group_tags?: string[];
1522
+ extra_meta?: any;
1523
+ quantity?: number;
1524
+ _custom_json?: any;
1525
+ item_size?: string;
1526
+ store_id?: number;
1527
+ display?: string;
1528
+ article_id?: string;
1529
+ parent_item_identifiers?: any[];
1530
+ seller_id?: number;
1531
+ pos?: boolean;
1532
+ item_id?: number;
1533
+ meta?: any;
1534
+ /**
1535
+ * - Add items using seller identifier for store os
1536
+ */
1537
+ seller_identifier?: string;
1538
+ };
1539
+ /** @returns {AddCartRequest} */
1540
+ declare function AddCartRequest(): AddCartRequest;
1541
+ type AddCartRequest = {
1542
+ items?: AddProductCart[];
1543
+ new_cart?: boolean;
1544
+ };
1545
+ /** @returns {AddCartDetailResponse} */
1546
+ declare function AddCartDetailResponse(): AddCartDetailResponse;
1547
+ type AddCartDetailResponse = {
1495
1548
  message?: string;
1496
- order_id?: string;
1497
- payment_selection_lock?: PaymentSelectionLock;
1498
- restrict_checkout?: boolean;
1499
- store_code?: string;
1500
- store_emps?: any[];
1549
+ /**
1550
+ * - When adding multiple items check if all
1551
+ * added. True if only few are added.
1552
+ */
1553
+ partial?: boolean;
1554
+ cart?: CartDetailResponse;
1555
+ /**
1556
+ * - True if all items are added successfully.
1557
+ * False if partially added or not added.
1558
+ */
1501
1559
  success?: boolean;
1502
- uid?: string;
1503
- user_type?: string;
1560
+ };
1561
+ /** @returns {UpdateProductCart} */
1562
+ declare function UpdateProductCart(): UpdateProductCart;
1563
+ type UpdateProductCart = {
1564
+ extra_meta?: any;
1565
+ _custom_json?: any;
1566
+ quantity?: number;
1567
+ item_size?: string;
1568
+ item_index?: number;
1569
+ identifiers: CartProductIdentifer;
1570
+ article_id?: string;
1571
+ parent_item_identifiers?: any;
1572
+ item_id?: number;
1573
+ meta?: any;
1574
+ };
1575
+ /** @returns {UpdateCartRequest} */
1576
+ declare function UpdateCartRequest(): UpdateCartRequest;
1577
+ type UpdateCartRequest = {
1578
+ items?: UpdateProductCart[];
1579
+ operation: string;
1580
+ };
1581
+ /** @returns {UpdateCartDetailResponse} */
1582
+ declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
1583
+ type UpdateCartDetailResponse = {
1584
+ message?: string;
1585
+ cart?: CartDetailResponse;
1586
+ /**
1587
+ * - True if all items are added successfully.
1588
+ * False if partially added or not added.
1589
+ */
1590
+ success?: boolean;
1591
+ };
1592
+ /** @returns {DeleteCartDetailResponse} */
1593
+ declare function DeleteCartDetailResponse(): DeleteCartDetailResponse;
1594
+ type DeleteCartDetailResponse = {
1595
+ message?: string;
1596
+ /**
1597
+ * - True if cart is archived successfully. False
1598
+ * if not archived.
1599
+ */
1600
+ success?: boolean;
1601
+ };
1602
+ /** @returns {CartItemCountResponse} */
1603
+ declare function CartItemCountResponse(): CartItemCountResponse;
1604
+ type CartItemCountResponse = {
1605
+ /**
1606
+ * - Item count present in cart
1607
+ */
1608
+ user_cart_items_count?: number;
1609
+ };
1610
+ /** @returns {PageCoupon} */
1611
+ declare function PageCoupon(): PageCoupon;
1612
+ type PageCoupon = {
1613
+ total_item_count?: number;
1614
+ has_next?: boolean;
1615
+ total?: number;
1616
+ current?: number;
1617
+ has_previous?: boolean;
1504
1618
  };
1505
1619
  /** @returns {Coupon} */
1506
1620
  declare function Coupon(): Coupon;
@@ -1509,61 +1623,264 @@ type Coupon = {
1509
1623
  * - The amount based on cart value
1510
1624
  */
1511
1625
  coupon_amount?: number;
1512
- coupon_applicable_message?: string;
1513
- coupon_code?: string;
1514
- coupon_type?: string;
1515
1626
  coupon_value?: number;
1516
- description?: string;
1517
- end_date?: string;
1518
- expires_on?: string;
1519
- is_applicable?: boolean;
1520
- is_applied?: boolean;
1521
- max_discount_value?: number;
1522
- message?: string;
1627
+ title?: string;
1523
1628
  minimum_cart_value?: number;
1524
- start_date?: string;
1525
1629
  sub_title?: string;
1526
- title?: string;
1527
- };
1528
- /** @returns {CouponBreakup} */
1529
- declare function CouponBreakup(): CouponBreakup;
1530
- type CouponBreakup = {
1531
- code?: string;
1630
+ expires_on?: string;
1631
+ message?: string;
1532
1632
  coupon_type?: string;
1533
- coupon_value?: number;
1633
+ max_discount_value?: number;
1634
+ coupon_code?: string;
1635
+ is_applicable?: boolean;
1534
1636
  description?: string;
1535
1637
  is_applied?: boolean;
1536
- max_discount_value?: number;
1537
- message?: string;
1538
- minimum_cart_value?: number;
1539
- sub_title?: string;
1540
- title?: string;
1638
+ start_date?: string;
1639
+ end_date?: string;
1640
+ coupon_applicable_message?: string;
1641
+ };
1642
+ /** @returns {GetCouponResponse} */
1643
+ declare function GetCouponResponse(): GetCouponResponse;
1644
+ type GetCouponResponse = {
1645
+ page?: PageCoupon;
1646
+ available_coupon_list?: Coupon[];
1647
+ };
1648
+ /** @returns {ApplyCouponRequest} */
1649
+ declare function ApplyCouponRequest(): ApplyCouponRequest;
1650
+ type ApplyCouponRequest = {
1651
+ /**
1652
+ * - Coupon code to be applied
1653
+ */
1654
+ coupon_code: string;
1655
+ };
1656
+ /** @returns {OfferPrice} */
1657
+ declare function OfferPrice(): OfferPrice;
1658
+ type OfferPrice = {
1659
+ /**
1660
+ * - Currency symbol for currency
1661
+ */
1662
+ currency_symbol?: string;
1663
+ /**
1664
+ * - Discounted per unit price for current
1665
+ * offer object
1666
+ */
1667
+ bulk_effective?: number;
1668
+ /**
1669
+ * - Currency code for all amounts
1670
+ */
1671
+ currency_code?: string;
1672
+ /**
1673
+ * - Current per unit price of product after
1674
+ * existing deductions
1675
+ */
1676
+ effective?: number;
1677
+ /**
1678
+ * - Original price of product
1679
+ */
1680
+ marked?: number;
1681
+ };
1682
+ /** @returns {OfferItem} */
1683
+ declare function OfferItem(): OfferItem;
1684
+ type OfferItem = {
1685
+ price?: OfferPrice;
1686
+ /**
1687
+ * - Percentage value of discount
1688
+ */
1689
+ margin?: number;
1690
+ /**
1691
+ * - Quantity on which offer is applicable
1692
+ */
1693
+ quantity?: number;
1694
+ /**
1695
+ * - Is true for best offer from all offers present
1696
+ * for all sellers
1697
+ */
1698
+ best?: boolean;
1699
+ /**
1700
+ * - Total price of offer quantity with discount
1701
+ */
1702
+ total?: number;
1703
+ /**
1704
+ * - Whether offer discount is auto applied in cart
1705
+ */
1706
+ auto_applied?: boolean;
1707
+ /**
1708
+ * - Offer type
1709
+ */
1541
1710
  type?: string;
1542
- uid?: string;
1543
- value?: number;
1544
1711
  };
1545
- /** @returns {CouponDetails} */
1546
- declare function CouponDetails(): CouponDetails;
1547
- type CouponDetails = {
1548
- code?: string;
1549
- discount_single_quantity?: number;
1550
- discount_total_quantity?: number;
1712
+ /** @returns {OfferSeller} */
1713
+ declare function OfferSeller(): OfferSeller;
1714
+ type OfferSeller = {
1715
+ /**
1716
+ * - Seller id
1717
+ */
1718
+ uid?: number;
1719
+ name?: string;
1720
+ };
1721
+ /** @returns {BulkPriceOffer} */
1722
+ declare function BulkPriceOffer(): BulkPriceOffer;
1723
+ type BulkPriceOffer = {
1724
+ offers?: OfferItem[];
1725
+ seller?: OfferSeller;
1726
+ };
1727
+ /** @returns {BulkPriceResponse} */
1728
+ declare function BulkPriceResponse(): BulkPriceResponse;
1729
+ type BulkPriceResponse = {
1730
+ /**
1731
+ * - Consist of offers from multiple seller
1732
+ */
1733
+ data?: BulkPriceOffer[];
1734
+ };
1735
+ /** @returns {RewardPointRequest} */
1736
+ declare function RewardPointRequest(): RewardPointRequest;
1737
+ type RewardPointRequest = {
1738
+ points: boolean;
1739
+ };
1740
+ /** @returns {GeoLocation} */
1741
+ declare function GeoLocation(): GeoLocation;
1742
+ type GeoLocation = {
1743
+ latitude?: number;
1744
+ longitude?: number;
1745
+ };
1746
+ /** @returns {Address} */
1747
+ declare function Address(): Address;
1748
+ type Address = {
1749
+ country_iso_code?: string;
1750
+ area?: string;
1751
+ phone?: string;
1752
+ country_phone_code?: string;
1753
+ checkout_mode?: string;
1754
+ address?: string;
1755
+ area_code_slug?: string;
1756
+ geo_location?: GeoLocation;
1757
+ id?: string;
1758
+ _custom_json?: any;
1759
+ city?: string;
1760
+ sector?: string;
1761
+ /**
1762
+ * - State code for international address
1763
+ */
1764
+ state_code?: string;
1765
+ created_by_user_id?: string;
1766
+ landmark?: string;
1767
+ user_id?: string;
1768
+ name?: string;
1769
+ google_map_point?: any;
1770
+ is_active?: boolean;
1771
+ tags?: string[];
1772
+ country_code?: string;
1773
+ address_type?: string;
1774
+ country?: string;
1775
+ is_default_address?: boolean;
1776
+ area_code?: string;
1777
+ email?: string;
1778
+ state?: string;
1779
+ meta?: any;
1780
+ };
1781
+ /** @returns {GetAddressesResponse} */
1782
+ declare function GetAddressesResponse(): GetAddressesResponse;
1783
+ type GetAddressesResponse = {
1784
+ pii_masking?: boolean;
1785
+ address?: Address[];
1786
+ };
1787
+ /** @returns {SaveAddressResponse} */
1788
+ declare function SaveAddressResponse(): SaveAddressResponse;
1789
+ type SaveAddressResponse = {
1790
+ id?: string;
1791
+ success?: boolean;
1792
+ is_default_address?: boolean;
1793
+ };
1794
+ /** @returns {UpdateAddressResponse} */
1795
+ declare function UpdateAddressResponse(): UpdateAddressResponse;
1796
+ type UpdateAddressResponse = {
1797
+ is_updated?: boolean;
1798
+ id?: string;
1799
+ success?: boolean;
1800
+ is_default_address?: boolean;
1801
+ };
1802
+ /** @returns {DeleteAddressResponse} */
1803
+ declare function DeleteAddressResponse(): DeleteAddressResponse;
1804
+ type DeleteAddressResponse = {
1805
+ id?: string;
1806
+ is_deleted?: boolean;
1807
+ };
1808
+ /** @returns {SelectCartAddressRequest} */
1809
+ declare function SelectCartAddressRequest(): SelectCartAddressRequest;
1810
+ type SelectCartAddressRequest = {
1811
+ id?: string;
1812
+ billing_address_id?: string;
1813
+ cart_id?: string;
1814
+ };
1815
+ /** @returns {UpdateCartPaymentRequest} */
1816
+ declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
1817
+ type UpdateCartPaymentRequest = {
1818
+ id?: string;
1819
+ payment_identifier?: string;
1820
+ address_id?: string;
1821
+ merchant_code?: string;
1822
+ aggregator_name?: string;
1823
+ payment_mode?: string;
1551
1824
  };
1552
1825
  /** @returns {CouponValidity} */
1553
1826
  declare function CouponValidity(): CouponValidity;
1554
1827
  type CouponValidity = {
1555
- code?: string;
1828
+ title?: string;
1556
1829
  discount?: number;
1557
- display_message_en?: string;
1558
1830
  next_validation_required?: boolean;
1559
- title?: string;
1560
1831
  valid?: boolean;
1561
- };
1562
- /** @returns {CurrencyInfo} */
1563
- declare function CurrencyInfo(): CurrencyInfo;
1564
- type CurrencyInfo = {
1832
+ display_message_en?: string;
1565
1833
  code?: string;
1566
- symbol?: string;
1834
+ };
1835
+ /** @returns {PaymentCouponValidate} */
1836
+ declare function PaymentCouponValidate(): PaymentCouponValidate;
1837
+ type PaymentCouponValidate = {
1838
+ message?: string;
1839
+ coupon_validity?: CouponValidity;
1840
+ success: boolean;
1841
+ };
1842
+ /** @returns {ShipmentResponse} */
1843
+ declare function ShipmentResponse(): ShipmentResponse;
1844
+ type ShipmentResponse = {
1845
+ shipments?: number;
1846
+ promise?: ShipmentPromise;
1847
+ order_type?: string;
1848
+ box_type?: string;
1849
+ shipment_type?: string;
1850
+ dp_options?: any;
1851
+ dp_id?: string;
1852
+ items?: CartProductInfo[];
1853
+ fulfillment_type?: string;
1854
+ fulfillment_id?: number;
1855
+ };
1856
+ /** @returns {CartShipmentsResponse} */
1857
+ declare function CartShipmentsResponse(): CartShipmentsResponse;
1858
+ type CartShipmentsResponse = {
1859
+ delivery_charge_info?: string;
1860
+ checkout_mode?: string;
1861
+ message?: string;
1862
+ gstin?: string;
1863
+ restrict_checkout?: boolean;
1864
+ last_modified?: string;
1865
+ cart_id?: number;
1866
+ is_valid?: boolean;
1867
+ breakup_values?: CartBreakup;
1868
+ currency?: CartCurrency;
1869
+ id?: string;
1870
+ shipments?: ShipmentResponse[];
1871
+ payment_selection_lock?: PaymentSelectionLock;
1872
+ coupon_text?: string;
1873
+ delivery_promise?: ShipmentPromise;
1874
+ error?: boolean;
1875
+ comment?: string;
1876
+ buy_now?: boolean;
1877
+ uid?: string;
1878
+ };
1879
+ /** @returns {CartCheckoutCustomMeta} */
1880
+ declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1881
+ type CartCheckoutCustomMeta = {
1882
+ key: string;
1883
+ value: string;
1567
1884
  };
1568
1885
  /** @returns {CustomerDetails} */
1569
1886
  declare function CustomerDetails(): CustomerDetails;
@@ -1572,132 +1889,126 @@ type CustomerDetails = {
1572
1889
  mobile: string;
1573
1890
  name?: string;
1574
1891
  };
1575
- /** @returns {DeleteAddressResponse} */
1576
- declare function DeleteAddressResponse(): DeleteAddressResponse;
1577
- type DeleteAddressResponse = {
1578
- id?: string;
1579
- is_deleted?: boolean;
1892
+ /** @returns {StaffCheckout} */
1893
+ declare function StaffCheckout(): StaffCheckout;
1894
+ type StaffCheckout = {
1895
+ employee_code?: string;
1896
+ user: string;
1897
+ last_name: string;
1898
+ first_name: string;
1899
+ _id: string;
1580
1900
  };
1581
- /** @returns {DeleteCartDetailResponse} */
1582
- declare function DeleteCartDetailResponse(): DeleteCartDetailResponse;
1583
- type DeleteCartDetailResponse = {
1584
- message?: string;
1901
+ /** @returns {CartCheckoutDetailRequest} */
1902
+ declare function CartCheckoutDetailRequest(): CartCheckoutDetailRequest;
1903
+ type CartCheckoutDetailRequest = {
1904
+ custom_meta?: CartCheckoutCustomMeta[];
1585
1905
  /**
1586
- * - True if cart is archived successfully. False
1587
- * if not archived.
1906
+ * - Customer details
1588
1907
  */
1589
- success?: boolean;
1908
+ customer_details?: any;
1909
+ merchant_code?: string;
1910
+ id?: string;
1911
+ payment_auto_confirm?: boolean;
1912
+ payment_mode: string;
1913
+ aggregator?: string;
1914
+ address_id?: string;
1915
+ callback_url?: string;
1916
+ delivery_address?: any;
1917
+ staff?: StaffCheckout;
1918
+ order_type?: string;
1919
+ ordering_store?: number;
1920
+ extra_meta?: any;
1921
+ payment_identifier?: string;
1922
+ billing_address?: any;
1923
+ payment_params?: any;
1924
+ billing_address_id?: string;
1925
+ meta?: any;
1926
+ payment_extra_identifiers?: any;
1927
+ iin?: string;
1928
+ network?: string;
1929
+ type?: string;
1930
+ card_id?: string;
1590
1931
  };
1591
- /** @returns {DeliveryChargesConfig} */
1592
- declare function DeliveryChargesConfig(): DeliveryChargesConfig;
1593
- type DeliveryChargesConfig = {
1594
- charges?: ChargesThreshold[];
1595
- enabled?: boolean;
1932
+ /** @returns {CheckCart} */
1933
+ declare function CheckCart(): CheckCart;
1934
+ type CheckCart = {
1935
+ checkout_mode?: string;
1936
+ user_type?: string;
1937
+ cod_message?: string;
1938
+ cart_id?: number;
1939
+ is_valid?: boolean;
1940
+ delivery_charges?: number;
1941
+ id?: string;
1942
+ payment_selection_lock?: PaymentSelectionLock;
1943
+ error_message?: string;
1944
+ delivery_promise?: ShipmentPromise;
1945
+ comment?: string;
1946
+ items?: CartProductInfo[];
1947
+ uid?: string;
1948
+ delivery_charge_order_value?: number;
1949
+ delivery_charge_info?: string;
1950
+ cod_available?: boolean;
1951
+ success?: boolean;
1952
+ store_code?: string;
1953
+ message?: string;
1954
+ gstin?: string;
1955
+ restrict_checkout?: boolean;
1956
+ last_modified?: string;
1957
+ order_id?: string;
1958
+ breakup_values?: CartBreakup;
1959
+ currency?: CartCurrency;
1960
+ store_emps?: any[];
1961
+ coupon_text?: string;
1962
+ buy_now?: boolean;
1963
+ cod_charges?: number;
1596
1964
  };
1597
- /** @returns {DiscountRulesApp} */
1598
- declare function DiscountRulesApp(): DiscountRulesApp;
1599
- type DiscountRulesApp = {
1600
- /**
1601
- * - Item criteria of promotion
1602
- */
1603
- item_criteria?: any;
1604
- /**
1605
- * - Matched buy rules for promotion
1606
- */
1607
- matched_buy_rules?: string[];
1608
- /**
1609
- * - Offer for promotion
1610
- */
1611
- offer?: any;
1612
- /**
1613
- * - Raw offer details for promotion
1614
- */
1615
- raw_offer?: any;
1965
+ /** @returns {CartCheckoutResponse} */
1966
+ declare function CartCheckoutResponse(): CartCheckoutResponse;
1967
+ type CartCheckoutResponse = {
1968
+ payment_confirm_url?: string;
1969
+ app_intercept_url?: string;
1970
+ success?: boolean;
1971
+ callback_url?: string;
1972
+ message?: string;
1973
+ data?: any;
1974
+ order_id?: string;
1975
+ cart?: CheckCart;
1616
1976
  };
1617
- /** @returns {DisplayBreakup} */
1618
- declare function DisplayBreakup(): DisplayBreakup;
1619
- type DisplayBreakup = {
1620
- currency_code?: string;
1621
- currency_symbol?: string;
1622
- display?: string;
1623
- key?: string;
1624
- message?: string[];
1625
- preset?: number;
1626
- value?: number;
1977
+ /** @returns {GiftDetail} */
1978
+ declare function GiftDetail(): GiftDetail;
1979
+ type GiftDetail = {
1980
+ is_gift_applied?: boolean;
1981
+ gift_message?: string;
1627
1982
  };
1628
- /** @returns {FreeGiftItem} */
1629
- declare function FreeGiftItem(): FreeGiftItem;
1630
- type FreeGiftItem = {
1631
- /**
1632
- * - Item brand name
1633
- */
1634
- item_brand_name?: string;
1635
- /**
1636
- * - Item id
1637
- */
1638
- item_id?: number;
1639
- /**
1640
- * - Item images URL
1641
- */
1642
- item_images_url?: string[];
1643
- /**
1644
- * - Item name
1645
- */
1646
- item_name?: string;
1647
- /**
1648
- * - Item price details
1649
- */
1650
- item_price_details?: any;
1651
- /**
1652
- * - Item slug
1653
- */
1654
- item_slug?: string;
1983
+ /** @returns {ArticleGiftDetail} */
1984
+ declare function ArticleGiftDetail(): ArticleGiftDetail;
1985
+ type ArticleGiftDetail = {
1986
+ article_id?: GiftDetail;
1655
1987
  };
1656
- /** @returns {FreeGiftItems} */
1657
- declare function FreeGiftItems(): FreeGiftItems;
1658
- type FreeGiftItems = {
1659
- /**
1660
- * - Item brand name
1661
- */
1662
- item_brand_name?: string;
1663
- /**
1664
- * - Item id
1665
- */
1666
- item_id?: number;
1667
- /**
1668
- * - Item images URL
1669
- */
1670
- item_images_url?: string[];
1671
- /**
1672
- * - Item name
1673
- */
1674
- item_name?: string;
1675
- /**
1676
- * - Item price details
1677
- */
1678
- item_price_details?: any;
1988
+ /** @returns {CartMetaRequest} */
1989
+ declare function CartMetaRequest(): CartMetaRequest;
1990
+ type CartMetaRequest = {
1991
+ delivery_slots?: any;
1992
+ gift_details?: ArticleGiftDetail;
1679
1993
  /**
1680
- * - Item slug
1994
+ * - Customer contact details for
1995
+ * customer pickup at store
1681
1996
  */
1682
- item_slug?: string;
1683
- };
1684
- /** @returns {GeoLocation} */
1685
- declare function GeoLocation(): GeoLocation;
1686
- type GeoLocation = {
1687
- latitude?: number;
1688
- longitude?: number;
1997
+ pick_up_customer_details?: any;
1998
+ checkout_mode?: string;
1999
+ comment?: string;
2000
+ gstin?: string;
1689
2001
  };
1690
- /** @returns {GetAddressesResponse} */
1691
- declare function GetAddressesResponse(): GetAddressesResponse;
1692
- type GetAddressesResponse = {
1693
- address?: Address[];
1694
- pii_masking?: boolean;
2002
+ /** @returns {CartMetaResponse} */
2003
+ declare function CartMetaResponse(): CartMetaResponse;
2004
+ type CartMetaResponse = {
2005
+ message?: string;
2006
+ is_valid?: boolean;
1695
2007
  };
1696
- /** @returns {GetCouponResponse} */
1697
- declare function GetCouponResponse(): GetCouponResponse;
1698
- type GetCouponResponse = {
1699
- available_coupon_list?: Coupon[];
1700
- page?: PageCoupon;
2008
+ /** @returns {CartMetaMissingResponse} */
2009
+ declare function CartMetaMissingResponse(): CartMetaMissingResponse;
2010
+ type CartMetaMissingResponse = {
2011
+ errors?: string[];
1701
2012
  };
1702
2013
  /** @returns {GetShareCartLinkRequest} */
1703
2014
  declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
@@ -1715,188 +2026,133 @@ type GetShareCartLinkRequest = {
1715
2026
  /** @returns {GetShareCartLinkResponse} */
1716
2027
  declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
1717
2028
  type GetShareCartLinkResponse = {
1718
- /**
1719
- * - Short shareable final url
1720
- */
1721
- share_url?: string;
1722
2029
  /**
1723
2030
  * - Short url unique id
1724
2031
  */
1725
2032
  token?: string;
1726
- };
1727
- /** @returns {GiftDetail} */
1728
- declare function GiftDetail(): GiftDetail;
1729
- type GiftDetail = {
1730
- gift_message?: string;
1731
- is_gift_applied?: boolean;
1732
- };
1733
- /** @returns {LadderOfferItem} */
1734
- declare function LadderOfferItem(): LadderOfferItem;
1735
- type LadderOfferItem = {
1736
2033
  /**
1737
- * - Percentage value of discount
1738
- */
1739
- margin?: number;
1740
- /**
1741
- * - Minimum quantity upto which offer is
1742
- * applicable. If not present that offer is applicable on all quantities
1743
- */
1744
- max_quantity?: number;
1745
- /**
1746
- * - Minimum quantity from which offer is applicable
1747
- */
1748
- min_quantity?: number;
1749
- price?: LadderPrice;
1750
- /**
1751
- * - Offer type
2034
+ * - Short shareable final url
1752
2035
  */
1753
- type?: string;
2036
+ share_url?: string;
1754
2037
  };
1755
- /** @returns {LadderPrice} */
1756
- declare function LadderPrice(): LadderPrice;
1757
- type LadderPrice = {
1758
- /**
1759
- * - Currency code for all amounts
1760
- */
1761
- currency_code?: string;
2038
+ /** @returns {SharedCartDetails} */
2039
+ declare function SharedCartDetails(): SharedCartDetails;
2040
+ type SharedCartDetails = {
1762
2041
  /**
1763
- * - Currency symbol for currency
2042
+ * - Short link id
1764
2043
  */
1765
- currency_symbol?: string;
2044
+ token?: string;
1766
2045
  /**
1767
- * - Current per unit price of product after
1768
- * existing deductions
2046
+ * - User details of who generated share link
1769
2047
  */
1770
- effective?: number;
2048
+ user?: any;
2049
+ created_on?: string;
1771
2050
  /**
1772
- * - Original price of product
2051
+ * - Share link device and other source information
1773
2052
  */
1774
- marked?: number;
2053
+ source?: any;
1775
2054
  /**
1776
- * - Discounted per unit price for current offer object
2055
+ * - Meta data sent while generating share cart link
1777
2056
  */
1778
- offer_price?: number;
2057
+ meta?: any;
1779
2058
  };
1780
- /** @returns {LadderPriceOffer} */
1781
- declare function LadderPriceOffer(): LadderPriceOffer;
1782
- type LadderPriceOffer = {
1783
- /**
1784
- * - Buy rules of promotions
1785
- */
1786
- buy_rules?: any;
1787
- /**
1788
- * - If this ladder offer is to be calculated
1789
- * on MRP or ESP price
1790
- */
1791
- calculate_on?: string;
1792
- /**
1793
- * - Offer details including T&C
1794
- */
1795
- description?: string;
1796
- /**
1797
- * - Discount rules of promotions
1798
- */
1799
- discount_rules?: any[];
1800
- /**
1801
- * - Details of free gift items
1802
- */
1803
- free_gift_items?: FreeGiftItems[];
1804
- /**
1805
- * - Promotion id
1806
- */
2059
+ /** @returns {SharedCart} */
2060
+ declare function SharedCart(): SharedCart;
2061
+ type SharedCart = {
2062
+ checkout_mode?: string;
2063
+ cart_id?: number;
2064
+ is_valid?: boolean;
1807
2065
  id?: string;
1808
- offer_prices?: LadderOfferItem[];
1809
- /**
1810
- * - Offer title
1811
- */
1812
- offer_text?: string;
1813
- /**
1814
- * - Group of promotion belongs to
1815
- */
1816
- promotion_group?: string;
1817
- /**
1818
- * - Datetime ISOString for promotion end date
1819
- */
1820
- valid_till?: string;
1821
- };
1822
- /** @returns {LadderPriceOffers} */
1823
- declare function LadderPriceOffers(): LadderPriceOffers;
1824
- type LadderPriceOffers = {
1825
- available_offers?: LadderPriceOffer[];
1826
- currency?: CurrencyInfo;
1827
- };
1828
- /** @returns {LoyaltyPoints} */
1829
- declare function LoyaltyPoints(): LoyaltyPoints;
1830
- type LoyaltyPoints = {
1831
- applicable?: number;
1832
- description?: string;
1833
- is_applied?: boolean;
1834
- total?: number;
2066
+ payment_selection_lock?: PaymentSelectionLock;
2067
+ delivery_promise?: ShipmentPromise;
2068
+ comment?: string;
2069
+ items?: CartProductInfo[];
2070
+ uid?: string;
2071
+ delivery_charge_info?: string;
2072
+ message?: string;
2073
+ gstin?: string;
2074
+ shared_cart_details?: SharedCartDetails;
2075
+ restrict_checkout?: boolean;
2076
+ last_modified?: string;
2077
+ breakup_values?: CartBreakup;
2078
+ currency?: CartCurrency;
2079
+ coupon_text?: string;
2080
+ buy_now?: boolean;
1835
2081
  };
1836
- /** @returns {OfferItem} */
1837
- declare function OfferItem(): OfferItem;
1838
- type OfferItem = {
2082
+ /** @returns {SharedCartResponse} */
2083
+ declare function SharedCartResponse(): SharedCartResponse;
2084
+ type SharedCartResponse = {
2085
+ error?: string;
2086
+ cart?: SharedCart;
2087
+ };
2088
+ /** @returns {FreeGiftItems} */
2089
+ declare function FreeGiftItems(): FreeGiftItems;
2090
+ type FreeGiftItems = {
1839
2091
  /**
1840
- * - Whether offer discount is auto applied in cart
2092
+ * - Item slug
1841
2093
  */
1842
- auto_applied?: boolean;
2094
+ item_slug?: string;
1843
2095
  /**
1844
- * - Is true for best offer from all offers present
1845
- * for all sellers
2096
+ * - Item name
1846
2097
  */
1847
- best?: boolean;
2098
+ item_name?: string;
1848
2099
  /**
1849
- * - Percentage value of discount
2100
+ * - Item price details
1850
2101
  */
1851
- margin?: number;
1852
- price?: OfferPrice;
2102
+ item_price_details?: any;
1853
2103
  /**
1854
- * - Quantity on which offer is applicable
2104
+ * - Item brand name
1855
2105
  */
1856
- quantity?: number;
2106
+ item_brand_name?: string;
1857
2107
  /**
1858
- * - Total price of offer quantity with discount
2108
+ * - Item id
1859
2109
  */
1860
- total?: number;
2110
+ item_id?: number;
1861
2111
  /**
1862
- * - Offer type
2112
+ * - Item images URL
1863
2113
  */
1864
- type?: string;
2114
+ item_images_url?: string[];
1865
2115
  };
1866
- /** @returns {OfferPrice} */
1867
- declare function OfferPrice(): OfferPrice;
1868
- type OfferPrice = {
2116
+ /** @returns {PromotionOffer} */
2117
+ declare function PromotionOffer(): PromotionOffer;
2118
+ type PromotionOffer = {
1869
2119
  /**
1870
- * - Discounted per unit price for current
1871
- * offer object
2120
+ * - Promotion id
1872
2121
  */
1873
- bulk_effective?: number;
2122
+ id?: string;
1874
2123
  /**
1875
- * - Currency code for all amounts
2124
+ * - Buy rules of promotions
1876
2125
  */
1877
- currency_code?: string;
2126
+ buy_rules?: any;
1878
2127
  /**
1879
- * - Currency symbol for currency
2128
+ * - Offer title
1880
2129
  */
1881
- currency_symbol?: string;
2130
+ offer_text?: string;
1882
2131
  /**
1883
- * - Current per unit price of product after
1884
- * existing deductions
2132
+ * - Group of promotion belongs to
1885
2133
  */
1886
- effective?: number;
2134
+ promotion_group?: string;
1887
2135
  /**
1888
- * - Original price of product
2136
+ * - Datetime ISOString for promotion end date
1889
2137
  */
1890
- marked?: number;
1891
- };
1892
- /** @returns {OfferSeller} */
1893
- declare function OfferSeller(): OfferSeller;
1894
- type OfferSeller = {
1895
- name?: string;
2138
+ valid_till?: string;
1896
2139
  /**
1897
- * - Seller id
2140
+ * - Discount rules of promotions
1898
2141
  */
1899
- uid?: number;
2142
+ discount_rules?: any[];
2143
+ /**
2144
+ * - Details of free gift items
2145
+ */
2146
+ free_gift_items?: FreeGiftItems[];
2147
+ /**
2148
+ * - Offer details including T&C
2149
+ */
2150
+ description?: string;
2151
+ };
2152
+ /** @returns {PromotionOffersResponse} */
2153
+ declare function PromotionOffersResponse(): PromotionOffersResponse;
2154
+ type PromotionOffersResponse = {
2155
+ available_promotions?: PromotionOffer[];
1900
2156
  };
1901
2157
  /** @returns {OperationErrorResponse} */
1902
2158
  declare function OperationErrorResponse(): OperationErrorResponse;
@@ -1904,200 +2160,69 @@ type OperationErrorResponse = {
1904
2160
  message?: string;
1905
2161
  success?: boolean;
1906
2162
  };
1907
- /** @returns {Ownership} */
1908
- declare function Ownership(): Ownership;
1909
- type Ownership = {
2163
+ /** @returns {LadderPrice} */
2164
+ declare function LadderPrice(): LadderPrice;
2165
+ type LadderPrice = {
1910
2166
  /**
1911
- * - Promo amount bearable party
2167
+ * - Currency symbol for currency
1912
2168
  */
1913
- payable_by?: string;
2169
+ currency_symbol?: string;
1914
2170
  /**
1915
- * - Promo amount payable category
2171
+ * - Discounted per unit price for current offer object
1916
2172
  */
1917
- payable_category?: string;
1918
- };
1919
- /** @returns {PageCoupon} */
1920
- declare function PageCoupon(): PageCoupon;
1921
- type PageCoupon = {
1922
- current?: number;
1923
- has_next?: boolean;
1924
- has_previous?: boolean;
1925
- total?: number;
1926
- total_item_count?: number;
1927
- };
1928
- /** @returns {PaymentCouponValidate} */
1929
- declare function PaymentCouponValidate(): PaymentCouponValidate;
1930
- type PaymentCouponValidate = {
1931
- coupon_validity?: CouponValidity;
1932
- message?: string;
1933
- success: boolean;
1934
- };
1935
- /** @returns {PaymentMeta} */
1936
- declare function PaymentMeta(): PaymentMeta;
1937
- type PaymentMeta = {
1938
- merchant_code?: string;
1939
- payment_gateway?: string;
1940
- payment_identifier?: string;
1941
- type?: string;
1942
- };
1943
- /** @returns {PaymentMethod} */
1944
- declare function PaymentMethod(): PaymentMethod;
1945
- type PaymentMethod = {
1946
- amount?: number;
1947
- mode: string;
1948
- name?: string;
1949
- payment?: string;
1950
- payment_extra_identifiers?: any;
1951
- payment_meta: PaymentMeta;
1952
- };
1953
- /** @returns {PaymentSelectionLock} */
1954
- declare function PaymentSelectionLock(): PaymentSelectionLock;
1955
- type PaymentSelectionLock = {
1956
- default_options?: string;
1957
- enabled?: boolean;
1958
- payment_identifier?: string;
1959
- };
1960
- /** @returns {ProductAction} */
1961
- declare function ProductAction(): ProductAction;
1962
- type ProductAction = {
1963
- query?: ActionQuery;
1964
- type?: string;
1965
- url?: string;
1966
- };
1967
- /** @returns {ProductArticle} */
1968
- declare function ProductArticle(): ProductArticle;
1969
- type ProductArticle = {
1970
- _custom_json?: any;
1971
- cart_item_meta?: any;
1972
- extra_meta?: any;
1973
- gift_card?: any;
1974
- identifier?: any;
1975
- is_gift_visible?: boolean;
1976
- meta?: any;
1977
- mto_quantity?: number;
1978
- parent_item_identifiers?: any;
1979
- price?: ArticlePriceInfo;
1980
- product_group_tags?: string[];
1981
- quantity?: number;
1982
- seller?: BaseInfo;
1983
- seller_identifier?: string;
1984
- size?: string;
1985
- store?: StoreInfo;
2173
+ offer_price?: number;
1986
2174
  /**
1987
- * - A list of article tags
2175
+ * - Currency code for all amounts
1988
2176
  */
1989
- tags?: string[];
1990
- type?: string;
1991
- uid?: string;
1992
- };
1993
- /** @returns {ProductAvailability} */
1994
- declare function ProductAvailability(): ProductAvailability;
1995
- type ProductAvailability = {
1996
- available_sizes?: ProductAvailabilitySize[];
1997
- deliverable?: boolean;
1998
- is_valid?: boolean;
1999
- other_store_quantity?: number;
2000
- out_of_stock?: boolean;
2001
- sizes?: string[];
2002
- };
2003
- /** @returns {ProductAvailabilitySize} */
2004
- declare function ProductAvailabilitySize(): ProductAvailabilitySize;
2005
- type ProductAvailabilitySize = {
2006
- display?: string;
2007
- is_available?: boolean;
2008
- value?: string;
2009
- };
2010
- /** @returns {ProductImage} */
2011
- declare function ProductImage(): ProductImage;
2012
- type ProductImage = {
2013
- aspect_ratio?: string;
2014
- secure_url?: string;
2015
- url?: string;
2016
- };
2017
- /** @returns {ProductPrice} */
2018
- declare function ProductPrice(): ProductPrice;
2019
- type ProductPrice = {
2020
- add_on?: number;
2021
- currency_code?: string;
2022
- currency_symbol?: string;
2023
- effective?: number;
2024
- marked?: number;
2025
- selling?: number;
2026
- };
2027
- /** @returns {ProductPriceInfo} */
2028
- declare function ProductPriceInfo(): ProductPriceInfo;
2029
- type ProductPriceInfo = {
2030
- base?: ProductPrice;
2031
- converted?: ProductPrice;
2032
- };
2033
- /** @returns {ProductPricePerUnit} */
2034
- declare function ProductPricePerUnit(): ProductPricePerUnit;
2035
- type ProductPricePerUnit = {
2036
- add_on?: number;
2037
2177
  currency_code?: string;
2038
- currency_symbol?: string;
2039
- effective?: number;
2040
- marked?: number;
2041
- selling_price?: number;
2042
- };
2043
- /** @returns {ProductPricePerUnitInfo} */
2044
- declare function ProductPricePerUnitInfo(): ProductPricePerUnitInfo;
2045
- type ProductPricePerUnitInfo = {
2046
- base?: ProductPricePerUnit;
2047
- converted?: ProductPricePerUnit;
2048
- };
2049
- /** @returns {PromiseFormatted} */
2050
- declare function PromiseFormatted(): PromiseFormatted;
2051
- type PromiseFormatted = {
2052
- max?: string;
2053
- min?: string;
2054
- };
2055
- /** @returns {PromiseISOFormat} */
2056
- declare function PromiseISOFormat(): PromiseISOFormat;
2057
- type PromiseISOFormat = {
2058
2178
  /**
2059
- * - Max promise in ISO format.
2179
+ * - Current per unit price of product after
2180
+ * existing deductions
2060
2181
  */
2061
- max?: string;
2182
+ effective?: number;
2062
2183
  /**
2063
- * - Min Promise in ISO format.
2184
+ * - Original price of product
2064
2185
  */
2065
- min?: string;
2066
- };
2067
- /** @returns {PromiseTimestamp} */
2068
- declare function PromiseTimestamp(): PromiseTimestamp;
2069
- type PromiseTimestamp = {
2070
- max?: number;
2071
- min?: number;
2072
- };
2073
- /** @returns {PromoMeta} */
2074
- declare function PromoMeta(): PromoMeta;
2075
- type PromoMeta = {
2076
- message?: string;
2186
+ marked?: number;
2077
2187
  };
2078
- /** @returns {PromotionOffer} */
2079
- declare function PromotionOffer(): PromotionOffer;
2080
- type PromotionOffer = {
2188
+ /** @returns {LadderOfferItem} */
2189
+ declare function LadderOfferItem(): LadderOfferItem;
2190
+ type LadderOfferItem = {
2191
+ price?: LadderPrice;
2081
2192
  /**
2082
- * - Buy rules of promotions
2193
+ * - Percentage value of discount
2083
2194
  */
2084
- buy_rules?: any;
2195
+ margin?: number;
2085
2196
  /**
2086
- * - Offer details including T&C
2197
+ * - Minimum quantity upto which offer is
2198
+ * applicable. If not present that offer is applicable on all quantities
2087
2199
  */
2088
- description?: string;
2200
+ max_quantity?: number;
2089
2201
  /**
2090
- * - Discount rules of promotions
2202
+ * - Minimum quantity from which offer is applicable
2091
2203
  */
2092
- discount_rules?: any[];
2204
+ min_quantity?: number;
2093
2205
  /**
2094
- * - Details of free gift items
2206
+ * - Offer type
2095
2207
  */
2096
- free_gift_items?: FreeGiftItems[];
2208
+ type?: string;
2209
+ };
2210
+ /** @returns {LadderPriceOffer} */
2211
+ declare function LadderPriceOffer(): LadderPriceOffer;
2212
+ type LadderPriceOffer = {
2097
2213
  /**
2098
2214
  * - Promotion id
2099
2215
  */
2100
2216
  id?: string;
2217
+ /**
2218
+ * - Buy rules of promotions
2219
+ */
2220
+ buy_rules?: any;
2221
+ /**
2222
+ * - If this ladder offer is to be calculated
2223
+ * on MRP or ESP price
2224
+ */
2225
+ calculate_on?: string;
2101
2226
  /**
2102
2227
  * - Offer title
2103
2228
  */
@@ -2110,188 +2235,79 @@ type PromotionOffer = {
2110
2235
  * - Datetime ISOString for promotion end date
2111
2236
  */
2112
2237
  valid_till?: string;
2113
- };
2114
- /** @returns {PromotionOffersResponse} */
2115
- declare function PromotionOffersResponse(): PromotionOffersResponse;
2116
- type PromotionOffersResponse = {
2117
- available_promotions?: PromotionOffer[];
2118
- };
2119
- /** @returns {RawBreakup} */
2120
- declare function RawBreakup(): RawBreakup;
2121
- type RawBreakup = {
2122
- cod_charge?: number;
2123
- convenience_fee?: number;
2124
- coupon?: number;
2125
- delivery_charge?: number;
2126
- discount?: number;
2127
- fynd_cash?: number;
2128
- gift_card?: number;
2129
- gst_charges?: number;
2130
- mop_total?: number;
2131
- mrp_total?: number;
2132
- subtotal?: number;
2133
- total?: number;
2134
- total_charge?: number;
2135
- vog?: number;
2136
- you_saved?: number;
2137
- };
2138
- /** @returns {RewardPointRequest} */
2139
- declare function RewardPointRequest(): RewardPointRequest;
2140
- type RewardPointRequest = {
2141
- points: boolean;
2142
- };
2143
- /** @returns {SaveAddressResponse} */
2144
- declare function SaveAddressResponse(): SaveAddressResponse;
2145
- type SaveAddressResponse = {
2146
- id?: string;
2147
- is_default_address?: boolean;
2148
- success?: boolean;
2149
- };
2150
- /** @returns {SelectCartAddressRequest} */
2151
- declare function SelectCartAddressRequest(): SelectCartAddressRequest;
2152
- type SelectCartAddressRequest = {
2153
- billing_address_id?: string;
2154
- cart_id?: string;
2155
- id?: string;
2156
- };
2157
- /** @returns {SharedCart} */
2158
- declare function SharedCart(): SharedCart;
2159
- type SharedCart = {
2160
- breakup_values?: CartBreakup;
2161
- buy_now?: boolean;
2162
- cart_id?: number;
2163
- checkout_mode?: string;
2164
- comment?: string;
2165
- coupon_text?: string;
2166
- currency?: CartCurrency;
2167
- delivery_charge_info?: string;
2168
- delivery_promise?: ShipmentPromise;
2169
- gstin?: string;
2170
- id?: string;
2171
- is_valid?: boolean;
2172
- items?: CartProductInfo[];
2173
- last_modified?: string;
2174
- message?: string;
2175
- payment_selection_lock?: PaymentSelectionLock;
2176
- restrict_checkout?: boolean;
2177
- shared_cart_details?: SharedCartDetails;
2178
- uid?: string;
2179
- };
2180
- /** @returns {SharedCartDetails} */
2181
- declare function SharedCartDetails(): SharedCartDetails;
2182
- type SharedCartDetails = {
2183
- created_on?: string;
2184
- /**
2185
- * - Meta data sent while generating share cart link
2186
- */
2187
- meta?: any;
2188
2238
  /**
2189
- * - Share link device and other source information
2239
+ * - Discount rules of promotions
2190
2240
  */
2191
- source?: any;
2241
+ discount_rules?: any[];
2242
+ offer_prices?: LadderOfferItem[];
2192
2243
  /**
2193
- * - Short link id
2244
+ * - Details of free gift items
2194
2245
  */
2195
- token?: string;
2246
+ free_gift_items?: FreeGiftItems[];
2196
2247
  /**
2197
- * - User details of who generated share link
2248
+ * - Offer details including T&C
2198
2249
  */
2199
- user?: any;
2200
- };
2201
- /** @returns {SharedCartResponse} */
2202
- declare function SharedCartResponse(): SharedCartResponse;
2203
- type SharedCartResponse = {
2204
- cart?: SharedCart;
2205
- error?: string;
2250
+ description?: string;
2206
2251
  };
2207
- /** @returns {ShipmentPromise} */
2208
- declare function ShipmentPromise(): ShipmentPromise;
2209
- type ShipmentPromise = {
2210
- formatted?: PromiseFormatted;
2211
- iso?: PromiseISOFormat;
2212
- timestamp?: PromiseTimestamp;
2252
+ /** @returns {CurrencyInfo} */
2253
+ declare function CurrencyInfo(): CurrencyInfo;
2254
+ type CurrencyInfo = {
2255
+ code?: string;
2256
+ symbol?: string;
2213
2257
  };
2214
- /** @returns {ShipmentResponse} */
2215
- declare function ShipmentResponse(): ShipmentResponse;
2216
- type ShipmentResponse = {
2217
- box_type?: string;
2218
- dp_id?: string;
2219
- dp_options?: any;
2220
- fulfillment_id?: number;
2221
- fulfillment_type?: string;
2222
- items?: CartProductInfo[];
2223
- order_type?: string;
2224
- promise?: ShipmentPromise;
2225
- shipment_type?: string;
2226
- shipments?: number;
2258
+ /** @returns {LadderPriceOffers} */
2259
+ declare function LadderPriceOffers(): LadderPriceOffers;
2260
+ type LadderPriceOffers = {
2261
+ available_offers?: LadderPriceOffer[];
2262
+ currency?: CurrencyInfo;
2227
2263
  };
2228
- /** @returns {StaffCheckout} */
2229
- declare function StaffCheckout(): StaffCheckout;
2230
- type StaffCheckout = {
2231
- _id: string;
2232
- employee_code?: string;
2233
- first_name: string;
2234
- last_name: string;
2235
- user: string;
2264
+ /** @returns {PaymentMeta} */
2265
+ declare function PaymentMeta(): PaymentMeta;
2266
+ type PaymentMeta = {
2267
+ merchant_code?: string;
2268
+ type?: string;
2269
+ payment_gateway?: string;
2270
+ payment_identifier?: string;
2236
2271
  };
2237
- /** @returns {StoreInfo} */
2238
- declare function StoreInfo(): StoreInfo;
2239
- type StoreInfo = {
2272
+ /** @returns {PaymentMethod} */
2273
+ declare function PaymentMethod(): PaymentMethod;
2274
+ type PaymentMethod = {
2275
+ payment_meta: PaymentMeta;
2276
+ mode: string;
2277
+ payment?: string;
2278
+ amount?: number;
2240
2279
  name?: string;
2241
- store_code?: string;
2242
- uid?: number;
2243
- };
2244
- /** @returns {Tags} */
2245
- declare function Tags(): Tags;
2246
- type Tags = {
2247
- tags?: any;
2248
- };
2249
- /** @returns {UpdateAddressResponse} */
2250
- declare function UpdateAddressResponse(): UpdateAddressResponse;
2251
- type UpdateAddressResponse = {
2252
- id?: string;
2253
- is_default_address?: boolean;
2254
- is_updated?: boolean;
2255
- success?: boolean;
2280
+ payment_extra_identifiers?: any;
2256
2281
  };
2257
- /** @returns {UpdateCartDetailResponse} */
2258
- declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
2259
- type UpdateCartDetailResponse = {
2260
- cart?: CartDetailResponse;
2261
- message?: string;
2282
+ /** @returns {CartCheckoutDetailV2Request} */
2283
+ declare function CartCheckoutDetailV2Request(): CartCheckoutDetailV2Request;
2284
+ type CartCheckoutDetailV2Request = {
2285
+ custom_meta?: any;
2262
2286
  /**
2263
- * - True if all items are added successfully.
2264
- * False if partially added or not added.
2287
+ * - Customer details
2265
2288
  */
2266
- success?: boolean;
2267
- };
2268
- /** @returns {UpdateCartPaymentRequest} */
2269
- declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
2270
- type UpdateCartPaymentRequest = {
2271
- address_id?: string;
2272
- aggregator_name?: string;
2273
- id?: string;
2289
+ customer_details?: any;
2274
2290
  merchant_code?: string;
2275
- payment_identifier?: string;
2276
- payment_mode?: string;
2277
- };
2278
- /** @returns {UpdateCartRequest} */
2279
- declare function UpdateCartRequest(): UpdateCartRequest;
2280
- type UpdateCartRequest = {
2281
- items?: UpdateProductCart[];
2282
- operation: string;
2283
- };
2284
- /** @returns {UpdateProductCart} */
2285
- declare function UpdateProductCart(): UpdateProductCart;
2286
- type UpdateProductCart = {
2287
- _custom_json?: any;
2288
- article_id?: string;
2291
+ cart_id?: string;
2292
+ id?: string;
2293
+ payment_auto_confirm?: boolean;
2294
+ payment_methods: PaymentMethod[];
2295
+ payment_mode: string;
2296
+ aggregator?: string;
2297
+ address_id?: string;
2298
+ callback_url?: string;
2299
+ delivery_address?: any;
2300
+ staff?: StaffCheckout;
2301
+ order_type?: string;
2302
+ ordering_store?: number;
2289
2303
  extra_meta?: any;
2290
- identifiers: CartProductIdentifer;
2291
- item_id?: number;
2292
- item_index?: number;
2293
- item_size?: string;
2304
+ payment_identifier?: string;
2305
+ billing_address?: any;
2306
+ payment_params?: any;
2307
+ billing_address_id?: string;
2294
2308
  meta?: any;
2295
- parent_item_identifiers?: any;
2296
- quantity?: number;
2309
+ iin?: string;
2310
+ network?: string;
2311
+ type?: string;
2312
+ card_id?: string;
2297
2313
  };