@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,3994 +0,0 @@
|
|
|
1
|
-
export = CartApplicationModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef BuyRules
|
|
4
|
-
* @property {Object} [item_criteria] - Item criteria of promotion.
|
|
5
|
-
* @property {Object} [cart_conditions] - Cart conditions details for promotion.
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
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.
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* @typedef Ownership
|
|
16
|
-
* @property {string} [payable_category] - Promotion amount payable category.
|
|
17
|
-
* @property {string} [payable_by] - Promotion amount bearable party.
|
|
18
|
-
*/
|
|
19
|
-
/**
|
|
20
|
-
* @typedef AppliedFreeArticles
|
|
21
|
-
* @property {FreeGiftItems} [free_gift_item_details] - Free gift items details.
|
|
22
|
-
* @property {string} [parent_item_identifier] - Parent item identifier for free article.
|
|
23
|
-
* @property {number} [quantity] - Quantity of free articles.
|
|
24
|
-
* @property {string} [article_id] - IDs of free articles.
|
|
25
|
-
*/
|
|
26
|
-
/**
|
|
27
|
-
* @typedef AppliedPromotion
|
|
28
|
-
* @property {string} [promo_id] - Promotion id.
|
|
29
|
-
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions.
|
|
30
|
-
* @property {string} [offer_text] - Offer text of current promotion.
|
|
31
|
-
* @property {string} [promotion_group] - Promotion group for the promotion.
|
|
32
|
-
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
33
|
-
* product MRP or ESP.
|
|
34
|
-
* @property {string} [promotion_name] - Promotion name of current promotion.
|
|
35
|
-
* @property {number} [amount] - Per unit discount amount applied with current promotion.
|
|
36
|
-
* @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions.
|
|
37
|
-
* @property {Ownership} [ownership] - Ownership of promotion.
|
|
38
|
-
* @property {number} [article_quantity] - Quantity of article on which
|
|
39
|
-
* promotion is applicable.
|
|
40
|
-
* @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
|
|
41
|
-
* article for free gift item promotions.
|
|
42
|
-
* @property {string} [promotion_type] - Promotion type of current promotion.
|
|
43
|
-
* @property {Object} [meta] - Meta object for extra data.
|
|
44
|
-
* @property {string} [code] - Promotion code.
|
|
45
|
-
*/
|
|
46
|
-
/**
|
|
47
|
-
* @typedef PaymentSelectionLock
|
|
48
|
-
* @property {boolean} [enabled] - Denotes if default payment selection is enable.
|
|
49
|
-
* @property {string} [default_options] - Default Selection Payment Mode.
|
|
50
|
-
* @property {string} [payment_identifier] - Identifier for Payment Mode.
|
|
51
|
-
*/
|
|
52
|
-
/**
|
|
53
|
-
* @typedef PromiseFormatted
|
|
54
|
-
* @property {string} [max] - Maximum Delivery promise formatted timestamp.
|
|
55
|
-
* @property {string} [min] - Minimum Delivery promise formatted timestamp.
|
|
56
|
-
*/
|
|
57
|
-
/**
|
|
58
|
-
* @typedef PromiseISOFormat
|
|
59
|
-
* @property {string} [max] - Max promise in ISO format.
|
|
60
|
-
* @property {string} [min] - Min Promise in ISO format.
|
|
61
|
-
*/
|
|
62
|
-
/**
|
|
63
|
-
* @typedef PromiseTimestamp
|
|
64
|
-
* @property {number} [max] - Maximum Promise for the shipment.
|
|
65
|
-
* @property {number} [min] - Minimum delivery promise time for the shipment.
|
|
66
|
-
*/
|
|
67
|
-
/**
|
|
68
|
-
* @typedef ShipmentPromise
|
|
69
|
-
* @property {PromiseFormatted} [formatted]
|
|
70
|
-
* @property {PromiseTimestamp} [timestamp]
|
|
71
|
-
* @property {PromiseISOFormat} [iso]
|
|
72
|
-
*/
|
|
73
|
-
/**
|
|
74
|
-
* @typedef BasePrice
|
|
75
|
-
* @property {number} [effective] - Current per unit price of product after
|
|
76
|
-
* existing deductions.
|
|
77
|
-
* @property {string} [currency_symbol] - Currency symbol of the currncy used for price.
|
|
78
|
-
* @property {number} [marked] - Original price of product.
|
|
79
|
-
* @property {string} [currency_code] - Currency code for all amounts.
|
|
80
|
-
*/
|
|
81
|
-
/**
|
|
82
|
-
* @typedef ArticlePriceInfo
|
|
83
|
-
* @property {BasePrice} [base]
|
|
84
|
-
* @property {BasePrice} [converted]
|
|
85
|
-
*/
|
|
86
|
-
/**
|
|
87
|
-
* @typedef BaseInfo
|
|
88
|
-
* @property {number} [uid] - Unique identifier of entities like brand or seller.
|
|
89
|
-
* @property {string} [name] - Name of entities like brand or seller.
|
|
90
|
-
*/
|
|
91
|
-
/**
|
|
92
|
-
* @typedef StoreInfo
|
|
93
|
-
* @property {string} [store_code] - A unique code or identifier for the store,
|
|
94
|
-
* often used for internal reference.
|
|
95
|
-
* @property {number} [uid] - Unique identifiers of the store from where product
|
|
96
|
-
* is fulfileld.
|
|
97
|
-
* @property {string} [name] - Store name of the store from where the product is
|
|
98
|
-
* fulfiled .
|
|
99
|
-
*/
|
|
100
|
-
/**
|
|
101
|
-
* @typedef ProductArticle
|
|
102
|
-
* @property {ArticlePriceInfo} [price]
|
|
103
|
-
* @property {string[]} [product_group_tags] - List fot the unique identifier
|
|
104
|
-
* for the product grouping.
|
|
105
|
-
* @property {Object} [extra_meta] - Field to update extra meta of the article in cart.
|
|
106
|
-
* @property {number} [quantity] - Quantity of the article added in cart.
|
|
107
|
-
* @property {Object} [_custom_json] - Field to update custom json of the article in cart.
|
|
108
|
-
* @property {Object} [meta] - Article meta data.
|
|
109
|
-
* @property {string} [size] - Size of the article added in cart.
|
|
110
|
-
* @property {number} [mto_quantity] - Quantity of the product which will
|
|
111
|
-
* specially manufactured as not available in stock.
|
|
112
|
-
* @property {BaseInfo} [seller]
|
|
113
|
-
* @property {string} [seller_identifier] - List of identifiers used by sellers
|
|
114
|
-
* for the product size.
|
|
115
|
-
* @property {Object} [parent_item_identifiers] - Fields to determine parent
|
|
116
|
-
* product of the product.
|
|
117
|
-
* @property {Object} [identifier] - Unique identifier of the article.
|
|
118
|
-
* @property {StoreInfo} [store]
|
|
119
|
-
* @property {Object} [cart_item_meta] - Meta details of the article added from cart.
|
|
120
|
-
* @property {string} [uid] - This unique identifier is assigned to the specific
|
|
121
|
-
* article. This represents item x size x location.
|
|
122
|
-
* @property {Object} [gift_card] - Gift card detail if gift card applied to the
|
|
123
|
-
* product which indicates gift price, gift applicable flag and display
|
|
124
|
-
* message for the gift.
|
|
125
|
-
* @property {boolean} [is_gift_visible] - Whether the product can be purchased
|
|
126
|
-
* as a gift. It is true if the product is available for gifting and false otherwise.
|
|
127
|
-
* @property {string} [type] - Type of the data sent in response. Possible value
|
|
128
|
-
* is article.
|
|
129
|
-
* @property {string[]} [tags] - A list of article tags.
|
|
130
|
-
*/
|
|
131
|
-
/**
|
|
132
|
-
* @typedef CartProductIdentifer
|
|
133
|
-
* @property {string} [identifier] - Article idenfier generated by cart.
|
|
134
|
-
*/
|
|
135
|
-
/**
|
|
136
|
-
* @typedef PromoMeta
|
|
137
|
-
* @property {string} [message] - Loyalty points message denotes how much
|
|
138
|
-
* loyalty points and applied and how much left with the user.
|
|
139
|
-
*/
|
|
140
|
-
/**
|
|
141
|
-
* @typedef ChargesAmount
|
|
142
|
-
* @property {number} [value] - This is the value of amount added.
|
|
143
|
-
* @property {string} [currency] - This is destination currency of value.
|
|
144
|
-
*/
|
|
145
|
-
/**
|
|
146
|
-
* @typedef Charges
|
|
147
|
-
* @property {Object} [meta] - Meta data realted to charges price adjustment.
|
|
148
|
-
* @property {ChargesAmount} [amount]
|
|
149
|
-
* @property {string} [name] - Name of the charge applied.
|
|
150
|
-
* @property {boolean} [allow_refund] - Whether refund is allowed or not for the charge.
|
|
151
|
-
* @property {string} [code] - Code of the charge applied.
|
|
152
|
-
* @property {string} [type] - Type of the charge applied.
|
|
153
|
-
*/
|
|
154
|
-
/**
|
|
155
|
-
* @typedef ProductPrice
|
|
156
|
-
* @property {string} [currency_symbol] - Currency symbol of the price defined
|
|
157
|
-
* for the product.
|
|
158
|
-
* @property {number} [selling] - Selling price of the product .
|
|
159
|
-
* @property {string} [currency_code] - Currency code of the price defined for
|
|
160
|
-
* the product.
|
|
161
|
-
* @property {number} [add_on] - Price before promotion and coupon amount
|
|
162
|
-
* applied for calculation.
|
|
163
|
-
* @property {number} [effective] - Selling price of the product .
|
|
164
|
-
* @property {number} [marked] - Maximum price of the product .
|
|
165
|
-
*/
|
|
166
|
-
/**
|
|
167
|
-
* @typedef ProductPriceInfo
|
|
168
|
-
* @property {ProductPrice} [base]
|
|
169
|
-
* @property {ProductPrice} [converted]
|
|
170
|
-
*/
|
|
171
|
-
/**
|
|
172
|
-
* @typedef ProductPricePerUnit
|
|
173
|
-
* @property {string} [currency_symbol] - Currency symbol of the price defined
|
|
174
|
-
* for the product.
|
|
175
|
-
* @property {number} [selling_price] - Selling price of the product .
|
|
176
|
-
* @property {string} [currency_code] - Currency code of the price defined for
|
|
177
|
-
* the product.
|
|
178
|
-
* @property {number} [add_on] - Price before promotion and coupon amount
|
|
179
|
-
* applied for calculation.
|
|
180
|
-
* @property {number} [effective] - Selling price of the product .
|
|
181
|
-
* @property {number} [marked] - Maximum price of the product .
|
|
182
|
-
*/
|
|
183
|
-
/**
|
|
184
|
-
* @typedef ProductPricePerUnitInfo
|
|
185
|
-
* @property {ProductPricePerUnit} [base]
|
|
186
|
-
* @property {ProductPricePerUnit} [converted]
|
|
187
|
-
*/
|
|
188
|
-
/**
|
|
189
|
-
* @typedef ProductAvailabilitySize
|
|
190
|
-
* @property {string} [display] - Display size of the product.
|
|
191
|
-
* @property {string} [value] - Actual value of the size.
|
|
192
|
-
* @property {boolean} [is_available] - Available flag for the size of the
|
|
193
|
-
* product if that is available.
|
|
194
|
-
*/
|
|
195
|
-
/**
|
|
196
|
-
* @typedef ProductAvailability
|
|
197
|
-
* @property {boolean} [out_of_stock] - Denotes if the product is available in stock.
|
|
198
|
-
* @property {boolean} [deliverable] - Deliverable flag denotes if the product
|
|
199
|
-
* is deliverable or not.
|
|
200
|
-
* @property {ProductAvailabilitySize[]} [available_sizes] - Product sizes availability.
|
|
201
|
-
* @property {boolean} [is_valid] - Valid flag for the product if the product
|
|
202
|
-
* added in cart is valid to place the order.
|
|
203
|
-
* @property {number} [other_store_quantity] - Quantity of the product available
|
|
204
|
-
* on other store.
|
|
205
|
-
* @property {string[]} [sizes] - All sizes of the product.
|
|
206
|
-
*/
|
|
207
|
-
/**
|
|
208
|
-
* @typedef ActionQuery
|
|
209
|
-
* @property {string[]} [product_slug] - Contains list of product slug.
|
|
210
|
-
*/
|
|
211
|
-
/**
|
|
212
|
-
* @typedef ProductAction
|
|
213
|
-
* @property {ActionQuery} [query]
|
|
214
|
-
* @property {string} [url] - Url of the product to render the product .
|
|
215
|
-
* @property {string} [type] - Type of action.
|
|
216
|
-
*/
|
|
217
|
-
/**
|
|
218
|
-
* @typedef Tags
|
|
219
|
-
* @property {Object} [tags] - Tags is a lable or batch that is attached to a
|
|
220
|
-
* product in cart.
|
|
221
|
-
*/
|
|
222
|
-
/**
|
|
223
|
-
* @typedef ProductImage
|
|
224
|
-
* @property {string} [secure_url] - Secured url of the product image.
|
|
225
|
-
* @property {string} [aspect_ratio] - Aspect ratio of the product image.
|
|
226
|
-
* @property {string} [url] - Bucket link url for product image.
|
|
227
|
-
*/
|
|
228
|
-
/**
|
|
229
|
-
* @typedef CategoryInfo
|
|
230
|
-
* @property {number} [uid] - Product Category Id.
|
|
231
|
-
* @property {string} [name] - Category name of the product .
|
|
232
|
-
*/
|
|
233
|
-
/**
|
|
234
|
-
* @typedef CartProduct
|
|
235
|
-
* @property {Object} [_custom_json] - Field to add custom json of the product in cart.
|
|
236
|
-
* @property {BaseInfo} [brand]
|
|
237
|
-
* @property {ProductAction} [action]
|
|
238
|
-
* @property {Tags} [teaser_tag]
|
|
239
|
-
* @property {string} [slug] - Unique product url name generated via product
|
|
240
|
-
* name and other meta data.
|
|
241
|
-
* @property {ProductImage[]} [images] - Product Images urls of different types
|
|
242
|
-
* like secure url, aspect ration url and url.
|
|
243
|
-
* @property {number} [uid] - Unique identifier of the product in cart.
|
|
244
|
-
* @property {string} [name] - Product name of the product in cart which is
|
|
245
|
-
* defined on platform.
|
|
246
|
-
* @property {string} [item_code] - Product code of the product while defining
|
|
247
|
-
* product on platform.
|
|
248
|
-
* @property {CategoryInfo[]} [categories] - Product category information which
|
|
249
|
-
* incldes category name and category id.
|
|
250
|
-
* @property {string[]} [tags] - Products tags that are added to each product to
|
|
251
|
-
* identify the set of products.
|
|
252
|
-
* @property {string} [type] - Type of product in cart.
|
|
253
|
-
* @property {Object} [attributes] - Product attributes defined on platform.
|
|
254
|
-
*/
|
|
255
|
-
/**
|
|
256
|
-
* @typedef CouponDetails
|
|
257
|
-
* @property {number} [discount_single_quantity] - Discout amount applied from
|
|
258
|
-
* coupon for single quantity of the product.
|
|
259
|
-
* @property {string} [code] - Coupon code of the coupon applied.
|
|
260
|
-
* @property {number} [discount_total_quantity] - Total discount earned from
|
|
261
|
-
* coupon applied to cart.
|
|
262
|
-
*/
|
|
263
|
-
/**
|
|
264
|
-
* @typedef CartProductInfo
|
|
265
|
-
* @property {ProductArticle} [article]
|
|
266
|
-
* @property {Object} [moq] - An Integer indication the Minimum Order Quantity
|
|
267
|
-
* of a product, e.g. 100.
|
|
268
|
-
* @property {CartProductIdentifer} identifiers
|
|
269
|
-
* @property {PromoMeta} [promo_meta]
|
|
270
|
-
* @property {ProductPriceInfo} [price]
|
|
271
|
-
* @property {number} [quantity] - Quantity of the product added in cart.
|
|
272
|
-
* @property {Charges[]} [charges] - Charges information which denotes types of
|
|
273
|
-
* charges and amount of charge applied to that product in cart.
|
|
274
|
-
* @property {string} [discount] - Discount amount of the product in cart.
|
|
275
|
-
* @property {ProductAvailability} [availability]
|
|
276
|
-
* @property {ShipmentPromise} [delivery_promise]
|
|
277
|
-
* @property {CartProduct} [product]
|
|
278
|
-
* @property {string} [product_ean_id] - European Article Number of the product
|
|
279
|
-
* (limited upto 50 EAN identifier in a single request).
|
|
280
|
-
* @property {Object} [bulk_offer] - Bulk offer information for the product
|
|
281
|
-
* which denotes if any bulk offer is applied to the product in cart.
|
|
282
|
-
* @property {Object} [parent_item_identifiers] - Parent item information of the
|
|
283
|
-
* product which identifies the parent of the product in cart.
|
|
284
|
-
* @property {CouponDetails} [coupon]
|
|
285
|
-
* @property {Object} [custom_order] - Whether MTO (Make to Order) is enabled or not.
|
|
286
|
-
* @property {string} [coupon_message] - Message for the coupon denotes which
|
|
287
|
-
* coupon is applied and empty if not applied.
|
|
288
|
-
* @property {string} [key] - The attribute key associated with the size.
|
|
289
|
-
* @property {string} [message] - Product level message which denotes error
|
|
290
|
-
* information to display over the product in cart.
|
|
291
|
-
* @property {boolean} [is_set] - Whether or not the product is a set of items.
|
|
292
|
-
* @property {ProductPricePerUnitInfo} [price_per_unit]
|
|
293
|
-
* @property {AppliedPromotion[]} [promotions_applied] - List of applicable
|
|
294
|
-
* promotion for the product in cart.
|
|
295
|
-
*/
|
|
296
|
-
/**
|
|
297
|
-
* @typedef DisplayBreakup
|
|
298
|
-
* @property {string} [currency_symbol] - Currency symbol for the price.
|
|
299
|
-
* @property {string} [key] - Key of the price like total_mrp, total, subtotal etc.
|
|
300
|
-
* @property {string} [display] - Display key field that to be shown against the value.
|
|
301
|
-
* @property {string[]} [message] - List of message at price level to be displayed.
|
|
302
|
-
* @property {string} [currency_code] - Currency code for the price .
|
|
303
|
-
* @property {number} [value] - Numeric value of the price.
|
|
304
|
-
* @property {number} [preset] - Value for the price which is set from platform
|
|
305
|
-
* if applicable.
|
|
306
|
-
*/
|
|
307
|
-
/**
|
|
308
|
-
* @typedef RawBreakup
|
|
309
|
-
* @property {number} [vog] - Total value of goods after all discount, coupons
|
|
310
|
-
* and promotion applied of all products in cart.
|
|
311
|
-
* @property {number} [subtotal] - Selling price amount of all products in cart.
|
|
312
|
-
* @property {number} [fynd_cash] - Loyalty points applied on cart.
|
|
313
|
-
* @property {number} [discount] - Discount amount recieved on cart.
|
|
314
|
-
* @property {number} [convenience_fee] - Convenience fee amount applied to cart.
|
|
315
|
-
* @property {number} [delivery_charge] - Delivery charge applied to cart.
|
|
316
|
-
* @property {number} [gst_charges] - GST charges applied on cart.
|
|
317
|
-
* @property {number} [mrp_total] - Maximum price total amount of all products in cart.
|
|
318
|
-
* @property {number} [mop_total] - Total of payment modes by which payment is
|
|
319
|
-
* going to be done.
|
|
320
|
-
* @property {number} [total_charge] - Total amount of charges applied on cart.
|
|
321
|
-
* @property {number} [coupon] - Coupon amount applied to cart.
|
|
322
|
-
* @property {number} [total] - Total payable amount by the customer.
|
|
323
|
-
* @property {number} [gift_card] - Gift cart amount applied on cart.
|
|
324
|
-
* @property {number} [you_saved] - Total amount will be saved if customer
|
|
325
|
-
* places the order.
|
|
326
|
-
* @property {number} [cod_charge] - Cod charge value applied to cart. This is
|
|
327
|
-
* applied when user select payment mode as COD.
|
|
328
|
-
*/
|
|
329
|
-
/**
|
|
330
|
-
* @typedef CouponBreakup
|
|
331
|
-
* @property {number} [coupon_value] - Value of the coupon applied to cart.
|
|
332
|
-
* @property {string} [title] - Coupon Title of the coupon applied denotes name
|
|
333
|
-
* of the coupon.
|
|
334
|
-
* @property {string} [sub_title] - Coupon subtitle of the coupon applied to
|
|
335
|
-
* cart which is used to display.
|
|
336
|
-
* @property {number} [minimum_cart_value] - Minumum cart value of cart after
|
|
337
|
-
* which the coupon can be applied.
|
|
338
|
-
* @property {string} [message] - Coupon message of the coupon applied to cart.
|
|
339
|
-
* @property {string} [coupon_type] - Type of the coupon applied to cart.
|
|
340
|
-
* @property {string} [uid] - Unique identifier of the coupon applied to cart.
|
|
341
|
-
* @property {number} [value] - Coupon value of the coupon applied to cart.
|
|
342
|
-
* @property {number} [max_discount_value] - Maximum discount value of the
|
|
343
|
-
* coupon applied to cart.
|
|
344
|
-
* @property {boolean} [is_applied] - Applied flag which denotes if any coupon
|
|
345
|
-
* is applied to cart.
|
|
346
|
-
* @property {string} [description] - Coupon description of the coupon applied to cart.
|
|
347
|
-
* @property {string} [code] - Coupon code of the coupon applied.
|
|
348
|
-
* @property {string} [type] - Type of the coupon applied to cart.
|
|
349
|
-
*/
|
|
350
|
-
/**
|
|
351
|
-
* @typedef LoyaltyPoints
|
|
352
|
-
* @property {number} [total] - Total loyalty points available with user.
|
|
353
|
-
* @property {string} [description] - Description for loyalty points.
|
|
354
|
-
* @property {number} [applicable] - Whether the loyalty points are applicable
|
|
355
|
-
* for the cart .
|
|
356
|
-
* @property {boolean} [is_applied] - Whether the loyalty points are applied on the cart .
|
|
357
|
-
*/
|
|
358
|
-
/**
|
|
359
|
-
* @typedef CartBreakup
|
|
360
|
-
* @property {DisplayBreakup[]} [display] - List of breakup data which is used
|
|
361
|
-
* to display the breakup to the customer like MRP total, Discount, Sub total,
|
|
362
|
-
* coupon value, promotion value and final total.
|
|
363
|
-
* @property {RawBreakup} [raw]
|
|
364
|
-
* @property {CouponBreakup} [coupon]
|
|
365
|
-
* @property {LoyaltyPoints} [loyalty_points]
|
|
366
|
-
*/
|
|
367
|
-
/**
|
|
368
|
-
* @typedef CartCurrency
|
|
369
|
-
* @property {string} [code] - Currency code defined by ISO 4217:2015.
|
|
370
|
-
* @property {string} [symbol] - Currency symbol for currency of user cart prices.
|
|
371
|
-
*/
|
|
372
|
-
/**
|
|
373
|
-
* @typedef CartDetailCoupon
|
|
374
|
-
* @property {number} [cashback_amount] - Fields denotes cashback amount applied to cart.
|
|
375
|
-
* @property {string} [cashback_message_primary] - Primary cashback message for
|
|
376
|
-
* coupon applied to cart.
|
|
377
|
-
* @property {string} [cashback_message_secondary] - Secondary cashback message
|
|
378
|
-
* for coupon applied to cart.
|
|
379
|
-
* @property {string} [coupon_code] - Coupon code to be applied to cart.
|
|
380
|
-
* @property {string} [coupon_description] - Coupon description of the coupon
|
|
381
|
-
* applied to cart.
|
|
382
|
-
* @property {string} [coupon_id] - Unique identifier of the coupon applied to cart.
|
|
383
|
-
* @property {string} [coupon_subtitle] - Coupon subtitle of the coupon applied to cart.
|
|
384
|
-
* @property {string} [coupon_title] - Coupon Title of the coupon applied.
|
|
385
|
-
* @property {string} [coupon_type] - Type of the coupon applied to cart.
|
|
386
|
-
* @property {number} [coupon_value] - Value of the coupon applied to cart.
|
|
387
|
-
* @property {number} [discount] - Total discount earned from coupon applied to cart.
|
|
388
|
-
* @property {boolean} [is_applied] - Flag to determine where the coupon is
|
|
389
|
-
* applied to cart or not.
|
|
390
|
-
* @property {boolean} [is_valid] - Determine where the coupon applied to cart is valid.
|
|
391
|
-
* @property {number} [maximum_discount_value] - Maximum discount value of the
|
|
392
|
-
* coupon applied to cart.
|
|
393
|
-
* @property {string} [message] - Coupon message of the coupon applied to cart.
|
|
394
|
-
* @property {number} [minimum_cart_value] - Minimum cart value of the coupon
|
|
395
|
-
* applied to cart.
|
|
396
|
-
*/
|
|
397
|
-
/**
|
|
398
|
-
* @typedef ChargesThreshold
|
|
399
|
-
* @property {number} [charges] - Charges amount to be applied on cart.
|
|
400
|
-
* @property {number} [threshold] - Threshold of cart value on which the charge
|
|
401
|
-
* should be applied .
|
|
402
|
-
*/
|
|
403
|
-
/**
|
|
404
|
-
* @typedef DeliveryChargesConfig
|
|
405
|
-
* @property {boolean} [enabled] - Delivery charge enabled for the cart or not.
|
|
406
|
-
* @property {ChargesThreshold[]} [charges] - Charges applicable based on threshold.
|
|
407
|
-
*/
|
|
408
|
-
/**
|
|
409
|
-
* @typedef CartCommonConfig
|
|
410
|
-
* @property {DeliveryChargesConfig} [delivery_charges_config]
|
|
411
|
-
*/
|
|
412
|
-
/**
|
|
413
|
-
* @typedef CartDetailResponse
|
|
414
|
-
* @property {number} [cart_id] - Unique identifier of the user cart.
|
|
415
|
-
* @property {string} [uid] - Unique identifier of the user cart.
|
|
416
|
-
* @property {AppliedPromotion[]} [applied_promo_details] - List of applied
|
|
417
|
-
* promotions data to cart which includes promotion id, promotion name, offer
|
|
418
|
-
* text, description, buy rules, discount rules and promotion type.
|
|
419
|
-
* @property {string} [checkout_mode] - Checkout mode of user cart.
|
|
420
|
-
* @property {string} [pan_no] - Permanent Account Number of the user.
|
|
421
|
-
* @property {boolean} [is_valid] - Cart validity flag determines the if the
|
|
422
|
-
* response is valid or not.
|
|
423
|
-
* @property {string} [id] - Unique identifier of the user cart.
|
|
424
|
-
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
425
|
-
* @property {ShipmentPromise} [delivery_promise]
|
|
426
|
-
* @property {string} [comment] - Comment message to be added in user cart.
|
|
427
|
-
* @property {CartProductInfo[]} [items] - Items data list in user cart that
|
|
428
|
-
* includes item id, item size, store id, available sizes and rest of the item
|
|
429
|
-
* related data.
|
|
430
|
-
* @property {string} [delivery_charge_info] - Delivery charge in information
|
|
431
|
-
* message on shipment .
|
|
432
|
-
* @property {CartCommonConfig} [common_config]
|
|
433
|
-
* @property {CartDetailCoupon} [coupon]
|
|
434
|
-
* @property {string} [message] - Message of the get cart detail API response.
|
|
435
|
-
* @property {Object} [notification] - Notification object which denotes
|
|
436
|
-
* notification data for user cart.
|
|
437
|
-
* @property {string} [staff_user_id] - Staff employee user id if cart is
|
|
438
|
-
* created by staff employee for the customer.
|
|
439
|
-
* @property {boolean} [success] - Success flag of get cart detail API response.
|
|
440
|
-
* @property {string} [gstin] - GSTIN added in user cart.
|
|
441
|
-
* @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
|
|
442
|
-
* the checkout process.
|
|
443
|
-
* @property {string} [last_modified] - Last modified timestamp of cart.
|
|
444
|
-
* @property {CartBreakup} [breakup_values]
|
|
445
|
-
* @property {CartCurrency} [currency]
|
|
446
|
-
* @property {string} [coupon_text] - Coupon text of coupon applied on cart.
|
|
447
|
-
* @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
|
|
448
|
-
* is doing fast checkout for the cart using buy now.
|
|
449
|
-
* @property {Object} [pan_config] - Pan card config states at what condition
|
|
450
|
-
* user should enter the pan card.
|
|
451
|
-
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
452
|
-
* checkout API payload .
|
|
453
|
-
*/
|
|
454
|
-
/**
|
|
455
|
-
* @typedef AddProductCart
|
|
456
|
-
* @property {Object} [article_assignment] - Field to determine how article
|
|
457
|
-
* assignment should happen by article assignment level and strategy.
|
|
458
|
-
* @property {string[]} [product_group_tags] - Field to specify the product
|
|
459
|
-
* groups of the product that the user is trying to add in cart.
|
|
460
|
-
* @property {Object} [extra_meta] - Extra meta data to be added at article
|
|
461
|
-
* level while add items to cart.
|
|
462
|
-
* @property {number} [quantity] - Field to specify the product quantity that
|
|
463
|
-
* user wants to buy.
|
|
464
|
-
* @property {Object} [_custom_json] - Field to add custom json at article level
|
|
465
|
-
* while add items to cart .
|
|
466
|
-
* @property {string} [item_size] - Field to determine size of the product.
|
|
467
|
-
* @property {number} [store_id] - Unique identifier of the store selected by
|
|
468
|
-
* the user from which user want to buy a product.
|
|
469
|
-
* @property {string} [display] - Display field at article level .
|
|
470
|
-
* @property {string} [article_id] - Unique identifier of an article .
|
|
471
|
-
* @property {Object[]} [parent_item_identifiers] - Fields to determine parent
|
|
472
|
-
* product of the product.
|
|
473
|
-
* @property {number} [seller_id] - Unique idetifier of the seller selected by
|
|
474
|
-
* the user from which user want to buy a product .
|
|
475
|
-
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
476
|
-
* from pos or not.
|
|
477
|
-
* @property {number} [item_id] - Unique identifier to identify product.
|
|
478
|
-
* @property {Object} [meta] - Field to add meta data at article level.
|
|
479
|
-
* @property {string} [seller_identifier] - Add items using seller identifier
|
|
480
|
-
* for store os.
|
|
481
|
-
*/
|
|
482
|
-
/**
|
|
483
|
-
* @typedef AddCartRequest
|
|
484
|
-
* @property {AddProductCart[]} [items] - List of items detail which need to be
|
|
485
|
-
* added to cart like item id, item size, and item quantity.
|
|
486
|
-
* @property {boolean} [new_cart] - Field to create to new cart whille user adds
|
|
487
|
-
* item to cart.
|
|
488
|
-
*/
|
|
489
|
-
/**
|
|
490
|
-
* @typedef AddCartDetailResponse
|
|
491
|
-
* @property {string} [message] - Message of add to cart API response.
|
|
492
|
-
* @property {boolean} [partial] - When adding multiple items check if all
|
|
493
|
-
* added. True if only few are added.
|
|
494
|
-
* @property {CartDetailResponse} [cart]
|
|
495
|
-
* @property {boolean} [success] - True if all items are added successfully.
|
|
496
|
-
* False if partially added or not added.
|
|
497
|
-
*/
|
|
498
|
-
/**
|
|
499
|
-
* @typedef UpdateProductCart
|
|
500
|
-
* @property {Object} [extra_meta] - Field to update extra meta of the product in cart.
|
|
501
|
-
* @property {Object} [_custom_json] - Field to update custom json of the product in cart.
|
|
502
|
-
* @property {number} [quantity] - Field to update the quantity of the item in cart.
|
|
503
|
-
* @property {string} [item_size] - Field to update the size of the product in cart.
|
|
504
|
-
* @property {number} [item_index] - Item index determines on which index the
|
|
505
|
-
* product falls to be updated.
|
|
506
|
-
* @property {CartProductIdentifer} identifiers
|
|
507
|
-
* @property {string} [article_id] - Article id of the product in cart.
|
|
508
|
-
* @property {Object} [parent_item_identifiers] - Field to update parent product
|
|
509
|
-
* of the item in cart.
|
|
510
|
-
* @property {number} [item_id] - Item id of the product that needs to be updated.
|
|
511
|
-
* @property {Object} [meta] - Field to update meta of the item in cart.
|
|
512
|
-
*/
|
|
513
|
-
/**
|
|
514
|
-
* @typedef UpdateCartRequest
|
|
515
|
-
* @property {UpdateProductCart[]} [items] - List items data that needs to be
|
|
516
|
-
* updated in cart.
|
|
517
|
-
* @property {string} operation - Field to determine if item to be removed from
|
|
518
|
-
* cart or it needs to be updated.
|
|
519
|
-
*/
|
|
520
|
-
/**
|
|
521
|
-
* @typedef UpdateCartDetailResponse
|
|
522
|
-
* @property {string} [message] - Message of update cart API response.
|
|
523
|
-
* @property {CartDetailResponse} [cart]
|
|
524
|
-
* @property {boolean} [success] - True if all items are added successfully.
|
|
525
|
-
* False if partially added or not added.
|
|
526
|
-
*/
|
|
527
|
-
/**
|
|
528
|
-
* @typedef DeleteCartDetailResponse
|
|
529
|
-
* @property {string} [message] - Message for delete cart response.
|
|
530
|
-
* @property {boolean} [success] - True if cart is archived successfully. False
|
|
531
|
-
* if not archived.
|
|
532
|
-
*/
|
|
533
|
-
/**
|
|
534
|
-
* @typedef CartItemCountResponse
|
|
535
|
-
* @property {number} [user_cart_items_count] - Item count present in cart.
|
|
536
|
-
*/
|
|
537
|
-
/**
|
|
538
|
-
* @typedef PageCoupon
|
|
539
|
-
* @property {number} [total_item_count] - Total coupons are available for the cart.
|
|
540
|
-
* @property {boolean} [has_next] - Denotes if next page of coupon is available.
|
|
541
|
-
* @property {number} [total] - Total pages of coupon availalbe.
|
|
542
|
-
* @property {number} [current] - Current page number.
|
|
543
|
-
* @property {boolean} [has_previous] - Denotes if previous page of the coupon
|
|
544
|
-
* is available.
|
|
545
|
-
*/
|
|
546
|
-
/**
|
|
547
|
-
* @typedef Coupon
|
|
548
|
-
* @property {number} [coupon_amount] - The amount based on cart value.
|
|
549
|
-
* @property {number} [coupon_value] - Coupon value of the coupon applied to cart.
|
|
550
|
-
* @property {string} [title] - Coupon Title of the coupon applied denotes name
|
|
551
|
-
* of the coupon.
|
|
552
|
-
* @property {number} [minimum_cart_value] - Minimum cart value of the coupon
|
|
553
|
-
* applied to cart.
|
|
554
|
-
* @property {string} [sub_title] - Coupon subtitle of the coupon applied to
|
|
555
|
-
* cart which is used to display.
|
|
556
|
-
* @property {string} [expires_on] - Message to display to user for expiry of the coupon .
|
|
557
|
-
* @property {string} [message] - Coupon message of the coupon applied to cart.
|
|
558
|
-
* @property {string} [coupon_type] - Type of the coupon applied to cart.
|
|
559
|
-
* @property {number} [max_discount_value] - Maximum discount value of the
|
|
560
|
-
* coupon applied to cart.
|
|
561
|
-
* @property {string} [coupon_code] - Coupon code of the coupon applied on cart.
|
|
562
|
-
* @property {boolean} [is_applicable] - Flag to determine where the coupon is
|
|
563
|
-
* applicable to cart or not.
|
|
564
|
-
* @property {string} [description] - Coupon description of the coupon applied to cart.
|
|
565
|
-
* @property {boolean} [is_applied] - Flag to determine where the coupon is
|
|
566
|
-
* applied to cart or not.
|
|
567
|
-
* @property {string} [start_date] - Start date of the coupon when the coupon
|
|
568
|
-
* will be live for the users to apply on cart.
|
|
569
|
-
* @property {string} [end_date] - End date of the coupon on which the coupon expires.
|
|
570
|
-
* @property {string} [coupon_applicable_message] - Message which is used to
|
|
571
|
-
* display to the customer if the coupon is applied successfully.
|
|
572
|
-
* @property {string} [offer_text] - Offer text of the coupon which highligts
|
|
573
|
-
* coupon offer defined while creating coupon .
|
|
574
|
-
* @property {boolean} [is_bank_offer] - Bank offer flag for the coupon if the
|
|
575
|
-
* coupon is applicable for only if payment done by bank or mode specified in coupon.
|
|
576
|
-
*/
|
|
577
|
-
/**
|
|
578
|
-
* @typedef GetCouponResponse
|
|
579
|
-
* @property {PageCoupon} [page]
|
|
580
|
-
* @property {Coupon[]} [available_coupon_list] - List of available coupon which
|
|
581
|
-
* can be applied on cart.
|
|
582
|
-
*/
|
|
583
|
-
/**
|
|
584
|
-
* @typedef ApplyCouponRequest
|
|
585
|
-
* @property {string} coupon_code - Coupon code to be applied.
|
|
586
|
-
*/
|
|
587
|
-
/**
|
|
588
|
-
* @typedef OfferPrice
|
|
589
|
-
* @property {string} [currency_symbol] - Currency symbol for currency.
|
|
590
|
-
* @property {number} [bulk_effective] - Discounted per unit price for current
|
|
591
|
-
* offer object.
|
|
592
|
-
* @property {string} [currency_code] - The currency code for an offer price is
|
|
593
|
-
* the three-letter code that corresponds to the currency in which the offer
|
|
594
|
-
* price is denominated.
|
|
595
|
-
* @property {number} [effective] - The "effective price" is the actual price
|
|
596
|
-
* paid by the consumer after accounting for product discounts. It represents
|
|
597
|
-
* the true cost of a product or service after all adjustments have been made.
|
|
598
|
-
* @property {number} [marked] - The price at which the product is sold to the
|
|
599
|
-
* end consumer, typically the original price before discounts.
|
|
600
|
-
*/
|
|
601
|
-
/**
|
|
602
|
-
* @typedef OfferItem
|
|
603
|
-
* @property {OfferPrice} [price]
|
|
604
|
-
* @property {number} [margin] - Percentage value of discount.
|
|
605
|
-
* @property {number} [quantity] - Quantity on which offer is applicable.
|
|
606
|
-
* @property {boolean} [best] - Is true for best offer from all offers present
|
|
607
|
-
* for all sellers.
|
|
608
|
-
* @property {number} [total] - Total price of offer quantity with discount.
|
|
609
|
-
* @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart.
|
|
610
|
-
* @property {string} [type] - Type of the offer.
|
|
611
|
-
*/
|
|
612
|
-
/**
|
|
613
|
-
* @typedef OfferSeller
|
|
614
|
-
* @property {number} [uid] - Unique identifier for a seller.
|
|
615
|
-
* @property {string} [name] - Name of a seller.
|
|
616
|
-
*/
|
|
617
|
-
/**
|
|
618
|
-
* @typedef BulkPriceOffer
|
|
619
|
-
* @property {OfferItem[]} [offers] - Offers is the list of Offer item, which
|
|
620
|
-
* consists of margin percentage, price, quantity, offer type and offer price.
|
|
621
|
-
* @property {OfferSeller} [seller]
|
|
622
|
-
*/
|
|
623
|
-
/**
|
|
624
|
-
* @typedef BulkPriceResponse
|
|
625
|
-
* @property {BulkPriceOffer[]} [data] - Actual data to be in response consist
|
|
626
|
-
* of offers from multiple seller.
|
|
627
|
-
*/
|
|
628
|
-
/**
|
|
629
|
-
* @typedef RewardPointRequest
|
|
630
|
-
* @property {boolean} points - Points to be applied for cart.
|
|
631
|
-
*/
|
|
632
|
-
/**
|
|
633
|
-
* @typedef GeoLocation
|
|
634
|
-
* @property {number} [latitude] - Latitude coordinate for address.
|
|
635
|
-
* @property {number} [longitude] - Longitude coordinate for address.
|
|
636
|
-
*/
|
|
637
|
-
/**
|
|
638
|
-
* @typedef Address
|
|
639
|
-
* @property {string} [country_iso_code] - Country iso code for address.
|
|
640
|
-
* @property {string} [area] - Area description for address.
|
|
641
|
-
* @property {string} [phone] - Phone number for address.
|
|
642
|
-
* @property {string} [country_phone_code] - Country phone code for address.
|
|
643
|
-
* @property {string} [checkout_mode] - Checkout mode of address on which
|
|
644
|
-
* address to be used for which checkout mode of cart.
|
|
645
|
-
* @property {string} [address] - Address description for address data.
|
|
646
|
-
* @property {string} [area_code_slug] - Area code slug for address. example
|
|
647
|
-
* pincode is slug for India.
|
|
648
|
-
* @property {GeoLocation} [geo_location]
|
|
649
|
-
* @property {string} [id] - Id of the address.
|
|
650
|
-
* @property {Object} [_custom_json] - Custom json of the address.
|
|
651
|
-
* @property {string} [city] - City of the address.
|
|
652
|
-
* @property {string} [sector] - Sector of the address.
|
|
653
|
-
* @property {string} [state_code] - State code for address.
|
|
654
|
-
* @property {string} [created_by_user_id] - Created by user id of address.
|
|
655
|
-
* @property {string} [landmark] - Landmark of address.
|
|
656
|
-
* @property {string} [user_id] - User id of address for which address is created.
|
|
657
|
-
* @property {string} [name] - Name of person in address data to whom it belongs to.
|
|
658
|
-
* @property {Object} [google_map_point] - Google map point of the address.
|
|
659
|
-
* @property {boolean} [is_active] - States whether address is active or not.
|
|
660
|
-
* @property {string[]} [tags] - Tags of address from which it can be identified.
|
|
661
|
-
* @property {string} [country_code] - Country code of address.
|
|
662
|
-
* @property {string} [address_type] - Address type of address.
|
|
663
|
-
* @property {string} [country] - Country of address.
|
|
664
|
-
* @property {boolean} [is_default_address] - Default address flag if no address
|
|
665
|
-
* selected then this should be the default address selected.
|
|
666
|
-
* @property {string} [area_code] - Area code of the address.
|
|
667
|
-
* @property {string} [email] - Email address for address data.
|
|
668
|
-
* @property {string} [state] - State of the address.
|
|
669
|
-
* @property {Object} [meta] - Metadata of the address.
|
|
670
|
-
*/
|
|
671
|
-
/**
|
|
672
|
-
* @typedef GetAddressesResponse
|
|
673
|
-
* @property {boolean} [pii_masking] - Personally Identifiable Information
|
|
674
|
-
* masking flag to denote if the user data in address is masked or not.
|
|
675
|
-
* @property {Address[]} [address] - Address description for address data.
|
|
676
|
-
*/
|
|
677
|
-
/**
|
|
678
|
-
* @typedef SaveAddressResponse
|
|
679
|
-
* @property {string} [id] - Id of the address.
|
|
680
|
-
* @property {boolean} [success] - Success flag of save address Response.
|
|
681
|
-
* @property {boolean} [is_default_address] - Default address flag if no address
|
|
682
|
-
* selected then this should be the default address selected.
|
|
683
|
-
*/
|
|
684
|
-
/**
|
|
685
|
-
* @typedef UpdateAddressResponse
|
|
686
|
-
* @property {boolean} [is_updated] - Updated flag for update address operation
|
|
687
|
-
* if the address updated or not.
|
|
688
|
-
* @property {string} [id] - ID of an address.
|
|
689
|
-
* @property {boolean} [success] - Success flag of update address response.
|
|
690
|
-
* @property {boolean} [is_default_address] - Default address flag if no address
|
|
691
|
-
* selected then this should be the default address selected.
|
|
692
|
-
*/
|
|
693
|
-
/**
|
|
694
|
-
* @typedef DeleteAddressResponse
|
|
695
|
-
* @property {string} [id] - Id of the address.
|
|
696
|
-
* @property {boolean} [is_deleted] - Deleted flag in delete address response
|
|
697
|
-
* states whether the address was deleted or not.
|
|
698
|
-
*/
|
|
699
|
-
/**
|
|
700
|
-
* @typedef SelectCartAddressRequest
|
|
701
|
-
* @property {string} [id] - Address is selected by user on which shipment to be
|
|
702
|
-
* delivered.
|
|
703
|
-
* @property {string} [billing_address_id] - Billing address id selected by user
|
|
704
|
-
* on which shipment bill to be generated.
|
|
705
|
-
* @property {string} [cart_id] - Cart id of the user cart for which the select
|
|
706
|
-
* address operation performed.
|
|
707
|
-
*/
|
|
708
|
-
/**
|
|
709
|
-
* @typedef UpdateCartPaymentRequest
|
|
710
|
-
* @property {string} [id] - Cart id of the user cart for which the update cart
|
|
711
|
-
* payment operation performed.
|
|
712
|
-
* @property {string} [payment_identifier] - Payment identifier of the payment
|
|
713
|
-
* mode selected to do the payment.
|
|
714
|
-
* @property {string} [address_id] - Address id of the user address selected to
|
|
715
|
-
* deliver the shipment.
|
|
716
|
-
* @property {string} [merchant_code] - Merchant code of the payment mode
|
|
717
|
-
* selected to do the payment.
|
|
718
|
-
* @property {string} [aggregator_name] - Aggregator name of the payment gateway.
|
|
719
|
-
* @property {string} [payment_mode] - Payment mode of the payment selected to
|
|
720
|
-
* do the payment.
|
|
721
|
-
*/
|
|
722
|
-
/**
|
|
723
|
-
* @typedef CouponValidity
|
|
724
|
-
* @property {string} [title] - Coupon Title of the coupon applied.
|
|
725
|
-
* @property {number} [discount] - Coupon discount value of the coupon applied.
|
|
726
|
-
* @property {boolean} [next_validation_required] - Flag for coupon validation
|
|
727
|
-
* required on next page or not.
|
|
728
|
-
* @property {boolean} [valid] - Valid flag which denotes if the applied coupon
|
|
729
|
-
* is valid or not.
|
|
730
|
-
* @property {string} [display_message_en] - Display message for coupon validity.
|
|
731
|
-
* @property {string} [code] - Coupon code of the coupon applied.
|
|
732
|
-
*/
|
|
733
|
-
/**
|
|
734
|
-
* @typedef PaymentCouponValidate
|
|
735
|
-
* @property {string} [message] - Payment mode valid message for coupon.
|
|
736
|
-
* @property {CouponValidity} [coupon_validity]
|
|
737
|
-
* @property {boolean} success - Success flag of coupon payment mode validity
|
|
738
|
-
* API response.
|
|
739
|
-
*/
|
|
740
|
-
/**
|
|
741
|
-
* @typedef ShipmentResponse
|
|
742
|
-
* @property {number} [shipments] - Count of shipments that will be shipped.
|
|
743
|
-
* @property {ShipmentPromise} [promise]
|
|
744
|
-
* @property {string} [order_type] - Order type of the shipment like pickAtStore
|
|
745
|
-
* or HomeDelivery.
|
|
746
|
-
* @property {string} [box_type] - Box type of the shipment in which the
|
|
747
|
-
* shipment will be delivered.
|
|
748
|
-
* @property {string} [shipment_type] - Shipment type of the shipment returned
|
|
749
|
-
* in get shipments API like single_shipment or multiple shipment. Single
|
|
750
|
-
* Shipment means 1 item in 1 shipment and vice versa in the other one.
|
|
751
|
-
* @property {Object} [dp_options] - Delivery partner options that are available
|
|
752
|
-
* to deliver the shipment.
|
|
753
|
-
* @property {string} [dp_id] - Delivery partner id of the shipment.
|
|
754
|
-
* @property {CartProductInfo[]} [items] - Item details in the shipment.
|
|
755
|
-
* @property {string} [fulfillment_type] - Fulfilment type of shipment.
|
|
756
|
-
* @property {number} [fulfillment_id] - Fulfilment id of the shipment.
|
|
757
|
-
*/
|
|
758
|
-
/**
|
|
759
|
-
* @typedef CartShipmentsResponse
|
|
760
|
-
* @property {string} [delivery_charge_info] - Delivery charge in information
|
|
761
|
-
* message on shipment.
|
|
762
|
-
* @property {string} [checkout_mode] - Checkout mode of cart.
|
|
763
|
-
* @property {string} [message] - Response message of get shipments API.
|
|
764
|
-
* @property {string} [gstin] - GSTIN number added in cart.
|
|
765
|
-
* @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
|
|
766
|
-
* the checkout process.
|
|
767
|
-
* @property {string} [last_modified] - Last modified timestamp of cart.
|
|
768
|
-
* @property {number} [cart_id] - Cart id of the user cart.
|
|
769
|
-
* @property {boolean} [is_valid] - Cart validity flag determines the if the
|
|
770
|
-
* response is valid or not.
|
|
771
|
-
* @property {CartBreakup} [breakup_values]
|
|
772
|
-
* @property {CartCurrency} [currency]
|
|
773
|
-
* @property {string} [id] - Cart id of the user cart.
|
|
774
|
-
* @property {ShipmentResponse[]} [shipments] - List of Shipments which includes
|
|
775
|
-
* shipment data like shipment items, shipment promise, Shipment type,
|
|
776
|
-
* shipment order type, shipment dp options etc.
|
|
777
|
-
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
778
|
-
* @property {string} [coupon_text] - Coupon text of coupon applied on cart.
|
|
779
|
-
* @property {ShipmentPromise} [delivery_promise]
|
|
780
|
-
* @property {boolean} [error] - Error details if any error occurs which
|
|
781
|
-
* includes type of error, error code and error message.
|
|
782
|
-
* @property {string} [comment] - Comment message added in cart.
|
|
783
|
-
* @property {boolean} [buy_now] - Buy now flag of user cart.
|
|
784
|
-
* @property {string} [uid] - Cart id of the user cart.
|
|
785
|
-
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
786
|
-
* checkout API payload.
|
|
787
|
-
*/
|
|
788
|
-
/**
|
|
789
|
-
* @typedef CustomerDetails
|
|
790
|
-
* @property {string} [email] - Email address of the customer to be added in
|
|
791
|
-
* customer detail while checkout.
|
|
792
|
-
* @property {string} mobile - Mobile number of customer to be added in customer
|
|
793
|
-
* detail while checkout.
|
|
794
|
-
* @property {string} [name] - Name of customer to be added in customer detail
|
|
795
|
-
* while checkout.
|
|
796
|
-
*/
|
|
797
|
-
/**
|
|
798
|
-
* @typedef StaffCheckout
|
|
799
|
-
* @property {string} [employee_code] - Employee code of staff who does checkout
|
|
800
|
-
* on behalf of customer.
|
|
801
|
-
* @property {string} user - User id of the employee who does checkout on behalf
|
|
802
|
-
* of customer.
|
|
803
|
-
* @property {string} last_name - Last name of staff employee who does checkout
|
|
804
|
-
* on behalf of customer.
|
|
805
|
-
* @property {string} first_name - First name of staff emplyee who does checkout
|
|
806
|
-
* on behalf of customer.
|
|
807
|
-
* @property {string} _id - Id of staff who does checkout on behalf of customer.
|
|
808
|
-
*/
|
|
809
|
-
/**
|
|
810
|
-
* @typedef CheckCart
|
|
811
|
-
* @property {string} [checkout_mode] - Checkout mode of user cart.
|
|
812
|
-
* @property {string} [user_type] - User type of the cart who places the order.
|
|
813
|
-
* @property {string} [cod_message] - Cash On Delivery message for the order placed.
|
|
814
|
-
* @property {number} [cart_id] - Cart id of the user cart for which the order placed.
|
|
815
|
-
* @property {boolean} [is_valid] - Valid flag fotr the checkout response if
|
|
816
|
-
* order placed was valid.
|
|
817
|
-
* @property {number} [delivery_charges] - Delivery charges of the order placed
|
|
818
|
-
* via checkout API.
|
|
819
|
-
* @property {string} [id] - Cart id of the user cart.
|
|
820
|
-
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
821
|
-
* @property {string} [error_message] - Error details if any error occurs which
|
|
822
|
-
* includes type of error, error code and error message.
|
|
823
|
-
* @property {ShipmentPromise} [delivery_promise]
|
|
824
|
-
* @property {string} [comment] - Comment message added in cart after order placed.
|
|
825
|
-
* @property {CartProductInfo[]} [items] - Items details in cart after order placed.
|
|
826
|
-
* @property {string} [uid] - Cart id of user cart.
|
|
827
|
-
* @property {number} [delivery_charge_order_value] - Delivery charge order value.
|
|
828
|
-
* @property {string} [delivery_charge_info] - Delivery charge in information
|
|
829
|
-
* message on shipment.
|
|
830
|
-
* @property {boolean} [cod_available] - Whether Cash On Delivery available.
|
|
831
|
-
* @property {boolean} [success] - Success flag of checkout cart API response.
|
|
832
|
-
* @property {string} [store_code] - Store code from which the order placed.
|
|
833
|
-
* @property {string} [message] - Message of the cart checkout API response.
|
|
834
|
-
* @property {string} [gstin] - GSTIN number added in cart.
|
|
835
|
-
* @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
|
|
836
|
-
* the checkout process.
|
|
837
|
-
* @property {string} [last_modified] - Last modified timestamp of cart.
|
|
838
|
-
* @property {string} [order_id] - Order id generated after placing order.
|
|
839
|
-
* @property {CartBreakup} [breakup_values]
|
|
840
|
-
* @property {CartCurrency} [currency]
|
|
841
|
-
* @property {Object[]} [store_emps] - Store employees data.
|
|
842
|
-
* @property {string} [coupon_text] - Coupon text of the applied coupon on order placed.
|
|
843
|
-
* @property {boolean} [buy_now] - Buy now flag of user cart.
|
|
844
|
-
* @property {number} [cod_charges] - Cash On Delivery charges of the user cart.
|
|
845
|
-
* @property {Object} [custom_cart_meta] - Meta data for customCart of user.
|
|
846
|
-
*/
|
|
847
|
-
/**
|
|
848
|
-
* @typedef CartCheckoutResponse
|
|
849
|
-
* @property {string} [payment_confirm_url] - Payment confirm url used to
|
|
850
|
-
* redirect after payment is confirmed.
|
|
851
|
-
* @property {string} [app_intercept_url] - App intercept url which is used to
|
|
852
|
-
* redirect on app after payment in confirmed/failed.
|
|
853
|
-
* @property {boolean} [success] - Success flag of cart checkout API response.
|
|
854
|
-
* @property {string} [callback_url] - Callback url to be redirected after
|
|
855
|
-
* payment received/failed.
|
|
856
|
-
* @property {string} [message] - Message of the cart checkout v2 API response.
|
|
857
|
-
* @property {Object} [data] - Data of the user cart checkout includes cart
|
|
858
|
-
* data, address, user id, order type etc.
|
|
859
|
-
* @property {string} [order_id] - Order id generated after placing order.
|
|
860
|
-
* @property {CheckCart} [cart]
|
|
861
|
-
*/
|
|
862
|
-
/**
|
|
863
|
-
* @typedef GiftDetail
|
|
864
|
-
* @property {boolean} [is_gift_applied] - Is gift applied flag which determines
|
|
865
|
-
* if this is a gift oder not.
|
|
866
|
-
* @property {string} [gift_message] - Gift message for the one while receive
|
|
867
|
-
* the delivery of the order with this message.
|
|
868
|
-
*/
|
|
869
|
-
/**
|
|
870
|
-
* @typedef ArticleGiftDetail
|
|
871
|
-
* @property {GiftDetail} [article_id]
|
|
872
|
-
*/
|
|
873
|
-
/**
|
|
874
|
-
* @typedef CartMetaRequest
|
|
875
|
-
* @property {Object} [delivery_slots] - Delivery slots details includes article
|
|
876
|
-
* level time slot when the shipment can be delivered.
|
|
877
|
-
* @property {ArticleGiftDetail} [gift_details]
|
|
878
|
-
* @property {Object} [pick_up_customer_details] - Customer contact details for
|
|
879
|
-
* customer pickup at store.
|
|
880
|
-
* @property {string} [checkout_mode] - Checkout mode of user cart.
|
|
881
|
-
* @property {string} [comment] - Comment message to be added in user cart.
|
|
882
|
-
* @property {string} [gstin] - GSTIN number to be added in user cart.
|
|
883
|
-
* @property {Object} [custom_cart_meta] - Custom cart meta json to be added in
|
|
884
|
-
* order meta which can be further received in cart API response and order
|
|
885
|
-
* meta in order detail API or webhook.
|
|
886
|
-
*/
|
|
887
|
-
/**
|
|
888
|
-
* @typedef CartMetaResponse
|
|
889
|
-
* @property {string} [message] - Detailed message.
|
|
890
|
-
* @property {boolean} [is_valid] - Whether added meta was vaild.
|
|
891
|
-
*/
|
|
892
|
-
/**
|
|
893
|
-
* @typedef CartMetaMissingResponse
|
|
894
|
-
* @property {string[]} [errors] - Detailed errors for invalid cart meta request.
|
|
895
|
-
*/
|
|
896
|
-
/**
|
|
897
|
-
* @typedef GetShareCartLinkRequest
|
|
898
|
-
* @property {string} [id] - Cart id of user cart for generating cart sharing token.
|
|
899
|
-
* @property {Object} [meta] - Staff, Ordering store or any other data. This
|
|
900
|
-
* data will be used to generate link as well as sent as shared details.
|
|
901
|
-
*/
|
|
902
|
-
/**
|
|
903
|
-
* @typedef GetShareCartLinkResponse
|
|
904
|
-
* @property {string} [token] - Short url unique id of the cart which is opted
|
|
905
|
-
* to share with other user.
|
|
906
|
-
* @property {string} [share_url] - Short shareable final url which can populate
|
|
907
|
-
* shared cart items in one's cart or replaced one's cart with shared cart items.
|
|
908
|
-
*/
|
|
909
|
-
/**
|
|
910
|
-
* @typedef SharedCartDetails
|
|
911
|
-
* @property {string} [token] - Short link id of the user cart that needs to be shared.
|
|
912
|
-
* @property {Object} [user] - User details of who generated share link.
|
|
913
|
-
* @property {string} [created_on] - Created on timestamp of user cart.
|
|
914
|
-
* @property {Object} [source] - Share link device and other source information.
|
|
915
|
-
* @property {Object} [meta] - Meta data sent while generating share cart link.
|
|
916
|
-
*/
|
|
917
|
-
/**
|
|
918
|
-
* @typedef SharedCart
|
|
919
|
-
* @property {string} [checkout_mode] - Checkout mode of address on which
|
|
920
|
-
* address to be used for which checkout mode of cart.
|
|
921
|
-
* @property {number} [cart_id] - Cart id of user cart for generating cart sharing token.
|
|
922
|
-
* @property {boolean} [is_valid] - Valid flag for get shared cart detail API.
|
|
923
|
-
* @property {string} [id] - Cart id of shared cart.
|
|
924
|
-
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
925
|
-
* @property {ShipmentPromise} [delivery_promise]
|
|
926
|
-
* @property {string} [comment] - Comment message added in user cart.
|
|
927
|
-
* @property {CartProductInfo[]} [items] - Items data list in user cart that
|
|
928
|
-
* includes item id, item size, store id, available sizes and rest of the item
|
|
929
|
-
* related data.
|
|
930
|
-
* @property {string} [uid] - Cart id of the user cart.
|
|
931
|
-
* @property {string} [delivery_charge_info] - Delivery charge info message of
|
|
932
|
-
* the user cart.
|
|
933
|
-
* @property {string} [message] - Message of the get shared cart API response.
|
|
934
|
-
* @property {string} [gstin] - GSTIN added in user cart.
|
|
935
|
-
* @property {SharedCartDetails} [shared_cart_details]
|
|
936
|
-
* @property {boolean} [restrict_checkout] - Restrict checkout flag to restrict
|
|
937
|
-
* the checkout process.
|
|
938
|
-
* @property {string} [last_modified] - Last modified timestamp of user cart.
|
|
939
|
-
* @property {CartBreakup} [breakup_values]
|
|
940
|
-
* @property {CartCurrency} [currency]
|
|
941
|
-
* @property {string} [coupon_text] - Coupon text of the applied coupon on user cart.
|
|
942
|
-
* @property {boolean} [buy_now] - Buy now flag of user cart.
|
|
943
|
-
* @property {Object} [custom_cart_meta] - Custom cart meta of user cart added
|
|
944
|
-
* via update cart meta API.
|
|
945
|
-
*/
|
|
946
|
-
/**
|
|
947
|
-
* @typedef SharedCartResponse
|
|
948
|
-
* @property {string} [error] - Error details if any error occurs which includes
|
|
949
|
-
* type of error, error code and error message.
|
|
950
|
-
* @property {SharedCart} [cart]
|
|
951
|
-
*/
|
|
952
|
-
/**
|
|
953
|
-
* @typedef PriceMinMax
|
|
954
|
-
* @property {number} [min] - Min price of article added in user cart.
|
|
955
|
-
* @property {number} [max] - Max price of article added in user cart.
|
|
956
|
-
*/
|
|
957
|
-
/**
|
|
958
|
-
* @typedef ItemPriceDetails
|
|
959
|
-
* @property {PriceMinMax} [marked]
|
|
960
|
-
* @property {PriceMinMax} [effective]
|
|
961
|
-
* @property {string} [currency] - Currency of the article added in cart.
|
|
962
|
-
*/
|
|
963
|
-
/**
|
|
964
|
-
* @typedef FreeGiftItems
|
|
965
|
-
* @property {string} [item_slug] - Slug for an item.
|
|
966
|
-
* @property {string} [item_name] - Name of the free gift item received via free
|
|
967
|
-
* gift promotion.
|
|
968
|
-
* @property {ItemPriceDetails} [item_price_details]
|
|
969
|
-
* @property {string} [item_brand_name] - Item brand name of the free gift item
|
|
970
|
-
* promotion applied on cart.
|
|
971
|
-
* @property {number} [item_id] - Item id of the free gift item.
|
|
972
|
-
* @property {string[]} [item_images_url] - Images URLs for free gift items.
|
|
973
|
-
*/
|
|
974
|
-
/**
|
|
975
|
-
* @typedef PromotionOffer
|
|
976
|
-
* @property {string} [id] - Promotion id of the promotion which is available on product.
|
|
977
|
-
* @property {Object} [buy_rules] - Buy rules of promotion which is available on product.
|
|
978
|
-
* @property {string} [offer_text] - Offer title of the promotion which is
|
|
979
|
-
* available on product.
|
|
980
|
-
* @property {string} [promotion_type] - Promotion type of the promotion which
|
|
981
|
-
* is availalbe on product.
|
|
982
|
-
* @property {string} [promotion_name] - Name of the promotion which is
|
|
983
|
-
* available on product.
|
|
984
|
-
* @property {string} [promotion_group] - Group of the promotion which is
|
|
985
|
-
* available on product.
|
|
986
|
-
* @property {string} [valid_till] - Datetime ISO String for promotion end date
|
|
987
|
-
* which is available on product.
|
|
988
|
-
* @property {Object[]} [discount_rules] - Discount rules of promotions which is
|
|
989
|
-
* avaiable on product.
|
|
990
|
-
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
|
|
991
|
-
* which included item id, brand name, item name, item slug, item price and
|
|
992
|
-
* item image url.
|
|
993
|
-
* @property {string} [description] - Offer details including T&C of the
|
|
994
|
-
* promotion which is avaiable on product.
|
|
995
|
-
*/
|
|
996
|
-
/**
|
|
997
|
-
* @typedef PromotionOffersResponse
|
|
998
|
-
* @property {PromotionOffer[]} [available_promotions] - Available promotion
|
|
999
|
-
* details which are available on product which includes promotion data like
|
|
1000
|
-
* promotion id, promotion name, buy rules, discount rules validity dates etc.
|
|
1001
|
-
*/
|
|
1002
|
-
/**
|
|
1003
|
-
* @typedef PromotionPaymentOffer
|
|
1004
|
-
* @property {string} [application_id] - Application id on which the promotion
|
|
1005
|
-
* was created.
|
|
1006
|
-
* @property {Object[]} [buy_rules] - Buy rules of promotions which denotes if
|
|
1007
|
-
* the rules matches than only promotion is applicable.
|
|
1008
|
-
* @property {string} [calculate_on] - Article Price on which promotion
|
|
1009
|
-
* calculated like effective price or marked price.
|
|
1010
|
-
* @property {string} [description] - Offer details including T&C of the
|
|
1011
|
-
* promotion which is avaiable on cart.
|
|
1012
|
-
* @property {Object[]} [discount_rules] - Discount rules of promotions which is
|
|
1013
|
-
* avaiable on cart.
|
|
1014
|
-
* @property {string} [id] - Promotion id of the promotion which is available on cart.
|
|
1015
|
-
* @property {string} [offer_text] - Offer title of the promotion which is
|
|
1016
|
-
* available on cart.
|
|
1017
|
-
* @property {string} [promotion_group] - Group promotion which is available on cart.
|
|
1018
|
-
* @property {string} [promotion_type] - Promotion type of the promotion which
|
|
1019
|
-
* is availalbe on cart.
|
|
1020
|
-
* @property {string} [promotion_name] - Name of the promotion which is available on cart.
|
|
1021
|
-
*/
|
|
1022
|
-
/**
|
|
1023
|
-
* @typedef PromotionPaymentOffersResponse
|
|
1024
|
-
* @property {boolean} [success] - Success flag of get payment offers API response.
|
|
1025
|
-
* @property {PromotionPaymentOffer[]} [promotions] - List of promotions data
|
|
1026
|
-
* which are applicable on cart/product.
|
|
1027
|
-
*/
|
|
1028
|
-
/**
|
|
1029
|
-
* @typedef OperationErrorResponse
|
|
1030
|
-
* @property {string} [message] - Message of get payment offer API response.
|
|
1031
|
-
* @property {boolean} [success] - Success flag of get payment offer API response.
|
|
1032
|
-
*/
|
|
1033
|
-
/**
|
|
1034
|
-
* @typedef LadderPrice
|
|
1035
|
-
* @property {string} [currency_symbol] - Currency symbol for currency of ladder
|
|
1036
|
-
* price product.
|
|
1037
|
-
* @property {number} [offer_price] - Discounted per unit price for current offer object.
|
|
1038
|
-
* @property {string} [currency_code] - Currency code for all amounts.
|
|
1039
|
-
* @property {number} [effective] - Current per unit price of product after
|
|
1040
|
-
* existing deductions.
|
|
1041
|
-
* @property {number} [marked] - Original price of product.
|
|
1042
|
-
*/
|
|
1043
|
-
/**
|
|
1044
|
-
* @typedef LadderOfferItem
|
|
1045
|
-
* @property {LadderPrice} [price]
|
|
1046
|
-
* @property {number} [margin] - Percentage value of discount.
|
|
1047
|
-
* @property {number} [max_quantity] - Minimum quantity upto which offer is
|
|
1048
|
-
* applicable. If not present that offer is applicable on all quantities.
|
|
1049
|
-
* @property {number} [min_quantity] - Minimum quantity from which offer is applicable.
|
|
1050
|
-
* @property {string} [type] - Offer type of the ladder promotion.
|
|
1051
|
-
*/
|
|
1052
|
-
/**
|
|
1053
|
-
* @typedef LadderPriceOffer
|
|
1054
|
-
* @property {string} [id] - ID of the promotion.
|
|
1055
|
-
* @property {Object} [buy_rules] - Buy rules of ladder price promotion
|
|
1056
|
-
* applicable on product.
|
|
1057
|
-
* @property {string} [calculate_on] - If this ladder offer is to be calculated
|
|
1058
|
-
* on MRP or ESP price.
|
|
1059
|
-
* @property {string} [offer_text] - Offer title of ladder price promotion
|
|
1060
|
-
* applicable on product.
|
|
1061
|
-
* @property {string} [promotion_group] - Group of ladder price promotion
|
|
1062
|
-
* applicable on product.
|
|
1063
|
-
* @property {string} [valid_till] - Datetime ISO String for promotion end date.
|
|
1064
|
-
* @property {Object[]} [discount_rules] - Discount rules of ladder price
|
|
1065
|
-
* promotion applicable on product.
|
|
1066
|
-
* @property {LadderOfferItem[]} [offer_prices] - Offer prices for ladder price
|
|
1067
|
-
* promotion applicable on product.
|
|
1068
|
-
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items list.
|
|
1069
|
-
* @property {string} [description] - Offer details including T&C of ladder
|
|
1070
|
-
* price promotion applicable on product.
|
|
1071
|
-
*/
|
|
1072
|
-
/**
|
|
1073
|
-
* @typedef CurrencyInfo
|
|
1074
|
-
* @property {string} [code] - Currency code of ladder price promotion.
|
|
1075
|
-
* @property {string} [symbol] - Currency symbol for currency of ladder price product.
|
|
1076
|
-
*/
|
|
1077
|
-
/**
|
|
1078
|
-
* @typedef LadderPriceOffers
|
|
1079
|
-
* @property {LadderPriceOffer[]} [available_offers] - Available ladder
|
|
1080
|
-
* promotions offers list.
|
|
1081
|
-
* @property {CurrencyInfo} [currency]
|
|
1082
|
-
*/
|
|
1083
|
-
/**
|
|
1084
|
-
* @typedef PaymentMeta
|
|
1085
|
-
* @property {string} [merchant_code] - Merchant code of the payment mode
|
|
1086
|
-
* selected to do the payment.
|
|
1087
|
-
* @property {string} [type] - Type of card if payment mode is card to do the payment.
|
|
1088
|
-
* @property {string} [payment_gateway] - Payment gateway used to do the payment.
|
|
1089
|
-
* @property {string} [payment_identifier] - Payment identifier of the payment
|
|
1090
|
-
* mode selected to do the payment.
|
|
1091
|
-
*/
|
|
1092
|
-
/**
|
|
1093
|
-
* @typedef PaymentMethod
|
|
1094
|
-
* @property {PaymentMeta} payment_meta
|
|
1095
|
-
* @property {string} mode - Payment mode of payment method used to make payment.
|
|
1096
|
-
* @property {string} [payment] - Payment name of payment method used to make payment.
|
|
1097
|
-
* @property {number} [amount] - Amount of the payment mode to be paid.
|
|
1098
|
-
* @property {string} [name] - Name of the payment mode used to make payment.
|
|
1099
|
-
* @property {Object} [payment_extra_identifiers] - Payment extra identifier for
|
|
1100
|
-
* the payment mode to do the payment.
|
|
1101
|
-
*/
|
|
1102
|
-
/**
|
|
1103
|
-
* @typedef CartCheckoutDetailV2Request
|
|
1104
|
-
* @property {Object} [custom_meta] - Custom meta data to be added in order.
|
|
1105
|
-
* @property {Object} [customer_details] - Customer details to be added in order.
|
|
1106
|
-
* @property {string} [merchant_code] - Merchant code of the payment mode
|
|
1107
|
-
* selected to do the payment.
|
|
1108
|
-
* @property {string} [cart_id] - Cart id of the user cart.
|
|
1109
|
-
* @property {string} [id] - Cart id of the user cart.
|
|
1110
|
-
* @property {boolean} [payment_auto_confirm] - Payment auto confirm flag if
|
|
1111
|
-
* payment need not to be collected from user.
|
|
1112
|
-
* @property {PaymentMethod[]} payment_methods - Payment methods list used to
|
|
1113
|
-
* make the payment.
|
|
1114
|
-
* @property {string} payment_mode - Payment mode of the payment selected to do
|
|
1115
|
-
* the payment.
|
|
1116
|
-
* @property {string} [aggregator] - Aggregator of payment mode to do the payment.
|
|
1117
|
-
* @property {string} [address_id] - Address id of the user where the order to
|
|
1118
|
-
* be delivered.
|
|
1119
|
-
* @property {string} [callback_url] - Callback url after payment received/failed.
|
|
1120
|
-
* @property {Object} [delivery_address] - Delivery address data which includes
|
|
1121
|
-
* customer address, customer phone, customer email, customer pincode,
|
|
1122
|
-
* customer landmark and customer name.
|
|
1123
|
-
* @property {StaffCheckout} [staff]
|
|
1124
|
-
* @property {string} [order_type] - Order type of the order being placed like
|
|
1125
|
-
* pickAtStore or HomeDelivery.
|
|
1126
|
-
* @property {number} [ordering_store] - Ordering store id of the store from
|
|
1127
|
-
* which the order is getting placed.
|
|
1128
|
-
* @property {Object} [extra_meta] - Extra meta to be added while checkout in order.
|
|
1129
|
-
* @property {string} [payment_identifier] - Payment identifier of the payment
|
|
1130
|
-
* mode selected to do the payment.
|
|
1131
|
-
* @property {Object} [billing_address] - Billing address json which includes
|
|
1132
|
-
* customer address, customer phone, customer email, customer pincode,
|
|
1133
|
-
* customer landmark and customer name.
|
|
1134
|
-
* @property {Object} [payment_params] - Payment params which includes payment
|
|
1135
|
-
* identifier and merchant code.
|
|
1136
|
-
* @property {string} [billing_address_id] - Billing address id selected by user
|
|
1137
|
-
* on which shipment bill to be generated.
|
|
1138
|
-
* @property {Object} [meta] - Meta data sent while checkout v2.
|
|
1139
|
-
* @property {string} [iin] - Issuer Identification Number' number of card if
|
|
1140
|
-
* payment mode is card to do the payment.
|
|
1141
|
-
* @property {string} [network] - Network of card if payment mode is card to do
|
|
1142
|
-
* the payment.
|
|
1143
|
-
* @property {string} [type] - Type of cart if payment mode is card to do the payment.
|
|
1144
|
-
* @property {string} [card_id] - Saved card id if payment mode is card to do the payment.
|
|
1145
|
-
*/
|
|
1146
|
-
declare class CartApplicationModel {
|
|
1147
|
-
}
|
|
1148
|
-
declare namespace CartApplicationModel {
|
|
1149
|
-
export { BuyRules, DiscountRulesApp, Ownership, AppliedFreeArticles, AppliedPromotion, PaymentSelectionLock, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, BasePrice, ArticlePriceInfo, BaseInfo, StoreInfo, ProductArticle, CartProductIdentifer, PromoMeta, ChargesAmount, Charges, ProductPrice, ProductPriceInfo, ProductPricePerUnit, ProductPricePerUnitInfo, ProductAvailabilitySize, ProductAvailability, ActionQuery, ProductAction, Tags, ProductImage, CategoryInfo, CartProduct, CouponDetails, CartProductInfo, DisplayBreakup, RawBreakup, CouponBreakup, LoyaltyPoints, CartBreakup, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, DeleteCartDetailResponse, CartItemCountResponse, PageCoupon, Coupon, GetCouponResponse, ApplyCouponRequest, OfferPrice, OfferItem, OfferSeller, BulkPriceOffer, BulkPriceResponse, RewardPointRequest, GeoLocation, Address, GetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, SelectCartAddressRequest, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, ShipmentResponse, CartShipmentsResponse, CustomerDetails, StaffCheckout, CheckCart, CartCheckoutResponse, GiftDetail, ArticleGiftDetail, CartMetaRequest, CartMetaResponse, CartMetaMissingResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, PromotionPaymentOffersResponse, OperationErrorResponse, LadderPrice, LadderOfferItem, LadderPriceOffer, CurrencyInfo, LadderPriceOffers, PaymentMeta, PaymentMethod, CartCheckoutDetailV2Request };
|
|
1150
|
-
}
|
|
1151
|
-
/** @returns {BuyRules} */
|
|
1152
|
-
declare function BuyRules(): BuyRules;
|
|
1153
|
-
type BuyRules = {
|
|
1154
|
-
/**
|
|
1155
|
-
* - Item criteria of promotion.
|
|
1156
|
-
*/
|
|
1157
|
-
item_criteria?: any;
|
|
1158
|
-
/**
|
|
1159
|
-
* - Cart conditions details for promotion.
|
|
1160
|
-
*/
|
|
1161
|
-
cart_conditions?: any;
|
|
1162
|
-
};
|
|
1163
|
-
/** @returns {DiscountRulesApp} */
|
|
1164
|
-
declare function DiscountRulesApp(): DiscountRulesApp;
|
|
1165
|
-
type DiscountRulesApp = {
|
|
1166
|
-
/**
|
|
1167
|
-
* - Matched buy rules for promotion.
|
|
1168
|
-
*/
|
|
1169
|
-
matched_buy_rules?: string[];
|
|
1170
|
-
/**
|
|
1171
|
-
* - Raw offer details for promotion.
|
|
1172
|
-
*/
|
|
1173
|
-
raw_offer?: any;
|
|
1174
|
-
/**
|
|
1175
|
-
* - Offer for promotion.
|
|
1176
|
-
*/
|
|
1177
|
-
offer?: any;
|
|
1178
|
-
/**
|
|
1179
|
-
* - Item criteria of promotion.
|
|
1180
|
-
*/
|
|
1181
|
-
item_criteria?: any;
|
|
1182
|
-
};
|
|
1183
|
-
/** @returns {Ownership} */
|
|
1184
|
-
declare function Ownership(): Ownership;
|
|
1185
|
-
type Ownership = {
|
|
1186
|
-
/**
|
|
1187
|
-
* - Promotion amount payable category.
|
|
1188
|
-
*/
|
|
1189
|
-
payable_category?: string;
|
|
1190
|
-
/**
|
|
1191
|
-
* - Promotion amount bearable party.
|
|
1192
|
-
*/
|
|
1193
|
-
payable_by?: string;
|
|
1194
|
-
};
|
|
1195
|
-
/** @returns {AppliedFreeArticles} */
|
|
1196
|
-
declare function AppliedFreeArticles(): AppliedFreeArticles;
|
|
1197
|
-
type AppliedFreeArticles = {
|
|
1198
|
-
/**
|
|
1199
|
-
* - Free gift items details.
|
|
1200
|
-
*/
|
|
1201
|
-
free_gift_item_details?: FreeGiftItems;
|
|
1202
|
-
/**
|
|
1203
|
-
* - Parent item identifier for free article.
|
|
1204
|
-
*/
|
|
1205
|
-
parent_item_identifier?: string;
|
|
1206
|
-
/**
|
|
1207
|
-
* - Quantity of free articles.
|
|
1208
|
-
*/
|
|
1209
|
-
quantity?: number;
|
|
1210
|
-
/**
|
|
1211
|
-
* - IDs of free articles.
|
|
1212
|
-
*/
|
|
1213
|
-
article_id?: string;
|
|
1214
|
-
};
|
|
1215
|
-
/** @returns {AppliedPromotion} */
|
|
1216
|
-
declare function AppliedPromotion(): AppliedPromotion;
|
|
1217
|
-
type AppliedPromotion = {
|
|
1218
|
-
/**
|
|
1219
|
-
* - Promotion id.
|
|
1220
|
-
*/
|
|
1221
|
-
promo_id?: string;
|
|
1222
|
-
/**
|
|
1223
|
-
* - Buy rules for promotions.
|
|
1224
|
-
*/
|
|
1225
|
-
buy_rules?: BuyRules[];
|
|
1226
|
-
/**
|
|
1227
|
-
* - Offer text of current promotion.
|
|
1228
|
-
*/
|
|
1229
|
-
offer_text?: string;
|
|
1230
|
-
/**
|
|
1231
|
-
* - Promotion group for the promotion.
|
|
1232
|
-
*/
|
|
1233
|
-
promotion_group?: string;
|
|
1234
|
-
/**
|
|
1235
|
-
* - If applied promotion is applied on
|
|
1236
|
-
* product MRP or ESP.
|
|
1237
|
-
*/
|
|
1238
|
-
mrp_promotion?: boolean;
|
|
1239
|
-
/**
|
|
1240
|
-
* - Promotion name of current promotion.
|
|
1241
|
-
*/
|
|
1242
|
-
promotion_name?: string;
|
|
1243
|
-
/**
|
|
1244
|
-
* - Per unit discount amount applied with current promotion.
|
|
1245
|
-
*/
|
|
1246
|
-
amount?: number;
|
|
1247
|
-
/**
|
|
1248
|
-
* - Discount rules for promotions.
|
|
1249
|
-
*/
|
|
1250
|
-
discount_rules?: DiscountRulesApp[];
|
|
1251
|
-
/**
|
|
1252
|
-
* - Ownership of promotion.
|
|
1253
|
-
*/
|
|
1254
|
-
ownership?: Ownership;
|
|
1255
|
-
/**
|
|
1256
|
-
* - Quantity of article on which
|
|
1257
|
-
* promotion is applicable.
|
|
1258
|
-
*/
|
|
1259
|
-
article_quantity?: number;
|
|
1260
|
-
/**
|
|
1261
|
-
* - Applied free
|
|
1262
|
-
* article for free gift item promotions.
|
|
1263
|
-
*/
|
|
1264
|
-
applied_free_articles?: AppliedFreeArticles[];
|
|
1265
|
-
/**
|
|
1266
|
-
* - Promotion type of current promotion.
|
|
1267
|
-
*/
|
|
1268
|
-
promotion_type?: string;
|
|
1269
|
-
/**
|
|
1270
|
-
* - Meta object for extra data.
|
|
1271
|
-
*/
|
|
1272
|
-
meta?: any;
|
|
1273
|
-
/**
|
|
1274
|
-
* - Promotion code.
|
|
1275
|
-
*/
|
|
1276
|
-
code?: string;
|
|
1277
|
-
};
|
|
1278
|
-
/** @returns {PaymentSelectionLock} */
|
|
1279
|
-
declare function PaymentSelectionLock(): PaymentSelectionLock;
|
|
1280
|
-
type PaymentSelectionLock = {
|
|
1281
|
-
/**
|
|
1282
|
-
* - Denotes if default payment selection is enable.
|
|
1283
|
-
*/
|
|
1284
|
-
enabled?: boolean;
|
|
1285
|
-
/**
|
|
1286
|
-
* - Default Selection Payment Mode.
|
|
1287
|
-
*/
|
|
1288
|
-
default_options?: string;
|
|
1289
|
-
/**
|
|
1290
|
-
* - Identifier for Payment Mode.
|
|
1291
|
-
*/
|
|
1292
|
-
payment_identifier?: string;
|
|
1293
|
-
};
|
|
1294
|
-
/** @returns {PromiseFormatted} */
|
|
1295
|
-
declare function PromiseFormatted(): PromiseFormatted;
|
|
1296
|
-
type PromiseFormatted = {
|
|
1297
|
-
/**
|
|
1298
|
-
* - Maximum Delivery promise formatted timestamp.
|
|
1299
|
-
*/
|
|
1300
|
-
max?: string;
|
|
1301
|
-
/**
|
|
1302
|
-
* - Minimum Delivery promise formatted timestamp.
|
|
1303
|
-
*/
|
|
1304
|
-
min?: string;
|
|
1305
|
-
};
|
|
1306
|
-
/** @returns {PromiseISOFormat} */
|
|
1307
|
-
declare function PromiseISOFormat(): PromiseISOFormat;
|
|
1308
|
-
type PromiseISOFormat = {
|
|
1309
|
-
/**
|
|
1310
|
-
* - Max promise in ISO format.
|
|
1311
|
-
*/
|
|
1312
|
-
max?: string;
|
|
1313
|
-
/**
|
|
1314
|
-
* - Min Promise in ISO format.
|
|
1315
|
-
*/
|
|
1316
|
-
min?: string;
|
|
1317
|
-
};
|
|
1318
|
-
/** @returns {PromiseTimestamp} */
|
|
1319
|
-
declare function PromiseTimestamp(): PromiseTimestamp;
|
|
1320
|
-
type PromiseTimestamp = {
|
|
1321
|
-
/**
|
|
1322
|
-
* - Maximum Promise for the shipment.
|
|
1323
|
-
*/
|
|
1324
|
-
max?: number;
|
|
1325
|
-
/**
|
|
1326
|
-
* - Minimum delivery promise time for the shipment.
|
|
1327
|
-
*/
|
|
1328
|
-
min?: number;
|
|
1329
|
-
};
|
|
1330
|
-
/** @returns {ShipmentPromise} */
|
|
1331
|
-
declare function ShipmentPromise(): ShipmentPromise;
|
|
1332
|
-
type ShipmentPromise = {
|
|
1333
|
-
formatted?: PromiseFormatted;
|
|
1334
|
-
timestamp?: PromiseTimestamp;
|
|
1335
|
-
iso?: PromiseISOFormat;
|
|
1336
|
-
};
|
|
1337
|
-
/** @returns {BasePrice} */
|
|
1338
|
-
declare function BasePrice(): BasePrice;
|
|
1339
|
-
type BasePrice = {
|
|
1340
|
-
/**
|
|
1341
|
-
* - Current per unit price of product after
|
|
1342
|
-
* existing deductions.
|
|
1343
|
-
*/
|
|
1344
|
-
effective?: number;
|
|
1345
|
-
/**
|
|
1346
|
-
* - Currency symbol of the currncy used for price.
|
|
1347
|
-
*/
|
|
1348
|
-
currency_symbol?: string;
|
|
1349
|
-
/**
|
|
1350
|
-
* - Original price of product.
|
|
1351
|
-
*/
|
|
1352
|
-
marked?: number;
|
|
1353
|
-
/**
|
|
1354
|
-
* - Currency code for all amounts.
|
|
1355
|
-
*/
|
|
1356
|
-
currency_code?: string;
|
|
1357
|
-
};
|
|
1358
|
-
/** @returns {ArticlePriceInfo} */
|
|
1359
|
-
declare function ArticlePriceInfo(): ArticlePriceInfo;
|
|
1360
|
-
type ArticlePriceInfo = {
|
|
1361
|
-
base?: BasePrice;
|
|
1362
|
-
converted?: BasePrice;
|
|
1363
|
-
};
|
|
1364
|
-
/** @returns {BaseInfo} */
|
|
1365
|
-
declare function BaseInfo(): BaseInfo;
|
|
1366
|
-
type BaseInfo = {
|
|
1367
|
-
/**
|
|
1368
|
-
* - Unique identifier of entities like brand or seller.
|
|
1369
|
-
*/
|
|
1370
|
-
uid?: number;
|
|
1371
|
-
/**
|
|
1372
|
-
* - Name of entities like brand or seller.
|
|
1373
|
-
*/
|
|
1374
|
-
name?: string;
|
|
1375
|
-
};
|
|
1376
|
-
/** @returns {StoreInfo} */
|
|
1377
|
-
declare function StoreInfo(): StoreInfo;
|
|
1378
|
-
type StoreInfo = {
|
|
1379
|
-
/**
|
|
1380
|
-
* - A unique code or identifier for the store,
|
|
1381
|
-
* often used for internal reference.
|
|
1382
|
-
*/
|
|
1383
|
-
store_code?: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* - Unique identifiers of the store from where product
|
|
1386
|
-
* is fulfileld.
|
|
1387
|
-
*/
|
|
1388
|
-
uid?: number;
|
|
1389
|
-
/**
|
|
1390
|
-
* - Store name of the store from where the product is
|
|
1391
|
-
* fulfiled .
|
|
1392
|
-
*/
|
|
1393
|
-
name?: string;
|
|
1394
|
-
};
|
|
1395
|
-
/** @returns {ProductArticle} */
|
|
1396
|
-
declare function ProductArticle(): ProductArticle;
|
|
1397
|
-
type ProductArticle = {
|
|
1398
|
-
price?: ArticlePriceInfo;
|
|
1399
|
-
/**
|
|
1400
|
-
* - List fot the unique identifier
|
|
1401
|
-
* for the product grouping.
|
|
1402
|
-
*/
|
|
1403
|
-
product_group_tags?: string[];
|
|
1404
|
-
/**
|
|
1405
|
-
* - Field to update extra meta of the article in cart.
|
|
1406
|
-
*/
|
|
1407
|
-
extra_meta?: any;
|
|
1408
|
-
/**
|
|
1409
|
-
* - Quantity of the article added in cart.
|
|
1410
|
-
*/
|
|
1411
|
-
quantity?: number;
|
|
1412
|
-
/**
|
|
1413
|
-
* - Field to update custom json of the article in cart.
|
|
1414
|
-
*/
|
|
1415
|
-
_custom_json?: any;
|
|
1416
|
-
/**
|
|
1417
|
-
* - Article meta data.
|
|
1418
|
-
*/
|
|
1419
|
-
meta?: any;
|
|
1420
|
-
/**
|
|
1421
|
-
* - Size of the article added in cart.
|
|
1422
|
-
*/
|
|
1423
|
-
size?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
* - Quantity of the product which will
|
|
1426
|
-
* specially manufactured as not available in stock.
|
|
1427
|
-
*/
|
|
1428
|
-
mto_quantity?: number;
|
|
1429
|
-
seller?: BaseInfo;
|
|
1430
|
-
/**
|
|
1431
|
-
* - List of identifiers used by sellers
|
|
1432
|
-
* for the product size.
|
|
1433
|
-
*/
|
|
1434
|
-
seller_identifier?: string;
|
|
1435
|
-
/**
|
|
1436
|
-
* - Fields to determine parent
|
|
1437
|
-
* product of the product.
|
|
1438
|
-
*/
|
|
1439
|
-
parent_item_identifiers?: any;
|
|
1440
|
-
/**
|
|
1441
|
-
* - Unique identifier of the article.
|
|
1442
|
-
*/
|
|
1443
|
-
identifier?: any;
|
|
1444
|
-
store?: StoreInfo;
|
|
1445
|
-
/**
|
|
1446
|
-
* - Meta details of the article added from cart.
|
|
1447
|
-
*/
|
|
1448
|
-
cart_item_meta?: any;
|
|
1449
|
-
/**
|
|
1450
|
-
* - This unique identifier is assigned to the specific
|
|
1451
|
-
* article. This represents item x size x location.
|
|
1452
|
-
*/
|
|
1453
|
-
uid?: string;
|
|
1454
|
-
/**
|
|
1455
|
-
* - Gift card detail if gift card applied to the
|
|
1456
|
-
* product which indicates gift price, gift applicable flag and display
|
|
1457
|
-
* message for the gift.
|
|
1458
|
-
*/
|
|
1459
|
-
gift_card?: any;
|
|
1460
|
-
/**
|
|
1461
|
-
* - Whether the product can be purchased
|
|
1462
|
-
* as a gift. It is true if the product is available for gifting and false otherwise.
|
|
1463
|
-
*/
|
|
1464
|
-
is_gift_visible?: boolean;
|
|
1465
|
-
/**
|
|
1466
|
-
* - Type of the data sent in response. Possible value
|
|
1467
|
-
* is article.
|
|
1468
|
-
*/
|
|
1469
|
-
type?: string;
|
|
1470
|
-
/**
|
|
1471
|
-
* - A list of article tags.
|
|
1472
|
-
*/
|
|
1473
|
-
tags?: string[];
|
|
1474
|
-
};
|
|
1475
|
-
/** @returns {CartProductIdentifer} */
|
|
1476
|
-
declare function CartProductIdentifer(): CartProductIdentifer;
|
|
1477
|
-
type CartProductIdentifer = {
|
|
1478
|
-
/**
|
|
1479
|
-
* - Article idenfier generated by cart.
|
|
1480
|
-
*/
|
|
1481
|
-
identifier?: string;
|
|
1482
|
-
};
|
|
1483
|
-
/** @returns {PromoMeta} */
|
|
1484
|
-
declare function PromoMeta(): PromoMeta;
|
|
1485
|
-
type PromoMeta = {
|
|
1486
|
-
/**
|
|
1487
|
-
* - Loyalty points message denotes how much
|
|
1488
|
-
* loyalty points and applied and how much left with the user.
|
|
1489
|
-
*/
|
|
1490
|
-
message?: string;
|
|
1491
|
-
};
|
|
1492
|
-
/** @returns {ChargesAmount} */
|
|
1493
|
-
declare function ChargesAmount(): ChargesAmount;
|
|
1494
|
-
type ChargesAmount = {
|
|
1495
|
-
/**
|
|
1496
|
-
* - This is the value of amount added.
|
|
1497
|
-
*/
|
|
1498
|
-
value?: number;
|
|
1499
|
-
/**
|
|
1500
|
-
* - This is destination currency of value.
|
|
1501
|
-
*/
|
|
1502
|
-
currency?: string;
|
|
1503
|
-
};
|
|
1504
|
-
/** @returns {Charges} */
|
|
1505
|
-
declare function Charges(): Charges;
|
|
1506
|
-
type Charges = {
|
|
1507
|
-
/**
|
|
1508
|
-
* - Meta data realted to charges price adjustment.
|
|
1509
|
-
*/
|
|
1510
|
-
meta?: any;
|
|
1511
|
-
amount?: ChargesAmount;
|
|
1512
|
-
/**
|
|
1513
|
-
* - Name of the charge applied.
|
|
1514
|
-
*/
|
|
1515
|
-
name?: string;
|
|
1516
|
-
/**
|
|
1517
|
-
* - Whether refund is allowed or not for the charge.
|
|
1518
|
-
*/
|
|
1519
|
-
allow_refund?: boolean;
|
|
1520
|
-
/**
|
|
1521
|
-
* - Code of the charge applied.
|
|
1522
|
-
*/
|
|
1523
|
-
code?: string;
|
|
1524
|
-
/**
|
|
1525
|
-
* - Type of the charge applied.
|
|
1526
|
-
*/
|
|
1527
|
-
type?: string;
|
|
1528
|
-
};
|
|
1529
|
-
/** @returns {ProductPrice} */
|
|
1530
|
-
declare function ProductPrice(): ProductPrice;
|
|
1531
|
-
type ProductPrice = {
|
|
1532
|
-
/**
|
|
1533
|
-
* - Currency symbol of the price defined
|
|
1534
|
-
* for the product.
|
|
1535
|
-
*/
|
|
1536
|
-
currency_symbol?: string;
|
|
1537
|
-
/**
|
|
1538
|
-
* - Selling price of the product .
|
|
1539
|
-
*/
|
|
1540
|
-
selling?: number;
|
|
1541
|
-
/**
|
|
1542
|
-
* - Currency code of the price defined for
|
|
1543
|
-
* the product.
|
|
1544
|
-
*/
|
|
1545
|
-
currency_code?: string;
|
|
1546
|
-
/**
|
|
1547
|
-
* - Price before promotion and coupon amount
|
|
1548
|
-
* applied for calculation.
|
|
1549
|
-
*/
|
|
1550
|
-
add_on?: number;
|
|
1551
|
-
/**
|
|
1552
|
-
* - Selling price of the product .
|
|
1553
|
-
*/
|
|
1554
|
-
effective?: number;
|
|
1555
|
-
/**
|
|
1556
|
-
* - Maximum price of the product .
|
|
1557
|
-
*/
|
|
1558
|
-
marked?: number;
|
|
1559
|
-
};
|
|
1560
|
-
/** @returns {ProductPriceInfo} */
|
|
1561
|
-
declare function ProductPriceInfo(): ProductPriceInfo;
|
|
1562
|
-
type ProductPriceInfo = {
|
|
1563
|
-
base?: ProductPrice;
|
|
1564
|
-
converted?: ProductPrice;
|
|
1565
|
-
};
|
|
1566
|
-
/** @returns {ProductPricePerUnit} */
|
|
1567
|
-
declare function ProductPricePerUnit(): ProductPricePerUnit;
|
|
1568
|
-
type ProductPricePerUnit = {
|
|
1569
|
-
/**
|
|
1570
|
-
* - Currency symbol of the price defined
|
|
1571
|
-
* for the product.
|
|
1572
|
-
*/
|
|
1573
|
-
currency_symbol?: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* - Selling price of the product .
|
|
1576
|
-
*/
|
|
1577
|
-
selling_price?: number;
|
|
1578
|
-
/**
|
|
1579
|
-
* - Currency code of the price defined for
|
|
1580
|
-
* the product.
|
|
1581
|
-
*/
|
|
1582
|
-
currency_code?: string;
|
|
1583
|
-
/**
|
|
1584
|
-
* - Price before promotion and coupon amount
|
|
1585
|
-
* applied for calculation.
|
|
1586
|
-
*/
|
|
1587
|
-
add_on?: number;
|
|
1588
|
-
/**
|
|
1589
|
-
* - Selling price of the product .
|
|
1590
|
-
*/
|
|
1591
|
-
effective?: number;
|
|
1592
|
-
/**
|
|
1593
|
-
* - Maximum price of the product .
|
|
1594
|
-
*/
|
|
1595
|
-
marked?: number;
|
|
1596
|
-
};
|
|
1597
|
-
/** @returns {ProductPricePerUnitInfo} */
|
|
1598
|
-
declare function ProductPricePerUnitInfo(): ProductPricePerUnitInfo;
|
|
1599
|
-
type ProductPricePerUnitInfo = {
|
|
1600
|
-
base?: ProductPricePerUnit;
|
|
1601
|
-
converted?: ProductPricePerUnit;
|
|
1602
|
-
};
|
|
1603
|
-
/** @returns {ProductAvailabilitySize} */
|
|
1604
|
-
declare function ProductAvailabilitySize(): ProductAvailabilitySize;
|
|
1605
|
-
type ProductAvailabilitySize = {
|
|
1606
|
-
/**
|
|
1607
|
-
* - Display size of the product.
|
|
1608
|
-
*/
|
|
1609
|
-
display?: string;
|
|
1610
|
-
/**
|
|
1611
|
-
* - Actual value of the size.
|
|
1612
|
-
*/
|
|
1613
|
-
value?: string;
|
|
1614
|
-
/**
|
|
1615
|
-
* - Available flag for the size of the
|
|
1616
|
-
* product if that is available.
|
|
1617
|
-
*/
|
|
1618
|
-
is_available?: boolean;
|
|
1619
|
-
};
|
|
1620
|
-
/** @returns {ProductAvailability} */
|
|
1621
|
-
declare function ProductAvailability(): ProductAvailability;
|
|
1622
|
-
type ProductAvailability = {
|
|
1623
|
-
/**
|
|
1624
|
-
* - Denotes if the product is available in stock.
|
|
1625
|
-
*/
|
|
1626
|
-
out_of_stock?: boolean;
|
|
1627
|
-
/**
|
|
1628
|
-
* - Deliverable flag denotes if the product
|
|
1629
|
-
* is deliverable or not.
|
|
1630
|
-
*/
|
|
1631
|
-
deliverable?: boolean;
|
|
1632
|
-
/**
|
|
1633
|
-
* - Product sizes availability.
|
|
1634
|
-
*/
|
|
1635
|
-
available_sizes?: ProductAvailabilitySize[];
|
|
1636
|
-
/**
|
|
1637
|
-
* - Valid flag for the product if the product
|
|
1638
|
-
* added in cart is valid to place the order.
|
|
1639
|
-
*/
|
|
1640
|
-
is_valid?: boolean;
|
|
1641
|
-
/**
|
|
1642
|
-
* - Quantity of the product available
|
|
1643
|
-
* on other store.
|
|
1644
|
-
*/
|
|
1645
|
-
other_store_quantity?: number;
|
|
1646
|
-
/**
|
|
1647
|
-
* - All sizes of the product.
|
|
1648
|
-
*/
|
|
1649
|
-
sizes?: string[];
|
|
1650
|
-
};
|
|
1651
|
-
/** @returns {ActionQuery} */
|
|
1652
|
-
declare function ActionQuery(): ActionQuery;
|
|
1653
|
-
type ActionQuery = {
|
|
1654
|
-
/**
|
|
1655
|
-
* - Contains list of product slug.
|
|
1656
|
-
*/
|
|
1657
|
-
product_slug?: string[];
|
|
1658
|
-
};
|
|
1659
|
-
/** @returns {ProductAction} */
|
|
1660
|
-
declare function ProductAction(): ProductAction;
|
|
1661
|
-
type ProductAction = {
|
|
1662
|
-
query?: ActionQuery;
|
|
1663
|
-
/**
|
|
1664
|
-
* - Url of the product to render the product .
|
|
1665
|
-
*/
|
|
1666
|
-
url?: string;
|
|
1667
|
-
/**
|
|
1668
|
-
* - Type of action.
|
|
1669
|
-
*/
|
|
1670
|
-
type?: string;
|
|
1671
|
-
};
|
|
1672
|
-
/** @returns {Tags} */
|
|
1673
|
-
declare function Tags(): Tags;
|
|
1674
|
-
type Tags = {
|
|
1675
|
-
/**
|
|
1676
|
-
* - Tags is a lable or batch that is attached to a
|
|
1677
|
-
* product in cart.
|
|
1678
|
-
*/
|
|
1679
|
-
tags?: any;
|
|
1680
|
-
};
|
|
1681
|
-
/** @returns {ProductImage} */
|
|
1682
|
-
declare function ProductImage(): ProductImage;
|
|
1683
|
-
type ProductImage = {
|
|
1684
|
-
/**
|
|
1685
|
-
* - Secured url of the product image.
|
|
1686
|
-
*/
|
|
1687
|
-
secure_url?: string;
|
|
1688
|
-
/**
|
|
1689
|
-
* - Aspect ratio of the product image.
|
|
1690
|
-
*/
|
|
1691
|
-
aspect_ratio?: string;
|
|
1692
|
-
/**
|
|
1693
|
-
* - Bucket link url for product image.
|
|
1694
|
-
*/
|
|
1695
|
-
url?: string;
|
|
1696
|
-
};
|
|
1697
|
-
/** @returns {CategoryInfo} */
|
|
1698
|
-
declare function CategoryInfo(): CategoryInfo;
|
|
1699
|
-
type CategoryInfo = {
|
|
1700
|
-
/**
|
|
1701
|
-
* - Product Category Id.
|
|
1702
|
-
*/
|
|
1703
|
-
uid?: number;
|
|
1704
|
-
/**
|
|
1705
|
-
* - Category name of the product .
|
|
1706
|
-
*/
|
|
1707
|
-
name?: string;
|
|
1708
|
-
};
|
|
1709
|
-
/** @returns {CartProduct} */
|
|
1710
|
-
declare function CartProduct(): CartProduct;
|
|
1711
|
-
type CartProduct = {
|
|
1712
|
-
/**
|
|
1713
|
-
* - Field to add custom json of the product in cart.
|
|
1714
|
-
*/
|
|
1715
|
-
_custom_json?: any;
|
|
1716
|
-
brand?: BaseInfo;
|
|
1717
|
-
action?: ProductAction;
|
|
1718
|
-
teaser_tag?: Tags;
|
|
1719
|
-
/**
|
|
1720
|
-
* - Unique product url name generated via product
|
|
1721
|
-
* name and other meta data.
|
|
1722
|
-
*/
|
|
1723
|
-
slug?: string;
|
|
1724
|
-
/**
|
|
1725
|
-
* - Product Images urls of different types
|
|
1726
|
-
* like secure url, aspect ration url and url.
|
|
1727
|
-
*/
|
|
1728
|
-
images?: ProductImage[];
|
|
1729
|
-
/**
|
|
1730
|
-
* - Unique identifier of the product in cart.
|
|
1731
|
-
*/
|
|
1732
|
-
uid?: number;
|
|
1733
|
-
/**
|
|
1734
|
-
* - Product name of the product in cart which is
|
|
1735
|
-
* defined on platform.
|
|
1736
|
-
*/
|
|
1737
|
-
name?: string;
|
|
1738
|
-
/**
|
|
1739
|
-
* - Product code of the product while defining
|
|
1740
|
-
* product on platform.
|
|
1741
|
-
*/
|
|
1742
|
-
item_code?: string;
|
|
1743
|
-
/**
|
|
1744
|
-
* - Product category information which
|
|
1745
|
-
* incldes category name and category id.
|
|
1746
|
-
*/
|
|
1747
|
-
categories?: CategoryInfo[];
|
|
1748
|
-
/**
|
|
1749
|
-
* - Products tags that are added to each product to
|
|
1750
|
-
* identify the set of products.
|
|
1751
|
-
*/
|
|
1752
|
-
tags?: string[];
|
|
1753
|
-
/**
|
|
1754
|
-
* - Type of product in cart.
|
|
1755
|
-
*/
|
|
1756
|
-
type?: string;
|
|
1757
|
-
/**
|
|
1758
|
-
* - Product attributes defined on platform.
|
|
1759
|
-
*/
|
|
1760
|
-
attributes?: any;
|
|
1761
|
-
};
|
|
1762
|
-
/** @returns {CouponDetails} */
|
|
1763
|
-
declare function CouponDetails(): CouponDetails;
|
|
1764
|
-
type CouponDetails = {
|
|
1765
|
-
/**
|
|
1766
|
-
* - Discout amount applied from
|
|
1767
|
-
* coupon for single quantity of the product.
|
|
1768
|
-
*/
|
|
1769
|
-
discount_single_quantity?: number;
|
|
1770
|
-
/**
|
|
1771
|
-
* - Coupon code of the coupon applied.
|
|
1772
|
-
*/
|
|
1773
|
-
code?: string;
|
|
1774
|
-
/**
|
|
1775
|
-
* - Total discount earned from
|
|
1776
|
-
* coupon applied to cart.
|
|
1777
|
-
*/
|
|
1778
|
-
discount_total_quantity?: number;
|
|
1779
|
-
};
|
|
1780
|
-
/** @returns {CartProductInfo} */
|
|
1781
|
-
declare function CartProductInfo(): CartProductInfo;
|
|
1782
|
-
type CartProductInfo = {
|
|
1783
|
-
article?: ProductArticle;
|
|
1784
|
-
/**
|
|
1785
|
-
* - An Integer indication the Minimum Order Quantity
|
|
1786
|
-
* of a product, e.g. 100.
|
|
1787
|
-
*/
|
|
1788
|
-
moq?: any;
|
|
1789
|
-
identifiers: CartProductIdentifer;
|
|
1790
|
-
promo_meta?: PromoMeta;
|
|
1791
|
-
price?: ProductPriceInfo;
|
|
1792
|
-
/**
|
|
1793
|
-
* - Quantity of the product added in cart.
|
|
1794
|
-
*/
|
|
1795
|
-
quantity?: number;
|
|
1796
|
-
/**
|
|
1797
|
-
* - Charges information which denotes types of
|
|
1798
|
-
* charges and amount of charge applied to that product in cart.
|
|
1799
|
-
*/
|
|
1800
|
-
charges?: Charges[];
|
|
1801
|
-
/**
|
|
1802
|
-
* - Discount amount of the product in cart.
|
|
1803
|
-
*/
|
|
1804
|
-
discount?: string;
|
|
1805
|
-
availability?: ProductAvailability;
|
|
1806
|
-
delivery_promise?: ShipmentPromise;
|
|
1807
|
-
product?: CartProduct;
|
|
1808
|
-
/**
|
|
1809
|
-
* - European Article Number of the product
|
|
1810
|
-
* (limited upto 50 EAN identifier in a single request).
|
|
1811
|
-
*/
|
|
1812
|
-
product_ean_id?: string;
|
|
1813
|
-
/**
|
|
1814
|
-
* - Bulk offer information for the product
|
|
1815
|
-
* which denotes if any bulk offer is applied to the product in cart.
|
|
1816
|
-
*/
|
|
1817
|
-
bulk_offer?: any;
|
|
1818
|
-
/**
|
|
1819
|
-
* - Parent item information of the
|
|
1820
|
-
* product which identifies the parent of the product in cart.
|
|
1821
|
-
*/
|
|
1822
|
-
parent_item_identifiers?: any;
|
|
1823
|
-
coupon?: CouponDetails;
|
|
1824
|
-
/**
|
|
1825
|
-
* - Whether MTO (Make to Order) is enabled or not.
|
|
1826
|
-
*/
|
|
1827
|
-
custom_order?: any;
|
|
1828
|
-
/**
|
|
1829
|
-
* - Message for the coupon denotes which
|
|
1830
|
-
* coupon is applied and empty if not applied.
|
|
1831
|
-
*/
|
|
1832
|
-
coupon_message?: string;
|
|
1833
|
-
/**
|
|
1834
|
-
* - The attribute key associated with the size.
|
|
1835
|
-
*/
|
|
1836
|
-
key?: string;
|
|
1837
|
-
/**
|
|
1838
|
-
* - Product level message which denotes error
|
|
1839
|
-
* information to display over the product in cart.
|
|
1840
|
-
*/
|
|
1841
|
-
message?: string;
|
|
1842
|
-
/**
|
|
1843
|
-
* - Whether or not the product is a set of items.
|
|
1844
|
-
*/
|
|
1845
|
-
is_set?: boolean;
|
|
1846
|
-
price_per_unit?: ProductPricePerUnitInfo;
|
|
1847
|
-
/**
|
|
1848
|
-
* - List of applicable
|
|
1849
|
-
* promotion for the product in cart.
|
|
1850
|
-
*/
|
|
1851
|
-
promotions_applied?: AppliedPromotion[];
|
|
1852
|
-
};
|
|
1853
|
-
/** @returns {DisplayBreakup} */
|
|
1854
|
-
declare function DisplayBreakup(): DisplayBreakup;
|
|
1855
|
-
type DisplayBreakup = {
|
|
1856
|
-
/**
|
|
1857
|
-
* - Currency symbol for the price.
|
|
1858
|
-
*/
|
|
1859
|
-
currency_symbol?: string;
|
|
1860
|
-
/**
|
|
1861
|
-
* - Key of the price like total_mrp, total, subtotal etc.
|
|
1862
|
-
*/
|
|
1863
|
-
key?: string;
|
|
1864
|
-
/**
|
|
1865
|
-
* - Display key field that to be shown against the value.
|
|
1866
|
-
*/
|
|
1867
|
-
display?: string;
|
|
1868
|
-
/**
|
|
1869
|
-
* - List of message at price level to be displayed.
|
|
1870
|
-
*/
|
|
1871
|
-
message?: string[];
|
|
1872
|
-
/**
|
|
1873
|
-
* - Currency code for the price .
|
|
1874
|
-
*/
|
|
1875
|
-
currency_code?: string;
|
|
1876
|
-
/**
|
|
1877
|
-
* - Numeric value of the price.
|
|
1878
|
-
*/
|
|
1879
|
-
value?: number;
|
|
1880
|
-
/**
|
|
1881
|
-
* - Value for the price which is set from platform
|
|
1882
|
-
* if applicable.
|
|
1883
|
-
*/
|
|
1884
|
-
preset?: number;
|
|
1885
|
-
};
|
|
1886
|
-
/** @returns {RawBreakup} */
|
|
1887
|
-
declare function RawBreakup(): RawBreakup;
|
|
1888
|
-
type RawBreakup = {
|
|
1889
|
-
/**
|
|
1890
|
-
* - Total value of goods after all discount, coupons
|
|
1891
|
-
* and promotion applied of all products in cart.
|
|
1892
|
-
*/
|
|
1893
|
-
vog?: number;
|
|
1894
|
-
/**
|
|
1895
|
-
* - Selling price amount of all products in cart.
|
|
1896
|
-
*/
|
|
1897
|
-
subtotal?: number;
|
|
1898
|
-
/**
|
|
1899
|
-
* - Loyalty points applied on cart.
|
|
1900
|
-
*/
|
|
1901
|
-
fynd_cash?: number;
|
|
1902
|
-
/**
|
|
1903
|
-
* - Discount amount recieved on cart.
|
|
1904
|
-
*/
|
|
1905
|
-
discount?: number;
|
|
1906
|
-
/**
|
|
1907
|
-
* - Convenience fee amount applied to cart.
|
|
1908
|
-
*/
|
|
1909
|
-
convenience_fee?: number;
|
|
1910
|
-
/**
|
|
1911
|
-
* - Delivery charge applied to cart.
|
|
1912
|
-
*/
|
|
1913
|
-
delivery_charge?: number;
|
|
1914
|
-
/**
|
|
1915
|
-
* - GST charges applied on cart.
|
|
1916
|
-
*/
|
|
1917
|
-
gst_charges?: number;
|
|
1918
|
-
/**
|
|
1919
|
-
* - Maximum price total amount of all products in cart.
|
|
1920
|
-
*/
|
|
1921
|
-
mrp_total?: number;
|
|
1922
|
-
/**
|
|
1923
|
-
* - Total of payment modes by which payment is
|
|
1924
|
-
* going to be done.
|
|
1925
|
-
*/
|
|
1926
|
-
mop_total?: number;
|
|
1927
|
-
/**
|
|
1928
|
-
* - Total amount of charges applied on cart.
|
|
1929
|
-
*/
|
|
1930
|
-
total_charge?: number;
|
|
1931
|
-
/**
|
|
1932
|
-
* - Coupon amount applied to cart.
|
|
1933
|
-
*/
|
|
1934
|
-
coupon?: number;
|
|
1935
|
-
/**
|
|
1936
|
-
* - Total payable amount by the customer.
|
|
1937
|
-
*/
|
|
1938
|
-
total?: number;
|
|
1939
|
-
/**
|
|
1940
|
-
* - Gift cart amount applied on cart.
|
|
1941
|
-
*/
|
|
1942
|
-
gift_card?: number;
|
|
1943
|
-
/**
|
|
1944
|
-
* - Total amount will be saved if customer
|
|
1945
|
-
* places the order.
|
|
1946
|
-
*/
|
|
1947
|
-
you_saved?: number;
|
|
1948
|
-
/**
|
|
1949
|
-
* - Cod charge value applied to cart. This is
|
|
1950
|
-
* applied when user select payment mode as COD.
|
|
1951
|
-
*/
|
|
1952
|
-
cod_charge?: number;
|
|
1953
|
-
};
|
|
1954
|
-
/** @returns {CouponBreakup} */
|
|
1955
|
-
declare function CouponBreakup(): CouponBreakup;
|
|
1956
|
-
type CouponBreakup = {
|
|
1957
|
-
/**
|
|
1958
|
-
* - Value of the coupon applied to cart.
|
|
1959
|
-
*/
|
|
1960
|
-
coupon_value?: number;
|
|
1961
|
-
/**
|
|
1962
|
-
* - Coupon Title of the coupon applied denotes name
|
|
1963
|
-
* of the coupon.
|
|
1964
|
-
*/
|
|
1965
|
-
title?: string;
|
|
1966
|
-
/**
|
|
1967
|
-
* - Coupon subtitle of the coupon applied to
|
|
1968
|
-
* cart which is used to display.
|
|
1969
|
-
*/
|
|
1970
|
-
sub_title?: string;
|
|
1971
|
-
/**
|
|
1972
|
-
* - Minumum cart value of cart after
|
|
1973
|
-
* which the coupon can be applied.
|
|
1974
|
-
*/
|
|
1975
|
-
minimum_cart_value?: number;
|
|
1976
|
-
/**
|
|
1977
|
-
* - Coupon message of the coupon applied to cart.
|
|
1978
|
-
*/
|
|
1979
|
-
message?: string;
|
|
1980
|
-
/**
|
|
1981
|
-
* - Type of the coupon applied to cart.
|
|
1982
|
-
*/
|
|
1983
|
-
coupon_type?: string;
|
|
1984
|
-
/**
|
|
1985
|
-
* - Unique identifier of the coupon applied to cart.
|
|
1986
|
-
*/
|
|
1987
|
-
uid?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* - Coupon value of the coupon applied to cart.
|
|
1990
|
-
*/
|
|
1991
|
-
value?: number;
|
|
1992
|
-
/**
|
|
1993
|
-
* - Maximum discount value of the
|
|
1994
|
-
* coupon applied to cart.
|
|
1995
|
-
*/
|
|
1996
|
-
max_discount_value?: number;
|
|
1997
|
-
/**
|
|
1998
|
-
* - Applied flag which denotes if any coupon
|
|
1999
|
-
* is applied to cart.
|
|
2000
|
-
*/
|
|
2001
|
-
is_applied?: boolean;
|
|
2002
|
-
/**
|
|
2003
|
-
* - Coupon description of the coupon applied to cart.
|
|
2004
|
-
*/
|
|
2005
|
-
description?: string;
|
|
2006
|
-
/**
|
|
2007
|
-
* - Coupon code of the coupon applied.
|
|
2008
|
-
*/
|
|
2009
|
-
code?: string;
|
|
2010
|
-
/**
|
|
2011
|
-
* - Type of the coupon applied to cart.
|
|
2012
|
-
*/
|
|
2013
|
-
type?: string;
|
|
2014
|
-
};
|
|
2015
|
-
/** @returns {LoyaltyPoints} */
|
|
2016
|
-
declare function LoyaltyPoints(): LoyaltyPoints;
|
|
2017
|
-
type LoyaltyPoints = {
|
|
2018
|
-
/**
|
|
2019
|
-
* - Total loyalty points available with user.
|
|
2020
|
-
*/
|
|
2021
|
-
total?: number;
|
|
2022
|
-
/**
|
|
2023
|
-
* - Description for loyalty points.
|
|
2024
|
-
*/
|
|
2025
|
-
description?: string;
|
|
2026
|
-
/**
|
|
2027
|
-
* - Whether the loyalty points are applicable
|
|
2028
|
-
* for the cart .
|
|
2029
|
-
*/
|
|
2030
|
-
applicable?: number;
|
|
2031
|
-
/**
|
|
2032
|
-
* - Whether the loyalty points are applied on the cart .
|
|
2033
|
-
*/
|
|
2034
|
-
is_applied?: boolean;
|
|
2035
|
-
};
|
|
2036
|
-
/** @returns {CartBreakup} */
|
|
2037
|
-
declare function CartBreakup(): CartBreakup;
|
|
2038
|
-
type CartBreakup = {
|
|
2039
|
-
/**
|
|
2040
|
-
* - List of breakup data which is used
|
|
2041
|
-
* to display the breakup to the customer like MRP total, Discount, Sub total,
|
|
2042
|
-
* coupon value, promotion value and final total.
|
|
2043
|
-
*/
|
|
2044
|
-
display?: DisplayBreakup[];
|
|
2045
|
-
raw?: RawBreakup;
|
|
2046
|
-
coupon?: CouponBreakup;
|
|
2047
|
-
loyalty_points?: LoyaltyPoints;
|
|
2048
|
-
};
|
|
2049
|
-
/** @returns {CartCurrency} */
|
|
2050
|
-
declare function CartCurrency(): CartCurrency;
|
|
2051
|
-
type CartCurrency = {
|
|
2052
|
-
/**
|
|
2053
|
-
* - Currency code defined by ISO 4217:2015.
|
|
2054
|
-
*/
|
|
2055
|
-
code?: string;
|
|
2056
|
-
/**
|
|
2057
|
-
* - Currency symbol for currency of user cart prices.
|
|
2058
|
-
*/
|
|
2059
|
-
symbol?: string;
|
|
2060
|
-
};
|
|
2061
|
-
/** @returns {CartDetailCoupon} */
|
|
2062
|
-
declare function CartDetailCoupon(): CartDetailCoupon;
|
|
2063
|
-
type CartDetailCoupon = {
|
|
2064
|
-
/**
|
|
2065
|
-
* - Fields denotes cashback amount applied to cart.
|
|
2066
|
-
*/
|
|
2067
|
-
cashback_amount?: number;
|
|
2068
|
-
/**
|
|
2069
|
-
* - Primary cashback message for
|
|
2070
|
-
* coupon applied to cart.
|
|
2071
|
-
*/
|
|
2072
|
-
cashback_message_primary?: string;
|
|
2073
|
-
/**
|
|
2074
|
-
* - Secondary cashback message
|
|
2075
|
-
* for coupon applied to cart.
|
|
2076
|
-
*/
|
|
2077
|
-
cashback_message_secondary?: string;
|
|
2078
|
-
/**
|
|
2079
|
-
* - Coupon code to be applied to cart.
|
|
2080
|
-
*/
|
|
2081
|
-
coupon_code?: string;
|
|
2082
|
-
/**
|
|
2083
|
-
* - Coupon description of the coupon
|
|
2084
|
-
* applied to cart.
|
|
2085
|
-
*/
|
|
2086
|
-
coupon_description?: string;
|
|
2087
|
-
/**
|
|
2088
|
-
* - Unique identifier of the coupon applied to cart.
|
|
2089
|
-
*/
|
|
2090
|
-
coupon_id?: string;
|
|
2091
|
-
/**
|
|
2092
|
-
* - Coupon subtitle of the coupon applied to cart.
|
|
2093
|
-
*/
|
|
2094
|
-
coupon_subtitle?: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* - Coupon Title of the coupon applied.
|
|
2097
|
-
*/
|
|
2098
|
-
coupon_title?: string;
|
|
2099
|
-
/**
|
|
2100
|
-
* - Type of the coupon applied to cart.
|
|
2101
|
-
*/
|
|
2102
|
-
coupon_type?: string;
|
|
2103
|
-
/**
|
|
2104
|
-
* - Value of the coupon applied to cart.
|
|
2105
|
-
*/
|
|
2106
|
-
coupon_value?: number;
|
|
2107
|
-
/**
|
|
2108
|
-
* - Total discount earned from coupon applied to cart.
|
|
2109
|
-
*/
|
|
2110
|
-
discount?: number;
|
|
2111
|
-
/**
|
|
2112
|
-
* - Flag to determine where the coupon is
|
|
2113
|
-
* applied to cart or not.
|
|
2114
|
-
*/
|
|
2115
|
-
is_applied?: boolean;
|
|
2116
|
-
/**
|
|
2117
|
-
* - Determine where the coupon applied to cart is valid.
|
|
2118
|
-
*/
|
|
2119
|
-
is_valid?: boolean;
|
|
2120
|
-
/**
|
|
2121
|
-
* - Maximum discount value of the
|
|
2122
|
-
* coupon applied to cart.
|
|
2123
|
-
*/
|
|
2124
|
-
maximum_discount_value?: number;
|
|
2125
|
-
/**
|
|
2126
|
-
* - Coupon message of the coupon applied to cart.
|
|
2127
|
-
*/
|
|
2128
|
-
message?: string;
|
|
2129
|
-
/**
|
|
2130
|
-
* - Minimum cart value of the coupon
|
|
2131
|
-
* applied to cart.
|
|
2132
|
-
*/
|
|
2133
|
-
minimum_cart_value?: number;
|
|
2134
|
-
};
|
|
2135
|
-
/** @returns {ChargesThreshold} */
|
|
2136
|
-
declare function ChargesThreshold(): ChargesThreshold;
|
|
2137
|
-
type ChargesThreshold = {
|
|
2138
|
-
/**
|
|
2139
|
-
* - Charges amount to be applied on cart.
|
|
2140
|
-
*/
|
|
2141
|
-
charges?: number;
|
|
2142
|
-
/**
|
|
2143
|
-
* - Threshold of cart value on which the charge
|
|
2144
|
-
* should be applied .
|
|
2145
|
-
*/
|
|
2146
|
-
threshold?: number;
|
|
2147
|
-
};
|
|
2148
|
-
/** @returns {DeliveryChargesConfig} */
|
|
2149
|
-
declare function DeliveryChargesConfig(): DeliveryChargesConfig;
|
|
2150
|
-
type DeliveryChargesConfig = {
|
|
2151
|
-
/**
|
|
2152
|
-
* - Delivery charge enabled for the cart or not.
|
|
2153
|
-
*/
|
|
2154
|
-
enabled?: boolean;
|
|
2155
|
-
/**
|
|
2156
|
-
* - Charges applicable based on threshold.
|
|
2157
|
-
*/
|
|
2158
|
-
charges?: ChargesThreshold[];
|
|
2159
|
-
};
|
|
2160
|
-
/** @returns {CartCommonConfig} */
|
|
2161
|
-
declare function CartCommonConfig(): CartCommonConfig;
|
|
2162
|
-
type CartCommonConfig = {
|
|
2163
|
-
delivery_charges_config?: DeliveryChargesConfig;
|
|
2164
|
-
};
|
|
2165
|
-
/** @returns {CartDetailResponse} */
|
|
2166
|
-
declare function CartDetailResponse(): CartDetailResponse;
|
|
2167
|
-
type CartDetailResponse = {
|
|
2168
|
-
/**
|
|
2169
|
-
* - Unique identifier of the user cart.
|
|
2170
|
-
*/
|
|
2171
|
-
cart_id?: number;
|
|
2172
|
-
/**
|
|
2173
|
-
* - Unique identifier of the user cart.
|
|
2174
|
-
*/
|
|
2175
|
-
uid?: string;
|
|
2176
|
-
/**
|
|
2177
|
-
* - List of applied
|
|
2178
|
-
* promotions data to cart which includes promotion id, promotion name, offer
|
|
2179
|
-
* text, description, buy rules, discount rules and promotion type.
|
|
2180
|
-
*/
|
|
2181
|
-
applied_promo_details?: AppliedPromotion[];
|
|
2182
|
-
/**
|
|
2183
|
-
* - Checkout mode of user cart.
|
|
2184
|
-
*/
|
|
2185
|
-
checkout_mode?: string;
|
|
2186
|
-
/**
|
|
2187
|
-
* - Permanent Account Number of the user.
|
|
2188
|
-
*/
|
|
2189
|
-
pan_no?: string;
|
|
2190
|
-
/**
|
|
2191
|
-
* - Cart validity flag determines the if the
|
|
2192
|
-
* response is valid or not.
|
|
2193
|
-
*/
|
|
2194
|
-
is_valid?: boolean;
|
|
2195
|
-
/**
|
|
2196
|
-
* - Unique identifier of the user cart.
|
|
2197
|
-
*/
|
|
2198
|
-
id?: string;
|
|
2199
|
-
payment_selection_lock?: PaymentSelectionLock;
|
|
2200
|
-
delivery_promise?: ShipmentPromise;
|
|
2201
|
-
/**
|
|
2202
|
-
* - Comment message to be added in user cart.
|
|
2203
|
-
*/
|
|
2204
|
-
comment?: string;
|
|
2205
|
-
/**
|
|
2206
|
-
* - Items data list in user cart that
|
|
2207
|
-
* includes item id, item size, store id, available sizes and rest of the item
|
|
2208
|
-
* related data.
|
|
2209
|
-
*/
|
|
2210
|
-
items?: CartProductInfo[];
|
|
2211
|
-
/**
|
|
2212
|
-
* - Delivery charge in information
|
|
2213
|
-
* message on shipment .
|
|
2214
|
-
*/
|
|
2215
|
-
delivery_charge_info?: string;
|
|
2216
|
-
common_config?: CartCommonConfig;
|
|
2217
|
-
coupon?: CartDetailCoupon;
|
|
2218
|
-
/**
|
|
2219
|
-
* - Message of the get cart detail API response.
|
|
2220
|
-
*/
|
|
2221
|
-
message?: string;
|
|
2222
|
-
/**
|
|
2223
|
-
* - Notification object which denotes
|
|
2224
|
-
* notification data for user cart.
|
|
2225
|
-
*/
|
|
2226
|
-
notification?: any;
|
|
2227
|
-
/**
|
|
2228
|
-
* - Staff employee user id if cart is
|
|
2229
|
-
* created by staff employee for the customer.
|
|
2230
|
-
*/
|
|
2231
|
-
staff_user_id?: string;
|
|
2232
|
-
/**
|
|
2233
|
-
* - Success flag of get cart detail API response.
|
|
2234
|
-
*/
|
|
2235
|
-
success?: boolean;
|
|
2236
|
-
/**
|
|
2237
|
-
* - GSTIN added in user cart.
|
|
2238
|
-
*/
|
|
2239
|
-
gstin?: string;
|
|
2240
|
-
/**
|
|
2241
|
-
* - Restrict checkout flag to restrict
|
|
2242
|
-
* the checkout process.
|
|
2243
|
-
*/
|
|
2244
|
-
restrict_checkout?: boolean;
|
|
2245
|
-
/**
|
|
2246
|
-
* - Last modified timestamp of cart.
|
|
2247
|
-
*/
|
|
2248
|
-
last_modified?: string;
|
|
2249
|
-
breakup_values?: CartBreakup;
|
|
2250
|
-
currency?: CartCurrency;
|
|
2251
|
-
/**
|
|
2252
|
-
* - Coupon text of coupon applied on cart.
|
|
2253
|
-
*/
|
|
2254
|
-
coupon_text?: string;
|
|
2255
|
-
/**
|
|
2256
|
-
* - Buy now flag for the cart which denotes user
|
|
2257
|
-
* is doing fast checkout for the cart using buy now.
|
|
2258
|
-
*/
|
|
2259
|
-
buy_now?: boolean;
|
|
2260
|
-
/**
|
|
2261
|
-
* - Pan card config states at what condition
|
|
2262
|
-
* user should enter the pan card.
|
|
2263
|
-
*/
|
|
2264
|
-
pan_config?: any;
|
|
2265
|
-
/**
|
|
2266
|
-
* - Custom meta details added cart
|
|
2267
|
-
* checkout API payload .
|
|
2268
|
-
*/
|
|
2269
|
-
custom_cart_meta?: any;
|
|
2270
|
-
};
|
|
2271
|
-
/** @returns {AddProductCart} */
|
|
2272
|
-
declare function AddProductCart(): AddProductCart;
|
|
2273
|
-
type AddProductCart = {
|
|
2274
|
-
/**
|
|
2275
|
-
* - Field to determine how article
|
|
2276
|
-
* assignment should happen by article assignment level and strategy.
|
|
2277
|
-
*/
|
|
2278
|
-
article_assignment?: any;
|
|
2279
|
-
/**
|
|
2280
|
-
* - Field to specify the product
|
|
2281
|
-
* groups of the product that the user is trying to add in cart.
|
|
2282
|
-
*/
|
|
2283
|
-
product_group_tags?: string[];
|
|
2284
|
-
/**
|
|
2285
|
-
* - Extra meta data to be added at article
|
|
2286
|
-
* level while add items to cart.
|
|
2287
|
-
*/
|
|
2288
|
-
extra_meta?: any;
|
|
2289
|
-
/**
|
|
2290
|
-
* - Field to specify the product quantity that
|
|
2291
|
-
* user wants to buy.
|
|
2292
|
-
*/
|
|
2293
|
-
quantity?: number;
|
|
2294
|
-
/**
|
|
2295
|
-
* - Field to add custom json at article level
|
|
2296
|
-
* while add items to cart .
|
|
2297
|
-
*/
|
|
2298
|
-
_custom_json?: any;
|
|
2299
|
-
/**
|
|
2300
|
-
* - Field to determine size of the product.
|
|
2301
|
-
*/
|
|
2302
|
-
item_size?: string;
|
|
2303
|
-
/**
|
|
2304
|
-
* - Unique identifier of the store selected by
|
|
2305
|
-
* the user from which user want to buy a product.
|
|
2306
|
-
*/
|
|
2307
|
-
store_id?: number;
|
|
2308
|
-
/**
|
|
2309
|
-
* - Display field at article level .
|
|
2310
|
-
*/
|
|
2311
|
-
display?: string;
|
|
2312
|
-
/**
|
|
2313
|
-
* - Unique identifier of an article .
|
|
2314
|
-
*/
|
|
2315
|
-
article_id?: string;
|
|
2316
|
-
/**
|
|
2317
|
-
* - Fields to determine parent
|
|
2318
|
-
* product of the product.
|
|
2319
|
-
*/
|
|
2320
|
-
parent_item_identifiers?: any[];
|
|
2321
|
-
/**
|
|
2322
|
-
* - Unique idetifier of the seller selected by
|
|
2323
|
-
* the user from which user want to buy a product .
|
|
2324
|
-
*/
|
|
2325
|
-
seller_id?: number;
|
|
2326
|
-
/**
|
|
2327
|
-
* - Filed to determine whether user is making request
|
|
2328
|
-
* from pos or not.
|
|
2329
|
-
*/
|
|
2330
|
-
pos?: boolean;
|
|
2331
|
-
/**
|
|
2332
|
-
* - Unique identifier to identify product.
|
|
2333
|
-
*/
|
|
2334
|
-
item_id?: number;
|
|
2335
|
-
/**
|
|
2336
|
-
* - Field to add meta data at article level.
|
|
2337
|
-
*/
|
|
2338
|
-
meta?: any;
|
|
2339
|
-
/**
|
|
2340
|
-
* - Add items using seller identifier
|
|
2341
|
-
* for store os.
|
|
2342
|
-
*/
|
|
2343
|
-
seller_identifier?: string;
|
|
2344
|
-
};
|
|
2345
|
-
/** @returns {AddCartRequest} */
|
|
2346
|
-
declare function AddCartRequest(): AddCartRequest;
|
|
2347
|
-
type AddCartRequest = {
|
|
2348
|
-
/**
|
|
2349
|
-
* - List of items detail which need to be
|
|
2350
|
-
* added to cart like item id, item size, and item quantity.
|
|
2351
|
-
*/
|
|
2352
|
-
items?: AddProductCart[];
|
|
2353
|
-
/**
|
|
2354
|
-
* - Field to create to new cart whille user adds
|
|
2355
|
-
* item to cart.
|
|
2356
|
-
*/
|
|
2357
|
-
new_cart?: boolean;
|
|
2358
|
-
};
|
|
2359
|
-
/** @returns {AddCartDetailResponse} */
|
|
2360
|
-
declare function AddCartDetailResponse(): AddCartDetailResponse;
|
|
2361
|
-
type AddCartDetailResponse = {
|
|
2362
|
-
/**
|
|
2363
|
-
* - Message of add to cart API response.
|
|
2364
|
-
*/
|
|
2365
|
-
message?: string;
|
|
2366
|
-
/**
|
|
2367
|
-
* - When adding multiple items check if all
|
|
2368
|
-
* added. True if only few are added.
|
|
2369
|
-
*/
|
|
2370
|
-
partial?: boolean;
|
|
2371
|
-
cart?: CartDetailResponse;
|
|
2372
|
-
/**
|
|
2373
|
-
* - True if all items are added successfully.
|
|
2374
|
-
* False if partially added or not added.
|
|
2375
|
-
*/
|
|
2376
|
-
success?: boolean;
|
|
2377
|
-
};
|
|
2378
|
-
/** @returns {UpdateProductCart} */
|
|
2379
|
-
declare function UpdateProductCart(): UpdateProductCart;
|
|
2380
|
-
type UpdateProductCart = {
|
|
2381
|
-
/**
|
|
2382
|
-
* - Field to update extra meta of the product in cart.
|
|
2383
|
-
*/
|
|
2384
|
-
extra_meta?: any;
|
|
2385
|
-
/**
|
|
2386
|
-
* - Field to update custom json of the product in cart.
|
|
2387
|
-
*/
|
|
2388
|
-
_custom_json?: any;
|
|
2389
|
-
/**
|
|
2390
|
-
* - Field to update the quantity of the item in cart.
|
|
2391
|
-
*/
|
|
2392
|
-
quantity?: number;
|
|
2393
|
-
/**
|
|
2394
|
-
* - Field to update the size of the product in cart.
|
|
2395
|
-
*/
|
|
2396
|
-
item_size?: string;
|
|
2397
|
-
/**
|
|
2398
|
-
* - Item index determines on which index the
|
|
2399
|
-
* product falls to be updated.
|
|
2400
|
-
*/
|
|
2401
|
-
item_index?: number;
|
|
2402
|
-
identifiers: CartProductIdentifer;
|
|
2403
|
-
/**
|
|
2404
|
-
* - Article id of the product in cart.
|
|
2405
|
-
*/
|
|
2406
|
-
article_id?: string;
|
|
2407
|
-
/**
|
|
2408
|
-
* - Field to update parent product
|
|
2409
|
-
* of the item in cart.
|
|
2410
|
-
*/
|
|
2411
|
-
parent_item_identifiers?: any;
|
|
2412
|
-
/**
|
|
2413
|
-
* - Item id of the product that needs to be updated.
|
|
2414
|
-
*/
|
|
2415
|
-
item_id?: number;
|
|
2416
|
-
/**
|
|
2417
|
-
* - Field to update meta of the item in cart.
|
|
2418
|
-
*/
|
|
2419
|
-
meta?: any;
|
|
2420
|
-
};
|
|
2421
|
-
/** @returns {UpdateCartRequest} */
|
|
2422
|
-
declare function UpdateCartRequest(): UpdateCartRequest;
|
|
2423
|
-
type UpdateCartRequest = {
|
|
2424
|
-
/**
|
|
2425
|
-
* - List items data that needs to be
|
|
2426
|
-
* updated in cart.
|
|
2427
|
-
*/
|
|
2428
|
-
items?: UpdateProductCart[];
|
|
2429
|
-
/**
|
|
2430
|
-
* - Field to determine if item to be removed from
|
|
2431
|
-
* cart or it needs to be updated.
|
|
2432
|
-
*/
|
|
2433
|
-
operation: string;
|
|
2434
|
-
};
|
|
2435
|
-
/** @returns {UpdateCartDetailResponse} */
|
|
2436
|
-
declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
|
|
2437
|
-
type UpdateCartDetailResponse = {
|
|
2438
|
-
/**
|
|
2439
|
-
* - Message of update cart API response.
|
|
2440
|
-
*/
|
|
2441
|
-
message?: string;
|
|
2442
|
-
cart?: CartDetailResponse;
|
|
2443
|
-
/**
|
|
2444
|
-
* - True if all items are added successfully.
|
|
2445
|
-
* False if partially added or not added.
|
|
2446
|
-
*/
|
|
2447
|
-
success?: boolean;
|
|
2448
|
-
};
|
|
2449
|
-
/** @returns {DeleteCartDetailResponse} */
|
|
2450
|
-
declare function DeleteCartDetailResponse(): DeleteCartDetailResponse;
|
|
2451
|
-
type DeleteCartDetailResponse = {
|
|
2452
|
-
/**
|
|
2453
|
-
* - Message for delete cart response.
|
|
2454
|
-
*/
|
|
2455
|
-
message?: string;
|
|
2456
|
-
/**
|
|
2457
|
-
* - True if cart is archived successfully. False
|
|
2458
|
-
* if not archived.
|
|
2459
|
-
*/
|
|
2460
|
-
success?: boolean;
|
|
2461
|
-
};
|
|
2462
|
-
/** @returns {CartItemCountResponse} */
|
|
2463
|
-
declare function CartItemCountResponse(): CartItemCountResponse;
|
|
2464
|
-
type CartItemCountResponse = {
|
|
2465
|
-
/**
|
|
2466
|
-
* - Item count present in cart.
|
|
2467
|
-
*/
|
|
2468
|
-
user_cart_items_count?: number;
|
|
2469
|
-
};
|
|
2470
|
-
/** @returns {PageCoupon} */
|
|
2471
|
-
declare function PageCoupon(): PageCoupon;
|
|
2472
|
-
type PageCoupon = {
|
|
2473
|
-
/**
|
|
2474
|
-
* - Total coupons are available for the cart.
|
|
2475
|
-
*/
|
|
2476
|
-
total_item_count?: number;
|
|
2477
|
-
/**
|
|
2478
|
-
* - Denotes if next page of coupon is available.
|
|
2479
|
-
*/
|
|
2480
|
-
has_next?: boolean;
|
|
2481
|
-
/**
|
|
2482
|
-
* - Total pages of coupon availalbe.
|
|
2483
|
-
*/
|
|
2484
|
-
total?: number;
|
|
2485
|
-
/**
|
|
2486
|
-
* - Current page number.
|
|
2487
|
-
*/
|
|
2488
|
-
current?: number;
|
|
2489
|
-
/**
|
|
2490
|
-
* - Denotes if previous page of the coupon
|
|
2491
|
-
* is available.
|
|
2492
|
-
*/
|
|
2493
|
-
has_previous?: boolean;
|
|
2494
|
-
};
|
|
2495
|
-
/** @returns {Coupon} */
|
|
2496
|
-
declare function Coupon(): Coupon;
|
|
2497
|
-
type Coupon = {
|
|
2498
|
-
/**
|
|
2499
|
-
* - The amount based on cart value.
|
|
2500
|
-
*/
|
|
2501
|
-
coupon_amount?: number;
|
|
2502
|
-
/**
|
|
2503
|
-
* - Coupon value of the coupon applied to cart.
|
|
2504
|
-
*/
|
|
2505
|
-
coupon_value?: number;
|
|
2506
|
-
/**
|
|
2507
|
-
* - Coupon Title of the coupon applied denotes name
|
|
2508
|
-
* of the coupon.
|
|
2509
|
-
*/
|
|
2510
|
-
title?: string;
|
|
2511
|
-
/**
|
|
2512
|
-
* - Minimum cart value of the coupon
|
|
2513
|
-
* applied to cart.
|
|
2514
|
-
*/
|
|
2515
|
-
minimum_cart_value?: number;
|
|
2516
|
-
/**
|
|
2517
|
-
* - Coupon subtitle of the coupon applied to
|
|
2518
|
-
* cart which is used to display.
|
|
2519
|
-
*/
|
|
2520
|
-
sub_title?: string;
|
|
2521
|
-
/**
|
|
2522
|
-
* - Message to display to user for expiry of the coupon .
|
|
2523
|
-
*/
|
|
2524
|
-
expires_on?: string;
|
|
2525
|
-
/**
|
|
2526
|
-
* - Coupon message of the coupon applied to cart.
|
|
2527
|
-
*/
|
|
2528
|
-
message?: string;
|
|
2529
|
-
/**
|
|
2530
|
-
* - Type of the coupon applied to cart.
|
|
2531
|
-
*/
|
|
2532
|
-
coupon_type?: string;
|
|
2533
|
-
/**
|
|
2534
|
-
* - Maximum discount value of the
|
|
2535
|
-
* coupon applied to cart.
|
|
2536
|
-
*/
|
|
2537
|
-
max_discount_value?: number;
|
|
2538
|
-
/**
|
|
2539
|
-
* - Coupon code of the coupon applied on cart.
|
|
2540
|
-
*/
|
|
2541
|
-
coupon_code?: string;
|
|
2542
|
-
/**
|
|
2543
|
-
* - Flag to determine where the coupon is
|
|
2544
|
-
* applicable to cart or not.
|
|
2545
|
-
*/
|
|
2546
|
-
is_applicable?: boolean;
|
|
2547
|
-
/**
|
|
2548
|
-
* - Coupon description of the coupon applied to cart.
|
|
2549
|
-
*/
|
|
2550
|
-
description?: string;
|
|
2551
|
-
/**
|
|
2552
|
-
* - Flag to determine where the coupon is
|
|
2553
|
-
* applied to cart or not.
|
|
2554
|
-
*/
|
|
2555
|
-
is_applied?: boolean;
|
|
2556
|
-
/**
|
|
2557
|
-
* - Start date of the coupon when the coupon
|
|
2558
|
-
* will be live for the users to apply on cart.
|
|
2559
|
-
*/
|
|
2560
|
-
start_date?: string;
|
|
2561
|
-
/**
|
|
2562
|
-
* - End date of the coupon on which the coupon expires.
|
|
2563
|
-
*/
|
|
2564
|
-
end_date?: string;
|
|
2565
|
-
/**
|
|
2566
|
-
* - Message which is used to
|
|
2567
|
-
* display to the customer if the coupon is applied successfully.
|
|
2568
|
-
*/
|
|
2569
|
-
coupon_applicable_message?: string;
|
|
2570
|
-
/**
|
|
2571
|
-
* - Offer text of the coupon which highligts
|
|
2572
|
-
* coupon offer defined while creating coupon .
|
|
2573
|
-
*/
|
|
2574
|
-
offer_text?: string;
|
|
2575
|
-
/**
|
|
2576
|
-
* - Bank offer flag for the coupon if the
|
|
2577
|
-
* coupon is applicable for only if payment done by bank or mode specified in coupon.
|
|
2578
|
-
*/
|
|
2579
|
-
is_bank_offer?: boolean;
|
|
2580
|
-
};
|
|
2581
|
-
/** @returns {GetCouponResponse} */
|
|
2582
|
-
declare function GetCouponResponse(): GetCouponResponse;
|
|
2583
|
-
type GetCouponResponse = {
|
|
2584
|
-
page?: PageCoupon;
|
|
2585
|
-
/**
|
|
2586
|
-
* - List of available coupon which
|
|
2587
|
-
* can be applied on cart.
|
|
2588
|
-
*/
|
|
2589
|
-
available_coupon_list?: Coupon[];
|
|
2590
|
-
};
|
|
2591
|
-
/** @returns {ApplyCouponRequest} */
|
|
2592
|
-
declare function ApplyCouponRequest(): ApplyCouponRequest;
|
|
2593
|
-
type ApplyCouponRequest = {
|
|
2594
|
-
/**
|
|
2595
|
-
* - Coupon code to be applied.
|
|
2596
|
-
*/
|
|
2597
|
-
coupon_code: string;
|
|
2598
|
-
};
|
|
2599
|
-
/** @returns {OfferPrice} */
|
|
2600
|
-
declare function OfferPrice(): OfferPrice;
|
|
2601
|
-
type OfferPrice = {
|
|
2602
|
-
/**
|
|
2603
|
-
* - Currency symbol for currency.
|
|
2604
|
-
*/
|
|
2605
|
-
currency_symbol?: string;
|
|
2606
|
-
/**
|
|
2607
|
-
* - Discounted per unit price for current
|
|
2608
|
-
* offer object.
|
|
2609
|
-
*/
|
|
2610
|
-
bulk_effective?: number;
|
|
2611
|
-
/**
|
|
2612
|
-
* - The currency code for an offer price is
|
|
2613
|
-
* the three-letter code that corresponds to the currency in which the offer
|
|
2614
|
-
* price is denominated.
|
|
2615
|
-
*/
|
|
2616
|
-
currency_code?: string;
|
|
2617
|
-
/**
|
|
2618
|
-
* - The "effective price" is the actual price
|
|
2619
|
-
* paid by the consumer after accounting for product discounts. It represents
|
|
2620
|
-
* the true cost of a product or service after all adjustments have been made.
|
|
2621
|
-
*/
|
|
2622
|
-
effective?: number;
|
|
2623
|
-
/**
|
|
2624
|
-
* - The price at which the product is sold to the
|
|
2625
|
-
* end consumer, typically the original price before discounts.
|
|
2626
|
-
*/
|
|
2627
|
-
marked?: number;
|
|
2628
|
-
};
|
|
2629
|
-
/** @returns {OfferItem} */
|
|
2630
|
-
declare function OfferItem(): OfferItem;
|
|
2631
|
-
type OfferItem = {
|
|
2632
|
-
price?: OfferPrice;
|
|
2633
|
-
/**
|
|
2634
|
-
* - Percentage value of discount.
|
|
2635
|
-
*/
|
|
2636
|
-
margin?: number;
|
|
2637
|
-
/**
|
|
2638
|
-
* - Quantity on which offer is applicable.
|
|
2639
|
-
*/
|
|
2640
|
-
quantity?: number;
|
|
2641
|
-
/**
|
|
2642
|
-
* - Is true for best offer from all offers present
|
|
2643
|
-
* for all sellers.
|
|
2644
|
-
*/
|
|
2645
|
-
best?: boolean;
|
|
2646
|
-
/**
|
|
2647
|
-
* - Total price of offer quantity with discount.
|
|
2648
|
-
*/
|
|
2649
|
-
total?: number;
|
|
2650
|
-
/**
|
|
2651
|
-
* - Whether offer discount is auto applied in cart.
|
|
2652
|
-
*/
|
|
2653
|
-
auto_applied?: boolean;
|
|
2654
|
-
/**
|
|
2655
|
-
* - Type of the offer.
|
|
2656
|
-
*/
|
|
2657
|
-
type?: string;
|
|
2658
|
-
};
|
|
2659
|
-
/** @returns {OfferSeller} */
|
|
2660
|
-
declare function OfferSeller(): OfferSeller;
|
|
2661
|
-
type OfferSeller = {
|
|
2662
|
-
/**
|
|
2663
|
-
* - Unique identifier for a seller.
|
|
2664
|
-
*/
|
|
2665
|
-
uid?: number;
|
|
2666
|
-
/**
|
|
2667
|
-
* - Name of a seller.
|
|
2668
|
-
*/
|
|
2669
|
-
name?: string;
|
|
2670
|
-
};
|
|
2671
|
-
/** @returns {BulkPriceOffer} */
|
|
2672
|
-
declare function BulkPriceOffer(): BulkPriceOffer;
|
|
2673
|
-
type BulkPriceOffer = {
|
|
2674
|
-
/**
|
|
2675
|
-
* - Offers is the list of Offer item, which
|
|
2676
|
-
* consists of margin percentage, price, quantity, offer type and offer price.
|
|
2677
|
-
*/
|
|
2678
|
-
offers?: OfferItem[];
|
|
2679
|
-
seller?: OfferSeller;
|
|
2680
|
-
};
|
|
2681
|
-
/** @returns {BulkPriceResponse} */
|
|
2682
|
-
declare function BulkPriceResponse(): BulkPriceResponse;
|
|
2683
|
-
type BulkPriceResponse = {
|
|
2684
|
-
/**
|
|
2685
|
-
* - Actual data to be in response consist
|
|
2686
|
-
* of offers from multiple seller.
|
|
2687
|
-
*/
|
|
2688
|
-
data?: BulkPriceOffer[];
|
|
2689
|
-
};
|
|
2690
|
-
/** @returns {RewardPointRequest} */
|
|
2691
|
-
declare function RewardPointRequest(): RewardPointRequest;
|
|
2692
|
-
type RewardPointRequest = {
|
|
2693
|
-
/**
|
|
2694
|
-
* - Points to be applied for cart.
|
|
2695
|
-
*/
|
|
2696
|
-
points: boolean;
|
|
2697
|
-
};
|
|
2698
|
-
/** @returns {GeoLocation} */
|
|
2699
|
-
declare function GeoLocation(): GeoLocation;
|
|
2700
|
-
type GeoLocation = {
|
|
2701
|
-
/**
|
|
2702
|
-
* - Latitude coordinate for address.
|
|
2703
|
-
*/
|
|
2704
|
-
latitude?: number;
|
|
2705
|
-
/**
|
|
2706
|
-
* - Longitude coordinate for address.
|
|
2707
|
-
*/
|
|
2708
|
-
longitude?: number;
|
|
2709
|
-
};
|
|
2710
|
-
/** @returns {Address} */
|
|
2711
|
-
declare function Address(): Address;
|
|
2712
|
-
type Address = {
|
|
2713
|
-
/**
|
|
2714
|
-
* - Country iso code for address.
|
|
2715
|
-
*/
|
|
2716
|
-
country_iso_code?: string;
|
|
2717
|
-
/**
|
|
2718
|
-
* - Area description for address.
|
|
2719
|
-
*/
|
|
2720
|
-
area?: string;
|
|
2721
|
-
/**
|
|
2722
|
-
* - Phone number for address.
|
|
2723
|
-
*/
|
|
2724
|
-
phone?: string;
|
|
2725
|
-
/**
|
|
2726
|
-
* - Country phone code for address.
|
|
2727
|
-
*/
|
|
2728
|
-
country_phone_code?: string;
|
|
2729
|
-
/**
|
|
2730
|
-
* - Checkout mode of address on which
|
|
2731
|
-
* address to be used for which checkout mode of cart.
|
|
2732
|
-
*/
|
|
2733
|
-
checkout_mode?: string;
|
|
2734
|
-
/**
|
|
2735
|
-
* - Address description for address data.
|
|
2736
|
-
*/
|
|
2737
|
-
address?: string;
|
|
2738
|
-
/**
|
|
2739
|
-
* - Area code slug for address. example
|
|
2740
|
-
* pincode is slug for India.
|
|
2741
|
-
*/
|
|
2742
|
-
area_code_slug?: string;
|
|
2743
|
-
geo_location?: GeoLocation;
|
|
2744
|
-
/**
|
|
2745
|
-
* - Id of the address.
|
|
2746
|
-
*/
|
|
2747
|
-
id?: string;
|
|
2748
|
-
/**
|
|
2749
|
-
* - Custom json of the address.
|
|
2750
|
-
*/
|
|
2751
|
-
_custom_json?: any;
|
|
2752
|
-
/**
|
|
2753
|
-
* - City of the address.
|
|
2754
|
-
*/
|
|
2755
|
-
city?: string;
|
|
2756
|
-
/**
|
|
2757
|
-
* - Sector of the address.
|
|
2758
|
-
*/
|
|
2759
|
-
sector?: string;
|
|
2760
|
-
/**
|
|
2761
|
-
* - State code for address.
|
|
2762
|
-
*/
|
|
2763
|
-
state_code?: string;
|
|
2764
|
-
/**
|
|
2765
|
-
* - Created by user id of address.
|
|
2766
|
-
*/
|
|
2767
|
-
created_by_user_id?: string;
|
|
2768
|
-
/**
|
|
2769
|
-
* - Landmark of address.
|
|
2770
|
-
*/
|
|
2771
|
-
landmark?: string;
|
|
2772
|
-
/**
|
|
2773
|
-
* - User id of address for which address is created.
|
|
2774
|
-
*/
|
|
2775
|
-
user_id?: string;
|
|
2776
|
-
/**
|
|
2777
|
-
* - Name of person in address data to whom it belongs to.
|
|
2778
|
-
*/
|
|
2779
|
-
name?: string;
|
|
2780
|
-
/**
|
|
2781
|
-
* - Google map point of the address.
|
|
2782
|
-
*/
|
|
2783
|
-
google_map_point?: any;
|
|
2784
|
-
/**
|
|
2785
|
-
* - States whether address is active or not.
|
|
2786
|
-
*/
|
|
2787
|
-
is_active?: boolean;
|
|
2788
|
-
/**
|
|
2789
|
-
* - Tags of address from which it can be identified.
|
|
2790
|
-
*/
|
|
2791
|
-
tags?: string[];
|
|
2792
|
-
/**
|
|
2793
|
-
* - Country code of address.
|
|
2794
|
-
*/
|
|
2795
|
-
country_code?: string;
|
|
2796
|
-
/**
|
|
2797
|
-
* - Address type of address.
|
|
2798
|
-
*/
|
|
2799
|
-
address_type?: string;
|
|
2800
|
-
/**
|
|
2801
|
-
* - Country of address.
|
|
2802
|
-
*/
|
|
2803
|
-
country?: string;
|
|
2804
|
-
/**
|
|
2805
|
-
* - Default address flag if no address
|
|
2806
|
-
* selected then this should be the default address selected.
|
|
2807
|
-
*/
|
|
2808
|
-
is_default_address?: boolean;
|
|
2809
|
-
/**
|
|
2810
|
-
* - Area code of the address.
|
|
2811
|
-
*/
|
|
2812
|
-
area_code?: string;
|
|
2813
|
-
/**
|
|
2814
|
-
* - Email address for address data.
|
|
2815
|
-
*/
|
|
2816
|
-
email?: string;
|
|
2817
|
-
/**
|
|
2818
|
-
* - State of the address.
|
|
2819
|
-
*/
|
|
2820
|
-
state?: string;
|
|
2821
|
-
/**
|
|
2822
|
-
* - Metadata of the address.
|
|
2823
|
-
*/
|
|
2824
|
-
meta?: any;
|
|
2825
|
-
};
|
|
2826
|
-
/** @returns {GetAddressesResponse} */
|
|
2827
|
-
declare function GetAddressesResponse(): GetAddressesResponse;
|
|
2828
|
-
type GetAddressesResponse = {
|
|
2829
|
-
/**
|
|
2830
|
-
* - Personally Identifiable Information
|
|
2831
|
-
* masking flag to denote if the user data in address is masked or not.
|
|
2832
|
-
*/
|
|
2833
|
-
pii_masking?: boolean;
|
|
2834
|
-
/**
|
|
2835
|
-
* - Address description for address data.
|
|
2836
|
-
*/
|
|
2837
|
-
address?: Address[];
|
|
2838
|
-
};
|
|
2839
|
-
/** @returns {SaveAddressResponse} */
|
|
2840
|
-
declare function SaveAddressResponse(): SaveAddressResponse;
|
|
2841
|
-
type SaveAddressResponse = {
|
|
2842
|
-
/**
|
|
2843
|
-
* - Id of the address.
|
|
2844
|
-
*/
|
|
2845
|
-
id?: string;
|
|
2846
|
-
/**
|
|
2847
|
-
* - Success flag of save address Response.
|
|
2848
|
-
*/
|
|
2849
|
-
success?: boolean;
|
|
2850
|
-
/**
|
|
2851
|
-
* - Default address flag if no address
|
|
2852
|
-
* selected then this should be the default address selected.
|
|
2853
|
-
*/
|
|
2854
|
-
is_default_address?: boolean;
|
|
2855
|
-
};
|
|
2856
|
-
/** @returns {UpdateAddressResponse} */
|
|
2857
|
-
declare function UpdateAddressResponse(): UpdateAddressResponse;
|
|
2858
|
-
type UpdateAddressResponse = {
|
|
2859
|
-
/**
|
|
2860
|
-
* - Updated flag for update address operation
|
|
2861
|
-
* if the address updated or not.
|
|
2862
|
-
*/
|
|
2863
|
-
is_updated?: boolean;
|
|
2864
|
-
/**
|
|
2865
|
-
* - ID of an address.
|
|
2866
|
-
*/
|
|
2867
|
-
id?: string;
|
|
2868
|
-
/**
|
|
2869
|
-
* - Success flag of update address response.
|
|
2870
|
-
*/
|
|
2871
|
-
success?: boolean;
|
|
2872
|
-
/**
|
|
2873
|
-
* - Default address flag if no address
|
|
2874
|
-
* selected then this should be the default address selected.
|
|
2875
|
-
*/
|
|
2876
|
-
is_default_address?: boolean;
|
|
2877
|
-
};
|
|
2878
|
-
/** @returns {DeleteAddressResponse} */
|
|
2879
|
-
declare function DeleteAddressResponse(): DeleteAddressResponse;
|
|
2880
|
-
type DeleteAddressResponse = {
|
|
2881
|
-
/**
|
|
2882
|
-
* - Id of the address.
|
|
2883
|
-
*/
|
|
2884
|
-
id?: string;
|
|
2885
|
-
/**
|
|
2886
|
-
* - Deleted flag in delete address response
|
|
2887
|
-
* states whether the address was deleted or not.
|
|
2888
|
-
*/
|
|
2889
|
-
is_deleted?: boolean;
|
|
2890
|
-
};
|
|
2891
|
-
/** @returns {SelectCartAddressRequest} */
|
|
2892
|
-
declare function SelectCartAddressRequest(): SelectCartAddressRequest;
|
|
2893
|
-
type SelectCartAddressRequest = {
|
|
2894
|
-
/**
|
|
2895
|
-
* - Address is selected by user on which shipment to be
|
|
2896
|
-
* delivered.
|
|
2897
|
-
*/
|
|
2898
|
-
id?: string;
|
|
2899
|
-
/**
|
|
2900
|
-
* - Billing address id selected by user
|
|
2901
|
-
* on which shipment bill to be generated.
|
|
2902
|
-
*/
|
|
2903
|
-
billing_address_id?: string;
|
|
2904
|
-
/**
|
|
2905
|
-
* - Cart id of the user cart for which the select
|
|
2906
|
-
* address operation performed.
|
|
2907
|
-
*/
|
|
2908
|
-
cart_id?: string;
|
|
2909
|
-
};
|
|
2910
|
-
/** @returns {UpdateCartPaymentRequest} */
|
|
2911
|
-
declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
|
|
2912
|
-
type UpdateCartPaymentRequest = {
|
|
2913
|
-
/**
|
|
2914
|
-
* - Cart id of the user cart for which the update cart
|
|
2915
|
-
* payment operation performed.
|
|
2916
|
-
*/
|
|
2917
|
-
id?: string;
|
|
2918
|
-
/**
|
|
2919
|
-
* - Payment identifier of the payment
|
|
2920
|
-
* mode selected to do the payment.
|
|
2921
|
-
*/
|
|
2922
|
-
payment_identifier?: string;
|
|
2923
|
-
/**
|
|
2924
|
-
* - Address id of the user address selected to
|
|
2925
|
-
* deliver the shipment.
|
|
2926
|
-
*/
|
|
2927
|
-
address_id?: string;
|
|
2928
|
-
/**
|
|
2929
|
-
* - Merchant code of the payment mode
|
|
2930
|
-
* selected to do the payment.
|
|
2931
|
-
*/
|
|
2932
|
-
merchant_code?: string;
|
|
2933
|
-
/**
|
|
2934
|
-
* - Aggregator name of the payment gateway.
|
|
2935
|
-
*/
|
|
2936
|
-
aggregator_name?: string;
|
|
2937
|
-
/**
|
|
2938
|
-
* - Payment mode of the payment selected to
|
|
2939
|
-
* do the payment.
|
|
2940
|
-
*/
|
|
2941
|
-
payment_mode?: string;
|
|
2942
|
-
};
|
|
2943
|
-
/** @returns {CouponValidity} */
|
|
2944
|
-
declare function CouponValidity(): CouponValidity;
|
|
2945
|
-
type CouponValidity = {
|
|
2946
|
-
/**
|
|
2947
|
-
* - Coupon Title of the coupon applied.
|
|
2948
|
-
*/
|
|
2949
|
-
title?: string;
|
|
2950
|
-
/**
|
|
2951
|
-
* - Coupon discount value of the coupon applied.
|
|
2952
|
-
*/
|
|
2953
|
-
discount?: number;
|
|
2954
|
-
/**
|
|
2955
|
-
* - Flag for coupon validation
|
|
2956
|
-
* required on next page or not.
|
|
2957
|
-
*/
|
|
2958
|
-
next_validation_required?: boolean;
|
|
2959
|
-
/**
|
|
2960
|
-
* - Valid flag which denotes if the applied coupon
|
|
2961
|
-
* is valid or not.
|
|
2962
|
-
*/
|
|
2963
|
-
valid?: boolean;
|
|
2964
|
-
/**
|
|
2965
|
-
* - Display message for coupon validity.
|
|
2966
|
-
*/
|
|
2967
|
-
display_message_en?: string;
|
|
2968
|
-
/**
|
|
2969
|
-
* - Coupon code of the coupon applied.
|
|
2970
|
-
*/
|
|
2971
|
-
code?: string;
|
|
2972
|
-
};
|
|
2973
|
-
/** @returns {PaymentCouponValidate} */
|
|
2974
|
-
declare function PaymentCouponValidate(): PaymentCouponValidate;
|
|
2975
|
-
type PaymentCouponValidate = {
|
|
2976
|
-
/**
|
|
2977
|
-
* - Payment mode valid message for coupon.
|
|
2978
|
-
*/
|
|
2979
|
-
message?: string;
|
|
2980
|
-
coupon_validity?: CouponValidity;
|
|
2981
|
-
/**
|
|
2982
|
-
* - Success flag of coupon payment mode validity
|
|
2983
|
-
* API response.
|
|
2984
|
-
*/
|
|
2985
|
-
success: boolean;
|
|
2986
|
-
};
|
|
2987
|
-
/** @returns {ShipmentResponse} */
|
|
2988
|
-
declare function ShipmentResponse(): ShipmentResponse;
|
|
2989
|
-
type ShipmentResponse = {
|
|
2990
|
-
/**
|
|
2991
|
-
* - Count of shipments that will be shipped.
|
|
2992
|
-
*/
|
|
2993
|
-
shipments?: number;
|
|
2994
|
-
promise?: ShipmentPromise;
|
|
2995
|
-
/**
|
|
2996
|
-
* - Order type of the shipment like pickAtStore
|
|
2997
|
-
* or HomeDelivery.
|
|
2998
|
-
*/
|
|
2999
|
-
order_type?: string;
|
|
3000
|
-
/**
|
|
3001
|
-
* - Box type of the shipment in which the
|
|
3002
|
-
* shipment will be delivered.
|
|
3003
|
-
*/
|
|
3004
|
-
box_type?: string;
|
|
3005
|
-
/**
|
|
3006
|
-
* - Shipment type of the shipment returned
|
|
3007
|
-
* in get shipments API like single_shipment or multiple shipment. Single
|
|
3008
|
-
* Shipment means 1 item in 1 shipment and vice versa in the other one.
|
|
3009
|
-
*/
|
|
3010
|
-
shipment_type?: string;
|
|
3011
|
-
/**
|
|
3012
|
-
* - Delivery partner options that are available
|
|
3013
|
-
* to deliver the shipment.
|
|
3014
|
-
*/
|
|
3015
|
-
dp_options?: any;
|
|
3016
|
-
/**
|
|
3017
|
-
* - Delivery partner id of the shipment.
|
|
3018
|
-
*/
|
|
3019
|
-
dp_id?: string;
|
|
3020
|
-
/**
|
|
3021
|
-
* - Item details in the shipment.
|
|
3022
|
-
*/
|
|
3023
|
-
items?: CartProductInfo[];
|
|
3024
|
-
/**
|
|
3025
|
-
* - Fulfilment type of shipment.
|
|
3026
|
-
*/
|
|
3027
|
-
fulfillment_type?: string;
|
|
3028
|
-
/**
|
|
3029
|
-
* - Fulfilment id of the shipment.
|
|
3030
|
-
*/
|
|
3031
|
-
fulfillment_id?: number;
|
|
3032
|
-
};
|
|
3033
|
-
/** @returns {CartShipmentsResponse} */
|
|
3034
|
-
declare function CartShipmentsResponse(): CartShipmentsResponse;
|
|
3035
|
-
type CartShipmentsResponse = {
|
|
3036
|
-
/**
|
|
3037
|
-
* - Delivery charge in information
|
|
3038
|
-
* message on shipment.
|
|
3039
|
-
*/
|
|
3040
|
-
delivery_charge_info?: string;
|
|
3041
|
-
/**
|
|
3042
|
-
* - Checkout mode of cart.
|
|
3043
|
-
*/
|
|
3044
|
-
checkout_mode?: string;
|
|
3045
|
-
/**
|
|
3046
|
-
* - Response message of get shipments API.
|
|
3047
|
-
*/
|
|
3048
|
-
message?: string;
|
|
3049
|
-
/**
|
|
3050
|
-
* - GSTIN number added in cart.
|
|
3051
|
-
*/
|
|
3052
|
-
gstin?: string;
|
|
3053
|
-
/**
|
|
3054
|
-
* - Restrict checkout flag to restrict
|
|
3055
|
-
* the checkout process.
|
|
3056
|
-
*/
|
|
3057
|
-
restrict_checkout?: boolean;
|
|
3058
|
-
/**
|
|
3059
|
-
* - Last modified timestamp of cart.
|
|
3060
|
-
*/
|
|
3061
|
-
last_modified?: string;
|
|
3062
|
-
/**
|
|
3063
|
-
* - Cart id of the user cart.
|
|
3064
|
-
*/
|
|
3065
|
-
cart_id?: number;
|
|
3066
|
-
/**
|
|
3067
|
-
* - Cart validity flag determines the if the
|
|
3068
|
-
* response is valid or not.
|
|
3069
|
-
*/
|
|
3070
|
-
is_valid?: boolean;
|
|
3071
|
-
breakup_values?: CartBreakup;
|
|
3072
|
-
currency?: CartCurrency;
|
|
3073
|
-
/**
|
|
3074
|
-
* - Cart id of the user cart.
|
|
3075
|
-
*/
|
|
3076
|
-
id?: string;
|
|
3077
|
-
/**
|
|
3078
|
-
* - List of Shipments which includes
|
|
3079
|
-
* shipment data like shipment items, shipment promise, Shipment type,
|
|
3080
|
-
* shipment order type, shipment dp options etc.
|
|
3081
|
-
*/
|
|
3082
|
-
shipments?: ShipmentResponse[];
|
|
3083
|
-
payment_selection_lock?: PaymentSelectionLock;
|
|
3084
|
-
/**
|
|
3085
|
-
* - Coupon text of coupon applied on cart.
|
|
3086
|
-
*/
|
|
3087
|
-
coupon_text?: string;
|
|
3088
|
-
delivery_promise?: ShipmentPromise;
|
|
3089
|
-
/**
|
|
3090
|
-
* - Error details if any error occurs which
|
|
3091
|
-
* includes type of error, error code and error message.
|
|
3092
|
-
*/
|
|
3093
|
-
error?: boolean;
|
|
3094
|
-
/**
|
|
3095
|
-
* - Comment message added in cart.
|
|
3096
|
-
*/
|
|
3097
|
-
comment?: string;
|
|
3098
|
-
/**
|
|
3099
|
-
* - Buy now flag of user cart.
|
|
3100
|
-
*/
|
|
3101
|
-
buy_now?: boolean;
|
|
3102
|
-
/**
|
|
3103
|
-
* - Cart id of the user cart.
|
|
3104
|
-
*/
|
|
3105
|
-
uid?: string;
|
|
3106
|
-
/**
|
|
3107
|
-
* - Custom meta details added cart
|
|
3108
|
-
* checkout API payload.
|
|
3109
|
-
*/
|
|
3110
|
-
custom_cart_meta?: any;
|
|
3111
|
-
};
|
|
3112
|
-
/** @returns {CustomerDetails} */
|
|
3113
|
-
declare function CustomerDetails(): CustomerDetails;
|
|
3114
|
-
type CustomerDetails = {
|
|
3115
|
-
/**
|
|
3116
|
-
* - Email address of the customer to be added in
|
|
3117
|
-
* customer detail while checkout.
|
|
3118
|
-
*/
|
|
3119
|
-
email?: string;
|
|
3120
|
-
/**
|
|
3121
|
-
* - Mobile number of customer to be added in customer
|
|
3122
|
-
* detail while checkout.
|
|
3123
|
-
*/
|
|
3124
|
-
mobile: string;
|
|
3125
|
-
/**
|
|
3126
|
-
* - Name of customer to be added in customer detail
|
|
3127
|
-
* while checkout.
|
|
3128
|
-
*/
|
|
3129
|
-
name?: string;
|
|
3130
|
-
};
|
|
3131
|
-
/** @returns {StaffCheckout} */
|
|
3132
|
-
declare function StaffCheckout(): StaffCheckout;
|
|
3133
|
-
type StaffCheckout = {
|
|
3134
|
-
/**
|
|
3135
|
-
* - Employee code of staff who does checkout
|
|
3136
|
-
* on behalf of customer.
|
|
3137
|
-
*/
|
|
3138
|
-
employee_code?: string;
|
|
3139
|
-
/**
|
|
3140
|
-
* - User id of the employee who does checkout on behalf
|
|
3141
|
-
* of customer.
|
|
3142
|
-
*/
|
|
3143
|
-
user: string;
|
|
3144
|
-
/**
|
|
3145
|
-
* - Last name of staff employee who does checkout
|
|
3146
|
-
* on behalf of customer.
|
|
3147
|
-
*/
|
|
3148
|
-
last_name: string;
|
|
3149
|
-
/**
|
|
3150
|
-
* - First name of staff emplyee who does checkout
|
|
3151
|
-
* on behalf of customer.
|
|
3152
|
-
*/
|
|
3153
|
-
first_name: string;
|
|
3154
|
-
/**
|
|
3155
|
-
* - Id of staff who does checkout on behalf of customer.
|
|
3156
|
-
*/
|
|
3157
|
-
_id: string;
|
|
3158
|
-
};
|
|
3159
|
-
/** @returns {CheckCart} */
|
|
3160
|
-
declare function CheckCart(): CheckCart;
|
|
3161
|
-
type CheckCart = {
|
|
3162
|
-
/**
|
|
3163
|
-
* - Checkout mode of user cart.
|
|
3164
|
-
*/
|
|
3165
|
-
checkout_mode?: string;
|
|
3166
|
-
/**
|
|
3167
|
-
* - User type of the cart who places the order.
|
|
3168
|
-
*/
|
|
3169
|
-
user_type?: string;
|
|
3170
|
-
/**
|
|
3171
|
-
* - Cash On Delivery message for the order placed.
|
|
3172
|
-
*/
|
|
3173
|
-
cod_message?: string;
|
|
3174
|
-
/**
|
|
3175
|
-
* - Cart id of the user cart for which the order placed.
|
|
3176
|
-
*/
|
|
3177
|
-
cart_id?: number;
|
|
3178
|
-
/**
|
|
3179
|
-
* - Valid flag fotr the checkout response if
|
|
3180
|
-
* order placed was valid.
|
|
3181
|
-
*/
|
|
3182
|
-
is_valid?: boolean;
|
|
3183
|
-
/**
|
|
3184
|
-
* - Delivery charges of the order placed
|
|
3185
|
-
* via checkout API.
|
|
3186
|
-
*/
|
|
3187
|
-
delivery_charges?: number;
|
|
3188
|
-
/**
|
|
3189
|
-
* - Cart id of the user cart.
|
|
3190
|
-
*/
|
|
3191
|
-
id?: string;
|
|
3192
|
-
payment_selection_lock?: PaymentSelectionLock;
|
|
3193
|
-
/**
|
|
3194
|
-
* - Error details if any error occurs which
|
|
3195
|
-
* includes type of error, error code and error message.
|
|
3196
|
-
*/
|
|
3197
|
-
error_message?: string;
|
|
3198
|
-
delivery_promise?: ShipmentPromise;
|
|
3199
|
-
/**
|
|
3200
|
-
* - Comment message added in cart after order placed.
|
|
3201
|
-
*/
|
|
3202
|
-
comment?: string;
|
|
3203
|
-
/**
|
|
3204
|
-
* - Items details in cart after order placed.
|
|
3205
|
-
*/
|
|
3206
|
-
items?: CartProductInfo[];
|
|
3207
|
-
/**
|
|
3208
|
-
* - Cart id of user cart.
|
|
3209
|
-
*/
|
|
3210
|
-
uid?: string;
|
|
3211
|
-
/**
|
|
3212
|
-
* - Delivery charge order value.
|
|
3213
|
-
*/
|
|
3214
|
-
delivery_charge_order_value?: number;
|
|
3215
|
-
/**
|
|
3216
|
-
* - Delivery charge in information
|
|
3217
|
-
* message on shipment.
|
|
3218
|
-
*/
|
|
3219
|
-
delivery_charge_info?: string;
|
|
3220
|
-
/**
|
|
3221
|
-
* - Whether Cash On Delivery available.
|
|
3222
|
-
*/
|
|
3223
|
-
cod_available?: boolean;
|
|
3224
|
-
/**
|
|
3225
|
-
* - Success flag of checkout cart API response.
|
|
3226
|
-
*/
|
|
3227
|
-
success?: boolean;
|
|
3228
|
-
/**
|
|
3229
|
-
* - Store code from which the order placed.
|
|
3230
|
-
*/
|
|
3231
|
-
store_code?: string;
|
|
3232
|
-
/**
|
|
3233
|
-
* - Message of the cart checkout API response.
|
|
3234
|
-
*/
|
|
3235
|
-
message?: string;
|
|
3236
|
-
/**
|
|
3237
|
-
* - GSTIN number added in cart.
|
|
3238
|
-
*/
|
|
3239
|
-
gstin?: string;
|
|
3240
|
-
/**
|
|
3241
|
-
* - Restrict checkout flag to restrict
|
|
3242
|
-
* the checkout process.
|
|
3243
|
-
*/
|
|
3244
|
-
restrict_checkout?: boolean;
|
|
3245
|
-
/**
|
|
3246
|
-
* - Last modified timestamp of cart.
|
|
3247
|
-
*/
|
|
3248
|
-
last_modified?: string;
|
|
3249
|
-
/**
|
|
3250
|
-
* - Order id generated after placing order.
|
|
3251
|
-
*/
|
|
3252
|
-
order_id?: string;
|
|
3253
|
-
breakup_values?: CartBreakup;
|
|
3254
|
-
currency?: CartCurrency;
|
|
3255
|
-
/**
|
|
3256
|
-
* - Store employees data.
|
|
3257
|
-
*/
|
|
3258
|
-
store_emps?: any[];
|
|
3259
|
-
/**
|
|
3260
|
-
* - Coupon text of the applied coupon on order placed.
|
|
3261
|
-
*/
|
|
3262
|
-
coupon_text?: string;
|
|
3263
|
-
/**
|
|
3264
|
-
* - Buy now flag of user cart.
|
|
3265
|
-
*/
|
|
3266
|
-
buy_now?: boolean;
|
|
3267
|
-
/**
|
|
3268
|
-
* - Cash On Delivery charges of the user cart.
|
|
3269
|
-
*/
|
|
3270
|
-
cod_charges?: number;
|
|
3271
|
-
/**
|
|
3272
|
-
* - Meta data for customCart of user.
|
|
3273
|
-
*/
|
|
3274
|
-
custom_cart_meta?: any;
|
|
3275
|
-
};
|
|
3276
|
-
/** @returns {CartCheckoutResponse} */
|
|
3277
|
-
declare function CartCheckoutResponse(): CartCheckoutResponse;
|
|
3278
|
-
type CartCheckoutResponse = {
|
|
3279
|
-
/**
|
|
3280
|
-
* - Payment confirm url used to
|
|
3281
|
-
* redirect after payment is confirmed.
|
|
3282
|
-
*/
|
|
3283
|
-
payment_confirm_url?: string;
|
|
3284
|
-
/**
|
|
3285
|
-
* - App intercept url which is used to
|
|
3286
|
-
* redirect on app after payment in confirmed/failed.
|
|
3287
|
-
*/
|
|
3288
|
-
app_intercept_url?: string;
|
|
3289
|
-
/**
|
|
3290
|
-
* - Success flag of cart checkout API response.
|
|
3291
|
-
*/
|
|
3292
|
-
success?: boolean;
|
|
3293
|
-
/**
|
|
3294
|
-
* - Callback url to be redirected after
|
|
3295
|
-
* payment received/failed.
|
|
3296
|
-
*/
|
|
3297
|
-
callback_url?: string;
|
|
3298
|
-
/**
|
|
3299
|
-
* - Message of the cart checkout v2 API response.
|
|
3300
|
-
*/
|
|
3301
|
-
message?: string;
|
|
3302
|
-
/**
|
|
3303
|
-
* - Data of the user cart checkout includes cart
|
|
3304
|
-
* data, address, user id, order type etc.
|
|
3305
|
-
*/
|
|
3306
|
-
data?: any;
|
|
3307
|
-
/**
|
|
3308
|
-
* - Order id generated after placing order.
|
|
3309
|
-
*/
|
|
3310
|
-
order_id?: string;
|
|
3311
|
-
cart?: CheckCart;
|
|
3312
|
-
};
|
|
3313
|
-
/** @returns {GiftDetail} */
|
|
3314
|
-
declare function GiftDetail(): GiftDetail;
|
|
3315
|
-
type GiftDetail = {
|
|
3316
|
-
/**
|
|
3317
|
-
* - Is gift applied flag which determines
|
|
3318
|
-
* if this is a gift oder not.
|
|
3319
|
-
*/
|
|
3320
|
-
is_gift_applied?: boolean;
|
|
3321
|
-
/**
|
|
3322
|
-
* - Gift message for the one while receive
|
|
3323
|
-
* the delivery of the order with this message.
|
|
3324
|
-
*/
|
|
3325
|
-
gift_message?: string;
|
|
3326
|
-
};
|
|
3327
|
-
/** @returns {ArticleGiftDetail} */
|
|
3328
|
-
declare function ArticleGiftDetail(): ArticleGiftDetail;
|
|
3329
|
-
type ArticleGiftDetail = {
|
|
3330
|
-
article_id?: GiftDetail;
|
|
3331
|
-
};
|
|
3332
|
-
/** @returns {CartMetaRequest} */
|
|
3333
|
-
declare function CartMetaRequest(): CartMetaRequest;
|
|
3334
|
-
type CartMetaRequest = {
|
|
3335
|
-
/**
|
|
3336
|
-
* - Delivery slots details includes article
|
|
3337
|
-
* level time slot when the shipment can be delivered.
|
|
3338
|
-
*/
|
|
3339
|
-
delivery_slots?: any;
|
|
3340
|
-
gift_details?: ArticleGiftDetail;
|
|
3341
|
-
/**
|
|
3342
|
-
* - Customer contact details for
|
|
3343
|
-
* customer pickup at store.
|
|
3344
|
-
*/
|
|
3345
|
-
pick_up_customer_details?: any;
|
|
3346
|
-
/**
|
|
3347
|
-
* - Checkout mode of user cart.
|
|
3348
|
-
*/
|
|
3349
|
-
checkout_mode?: string;
|
|
3350
|
-
/**
|
|
3351
|
-
* - Comment message to be added in user cart.
|
|
3352
|
-
*/
|
|
3353
|
-
comment?: string;
|
|
3354
|
-
/**
|
|
3355
|
-
* - GSTIN number to be added in user cart.
|
|
3356
|
-
*/
|
|
3357
|
-
gstin?: string;
|
|
3358
|
-
/**
|
|
3359
|
-
* - Custom cart meta json to be added in
|
|
3360
|
-
* order meta which can be further received in cart API response and order
|
|
3361
|
-
* meta in order detail API or webhook.
|
|
3362
|
-
*/
|
|
3363
|
-
custom_cart_meta?: any;
|
|
3364
|
-
};
|
|
3365
|
-
/** @returns {CartMetaResponse} */
|
|
3366
|
-
declare function CartMetaResponse(): CartMetaResponse;
|
|
3367
|
-
type CartMetaResponse = {
|
|
3368
|
-
/**
|
|
3369
|
-
* - Detailed message.
|
|
3370
|
-
*/
|
|
3371
|
-
message?: string;
|
|
3372
|
-
/**
|
|
3373
|
-
* - Whether added meta was vaild.
|
|
3374
|
-
*/
|
|
3375
|
-
is_valid?: boolean;
|
|
3376
|
-
};
|
|
3377
|
-
/** @returns {CartMetaMissingResponse} */
|
|
3378
|
-
declare function CartMetaMissingResponse(): CartMetaMissingResponse;
|
|
3379
|
-
type CartMetaMissingResponse = {
|
|
3380
|
-
/**
|
|
3381
|
-
* - Detailed errors for invalid cart meta request.
|
|
3382
|
-
*/
|
|
3383
|
-
errors?: string[];
|
|
3384
|
-
};
|
|
3385
|
-
/** @returns {GetShareCartLinkRequest} */
|
|
3386
|
-
declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
|
|
3387
|
-
type GetShareCartLinkRequest = {
|
|
3388
|
-
/**
|
|
3389
|
-
* - Cart id of user cart for generating cart sharing token.
|
|
3390
|
-
*/
|
|
3391
|
-
id?: string;
|
|
3392
|
-
/**
|
|
3393
|
-
* - Staff, Ordering store or any other data. This
|
|
3394
|
-
* data will be used to generate link as well as sent as shared details.
|
|
3395
|
-
*/
|
|
3396
|
-
meta?: any;
|
|
3397
|
-
};
|
|
3398
|
-
/** @returns {GetShareCartLinkResponse} */
|
|
3399
|
-
declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
|
|
3400
|
-
type GetShareCartLinkResponse = {
|
|
3401
|
-
/**
|
|
3402
|
-
* - Short url unique id of the cart which is opted
|
|
3403
|
-
* to share with other user.
|
|
3404
|
-
*/
|
|
3405
|
-
token?: string;
|
|
3406
|
-
/**
|
|
3407
|
-
* - Short shareable final url which can populate
|
|
3408
|
-
* shared cart items in one's cart or replaced one's cart with shared cart items.
|
|
3409
|
-
*/
|
|
3410
|
-
share_url?: string;
|
|
3411
|
-
};
|
|
3412
|
-
/** @returns {SharedCartDetails} */
|
|
3413
|
-
declare function SharedCartDetails(): SharedCartDetails;
|
|
3414
|
-
type SharedCartDetails = {
|
|
3415
|
-
/**
|
|
3416
|
-
* - Short link id of the user cart that needs to be shared.
|
|
3417
|
-
*/
|
|
3418
|
-
token?: string;
|
|
3419
|
-
/**
|
|
3420
|
-
* - User details of who generated share link.
|
|
3421
|
-
*/
|
|
3422
|
-
user?: any;
|
|
3423
|
-
/**
|
|
3424
|
-
* - Created on timestamp of user cart.
|
|
3425
|
-
*/
|
|
3426
|
-
created_on?: string;
|
|
3427
|
-
/**
|
|
3428
|
-
* - Share link device and other source information.
|
|
3429
|
-
*/
|
|
3430
|
-
source?: any;
|
|
3431
|
-
/**
|
|
3432
|
-
* - Meta data sent while generating share cart link.
|
|
3433
|
-
*/
|
|
3434
|
-
meta?: any;
|
|
3435
|
-
};
|
|
3436
|
-
/** @returns {SharedCart} */
|
|
3437
|
-
declare function SharedCart(): SharedCart;
|
|
3438
|
-
type SharedCart = {
|
|
3439
|
-
/**
|
|
3440
|
-
* - Checkout mode of address on which
|
|
3441
|
-
* address to be used for which checkout mode of cart.
|
|
3442
|
-
*/
|
|
3443
|
-
checkout_mode?: string;
|
|
3444
|
-
/**
|
|
3445
|
-
* - Cart id of user cart for generating cart sharing token.
|
|
3446
|
-
*/
|
|
3447
|
-
cart_id?: number;
|
|
3448
|
-
/**
|
|
3449
|
-
* - Valid flag for get shared cart detail API.
|
|
3450
|
-
*/
|
|
3451
|
-
is_valid?: boolean;
|
|
3452
|
-
/**
|
|
3453
|
-
* - Cart id of shared cart.
|
|
3454
|
-
*/
|
|
3455
|
-
id?: string;
|
|
3456
|
-
payment_selection_lock?: PaymentSelectionLock;
|
|
3457
|
-
delivery_promise?: ShipmentPromise;
|
|
3458
|
-
/**
|
|
3459
|
-
* - Comment message added in user cart.
|
|
3460
|
-
*/
|
|
3461
|
-
comment?: string;
|
|
3462
|
-
/**
|
|
3463
|
-
* - Items data list in user cart that
|
|
3464
|
-
* includes item id, item size, store id, available sizes and rest of the item
|
|
3465
|
-
* related data.
|
|
3466
|
-
*/
|
|
3467
|
-
items?: CartProductInfo[];
|
|
3468
|
-
/**
|
|
3469
|
-
* - Cart id of the user cart.
|
|
3470
|
-
*/
|
|
3471
|
-
uid?: string;
|
|
3472
|
-
/**
|
|
3473
|
-
* - Delivery charge info message of
|
|
3474
|
-
* the user cart.
|
|
3475
|
-
*/
|
|
3476
|
-
delivery_charge_info?: string;
|
|
3477
|
-
/**
|
|
3478
|
-
* - Message of the get shared cart API response.
|
|
3479
|
-
*/
|
|
3480
|
-
message?: string;
|
|
3481
|
-
/**
|
|
3482
|
-
* - GSTIN added in user cart.
|
|
3483
|
-
*/
|
|
3484
|
-
gstin?: string;
|
|
3485
|
-
shared_cart_details?: SharedCartDetails;
|
|
3486
|
-
/**
|
|
3487
|
-
* - Restrict checkout flag to restrict
|
|
3488
|
-
* the checkout process.
|
|
3489
|
-
*/
|
|
3490
|
-
restrict_checkout?: boolean;
|
|
3491
|
-
/**
|
|
3492
|
-
* - Last modified timestamp of user cart.
|
|
3493
|
-
*/
|
|
3494
|
-
last_modified?: string;
|
|
3495
|
-
breakup_values?: CartBreakup;
|
|
3496
|
-
currency?: CartCurrency;
|
|
3497
|
-
/**
|
|
3498
|
-
* - Coupon text of the applied coupon on user cart.
|
|
3499
|
-
*/
|
|
3500
|
-
coupon_text?: string;
|
|
3501
|
-
/**
|
|
3502
|
-
* - Buy now flag of user cart.
|
|
3503
|
-
*/
|
|
3504
|
-
buy_now?: boolean;
|
|
3505
|
-
/**
|
|
3506
|
-
* - Custom cart meta of user cart added
|
|
3507
|
-
* via update cart meta API.
|
|
3508
|
-
*/
|
|
3509
|
-
custom_cart_meta?: any;
|
|
3510
|
-
};
|
|
3511
|
-
/** @returns {SharedCartResponse} */
|
|
3512
|
-
declare function SharedCartResponse(): SharedCartResponse;
|
|
3513
|
-
type SharedCartResponse = {
|
|
3514
|
-
/**
|
|
3515
|
-
* - Error details if any error occurs which includes
|
|
3516
|
-
* type of error, error code and error message.
|
|
3517
|
-
*/
|
|
3518
|
-
error?: string;
|
|
3519
|
-
cart?: SharedCart;
|
|
3520
|
-
};
|
|
3521
|
-
/** @returns {PriceMinMax} */
|
|
3522
|
-
declare function PriceMinMax(): PriceMinMax;
|
|
3523
|
-
type PriceMinMax = {
|
|
3524
|
-
/**
|
|
3525
|
-
* - Min price of article added in user cart.
|
|
3526
|
-
*/
|
|
3527
|
-
min?: number;
|
|
3528
|
-
/**
|
|
3529
|
-
* - Max price of article added in user cart.
|
|
3530
|
-
*/
|
|
3531
|
-
max?: number;
|
|
3532
|
-
};
|
|
3533
|
-
/** @returns {ItemPriceDetails} */
|
|
3534
|
-
declare function ItemPriceDetails(): ItemPriceDetails;
|
|
3535
|
-
type ItemPriceDetails = {
|
|
3536
|
-
marked?: PriceMinMax;
|
|
3537
|
-
effective?: PriceMinMax;
|
|
3538
|
-
/**
|
|
3539
|
-
* - Currency of the article added in cart.
|
|
3540
|
-
*/
|
|
3541
|
-
currency?: string;
|
|
3542
|
-
};
|
|
3543
|
-
/** @returns {FreeGiftItems} */
|
|
3544
|
-
declare function FreeGiftItems(): FreeGiftItems;
|
|
3545
|
-
type FreeGiftItems = {
|
|
3546
|
-
/**
|
|
3547
|
-
* - Slug for an item.
|
|
3548
|
-
*/
|
|
3549
|
-
item_slug?: string;
|
|
3550
|
-
/**
|
|
3551
|
-
* - Name of the free gift item received via free
|
|
3552
|
-
* gift promotion.
|
|
3553
|
-
*/
|
|
3554
|
-
item_name?: string;
|
|
3555
|
-
item_price_details?: ItemPriceDetails;
|
|
3556
|
-
/**
|
|
3557
|
-
* - Item brand name of the free gift item
|
|
3558
|
-
* promotion applied on cart.
|
|
3559
|
-
*/
|
|
3560
|
-
item_brand_name?: string;
|
|
3561
|
-
/**
|
|
3562
|
-
* - Item id of the free gift item.
|
|
3563
|
-
*/
|
|
3564
|
-
item_id?: number;
|
|
3565
|
-
/**
|
|
3566
|
-
* - Images URLs for free gift items.
|
|
3567
|
-
*/
|
|
3568
|
-
item_images_url?: string[];
|
|
3569
|
-
};
|
|
3570
|
-
/** @returns {PromotionOffer} */
|
|
3571
|
-
declare function PromotionOffer(): PromotionOffer;
|
|
3572
|
-
type PromotionOffer = {
|
|
3573
|
-
/**
|
|
3574
|
-
* - Promotion id of the promotion which is available on product.
|
|
3575
|
-
*/
|
|
3576
|
-
id?: string;
|
|
3577
|
-
/**
|
|
3578
|
-
* - Buy rules of promotion which is available on product.
|
|
3579
|
-
*/
|
|
3580
|
-
buy_rules?: any;
|
|
3581
|
-
/**
|
|
3582
|
-
* - Offer title of the promotion which is
|
|
3583
|
-
* available on product.
|
|
3584
|
-
*/
|
|
3585
|
-
offer_text?: string;
|
|
3586
|
-
/**
|
|
3587
|
-
* - Promotion type of the promotion which
|
|
3588
|
-
* is availalbe on product.
|
|
3589
|
-
*/
|
|
3590
|
-
promotion_type?: string;
|
|
3591
|
-
/**
|
|
3592
|
-
* - Name of the promotion which is
|
|
3593
|
-
* available on product.
|
|
3594
|
-
*/
|
|
3595
|
-
promotion_name?: string;
|
|
3596
|
-
/**
|
|
3597
|
-
* - Group of the promotion which is
|
|
3598
|
-
* available on product.
|
|
3599
|
-
*/
|
|
3600
|
-
promotion_group?: string;
|
|
3601
|
-
/**
|
|
3602
|
-
* - Datetime ISO String for promotion end date
|
|
3603
|
-
* which is available on product.
|
|
3604
|
-
*/
|
|
3605
|
-
valid_till?: string;
|
|
3606
|
-
/**
|
|
3607
|
-
* - Discount rules of promotions which is
|
|
3608
|
-
* avaiable on product.
|
|
3609
|
-
*/
|
|
3610
|
-
discount_rules?: any[];
|
|
3611
|
-
/**
|
|
3612
|
-
* - Details of free gift items
|
|
3613
|
-
* which included item id, brand name, item name, item slug, item price and
|
|
3614
|
-
* item image url.
|
|
3615
|
-
*/
|
|
3616
|
-
free_gift_items?: FreeGiftItems[];
|
|
3617
|
-
/**
|
|
3618
|
-
* - Offer details including T&C of the
|
|
3619
|
-
* promotion which is avaiable on product.
|
|
3620
|
-
*/
|
|
3621
|
-
description?: string;
|
|
3622
|
-
};
|
|
3623
|
-
/** @returns {PromotionOffersResponse} */
|
|
3624
|
-
declare function PromotionOffersResponse(): PromotionOffersResponse;
|
|
3625
|
-
type PromotionOffersResponse = {
|
|
3626
|
-
/**
|
|
3627
|
-
* - Available promotion
|
|
3628
|
-
* details which are available on product which includes promotion data like
|
|
3629
|
-
* promotion id, promotion name, buy rules, discount rules validity dates etc.
|
|
3630
|
-
*/
|
|
3631
|
-
available_promotions?: PromotionOffer[];
|
|
3632
|
-
};
|
|
3633
|
-
/** @returns {PromotionPaymentOffer} */
|
|
3634
|
-
declare function PromotionPaymentOffer(): PromotionPaymentOffer;
|
|
3635
|
-
type PromotionPaymentOffer = {
|
|
3636
|
-
/**
|
|
3637
|
-
* - Application id on which the promotion
|
|
3638
|
-
* was created.
|
|
3639
|
-
*/
|
|
3640
|
-
application_id?: string;
|
|
3641
|
-
/**
|
|
3642
|
-
* - Buy rules of promotions which denotes if
|
|
3643
|
-
* the rules matches than only promotion is applicable.
|
|
3644
|
-
*/
|
|
3645
|
-
buy_rules?: any[];
|
|
3646
|
-
/**
|
|
3647
|
-
* - Article Price on which promotion
|
|
3648
|
-
* calculated like effective price or marked price.
|
|
3649
|
-
*/
|
|
3650
|
-
calculate_on?: string;
|
|
3651
|
-
/**
|
|
3652
|
-
* - Offer details including T&C of the
|
|
3653
|
-
* promotion which is avaiable on cart.
|
|
3654
|
-
*/
|
|
3655
|
-
description?: string;
|
|
3656
|
-
/**
|
|
3657
|
-
* - Discount rules of promotions which is
|
|
3658
|
-
* avaiable on cart.
|
|
3659
|
-
*/
|
|
3660
|
-
discount_rules?: any[];
|
|
3661
|
-
/**
|
|
3662
|
-
* - Promotion id of the promotion which is available on cart.
|
|
3663
|
-
*/
|
|
3664
|
-
id?: string;
|
|
3665
|
-
/**
|
|
3666
|
-
* - Offer title of the promotion which is
|
|
3667
|
-
* available on cart.
|
|
3668
|
-
*/
|
|
3669
|
-
offer_text?: string;
|
|
3670
|
-
/**
|
|
3671
|
-
* - Group promotion which is available on cart.
|
|
3672
|
-
*/
|
|
3673
|
-
promotion_group?: string;
|
|
3674
|
-
/**
|
|
3675
|
-
* - Promotion type of the promotion which
|
|
3676
|
-
* is availalbe on cart.
|
|
3677
|
-
*/
|
|
3678
|
-
promotion_type?: string;
|
|
3679
|
-
/**
|
|
3680
|
-
* - Name of the promotion which is available on cart.
|
|
3681
|
-
*/
|
|
3682
|
-
promotion_name?: string;
|
|
3683
|
-
};
|
|
3684
|
-
/** @returns {PromotionPaymentOffersResponse} */
|
|
3685
|
-
declare function PromotionPaymentOffersResponse(): PromotionPaymentOffersResponse;
|
|
3686
|
-
type PromotionPaymentOffersResponse = {
|
|
3687
|
-
/**
|
|
3688
|
-
* - Success flag of get payment offers API response.
|
|
3689
|
-
*/
|
|
3690
|
-
success?: boolean;
|
|
3691
|
-
/**
|
|
3692
|
-
* - List of promotions data
|
|
3693
|
-
* which are applicable on cart/product.
|
|
3694
|
-
*/
|
|
3695
|
-
promotions?: PromotionPaymentOffer[];
|
|
3696
|
-
};
|
|
3697
|
-
/** @returns {OperationErrorResponse} */
|
|
3698
|
-
declare function OperationErrorResponse(): OperationErrorResponse;
|
|
3699
|
-
type OperationErrorResponse = {
|
|
3700
|
-
/**
|
|
3701
|
-
* - Message of get payment offer API response.
|
|
3702
|
-
*/
|
|
3703
|
-
message?: string;
|
|
3704
|
-
/**
|
|
3705
|
-
* - Success flag of get payment offer API response.
|
|
3706
|
-
*/
|
|
3707
|
-
success?: boolean;
|
|
3708
|
-
};
|
|
3709
|
-
/** @returns {LadderPrice} */
|
|
3710
|
-
declare function LadderPrice(): LadderPrice;
|
|
3711
|
-
type LadderPrice = {
|
|
3712
|
-
/**
|
|
3713
|
-
* - Currency symbol for currency of ladder
|
|
3714
|
-
* price product.
|
|
3715
|
-
*/
|
|
3716
|
-
currency_symbol?: string;
|
|
3717
|
-
/**
|
|
3718
|
-
* - Discounted per unit price for current offer object.
|
|
3719
|
-
*/
|
|
3720
|
-
offer_price?: number;
|
|
3721
|
-
/**
|
|
3722
|
-
* - Currency code for all amounts.
|
|
3723
|
-
*/
|
|
3724
|
-
currency_code?: string;
|
|
3725
|
-
/**
|
|
3726
|
-
* - Current per unit price of product after
|
|
3727
|
-
* existing deductions.
|
|
3728
|
-
*/
|
|
3729
|
-
effective?: number;
|
|
3730
|
-
/**
|
|
3731
|
-
* - Original price of product.
|
|
3732
|
-
*/
|
|
3733
|
-
marked?: number;
|
|
3734
|
-
};
|
|
3735
|
-
/** @returns {LadderOfferItem} */
|
|
3736
|
-
declare function LadderOfferItem(): LadderOfferItem;
|
|
3737
|
-
type LadderOfferItem = {
|
|
3738
|
-
price?: LadderPrice;
|
|
3739
|
-
/**
|
|
3740
|
-
* - Percentage value of discount.
|
|
3741
|
-
*/
|
|
3742
|
-
margin?: number;
|
|
3743
|
-
/**
|
|
3744
|
-
* - Minimum quantity upto which offer is
|
|
3745
|
-
* applicable. If not present that offer is applicable on all quantities.
|
|
3746
|
-
*/
|
|
3747
|
-
max_quantity?: number;
|
|
3748
|
-
/**
|
|
3749
|
-
* - Minimum quantity from which offer is applicable.
|
|
3750
|
-
*/
|
|
3751
|
-
min_quantity?: number;
|
|
3752
|
-
/**
|
|
3753
|
-
* - Offer type of the ladder promotion.
|
|
3754
|
-
*/
|
|
3755
|
-
type?: string;
|
|
3756
|
-
};
|
|
3757
|
-
/** @returns {LadderPriceOffer} */
|
|
3758
|
-
declare function LadderPriceOffer(): LadderPriceOffer;
|
|
3759
|
-
type LadderPriceOffer = {
|
|
3760
|
-
/**
|
|
3761
|
-
* - ID of the promotion.
|
|
3762
|
-
*/
|
|
3763
|
-
id?: string;
|
|
3764
|
-
/**
|
|
3765
|
-
* - Buy rules of ladder price promotion
|
|
3766
|
-
* applicable on product.
|
|
3767
|
-
*/
|
|
3768
|
-
buy_rules?: any;
|
|
3769
|
-
/**
|
|
3770
|
-
* - If this ladder offer is to be calculated
|
|
3771
|
-
* on MRP or ESP price.
|
|
3772
|
-
*/
|
|
3773
|
-
calculate_on?: string;
|
|
3774
|
-
/**
|
|
3775
|
-
* - Offer title of ladder price promotion
|
|
3776
|
-
* applicable on product.
|
|
3777
|
-
*/
|
|
3778
|
-
offer_text?: string;
|
|
3779
|
-
/**
|
|
3780
|
-
* - Group of ladder price promotion
|
|
3781
|
-
* applicable on product.
|
|
3782
|
-
*/
|
|
3783
|
-
promotion_group?: string;
|
|
3784
|
-
/**
|
|
3785
|
-
* - Datetime ISO String for promotion end date.
|
|
3786
|
-
*/
|
|
3787
|
-
valid_till?: string;
|
|
3788
|
-
/**
|
|
3789
|
-
* - Discount rules of ladder price
|
|
3790
|
-
* promotion applicable on product.
|
|
3791
|
-
*/
|
|
3792
|
-
discount_rules?: any[];
|
|
3793
|
-
/**
|
|
3794
|
-
* - Offer prices for ladder price
|
|
3795
|
-
* promotion applicable on product.
|
|
3796
|
-
*/
|
|
3797
|
-
offer_prices?: LadderOfferItem[];
|
|
3798
|
-
/**
|
|
3799
|
-
* - Details of free gift items list.
|
|
3800
|
-
*/
|
|
3801
|
-
free_gift_items?: FreeGiftItems[];
|
|
3802
|
-
/**
|
|
3803
|
-
* - Offer details including T&C of ladder
|
|
3804
|
-
* price promotion applicable on product.
|
|
3805
|
-
*/
|
|
3806
|
-
description?: string;
|
|
3807
|
-
};
|
|
3808
|
-
/** @returns {CurrencyInfo} */
|
|
3809
|
-
declare function CurrencyInfo(): CurrencyInfo;
|
|
3810
|
-
type CurrencyInfo = {
|
|
3811
|
-
/**
|
|
3812
|
-
* - Currency code of ladder price promotion.
|
|
3813
|
-
*/
|
|
3814
|
-
code?: string;
|
|
3815
|
-
/**
|
|
3816
|
-
* - Currency symbol for currency of ladder price product.
|
|
3817
|
-
*/
|
|
3818
|
-
symbol?: string;
|
|
3819
|
-
};
|
|
3820
|
-
/** @returns {LadderPriceOffers} */
|
|
3821
|
-
declare function LadderPriceOffers(): LadderPriceOffers;
|
|
3822
|
-
type LadderPriceOffers = {
|
|
3823
|
-
/**
|
|
3824
|
-
* - Available ladder
|
|
3825
|
-
* promotions offers list.
|
|
3826
|
-
*/
|
|
3827
|
-
available_offers?: LadderPriceOffer[];
|
|
3828
|
-
currency?: CurrencyInfo;
|
|
3829
|
-
};
|
|
3830
|
-
/** @returns {PaymentMeta} */
|
|
3831
|
-
declare function PaymentMeta(): PaymentMeta;
|
|
3832
|
-
type PaymentMeta = {
|
|
3833
|
-
/**
|
|
3834
|
-
* - Merchant code of the payment mode
|
|
3835
|
-
* selected to do the payment.
|
|
3836
|
-
*/
|
|
3837
|
-
merchant_code?: string;
|
|
3838
|
-
/**
|
|
3839
|
-
* - Type of card if payment mode is card to do the payment.
|
|
3840
|
-
*/
|
|
3841
|
-
type?: string;
|
|
3842
|
-
/**
|
|
3843
|
-
* - Payment gateway used to do the payment.
|
|
3844
|
-
*/
|
|
3845
|
-
payment_gateway?: string;
|
|
3846
|
-
/**
|
|
3847
|
-
* - Payment identifier of the payment
|
|
3848
|
-
* mode selected to do the payment.
|
|
3849
|
-
*/
|
|
3850
|
-
payment_identifier?: string;
|
|
3851
|
-
};
|
|
3852
|
-
/** @returns {PaymentMethod} */
|
|
3853
|
-
declare function PaymentMethod(): PaymentMethod;
|
|
3854
|
-
type PaymentMethod = {
|
|
3855
|
-
payment_meta: PaymentMeta;
|
|
3856
|
-
/**
|
|
3857
|
-
* - Payment mode of payment method used to make payment.
|
|
3858
|
-
*/
|
|
3859
|
-
mode: string;
|
|
3860
|
-
/**
|
|
3861
|
-
* - Payment name of payment method used to make payment.
|
|
3862
|
-
*/
|
|
3863
|
-
payment?: string;
|
|
3864
|
-
/**
|
|
3865
|
-
* - Amount of the payment mode to be paid.
|
|
3866
|
-
*/
|
|
3867
|
-
amount?: number;
|
|
3868
|
-
/**
|
|
3869
|
-
* - Name of the payment mode used to make payment.
|
|
3870
|
-
*/
|
|
3871
|
-
name?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* - Payment extra identifier for
|
|
3874
|
-
* the payment mode to do the payment.
|
|
3875
|
-
*/
|
|
3876
|
-
payment_extra_identifiers?: any;
|
|
3877
|
-
};
|
|
3878
|
-
/** @returns {CartCheckoutDetailV2Request} */
|
|
3879
|
-
declare function CartCheckoutDetailV2Request(): CartCheckoutDetailV2Request;
|
|
3880
|
-
type CartCheckoutDetailV2Request = {
|
|
3881
|
-
/**
|
|
3882
|
-
* - Custom meta data to be added in order.
|
|
3883
|
-
*/
|
|
3884
|
-
custom_meta?: any;
|
|
3885
|
-
/**
|
|
3886
|
-
* - Customer details to be added in order.
|
|
3887
|
-
*/
|
|
3888
|
-
customer_details?: any;
|
|
3889
|
-
/**
|
|
3890
|
-
* - Merchant code of the payment mode
|
|
3891
|
-
* selected to do the payment.
|
|
3892
|
-
*/
|
|
3893
|
-
merchant_code?: string;
|
|
3894
|
-
/**
|
|
3895
|
-
* - Cart id of the user cart.
|
|
3896
|
-
*/
|
|
3897
|
-
cart_id?: string;
|
|
3898
|
-
/**
|
|
3899
|
-
* - Cart id of the user cart.
|
|
3900
|
-
*/
|
|
3901
|
-
id?: string;
|
|
3902
|
-
/**
|
|
3903
|
-
* - Payment auto confirm flag if
|
|
3904
|
-
* payment need not to be collected from user.
|
|
3905
|
-
*/
|
|
3906
|
-
payment_auto_confirm?: boolean;
|
|
3907
|
-
/**
|
|
3908
|
-
* - Payment methods list used to
|
|
3909
|
-
* make the payment.
|
|
3910
|
-
*/
|
|
3911
|
-
payment_methods: PaymentMethod[];
|
|
3912
|
-
/**
|
|
3913
|
-
* - Payment mode of the payment selected to do
|
|
3914
|
-
* the payment.
|
|
3915
|
-
*/
|
|
3916
|
-
payment_mode: string;
|
|
3917
|
-
/**
|
|
3918
|
-
* - Aggregator of payment mode to do the payment.
|
|
3919
|
-
*/
|
|
3920
|
-
aggregator?: string;
|
|
3921
|
-
/**
|
|
3922
|
-
* - Address id of the user where the order to
|
|
3923
|
-
* be delivered.
|
|
3924
|
-
*/
|
|
3925
|
-
address_id?: string;
|
|
3926
|
-
/**
|
|
3927
|
-
* - Callback url after payment received/failed.
|
|
3928
|
-
*/
|
|
3929
|
-
callback_url?: string;
|
|
3930
|
-
/**
|
|
3931
|
-
* - Delivery address data which includes
|
|
3932
|
-
* customer address, customer phone, customer email, customer pincode,
|
|
3933
|
-
* customer landmark and customer name.
|
|
3934
|
-
*/
|
|
3935
|
-
delivery_address?: any;
|
|
3936
|
-
staff?: StaffCheckout;
|
|
3937
|
-
/**
|
|
3938
|
-
* - Order type of the order being placed like
|
|
3939
|
-
* pickAtStore or HomeDelivery.
|
|
3940
|
-
*/
|
|
3941
|
-
order_type?: string;
|
|
3942
|
-
/**
|
|
3943
|
-
* - Ordering store id of the store from
|
|
3944
|
-
* which the order is getting placed.
|
|
3945
|
-
*/
|
|
3946
|
-
ordering_store?: number;
|
|
3947
|
-
/**
|
|
3948
|
-
* - Extra meta to be added while checkout in order.
|
|
3949
|
-
*/
|
|
3950
|
-
extra_meta?: any;
|
|
3951
|
-
/**
|
|
3952
|
-
* - Payment identifier of the payment
|
|
3953
|
-
* mode selected to do the payment.
|
|
3954
|
-
*/
|
|
3955
|
-
payment_identifier?: string;
|
|
3956
|
-
/**
|
|
3957
|
-
* - Billing address json which includes
|
|
3958
|
-
* customer address, customer phone, customer email, customer pincode,
|
|
3959
|
-
* customer landmark and customer name.
|
|
3960
|
-
*/
|
|
3961
|
-
billing_address?: any;
|
|
3962
|
-
/**
|
|
3963
|
-
* - Payment params which includes payment
|
|
3964
|
-
* identifier and merchant code.
|
|
3965
|
-
*/
|
|
3966
|
-
payment_params?: any;
|
|
3967
|
-
/**
|
|
3968
|
-
* - Billing address id selected by user
|
|
3969
|
-
* on which shipment bill to be generated.
|
|
3970
|
-
*/
|
|
3971
|
-
billing_address_id?: string;
|
|
3972
|
-
/**
|
|
3973
|
-
* - Meta data sent while checkout v2.
|
|
3974
|
-
*/
|
|
3975
|
-
meta?: any;
|
|
3976
|
-
/**
|
|
3977
|
-
* - Issuer Identification Number' number of card if
|
|
3978
|
-
* payment mode is card to do the payment.
|
|
3979
|
-
*/
|
|
3980
|
-
iin?: string;
|
|
3981
|
-
/**
|
|
3982
|
-
* - Network of card if payment mode is card to do
|
|
3983
|
-
* the payment.
|
|
3984
|
-
*/
|
|
3985
|
-
network?: string;
|
|
3986
|
-
/**
|
|
3987
|
-
* - Type of cart if payment mode is card to do the payment.
|
|
3988
|
-
*/
|
|
3989
|
-
type?: string;
|
|
3990
|
-
/**
|
|
3991
|
-
* - Saved card id if payment mode is card to do the payment.
|
|
3992
|
-
*/
|
|
3993
|
-
card_id?: string;
|
|
3994
|
-
};
|