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