@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
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 +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -1,176 +1,3640 @@
|
|
|
1
|
-
export =
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
1
|
+
export = CartPlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef AbandonedCart
|
|
4
|
+
* @property {string} _id
|
|
5
|
+
* @property {string} [app_id]
|
|
6
|
+
* @property {Object[]} articles
|
|
7
|
+
* @property {number} [bulk_coupon_discount]
|
|
8
|
+
* @property {boolean} [buy_now]
|
|
9
|
+
* @property {number} [cart_value]
|
|
10
|
+
* @property {Object} cashback
|
|
11
|
+
* @property {string} [checkout_mode]
|
|
12
|
+
* @property {Object} [cod_charges]
|
|
13
|
+
* @property {string} [comment]
|
|
14
|
+
* @property {Object} [coupon]
|
|
15
|
+
* @property {string} created_on
|
|
16
|
+
* @property {Object} [delivery_charges]
|
|
17
|
+
* @property {number} [discount]
|
|
18
|
+
* @property {string} expire_at
|
|
19
|
+
* @property {number[]} [fc_index_map]
|
|
20
|
+
* @property {Object} [fynd_credits]
|
|
21
|
+
* @property {string} [gstin]
|
|
22
|
+
* @property {boolean} [is_active]
|
|
23
|
+
* @property {boolean} [is_archive]
|
|
24
|
+
* @property {boolean} is_default
|
|
25
|
+
* @property {string} last_modified
|
|
26
|
+
* @property {boolean} [merge_qty]
|
|
27
|
+
* @property {Object} [meta]
|
|
28
|
+
* @property {string} [order_id]
|
|
29
|
+
* @property {Object[]} [payment_methods]
|
|
30
|
+
* @property {string} [payment_mode]
|
|
31
|
+
* @property {Object} [payments]
|
|
32
|
+
* @property {Object} [pick_up_customer_details]
|
|
33
|
+
* @property {Object} [promotion]
|
|
34
|
+
* @property {Object[]} [shipments]
|
|
35
|
+
* @property {number} uid
|
|
36
|
+
* @property {string} user_id
|
|
37
|
+
*/
|
|
38
|
+
/**
|
|
39
|
+
* @typedef AbandonedCartResponse
|
|
40
|
+
* @property {AbandonedCart[]} [items]
|
|
41
|
+
* @property {string} [message] - Message of the response
|
|
42
|
+
* @property {Page} [page]
|
|
43
|
+
* @property {Object} [result]
|
|
44
|
+
* @property {boolean} [success] - The request success is defined
|
|
45
|
+
*/
|
|
46
|
+
/**
|
|
47
|
+
* @typedef ActionQuery
|
|
48
|
+
* @property {string[]} [product_slug] - Contains list of product slug
|
|
49
|
+
*/
|
|
50
|
+
/**
|
|
51
|
+
* @typedef ActivePromosResponse
|
|
52
|
+
* @property {string} [created_on] - Coupon creation date
|
|
53
|
+
* @property {string} [description] - The description of the offer in the form of an HTML
|
|
54
|
+
* @property {string} [entity_slug]
|
|
55
|
+
* @property {string} [entity_type] - Type of entity to be selected from :
|
|
56
|
+
* ['coupon', 'promotion']
|
|
57
|
+
* @property {string} [example] - Discount offers examples
|
|
58
|
+
* @property {boolean} [is_hidden] - If the promo is active or not
|
|
59
|
+
* @property {string} [modified_on] - Coupon modification date
|
|
60
|
+
* @property {string} [subtitle] - Small description of the current offer
|
|
61
|
+
* @property {string} [title] - Name of the promotion
|
|
62
|
+
* @property {string} [type] - Coupon type
|
|
63
|
+
*/
|
|
64
|
+
/**
|
|
65
|
+
* @typedef AddCartDetailResponse
|
|
66
|
+
* @property {CartDetailResponse} [cart]
|
|
67
|
+
* @property {string} [message]
|
|
68
|
+
* @property {boolean} [partial] - When adding multiple items check if all
|
|
69
|
+
* added. True if only few are added.
|
|
70
|
+
* @property {boolean} [success] - True if all items are added successfully.
|
|
71
|
+
* False if partially added or not added.
|
|
72
|
+
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef AddCartRequest
|
|
75
|
+
* @property {AddProductCart[]} [items]
|
|
76
|
+
* @property {boolean} [new_cart]
|
|
77
|
+
*/
|
|
78
|
+
/**
|
|
79
|
+
* @typedef AddProductCart
|
|
80
|
+
* @property {Object} [_custom_json]
|
|
81
|
+
* @property {Object} [article_assignment]
|
|
82
|
+
* @property {string} [article_id]
|
|
83
|
+
* @property {string} [display]
|
|
84
|
+
* @property {Object} [extra_meta]
|
|
85
|
+
* @property {number} [item_id]
|
|
86
|
+
* @property {string} [item_size]
|
|
87
|
+
* @property {Object} [meta]
|
|
88
|
+
* @property {Object[]} [parent_item_identifiers]
|
|
89
|
+
* @property {boolean} [pos]
|
|
90
|
+
* @property {string[]} [product_group_tags]
|
|
91
|
+
* @property {number} [quantity]
|
|
92
|
+
* @property {number} [seller_id]
|
|
93
|
+
* @property {number} [store_id]
|
|
94
|
+
*/
|
|
95
|
+
/**
|
|
96
|
+
* @typedef AppliedFreeArticles
|
|
97
|
+
* @property {string} [article_id] - Free article id
|
|
98
|
+
* @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
|
|
99
|
+
* @property {string} [parent_item_identifier] - Parent item identifier for free article
|
|
100
|
+
* @property {number} [quantity] - Free article quantity
|
|
101
|
+
*/
|
|
102
|
+
/**
|
|
103
|
+
* @typedef AppliedPromotion
|
|
104
|
+
* @property {number} [amount] - Per unit discount amount applied with current promotion
|
|
105
|
+
* @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
|
|
106
|
+
* article for free gift item promotions
|
|
107
|
+
* @property {number} [article_quantity] - Quantity of article on which
|
|
108
|
+
* promotion is applicable
|
|
109
|
+
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions
|
|
110
|
+
* @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
|
|
111
|
+
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
112
|
+
* product MRP or ESP
|
|
113
|
+
* @property {string} [offer_text] - Offer text of current promotion
|
|
114
|
+
* @property {Ownership2} [ownership] - Ownership of promotion
|
|
115
|
+
* @property {string} [promo_id] - Promotion id
|
|
116
|
+
* @property {string} [promotion_group] - Promotion group for the promotion
|
|
117
|
+
* @property {string} [promotion_name] - Promotion name of current promotion
|
|
118
|
+
* @property {string} [promotion_type] - Promotion type of current promotion
|
|
119
|
+
*/
|
|
120
|
+
/**
|
|
121
|
+
* @typedef ApplyCouponRequest
|
|
122
|
+
* @property {string} coupon_code - Coupon code to be applied
|
|
123
|
+
*/
|
|
124
|
+
/**
|
|
125
|
+
* @typedef Article
|
|
126
|
+
* @property {string} article_id
|
|
127
|
+
* @property {string} [code]
|
|
128
|
+
* @property {Object} [meta]
|
|
129
|
+
* @property {string} [type]
|
|
130
|
+
* @property {number} [value]
|
|
131
|
+
*/
|
|
132
|
+
/**
|
|
133
|
+
* @typedef ArticlePriceInfo
|
|
134
|
+
* @property {BasePrice} [base]
|
|
135
|
+
* @property {BasePrice} [converted]
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* @typedef BaseInfo
|
|
139
|
+
* @property {string} [name]
|
|
140
|
+
* @property {number} [uid]
|
|
141
|
+
*/
|
|
142
|
+
/**
|
|
143
|
+
* @typedef BasePrice
|
|
144
|
+
* @property {string} [currency_code]
|
|
145
|
+
* @property {string} [currency_symbol]
|
|
146
|
+
* @property {number} [effective]
|
|
147
|
+
* @property {number} [marked]
|
|
148
|
+
*/
|
|
149
|
+
/**
|
|
150
|
+
* @typedef BulkBundleRestriction
|
|
151
|
+
* @property {boolean} multi_store_allowed
|
|
152
|
+
*/
|
|
153
|
+
/**
|
|
154
|
+
* @typedef BuyRules
|
|
155
|
+
* @property {Object} [cart_conditions] - Cart conditions details for promotion
|
|
156
|
+
* @property {Object} [item_criteria] - Item criteria of promotion
|
|
157
|
+
*/
|
|
158
|
+
/**
|
|
159
|
+
* @typedef CartBreakup
|
|
160
|
+
* @property {CouponBreakup} [coupon]
|
|
161
|
+
* @property {DisplayBreakup[]} [display]
|
|
162
|
+
* @property {LoyaltyPoints} [loyalty_points]
|
|
163
|
+
* @property {RawBreakup} [raw]
|
|
164
|
+
*/
|
|
165
|
+
/**
|
|
166
|
+
* @typedef CartCheckoutResponse
|
|
167
|
+
* @property {string} [app_intercept_url]
|
|
168
|
+
* @property {string} [callback_url]
|
|
169
|
+
* @property {CheckCart} [cart]
|
|
170
|
+
* @property {Object} [data]
|
|
171
|
+
* @property {string} [message]
|
|
172
|
+
* @property {string} [order_id]
|
|
173
|
+
* @property {string} [payment_confirm_url]
|
|
174
|
+
* @property {boolean} [success]
|
|
175
|
+
*/
|
|
176
|
+
/**
|
|
177
|
+
* @typedef CartCurrency
|
|
178
|
+
* @property {string} [code] - Currency code defined by ISO 4217:2015
|
|
179
|
+
* @property {string} [symbol]
|
|
180
|
+
*/
|
|
181
|
+
/**
|
|
182
|
+
* @typedef CartDeliveryModesResponse
|
|
183
|
+
* @property {string[]} [available_modes] - Available delivery modes
|
|
184
|
+
* @property {number[]} [pickup_stores] - Store pick up available store uids
|
|
185
|
+
*/
|
|
186
|
+
/**
|
|
187
|
+
* @typedef CartDetailResponse
|
|
188
|
+
* @property {AppliedPromotion[]} [applied_promo_details]
|
|
189
|
+
* @property {CartBreakup} [breakup_values]
|
|
190
|
+
* @property {boolean} [buy_now]
|
|
191
|
+
* @property {string} [checkout_mode]
|
|
192
|
+
* @property {string} [comment]
|
|
193
|
+
* @property {string} [coupon_text]
|
|
194
|
+
* @property {CartCurrency} [currency]
|
|
195
|
+
* @property {string} [delivery_charge_info]
|
|
196
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
197
|
+
* @property {string} [gstin]
|
|
198
|
+
* @property {string} [id]
|
|
199
|
+
* @property {boolean} [is_valid]
|
|
200
|
+
* @property {CartProductInfo[]} [items]
|
|
201
|
+
* @property {string} [last_modified]
|
|
202
|
+
* @property {string} [message]
|
|
203
|
+
* @property {Object} [pan_config]
|
|
204
|
+
* @property {string} [pan_no]
|
|
205
|
+
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
206
|
+
* @property {boolean} [restrict_checkout]
|
|
207
|
+
*/
|
|
208
|
+
/**
|
|
209
|
+
* @typedef CartItem
|
|
210
|
+
* @property {string} product_id
|
|
211
|
+
* @property {number} [quantity]
|
|
212
|
+
* @property {string} size
|
|
213
|
+
*/
|
|
214
|
+
/**
|
|
215
|
+
* @typedef CartItemCountResponse
|
|
216
|
+
* @property {number} [user_cart_items_count] - Item count present in cart
|
|
217
|
+
*/
|
|
218
|
+
/**
|
|
219
|
+
* @typedef CartItemMeta
|
|
220
|
+
* @property {string} [group_id]
|
|
221
|
+
* @property {boolean} [primary_item]
|
|
222
|
+
*/
|
|
223
|
+
/**
|
|
224
|
+
* @typedef CartList
|
|
225
|
+
* @property {string} [cart_id]
|
|
226
|
+
* @property {number} [cart_value]
|
|
227
|
+
* @property {string} [created_on]
|
|
228
|
+
* @property {number} [item_counts]
|
|
229
|
+
* @property {Object} [pick_up_customer_details]
|
|
230
|
+
* @property {string} [user_id]
|
|
231
|
+
*/
|
|
232
|
+
/**
|
|
233
|
+
* @typedef CartMetaConfigAdd
|
|
234
|
+
* @property {boolean} [bulk_coupons]
|
|
235
|
+
* @property {DeliveryCharges} [delivery_charges]
|
|
236
|
+
* @property {boolean} [enabled]
|
|
237
|
+
* @property {string} [gift_display_text]
|
|
238
|
+
* @property {number} [gift_pricing]
|
|
239
|
+
* @property {number} [max_cart_items]
|
|
240
|
+
* @property {number} [min_cart_value]
|
|
241
|
+
* @property {boolean} [revenue_engine_coupon]
|
|
242
|
+
*/
|
|
243
|
+
/**
|
|
244
|
+
* @typedef CartMetaConfigUpdate
|
|
245
|
+
* @property {boolean} [bulk_coupons]
|
|
246
|
+
* @property {DeliveryCharges} [delivery_charges]
|
|
247
|
+
* @property {boolean} [enabled]
|
|
248
|
+
* @property {string} [gift_display_text]
|
|
249
|
+
* @property {number} [gift_pricing]
|
|
250
|
+
* @property {number} [max_cart_items]
|
|
251
|
+
* @property {number} [min_cart_value]
|
|
252
|
+
* @property {boolean} [revenue_engine_coupon]
|
|
253
|
+
*/
|
|
254
|
+
/**
|
|
255
|
+
* @typedef CartMetaMissingResponse
|
|
256
|
+
* @property {string[]} [errors]
|
|
257
|
+
*/
|
|
258
|
+
/**
|
|
259
|
+
* @typedef CartMetaResponse
|
|
260
|
+
* @property {boolean} [is_valid]
|
|
261
|
+
* @property {string} [message]
|
|
262
|
+
*/
|
|
263
|
+
/**
|
|
264
|
+
* @typedef CartProduct
|
|
265
|
+
* @property {Object} [_custom_json]
|
|
266
|
+
* @property {ProductAction} [action]
|
|
267
|
+
* @property {BaseInfo} [brand]
|
|
268
|
+
* @property {CategoryInfo[]} [categories]
|
|
269
|
+
* @property {ProductImage[]} [images]
|
|
270
|
+
* @property {string} [item_code]
|
|
271
|
+
* @property {string} [name]
|
|
272
|
+
* @property {string} [slug] - Unique product url name generated via product
|
|
273
|
+
* name and other meta data
|
|
274
|
+
* @property {string[]} [tags]
|
|
275
|
+
* @property {Tags} [teaser_tag]
|
|
276
|
+
* @property {string} [type]
|
|
277
|
+
* @property {number} [uid]
|
|
278
|
+
*/
|
|
279
|
+
/**
|
|
280
|
+
* @typedef CartProductIdentifer
|
|
281
|
+
* @property {string} [identifier] - Article idenfier generated by cart
|
|
282
|
+
*/
|
|
283
|
+
/**
|
|
284
|
+
* @typedef CartProductInfo
|
|
285
|
+
* @property {ProductArticle} [article]
|
|
286
|
+
* @property {ProductAvailability} [availability]
|
|
287
|
+
* @property {Object} [bulk_offer]
|
|
288
|
+
* @property {CouponDetails} [coupon]
|
|
289
|
+
* @property {string} [coupon_message]
|
|
290
|
+
* @property {Object} [custom_order]
|
|
291
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
292
|
+
* @property {string} [discount]
|
|
293
|
+
* @property {CartProductIdentifer} identifiers
|
|
294
|
+
* @property {boolean} [is_set]
|
|
295
|
+
* @property {string} [key]
|
|
296
|
+
* @property {string} [message]
|
|
297
|
+
* @property {Object} [moq]
|
|
298
|
+
* @property {Object} [parent_item_identifiers]
|
|
299
|
+
* @property {ProductPriceInfo} [price]
|
|
300
|
+
* @property {ProductPriceInfo} [price_per_unit]
|
|
301
|
+
* @property {CartProduct} [product]
|
|
302
|
+
* @property {PromoMeta} [promo_meta]
|
|
303
|
+
* @property {AppliedPromotion[]} [promotions_applied]
|
|
304
|
+
* @property {number} [quantity]
|
|
305
|
+
*/
|
|
306
|
+
/**
|
|
307
|
+
* @typedef CategoryInfo
|
|
308
|
+
* @property {string} [name]
|
|
309
|
+
* @property {number} [uid] - Product Category Id
|
|
310
|
+
*/
|
|
311
|
+
/**
|
|
312
|
+
* @typedef Charges
|
|
313
|
+
* @property {number} [charges]
|
|
314
|
+
* @property {number} [threshold]
|
|
315
|
+
*/
|
|
316
|
+
/**
|
|
317
|
+
* @typedef CheckCart
|
|
318
|
+
* @property {CartBreakup} [breakup_values]
|
|
319
|
+
* @property {boolean} [buy_now]
|
|
320
|
+
* @property {number} [cart_id]
|
|
321
|
+
* @property {string} [checkout_mode]
|
|
322
|
+
* @property {boolean} [cod_available]
|
|
323
|
+
* @property {number} [cod_charges]
|
|
324
|
+
* @property {string} [cod_message]
|
|
325
|
+
* @property {string} [comment]
|
|
326
|
+
* @property {string} [coupon_text]
|
|
327
|
+
* @property {CartCurrency} [currency]
|
|
328
|
+
* @property {string} [delivery_charge_info]
|
|
329
|
+
* @property {number} [delivery_charge_order_value]
|
|
330
|
+
* @property {number} [delivery_charges]
|
|
331
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
332
|
+
* @property {string} [error_message]
|
|
333
|
+
* @property {string} [gstin]
|
|
334
|
+
* @property {string} [id]
|
|
335
|
+
* @property {boolean} [is_valid]
|
|
336
|
+
* @property {CartProductInfo[]} [items]
|
|
337
|
+
* @property {string} [last_modified]
|
|
338
|
+
* @property {string} [message]
|
|
339
|
+
* @property {string} [order_id]
|
|
340
|
+
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
341
|
+
* @property {boolean} [restrict_checkout]
|
|
342
|
+
* @property {string} [store_code]
|
|
343
|
+
* @property {Object[]} [store_emps]
|
|
344
|
+
* @property {boolean} [success]
|
|
345
|
+
* @property {string} [uid]
|
|
346
|
+
* @property {string} [user_type]
|
|
347
|
+
*/
|
|
348
|
+
/**
|
|
349
|
+
* @typedef Collection
|
|
350
|
+
* @property {string} collected_by
|
|
351
|
+
* @property {string} refund_by
|
|
352
|
+
*/
|
|
353
|
+
/**
|
|
354
|
+
* @typedef CompareObject
|
|
355
|
+
* @property {number} [equals]
|
|
356
|
+
* @property {number} [greater_than]
|
|
357
|
+
* @property {number} [greater_than_equals]
|
|
358
|
+
* @property {number} [less_than]
|
|
359
|
+
* @property {number} [less_than_equals]
|
|
360
|
+
*/
|
|
361
|
+
/**
|
|
362
|
+
* @typedef Coupon
|
|
363
|
+
* @property {string} [coupon_code]
|
|
364
|
+
* @property {string} [coupon_type]
|
|
365
|
+
* @property {number} [coupon_value]
|
|
366
|
+
* @property {string} [description]
|
|
367
|
+
* @property {string} [expires_on]
|
|
368
|
+
* @property {boolean} [is_applicable]
|
|
369
|
+
* @property {boolean} [is_applied]
|
|
370
|
+
* @property {number} [max_discount_value]
|
|
371
|
+
* @property {string} [message]
|
|
372
|
+
* @property {number} [minimum_cart_value]
|
|
373
|
+
* @property {string} [sub_title]
|
|
374
|
+
* @property {string} [title]
|
|
375
|
+
*/
|
|
376
|
+
/**
|
|
377
|
+
* @typedef CouponAction
|
|
378
|
+
* @property {string} [action_date]
|
|
379
|
+
* @property {string} [txn_mode]
|
|
380
|
+
*/
|
|
381
|
+
/**
|
|
382
|
+
* @typedef CouponAdd
|
|
383
|
+
* @property {CouponSchedule} [_schedule]
|
|
384
|
+
* @property {CouponAction} [action]
|
|
385
|
+
* @property {CouponAuthor} [author]
|
|
386
|
+
* @property {string} code
|
|
387
|
+
* @property {CouponDateMeta} [date_meta]
|
|
388
|
+
* @property {DisplayMeta} display_meta
|
|
389
|
+
* @property {Identifier} identifiers
|
|
390
|
+
* @property {Ownership} ownership
|
|
391
|
+
* @property {Restrictions} [restrictions]
|
|
392
|
+
* @property {Rule[]} rule
|
|
393
|
+
* @property {RuleDefinition} rule_definition
|
|
394
|
+
* @property {State} [state]
|
|
395
|
+
* @property {string[]} [tags]
|
|
396
|
+
* @property {string} type_slug
|
|
397
|
+
* @property {Validation} [validation]
|
|
398
|
+
* @property {Validity} validity
|
|
399
|
+
*/
|
|
400
|
+
/**
|
|
401
|
+
* @typedef CouponAuthor
|
|
402
|
+
* @property {string} [created_by]
|
|
403
|
+
* @property {string} [modified_by]
|
|
404
|
+
*/
|
|
405
|
+
/**
|
|
406
|
+
* @typedef CouponBreakup
|
|
407
|
+
* @property {string} [code]
|
|
408
|
+
* @property {string} [coupon_type]
|
|
409
|
+
* @property {number} [coupon_value]
|
|
410
|
+
* @property {string} [description]
|
|
411
|
+
* @property {boolean} [is_applied]
|
|
412
|
+
* @property {number} [max_discount_value]
|
|
413
|
+
* @property {string} [message]
|
|
414
|
+
* @property {number} [minimum_cart_value]
|
|
415
|
+
* @property {string} [sub_title]
|
|
416
|
+
* @property {string} [title]
|
|
417
|
+
* @property {string} [type]
|
|
418
|
+
* @property {string} [uid]
|
|
419
|
+
* @property {number} [value]
|
|
420
|
+
*/
|
|
421
|
+
/**
|
|
422
|
+
* @typedef CouponDateMeta
|
|
423
|
+
* @property {string} [created_on]
|
|
424
|
+
* @property {string} [modified_on]
|
|
425
|
+
*/
|
|
426
|
+
/**
|
|
427
|
+
* @typedef CouponDetails
|
|
428
|
+
* @property {string} [code]
|
|
429
|
+
* @property {number} [discount_single_quantity]
|
|
430
|
+
* @property {number} [discount_total_quantity]
|
|
431
|
+
*/
|
|
432
|
+
/**
|
|
433
|
+
* @typedef CouponPartialUpdate
|
|
434
|
+
* @property {boolean} [archive] - Send true to unpublish coupon
|
|
435
|
+
* @property {CouponSchedule} [schedule]
|
|
436
|
+
*/
|
|
437
|
+
/**
|
|
438
|
+
* @typedef CouponSchedule
|
|
439
|
+
* @property {string} [cron]
|
|
440
|
+
* @property {number} [duration]
|
|
441
|
+
* @property {string} [end]
|
|
442
|
+
* @property {Object[]} [next_schedule]
|
|
443
|
+
* @property {string} [start]
|
|
444
|
+
*/
|
|
445
|
+
/**
|
|
446
|
+
* @typedef CouponsResponse
|
|
447
|
+
* @property {CouponAdd} [items]
|
|
448
|
+
* @property {Page} [page]
|
|
449
|
+
*/
|
|
450
|
+
/**
|
|
451
|
+
* @typedef CouponUpdate
|
|
452
|
+
* @property {CouponSchedule} [_schedule]
|
|
453
|
+
* @property {CouponAction} [action]
|
|
454
|
+
* @property {CouponAuthor} [author]
|
|
455
|
+
* @property {string} code
|
|
456
|
+
* @property {CouponDateMeta} [date_meta]
|
|
457
|
+
* @property {DisplayMeta} display_meta
|
|
458
|
+
* @property {Identifier} identifiers
|
|
459
|
+
* @property {Ownership} ownership
|
|
460
|
+
* @property {Restrictions} [restrictions]
|
|
461
|
+
* @property {Rule[]} rule
|
|
462
|
+
* @property {RuleDefinition} rule_definition
|
|
463
|
+
* @property {State} [state]
|
|
464
|
+
* @property {string[]} [tags]
|
|
465
|
+
* @property {string} type_slug
|
|
466
|
+
* @property {Validation} [validation]
|
|
467
|
+
* @property {Validity} validity
|
|
468
|
+
*/
|
|
469
|
+
/**
|
|
470
|
+
* @typedef CouponValidity
|
|
471
|
+
* @property {string} [code]
|
|
472
|
+
* @property {number} [discount]
|
|
473
|
+
* @property {string} [display_message_en]
|
|
474
|
+
* @property {boolean} [next_validation_required]
|
|
475
|
+
* @property {string} [title]
|
|
476
|
+
* @property {boolean} [valid]
|
|
477
|
+
*/
|
|
478
|
+
/**
|
|
479
|
+
* @typedef DeleteAddressResponse
|
|
480
|
+
* @property {string} [id]
|
|
481
|
+
* @property {boolean} [is_deleted]
|
|
482
|
+
*/
|
|
483
|
+
/**
|
|
484
|
+
* @typedef DeleteCartDetailResponse
|
|
485
|
+
* @property {string} [message]
|
|
486
|
+
* @property {boolean} [success] - True if cart is archived successfully. False
|
|
487
|
+
* if not archived.
|
|
488
|
+
*/
|
|
489
|
+
/**
|
|
490
|
+
* @typedef DeleteCartRequest
|
|
491
|
+
* @property {string[]} [cart_id_list]
|
|
492
|
+
*/
|
|
493
|
+
/**
|
|
494
|
+
* @typedef DeliveryCharges
|
|
495
|
+
* @property {Charges[]} [charges]
|
|
496
|
+
* @property {boolean} [enabled]
|
|
497
|
+
*/
|
|
498
|
+
/**
|
|
499
|
+
* @typedef DiscountOffer
|
|
500
|
+
* @property {boolean} [apportion_discount]
|
|
501
|
+
* @property {string} [code]
|
|
502
|
+
* @property {number} [discount_amount]
|
|
503
|
+
* @property {number} [discount_percentage]
|
|
504
|
+
* @property {number} [discount_price]
|
|
505
|
+
* @property {number} [max_discount_amount]
|
|
506
|
+
* @property {number} [max_offer_quantity]
|
|
507
|
+
* @property {number} [max_usage_per_transaction]
|
|
508
|
+
* @property {number} [min_offer_quantity]
|
|
509
|
+
* @property {boolean} [partial_can_ret]
|
|
510
|
+
*/
|
|
511
|
+
/**
|
|
512
|
+
* @typedef DiscountRule
|
|
513
|
+
* @property {string} buy_condition
|
|
514
|
+
* @property {string} discount_type
|
|
515
|
+
* @property {ItemCriteria} item_criteria
|
|
516
|
+
* @property {DiscountOffer} offer
|
|
517
|
+
*/
|
|
518
|
+
/**
|
|
519
|
+
* @typedef DiscountRulesApp
|
|
520
|
+
* @property {Object} [item_criteria] - Item criteria of promotion
|
|
521
|
+
* @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
|
|
522
|
+
* @property {Object} [offer] - Offer for promotion
|
|
523
|
+
* @property {Object} [raw_offer] - Raw offer details for promotion
|
|
524
|
+
*/
|
|
525
|
+
/**
|
|
526
|
+
* @typedef DisplayBreakup
|
|
527
|
+
* @property {string} [currency_code]
|
|
528
|
+
* @property {string} [currency_symbol]
|
|
529
|
+
* @property {string} [display]
|
|
530
|
+
* @property {string} [key]
|
|
531
|
+
* @property {string[]} [message]
|
|
532
|
+
* @property {number} [value]
|
|
533
|
+
*/
|
|
534
|
+
/**
|
|
535
|
+
* @typedef DisplayMeta
|
|
536
|
+
* @property {DisplayMetaDict} [apply]
|
|
537
|
+
* @property {DisplayMetaDict} [auto]
|
|
538
|
+
* @property {string} [description]
|
|
539
|
+
* @property {DisplayMetaDict} [remove]
|
|
540
|
+
* @property {string} [subtitle]
|
|
541
|
+
* @property {string} [title]
|
|
542
|
+
*/
|
|
543
|
+
/**
|
|
544
|
+
* @typedef DisplayMeta1
|
|
545
|
+
* @property {string} [description]
|
|
546
|
+
* @property {string} [name]
|
|
547
|
+
* @property {string} [offer_label]
|
|
548
|
+
* @property {string} [offer_text]
|
|
549
|
+
*/
|
|
550
|
+
/**
|
|
551
|
+
* @typedef DisplayMetaDict
|
|
552
|
+
* @property {string} [subtitle]
|
|
553
|
+
* @property {string} [title]
|
|
554
|
+
*/
|
|
555
|
+
/**
|
|
556
|
+
* @typedef Files
|
|
557
|
+
* @property {string} key
|
|
558
|
+
* @property {string[]} values
|
|
559
|
+
*/
|
|
560
|
+
/**
|
|
561
|
+
* @typedef FreeGiftItem
|
|
562
|
+
* @property {string} [item_brand_name] - Item brand name
|
|
563
|
+
* @property {number} [item_id] - Item id
|
|
564
|
+
* @property {string[]} [item_images_url] - Item images URL
|
|
565
|
+
* @property {string} [item_name] - Item name
|
|
566
|
+
* @property {Object} [item_price_details] - Item price details
|
|
567
|
+
* @property {string} [item_slug] - Item slug
|
|
568
|
+
*/
|
|
569
|
+
/**
|
|
570
|
+
* @typedef GeoLocation
|
|
571
|
+
* @property {number} [latitude]
|
|
572
|
+
* @property {number} [longitude]
|
|
573
|
+
*/
|
|
574
|
+
/**
|
|
575
|
+
* @typedef GetCouponResponse
|
|
576
|
+
* @property {Coupon[]} [available_coupon_list]
|
|
577
|
+
* @property {PageCoupon} [page]
|
|
578
|
+
*/
|
|
579
|
+
/**
|
|
580
|
+
* @typedef GetShareCartLinkRequest
|
|
581
|
+
* @property {string} [id] - Cart uid for generating sharing
|
|
582
|
+
* @property {Object} [meta] - Staff, Ordering store or any other data. This
|
|
583
|
+
* data will be used to generate link as well as sent as shared details.
|
|
584
|
+
*/
|
|
585
|
+
/**
|
|
586
|
+
* @typedef GetShareCartLinkResponse
|
|
587
|
+
* @property {string} [share_url] - Short shareable final url
|
|
588
|
+
* @property {string} [token] - Short url unique id
|
|
589
|
+
*/
|
|
590
|
+
/**
|
|
591
|
+
* @typedef Identifier
|
|
592
|
+
* @property {string[]} [article_id]
|
|
593
|
+
* @property {number[]} [brand_id]
|
|
594
|
+
* @property {number[]} [category_id]
|
|
595
|
+
* @property {string[]} [collection_id]
|
|
596
|
+
* @property {number[]} [company_id]
|
|
597
|
+
* @property {string[]} [email_domain]
|
|
598
|
+
* @property {number[]} [exclude_brand_id]
|
|
599
|
+
* @property {number[]} [item_id]
|
|
600
|
+
* @property {number[]} [store_id]
|
|
601
|
+
* @property {string[]} [user_id]
|
|
602
|
+
*/
|
|
603
|
+
/**
|
|
604
|
+
* @typedef ItemCriteria
|
|
605
|
+
* @property {boolean} [all_items]
|
|
606
|
+
* @property {string[]} [available_zones]
|
|
607
|
+
* @property {string[]} [buy_rules]
|
|
608
|
+
* @property {CompareObject} [cart_quantity]
|
|
609
|
+
* @property {CompareObject} [cart_total]
|
|
610
|
+
* @property {CompareObject} [cart_unique_item_amount]
|
|
611
|
+
* @property {CompareObject} [cart_unique_item_quantity]
|
|
612
|
+
* @property {number[]} [item_brand]
|
|
613
|
+
* @property {number[]} [item_category]
|
|
614
|
+
* @property {number[]} [item_company]
|
|
615
|
+
* @property {number[]} [item_department]
|
|
616
|
+
* @property {number[]} [item_exclude_brand]
|
|
617
|
+
* @property {number[]} [item_exclude_category]
|
|
618
|
+
* @property {number[]} [item_exclude_company]
|
|
619
|
+
* @property {number[]} [item_exclude_department]
|
|
620
|
+
* @property {number[]} [item_exclude_id]
|
|
621
|
+
* @property {number[]} [item_exclude_l1_category]
|
|
622
|
+
* @property {number[]} [item_exclude_l2_category]
|
|
623
|
+
* @property {string[]} [item_exclude_sku]
|
|
624
|
+
* @property {number[]} [item_exclude_store]
|
|
625
|
+
* @property {number[]} [item_id]
|
|
626
|
+
* @property {number[]} [item_l1_category]
|
|
627
|
+
* @property {number[]} [item_l2_category]
|
|
628
|
+
* @property {string[]} [item_size]
|
|
629
|
+
* @property {string[]} [item_sku]
|
|
630
|
+
* @property {number[]} [item_store]
|
|
631
|
+
* @property {string[]} [item_tags]
|
|
632
|
+
*/
|
|
633
|
+
/**
|
|
634
|
+
* @typedef LoyaltyPoints
|
|
635
|
+
* @property {number} [applicable]
|
|
636
|
+
* @property {string} [description]
|
|
637
|
+
* @property {boolean} [is_applied]
|
|
638
|
+
* @property {number} [total]
|
|
639
|
+
*/
|
|
640
|
+
/**
|
|
641
|
+
* @typedef MultiCartResponse
|
|
642
|
+
* @property {CartList[]} [data]
|
|
643
|
+
* @property {boolean} [success]
|
|
644
|
+
*/
|
|
645
|
+
/**
|
|
646
|
+
* @typedef MultiTenderPaymentMeta
|
|
647
|
+
* @property {string} [current_status]
|
|
648
|
+
* @property {Object} [extra_meta]
|
|
649
|
+
* @property {string} [order_id]
|
|
650
|
+
* @property {string} [payment_gateway]
|
|
651
|
+
* @property {string} [payment_id]
|
|
652
|
+
*/
|
|
653
|
+
/**
|
|
654
|
+
* @typedef MultiTenderPaymentMethod
|
|
655
|
+
* @property {number} amount - Payment amount
|
|
656
|
+
* @property {MultiTenderPaymentMeta} [meta]
|
|
657
|
+
* @property {string} mode
|
|
658
|
+
* @property {string} [name] - Payment mode name
|
|
659
|
+
*/
|
|
660
|
+
/**
|
|
661
|
+
* @typedef OpenapiCartDetailsRequest
|
|
662
|
+
* @property {CartItem[]} cart_items
|
|
663
|
+
*/
|
|
664
|
+
/**
|
|
665
|
+
* @typedef OpenapiCartDetailsResponse
|
|
666
|
+
* @property {CartBreakup} [breakup_values]
|
|
667
|
+
* @property {boolean} [is_valid]
|
|
668
|
+
* @property {CartProductInfo[]} [items]
|
|
669
|
+
* @property {string} [message]
|
|
670
|
+
*/
|
|
671
|
+
/**
|
|
672
|
+
* @typedef OpenApiCartServiceabilityRequest
|
|
673
|
+
* @property {CartItem[]} cart_items
|
|
674
|
+
* @property {ShippingAddress} shipping_address
|
|
675
|
+
*/
|
|
676
|
+
/**
|
|
677
|
+
* @typedef OpenApiCartServiceabilityResponse
|
|
678
|
+
* @property {CartBreakup} [breakup_values]
|
|
679
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
680
|
+
* @property {boolean} [is_valid]
|
|
681
|
+
* @property {CartProductInfo[]} [items]
|
|
682
|
+
* @property {string} [message]
|
|
683
|
+
*/
|
|
684
|
+
/**
|
|
685
|
+
* @typedef OpenApiCheckoutResponse
|
|
686
|
+
* @property {string} [message]
|
|
687
|
+
* @property {string} order_id - Fynd order id
|
|
688
|
+
* @property {string} [order_ref_id] - Order id sent in request
|
|
689
|
+
* @property {boolean} [success]
|
|
690
|
+
*/
|
|
691
|
+
/**
|
|
692
|
+
* @typedef OpenApiErrorResponse
|
|
693
|
+
* @property {Object} [errors] - Contains field name which has error as key and
|
|
694
|
+
* error message as value
|
|
695
|
+
* @property {string} [message]
|
|
696
|
+
* @property {boolean} [success]
|
|
697
|
+
*/
|
|
698
|
+
/**
|
|
699
|
+
* @typedef OpenApiFiles
|
|
700
|
+
* @property {string} key
|
|
701
|
+
* @property {string[]} values
|
|
702
|
+
*/
|
|
703
|
+
/**
|
|
704
|
+
* @typedef OpenApiOrderItem
|
|
705
|
+
* @property {number} amount_paid
|
|
706
|
+
* @property {number} cashback_applied
|
|
707
|
+
* @property {number} cod_charges
|
|
708
|
+
* @property {number} coupon_effective_discount
|
|
709
|
+
* @property {number} delivery_charges
|
|
710
|
+
* @property {number} discount
|
|
711
|
+
* @property {number} [employee_discount]
|
|
712
|
+
* @property {Object} [extra_meta]
|
|
713
|
+
* @property {OpenApiFiles[]} [files]
|
|
714
|
+
* @property {number} [loyalty_discount]
|
|
715
|
+
* @property {CartItemMeta} [meta]
|
|
716
|
+
* @property {MultiTenderPaymentMethod[]} payment_methods
|
|
717
|
+
* @property {number} price_effective
|
|
718
|
+
* @property {number} price_marked
|
|
719
|
+
* @property {number} product_id
|
|
720
|
+
* @property {number} [quantity]
|
|
721
|
+
* @property {string} size
|
|
722
|
+
*/
|
|
723
|
+
/**
|
|
724
|
+
* @typedef OpenApiPlatformCheckoutReq
|
|
725
|
+
* @property {string} [affiliate_order_id]
|
|
726
|
+
* @property {ShippingAddress} billing_address
|
|
727
|
+
* @property {OpenApiOrderItem[]} cart_items
|
|
728
|
+
* @property {number} cart_value
|
|
729
|
+
* @property {number} cashback_applied
|
|
730
|
+
* @property {number} cod_charges
|
|
731
|
+
* @property {string} [comment]
|
|
732
|
+
* @property {string} [coupon]
|
|
733
|
+
* @property {string} coupon_code
|
|
734
|
+
* @property {number} coupon_value
|
|
735
|
+
* @property {string} [currency_code]
|
|
736
|
+
* @property {number} delivery_charges
|
|
737
|
+
* @property {Object} [employee_discount]
|
|
738
|
+
* @property {OpenApiFiles[]} [files]
|
|
739
|
+
* @property {string} [gstin]
|
|
740
|
+
* @property {number} [loyalty_discount]
|
|
741
|
+
* @property {string} [order_id]
|
|
742
|
+
* @property {MultiTenderPaymentMethod[]} payment_methods
|
|
743
|
+
* @property {string} [payment_mode]
|
|
744
|
+
* @property {ShippingAddress} [shipping_address]
|
|
745
|
+
*/
|
|
746
|
+
/**
|
|
747
|
+
* @typedef OperationErrorResponse
|
|
748
|
+
* @property {string} [message]
|
|
749
|
+
* @property {boolean} [success]
|
|
750
|
+
*/
|
|
751
|
+
/**
|
|
752
|
+
* @typedef OverrideCartItem
|
|
753
|
+
* @property {number} amount_paid
|
|
754
|
+
* @property {number} discount
|
|
755
|
+
* @property {Object} [extra_meta]
|
|
756
|
+
* @property {number} item_id
|
|
757
|
+
* @property {number} price_effective
|
|
758
|
+
* @property {number} price_marked
|
|
759
|
+
* @property {OverrideCartItemPromo[]} [promo_list]
|
|
760
|
+
* @property {number} [quantity]
|
|
761
|
+
* @property {string} [seller_identifier]
|
|
762
|
+
* @property {string} size
|
|
763
|
+
*/
|
|
764
|
+
/**
|
|
765
|
+
* @typedef OverrideCartItemPromo
|
|
766
|
+
* @property {Object[]} [item_list]
|
|
767
|
+
* @property {string} promo_amount
|
|
768
|
+
* @property {string} [promo_desc]
|
|
769
|
+
* @property {string} promo_id
|
|
770
|
+
* @property {string} [rwrd_tndr]
|
|
771
|
+
*/
|
|
772
|
+
/**
|
|
773
|
+
* @typedef OverrideCheckoutReq
|
|
774
|
+
* @property {string} aggregator
|
|
775
|
+
* @property {Object} [billing_address]
|
|
776
|
+
* @property {string} cart_id
|
|
777
|
+
* @property {OverrideCartItem[]} cart_items
|
|
778
|
+
* @property {string} currency_code
|
|
779
|
+
* @property {string} merchant_code
|
|
780
|
+
* @property {string} order_type
|
|
781
|
+
* @property {number} [ordering_store]
|
|
782
|
+
* @property {string} payment_identifier
|
|
783
|
+
* @property {string} payment_mode
|
|
784
|
+
* @property {Object} [shipping_address]
|
|
785
|
+
*/
|
|
786
|
+
/**
|
|
787
|
+
* @typedef OverrideCheckoutResponse
|
|
788
|
+
* @property {Object} cart
|
|
789
|
+
* @property {Object} data
|
|
790
|
+
* @property {string} message
|
|
791
|
+
* @property {string} order_id
|
|
792
|
+
* @property {string} success
|
|
793
|
+
*/
|
|
794
|
+
/**
|
|
795
|
+
* @typedef Ownership
|
|
796
|
+
* @property {string} payable_by
|
|
797
|
+
* @property {string} payable_category
|
|
798
|
+
*/
|
|
799
|
+
/**
|
|
800
|
+
* @typedef Ownership1
|
|
801
|
+
* @property {string} payable_by
|
|
802
|
+
* @property {string} payable_category
|
|
803
|
+
*/
|
|
804
|
+
/**
|
|
805
|
+
* @typedef Ownership2
|
|
806
|
+
* @property {string} [payable_by] - Promo amount bearable party
|
|
807
|
+
* @property {string} [payable_category] - Promo amount payable category
|
|
808
|
+
*/
|
|
809
|
+
/**
|
|
810
|
+
* @typedef Page
|
|
811
|
+
* @property {number} [current]
|
|
812
|
+
* @property {boolean} [has_next]
|
|
813
|
+
* @property {boolean} [has_previous]
|
|
814
|
+
* @property {number} [item_total]
|
|
815
|
+
* @property {string} [next_id]
|
|
816
|
+
* @property {number} [size]
|
|
817
|
+
* @property {string} type
|
|
818
|
+
*/
|
|
819
|
+
/**
|
|
820
|
+
* @typedef PageCoupon
|
|
821
|
+
* @property {number} [current]
|
|
822
|
+
* @property {boolean} [has_next]
|
|
823
|
+
* @property {boolean} [has_previous]
|
|
824
|
+
* @property {number} [total]
|
|
825
|
+
* @property {number} [total_item_count]
|
|
826
|
+
*/
|
|
827
|
+
/**
|
|
828
|
+
* @typedef PaymentAllowValue
|
|
829
|
+
* @property {number} [max]
|
|
830
|
+
*/
|
|
831
|
+
/**
|
|
832
|
+
* @typedef PaymentAllowValue1
|
|
833
|
+
* @property {number} [max]
|
|
834
|
+
*/
|
|
835
|
+
/**
|
|
836
|
+
* @typedef PaymentCouponValidate
|
|
837
|
+
* @property {CouponValidity} [coupon_validity]
|
|
838
|
+
* @property {string} [message]
|
|
839
|
+
* @property {boolean} success
|
|
840
|
+
*/
|
|
841
|
+
/**
|
|
842
|
+
* @typedef PaymentMeta
|
|
843
|
+
* @property {string} [merchant_code]
|
|
844
|
+
* @property {string} [payment_gateway]
|
|
845
|
+
* @property {string} [payment_identifier]
|
|
846
|
+
* @property {string} [type]
|
|
847
|
+
*/
|
|
848
|
+
/**
|
|
849
|
+
* @typedef PaymentMethod
|
|
850
|
+
* @property {number} [amount]
|
|
851
|
+
* @property {string} mode
|
|
852
|
+
* @property {string} [name]
|
|
853
|
+
* @property {string} [payment]
|
|
854
|
+
* @property {PaymentMeta} payment_meta
|
|
855
|
+
*/
|
|
856
|
+
/**
|
|
857
|
+
* @typedef PaymentModes
|
|
858
|
+
* @property {string[]} [codes]
|
|
859
|
+
* @property {string[]} [iins]
|
|
860
|
+
* @property {string[]} [networks]
|
|
861
|
+
* @property {string[]} [types]
|
|
862
|
+
* @property {PaymentAllowValue} [uses]
|
|
863
|
+
*/
|
|
864
|
+
/**
|
|
865
|
+
* @typedef PaymentSelectionLock
|
|
866
|
+
* @property {string} [default_options]
|
|
867
|
+
* @property {boolean} [enabled]
|
|
868
|
+
* @property {string} [payment_identifier]
|
|
869
|
+
*/
|
|
870
|
+
/**
|
|
871
|
+
* @typedef PickupStoreDetail
|
|
872
|
+
* @property {string} [address]
|
|
873
|
+
* @property {string} [address_type]
|
|
874
|
+
* @property {string} [area]
|
|
875
|
+
* @property {string} [area_code]
|
|
876
|
+
* @property {string} [area_code_slug]
|
|
877
|
+
* @property {string} [city]
|
|
878
|
+
* @property {string} [country]
|
|
879
|
+
* @property {string} [email]
|
|
880
|
+
* @property {number} [id]
|
|
881
|
+
* @property {string} [landmark]
|
|
882
|
+
* @property {string} [name]
|
|
883
|
+
* @property {string} [phone]
|
|
884
|
+
* @property {number} [pincode]
|
|
885
|
+
* @property {string} [state]
|
|
886
|
+
* @property {string} [store_code]
|
|
887
|
+
* @property {number} [uid]
|
|
888
|
+
*/
|
|
889
|
+
/**
|
|
890
|
+
* @typedef PlatformAddCartRequest
|
|
891
|
+
* @property {AddProductCart[]} [items]
|
|
892
|
+
* @property {boolean} [new_cart]
|
|
893
|
+
* @property {string} [user_id]
|
|
894
|
+
*/
|
|
895
|
+
/**
|
|
896
|
+
* @typedef PlatformAddress
|
|
897
|
+
* @property {string} [address]
|
|
898
|
+
* @property {string} [address_type]
|
|
899
|
+
* @property {string} [area]
|
|
900
|
+
* @property {string} [area_code]
|
|
901
|
+
* @property {string} [area_code_slug]
|
|
902
|
+
* @property {string} [cart_id]
|
|
903
|
+
* @property {string} [checkout_mode]
|
|
904
|
+
* @property {string} [city]
|
|
905
|
+
* @property {string} [country]
|
|
906
|
+
* @property {string} [country_code]
|
|
907
|
+
* @property {string} [created_by_user_id]
|
|
908
|
+
* @property {string} [email]
|
|
909
|
+
* @property {GeoLocation} [geo_location]
|
|
910
|
+
* @property {Object} [google_map_point]
|
|
911
|
+
* @property {string} [id]
|
|
912
|
+
* @property {boolean} [is_active]
|
|
913
|
+
* @property {boolean} [is_default_address]
|
|
914
|
+
* @property {string} [landmark]
|
|
915
|
+
* @property {Object} [meta]
|
|
916
|
+
* @property {string} [name]
|
|
917
|
+
* @property {string} [phone]
|
|
918
|
+
* @property {string} [state]
|
|
919
|
+
* @property {string[]} [tags]
|
|
920
|
+
* @property {string} [user_id]
|
|
921
|
+
*/
|
|
922
|
+
/**
|
|
923
|
+
* @typedef PlatformCartCheckoutDetailRequest
|
|
924
|
+
* @property {string} [address_id]
|
|
925
|
+
* @property {string} [aggregator]
|
|
926
|
+
* @property {Object} [billing_address]
|
|
927
|
+
* @property {string} [billing_address_id]
|
|
928
|
+
* @property {string} [callback_url]
|
|
929
|
+
* @property {string} [checkout_mode]
|
|
930
|
+
* @property {Object} [delivery_address]
|
|
931
|
+
* @property {string} [device_id]
|
|
932
|
+
* @property {string} [employee_code]
|
|
933
|
+
* @property {Object} [extra_meta]
|
|
934
|
+
* @property {Files[]} [files] - List of file url
|
|
935
|
+
* @property {string} id
|
|
936
|
+
* @property {string} [merchant_code]
|
|
937
|
+
* @property {Object} [meta]
|
|
938
|
+
* @property {string} order_type
|
|
939
|
+
* @property {number} [ordering_store]
|
|
940
|
+
* @property {boolean} [payment_auto_confirm]
|
|
941
|
+
* @property {string} [payment_identifier]
|
|
942
|
+
* @property {string} payment_mode
|
|
943
|
+
* @property {Object} [payment_params]
|
|
944
|
+
* @property {number} [pick_at_store_uid]
|
|
945
|
+
* @property {boolean} [pos]
|
|
946
|
+
* @property {StaffCheckout} [staff]
|
|
947
|
+
* @property {string} user_id
|
|
948
|
+
*/
|
|
949
|
+
/**
|
|
950
|
+
* @typedef PlatformCartCheckoutDetailV2Request
|
|
951
|
+
* @property {string} [address_id]
|
|
952
|
+
* @property {string} [aggregator]
|
|
953
|
+
* @property {Object} [billing_address]
|
|
954
|
+
* @property {string} [billing_address_id]
|
|
955
|
+
* @property {string} [callback_url]
|
|
956
|
+
* @property {string} [checkout_mode]
|
|
957
|
+
* @property {Object} [custom_meta]
|
|
958
|
+
* @property {Object} [delivery_address]
|
|
959
|
+
* @property {string} [device_id]
|
|
960
|
+
* @property {string} [employee_code]
|
|
961
|
+
* @property {Object} [extra_meta]
|
|
962
|
+
* @property {Files[]} [files] - List of file url
|
|
963
|
+
* @property {string} id
|
|
964
|
+
* @property {string} [merchant_code]
|
|
965
|
+
* @property {Object} [meta]
|
|
966
|
+
* @property {string} order_type
|
|
967
|
+
* @property {number} [ordering_store]
|
|
968
|
+
* @property {boolean} [payment_auto_confirm]
|
|
969
|
+
* @property {string} [payment_identifier]
|
|
970
|
+
* @property {PaymentMethod[]} payment_methods
|
|
971
|
+
* @property {string} [payment_mode]
|
|
972
|
+
* @property {Object} [payment_params]
|
|
973
|
+
* @property {number} [pick_at_store_uid]
|
|
974
|
+
* @property {boolean} [pos]
|
|
975
|
+
* @property {StaffCheckout} [staff]
|
|
976
|
+
* @property {string} user_id
|
|
977
|
+
*/
|
|
978
|
+
/**
|
|
979
|
+
* @typedef PlatformCartMetaRequest
|
|
980
|
+
* @property {string} [checkout_mode]
|
|
981
|
+
* @property {string} [comment]
|
|
982
|
+
* @property {Object} [gift_details]
|
|
983
|
+
* @property {string} [gstin]
|
|
984
|
+
* @property {string} [pan_no]
|
|
985
|
+
* @property {Object} [pick_up_customer_details] - Customer contact details for
|
|
986
|
+
* customer pickup at store
|
|
987
|
+
* @property {string} [staff_user_id] - Staff user id
|
|
988
|
+
*/
|
|
989
|
+
/**
|
|
990
|
+
* @typedef PlatformCartShipmentsResponse
|
|
991
|
+
* @property {AppliedPromotion[]} [applied_promo_details]
|
|
992
|
+
* @property {CartBreakup} [breakup_values]
|
|
993
|
+
* @property {boolean} [buy_now]
|
|
994
|
+
* @property {string} [checkout_mode]
|
|
995
|
+
* @property {string} [comment]
|
|
996
|
+
* @property {string} [coupon_text]
|
|
997
|
+
* @property {CartCurrency} [currency]
|
|
998
|
+
* @property {string} [delivery_charge_info]
|
|
999
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
1000
|
+
* @property {boolean} [error]
|
|
1001
|
+
* @property {string} [gstin]
|
|
1002
|
+
* @property {string} [id]
|
|
1003
|
+
* @property {boolean} [is_valid]
|
|
1004
|
+
* @property {CartProductInfo[]} [items]
|
|
1005
|
+
* @property {string} [last_modified]
|
|
1006
|
+
* @property {string} [message]
|
|
1007
|
+
* @property {Object} [pan_config]
|
|
1008
|
+
* @property {string} [pan_no]
|
|
1009
|
+
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
1010
|
+
* @property {boolean} [restrict_checkout]
|
|
1011
|
+
* @property {PlatformShipmentResponse[]} [shipments]
|
|
1012
|
+
* @property {string} [staff_user_id]
|
|
1013
|
+
*/
|
|
1014
|
+
/**
|
|
1015
|
+
* @typedef PlatformGetAddressesResponse
|
|
1016
|
+
* @property {PlatformAddress[]} [address]
|
|
1017
|
+
*/
|
|
1018
|
+
/**
|
|
1019
|
+
* @typedef PlatformSelectCartAddressRequest
|
|
1020
|
+
* @property {string} [billing_address_id]
|
|
1021
|
+
* @property {string} [cart_id]
|
|
1022
|
+
* @property {string} [checkout_mode]
|
|
1023
|
+
* @property {string} [id]
|
|
1024
|
+
* @property {string} [user_id]
|
|
1025
|
+
*/
|
|
1026
|
+
/**
|
|
1027
|
+
* @typedef PlatformShipmentResponse
|
|
1028
|
+
* @property {ShipmentArticle[]} [articles]
|
|
1029
|
+
* @property {string} [box_type]
|
|
1030
|
+
* @property {string} [dp_id]
|
|
1031
|
+
* @property {Object} [dp_options]
|
|
1032
|
+
* @property {number} [fulfillment_id]
|
|
1033
|
+
* @property {string} [fulfillment_type]
|
|
1034
|
+
* @property {CartProductInfo[]} [items]
|
|
1035
|
+
* @property {string} [order_type]
|
|
1036
|
+
* @property {ShipmentPromise} [promise]
|
|
1037
|
+
* @property {string} [shipment_type]
|
|
1038
|
+
* @property {number} [shipments]
|
|
1039
|
+
*/
|
|
1040
|
+
/**
|
|
1041
|
+
* @typedef PlatformUpdateCartRequest
|
|
1042
|
+
* @property {UpdateProductCart[]} [items]
|
|
1043
|
+
* @property {string} operation
|
|
1044
|
+
* @property {string} [user_id]
|
|
1045
|
+
*/
|
|
1046
|
+
/**
|
|
1047
|
+
* @typedef PostOrder
|
|
1048
|
+
* @property {boolean} [cancellation_allowed]
|
|
1049
|
+
* @property {boolean} [return_allowed]
|
|
1050
|
+
*/
|
|
1051
|
+
/**
|
|
1052
|
+
* @typedef PostOrder1
|
|
1053
|
+
* @property {boolean} [cancellation_allowed]
|
|
1054
|
+
* @property {boolean} [return_allowed]
|
|
1055
|
+
*/
|
|
1056
|
+
/**
|
|
1057
|
+
* @typedef PriceAdjustment
|
|
1058
|
+
* @property {boolean} [allowed_refund]
|
|
1059
|
+
* @property {string} [apply_expiry]
|
|
1060
|
+
* @property {Article[]} article_ids
|
|
1061
|
+
* @property {boolean} article_level_distribution
|
|
1062
|
+
* @property {string} cart_id
|
|
1063
|
+
* @property {number} [cart_value]
|
|
1064
|
+
* @property {Collection} collection
|
|
1065
|
+
* @property {string} [id]
|
|
1066
|
+
* @property {boolean} is_authenticated
|
|
1067
|
+
* @property {string} message
|
|
1068
|
+
* @property {Object} [meta]
|
|
1069
|
+
* @property {string} type
|
|
1070
|
+
* @property {number} value
|
|
1071
|
+
*/
|
|
1072
|
+
/**
|
|
1073
|
+
* @typedef PriceAdjustmentAdd
|
|
1074
|
+
* @property {boolean} [allowed_refund]
|
|
1075
|
+
* @property {string} [apply_expiry]
|
|
1076
|
+
* @property {Article[]} article_ids
|
|
1077
|
+
* @property {boolean} article_level_distribution
|
|
1078
|
+
* @property {string} cart_id
|
|
1079
|
+
* @property {number} [cart_value]
|
|
1080
|
+
* @property {Collection} collection
|
|
1081
|
+
* @property {string} [created_by]
|
|
1082
|
+
* @property {boolean} is_authenticated
|
|
1083
|
+
* @property {string} message
|
|
1084
|
+
* @property {Object} [meta]
|
|
1085
|
+
* @property {string} type
|
|
1086
|
+
* @property {number} value
|
|
1087
|
+
*/
|
|
1088
|
+
/**
|
|
1089
|
+
* @typedef PriceAdjustmentResponse
|
|
1090
|
+
* @property {PriceAdjustment} [data]
|
|
1091
|
+
*/
|
|
1092
|
+
/**
|
|
1093
|
+
* @typedef PriceAdjustmentUpdate
|
|
1094
|
+
* @property {boolean} [allowed_refund]
|
|
1095
|
+
* @property {string} [apply_expiry]
|
|
1096
|
+
* @property {Article[]} article_ids
|
|
1097
|
+
* @property {boolean} article_level_distribution
|
|
1098
|
+
* @property {string} cart_id
|
|
1099
|
+
* @property {number} [cart_value]
|
|
1100
|
+
* @property {Collection} collection
|
|
1101
|
+
* @property {boolean} is_authenticated
|
|
1102
|
+
* @property {string} message
|
|
1103
|
+
* @property {Object} [meta]
|
|
1104
|
+
* @property {string} [modified_by]
|
|
1105
|
+
* @property {string} type
|
|
1106
|
+
* @property {number} value
|
|
1107
|
+
*/
|
|
1108
|
+
/**
|
|
1109
|
+
* @typedef PriceRange
|
|
1110
|
+
* @property {number} [max]
|
|
1111
|
+
* @property {number} [min]
|
|
1112
|
+
*/
|
|
1113
|
+
/**
|
|
1114
|
+
* @typedef ProductAction
|
|
1115
|
+
* @property {ActionQuery} [query]
|
|
1116
|
+
* @property {string} [type]
|
|
1117
|
+
* @property {string} [url]
|
|
1118
|
+
*/
|
|
1119
|
+
/**
|
|
1120
|
+
* @typedef ProductArticle
|
|
1121
|
+
* @property {Object} [_custom_json]
|
|
1122
|
+
* @property {Object} [cart_item_meta]
|
|
1123
|
+
* @property {Object} [extra_meta]
|
|
1124
|
+
* @property {Object} [gift_card]
|
|
1125
|
+
* @property {Object} [identifier]
|
|
1126
|
+
* @property {boolean} [is_gift_visible]
|
|
1127
|
+
* @property {Object} [meta]
|
|
1128
|
+
* @property {number} [mto_quantity]
|
|
1129
|
+
* @property {Object} [parent_item_identifiers]
|
|
1130
|
+
* @property {ArticlePriceInfo} [price]
|
|
1131
|
+
* @property {string[]} [product_group_tags]
|
|
1132
|
+
* @property {number} [quantity]
|
|
1133
|
+
* @property {BaseInfo} [seller]
|
|
1134
|
+
* @property {string} [seller_identifier]
|
|
1135
|
+
* @property {string} [size]
|
|
1136
|
+
* @property {StoreInfo} [store]
|
|
1137
|
+
* @property {string} [type]
|
|
1138
|
+
* @property {string} [uid]
|
|
1139
|
+
*/
|
|
1140
|
+
/**
|
|
1141
|
+
* @typedef ProductAvailability
|
|
1142
|
+
* @property {ProductAvailabilitySize[]} [available_sizes]
|
|
1143
|
+
* @property {boolean} [deliverable]
|
|
1144
|
+
* @property {boolean} [is_valid]
|
|
1145
|
+
* @property {number} [other_store_quantity]
|
|
1146
|
+
* @property {boolean} [out_of_stock]
|
|
1147
|
+
* @property {string[]} [sizes]
|
|
1148
|
+
*/
|
|
1149
|
+
/**
|
|
1150
|
+
* @typedef ProductAvailabilitySize
|
|
1151
|
+
* @property {string} [display]
|
|
1152
|
+
* @property {boolean} [is_available]
|
|
1153
|
+
* @property {string} [value]
|
|
1154
|
+
*/
|
|
1155
|
+
/**
|
|
1156
|
+
* @typedef ProductImage
|
|
1157
|
+
* @property {string} [aspect_ratio]
|
|
1158
|
+
* @property {string} [secure_url]
|
|
1159
|
+
* @property {string} [url]
|
|
1160
|
+
*/
|
|
1161
|
+
/**
|
|
1162
|
+
* @typedef ProductPrice
|
|
1163
|
+
* @property {number} [add_on]
|
|
1164
|
+
* @property {string} [currency_code]
|
|
1165
|
+
* @property {string} [currency_symbol]
|
|
1166
|
+
* @property {number} [effective]
|
|
1167
|
+
* @property {number} [marked]
|
|
1168
|
+
* @property {number} [selling]
|
|
1169
|
+
*/
|
|
1170
|
+
/**
|
|
1171
|
+
* @typedef ProductPriceInfo
|
|
1172
|
+
* @property {ProductPrice} [base]
|
|
1173
|
+
* @property {ProductPrice} [converted]
|
|
1174
|
+
*/
|
|
1175
|
+
/**
|
|
1176
|
+
* @typedef PromiseFormatted
|
|
1177
|
+
* @property {string} [max]
|
|
1178
|
+
* @property {string} [min]
|
|
1179
|
+
*/
|
|
1180
|
+
/**
|
|
1181
|
+
* @typedef PromiseTimestamp
|
|
1182
|
+
* @property {number} [max]
|
|
1183
|
+
* @property {number} [min]
|
|
1184
|
+
*/
|
|
1185
|
+
/**
|
|
1186
|
+
* @typedef PromoMeta
|
|
1187
|
+
* @property {string} [message]
|
|
1188
|
+
*/
|
|
1189
|
+
/**
|
|
1190
|
+
* @typedef PromotionAction
|
|
1191
|
+
* @property {string} action_date
|
|
1192
|
+
* @property {string} action_type
|
|
1193
|
+
*/
|
|
1194
|
+
/**
|
|
1195
|
+
* @typedef PromotionAdd
|
|
1196
|
+
* @property {Object} [_custom_json]
|
|
1197
|
+
* @property {PromotionSchedule} [_schedule]
|
|
1198
|
+
* @property {string} application_id
|
|
1199
|
+
* @property {boolean} [apply_all_discount]
|
|
1200
|
+
* @property {string} [apply_exclusive]
|
|
1201
|
+
* @property {number} [apply_priority]
|
|
1202
|
+
* @property {PromotionAuthor} [author]
|
|
1203
|
+
* @property {Object} buy_rules
|
|
1204
|
+
* @property {string} [calculate_on] - Only available for Contract pricing and
|
|
1205
|
+
* Ladder pricing promotion type
|
|
1206
|
+
* @property {string} [code]
|
|
1207
|
+
* @property {string} [currency]
|
|
1208
|
+
* @property {PromotionDateMeta} [date_meta]
|
|
1209
|
+
* @property {DiscountRule[]} discount_rules
|
|
1210
|
+
* @property {DisplayMeta1} display_meta
|
|
1211
|
+
* @property {string} mode
|
|
1212
|
+
* @property {Ownership1} ownership
|
|
1213
|
+
* @property {PromotionAction} [post_order_action]
|
|
1214
|
+
* @property {string} promo_group
|
|
1215
|
+
* @property {string} promotion_type
|
|
1216
|
+
* @property {Restrictions1} [restrictions]
|
|
1217
|
+
* @property {boolean} [stackable]
|
|
1218
|
+
* @property {Visibility} [visiblility]
|
|
1219
|
+
*/
|
|
1220
|
+
/**
|
|
1221
|
+
* @typedef PromotionAuthor
|
|
1222
|
+
* @property {string} [created_by]
|
|
1223
|
+
* @property {string} [modified_by]
|
|
1224
|
+
*/
|
|
1225
|
+
/**
|
|
1226
|
+
* @typedef PromotionDateMeta
|
|
1227
|
+
* @property {string} [created_on]
|
|
1228
|
+
* @property {string} [modified_on]
|
|
1229
|
+
*/
|
|
1230
|
+
/**
|
|
1231
|
+
* @typedef PromotionListItem
|
|
1232
|
+
* @property {Object} [_custom_json]
|
|
1233
|
+
* @property {PromotionSchedule} [_schedule]
|
|
1234
|
+
* @property {string} application_id
|
|
1235
|
+
* @property {boolean} [apply_all_discount]
|
|
1236
|
+
* @property {string} [apply_exclusive]
|
|
1237
|
+
* @property {number} [apply_priority]
|
|
1238
|
+
* @property {PromotionAuthor} [author]
|
|
1239
|
+
* @property {Object} buy_rules
|
|
1240
|
+
* @property {string} [calculate_on] - Only available for Contract pricing and
|
|
1241
|
+
* Ladder pricing promotion type
|
|
1242
|
+
* @property {string} [code]
|
|
1243
|
+
* @property {string} [currency]
|
|
1244
|
+
* @property {PromotionDateMeta} [date_meta]
|
|
1245
|
+
* @property {DiscountRule[]} discount_rules
|
|
1246
|
+
* @property {DisplayMeta1} display_meta
|
|
1247
|
+
* @property {string} mode
|
|
1248
|
+
* @property {Ownership1} ownership
|
|
1249
|
+
* @property {PromotionAction} [post_order_action]
|
|
1250
|
+
* @property {string} promo_group
|
|
1251
|
+
* @property {string} promotion_type
|
|
1252
|
+
* @property {Restrictions1} [restrictions]
|
|
1253
|
+
* @property {boolean} [stackable]
|
|
1254
|
+
* @property {Visibility} [visiblility]
|
|
1255
|
+
*/
|
|
1256
|
+
/**
|
|
1257
|
+
* @typedef PromotionPartialUpdate
|
|
1258
|
+
* @property {boolean} [archive] - Send true to unpublish promotion
|
|
1259
|
+
* @property {PromotionSchedule} [schedule]
|
|
1260
|
+
*/
|
|
1261
|
+
/**
|
|
1262
|
+
* @typedef PromotionPaymentModes
|
|
1263
|
+
* @property {string[]} [codes]
|
|
1264
|
+
* @property {string} type
|
|
1265
|
+
* @property {PaymentAllowValue1} [uses]
|
|
1266
|
+
*/
|
|
1267
|
+
/**
|
|
1268
|
+
* @typedef PromotionSchedule
|
|
1269
|
+
* @property {string} [cron]
|
|
1270
|
+
* @property {number} [duration]
|
|
1271
|
+
* @property {string} end
|
|
1272
|
+
* @property {Object[]} [next_schedule]
|
|
1273
|
+
* @property {boolean} published
|
|
1274
|
+
* @property {string} start
|
|
1275
|
+
*/
|
|
1276
|
+
/**
|
|
1277
|
+
* @typedef PromotionsResponse
|
|
1278
|
+
* @property {PromotionListItem[]} [items]
|
|
1279
|
+
* @property {Page} [page]
|
|
1280
|
+
*/
|
|
1281
|
+
/**
|
|
1282
|
+
* @typedef PromotionUpdate
|
|
1283
|
+
* @property {Object} [_custom_json]
|
|
1284
|
+
* @property {PromotionSchedule} [_schedule]
|
|
1285
|
+
* @property {string} application_id
|
|
1286
|
+
* @property {boolean} [apply_all_discount]
|
|
1287
|
+
* @property {string} [apply_exclusive]
|
|
1288
|
+
* @property {number} [apply_priority]
|
|
1289
|
+
* @property {PromotionAuthor} [author]
|
|
1290
|
+
* @property {Object} buy_rules
|
|
1291
|
+
* @property {string} [calculate_on] - Only available for Contract pricing and
|
|
1292
|
+
* Ladder pricing promotion type
|
|
1293
|
+
* @property {string} [code]
|
|
1294
|
+
* @property {string} [currency]
|
|
1295
|
+
* @property {PromotionDateMeta} [date_meta]
|
|
1296
|
+
* @property {DiscountRule[]} discount_rules
|
|
1297
|
+
* @property {DisplayMeta1} display_meta
|
|
1298
|
+
* @property {string} mode
|
|
1299
|
+
* @property {Ownership1} ownership
|
|
1300
|
+
* @property {PromotionAction} [post_order_action]
|
|
1301
|
+
* @property {string} promo_group
|
|
1302
|
+
* @property {string} promotion_type
|
|
1303
|
+
* @property {Restrictions1} [restrictions]
|
|
1304
|
+
* @property {boolean} [stackable]
|
|
1305
|
+
* @property {Visibility} [visiblility]
|
|
1306
|
+
*/
|
|
1307
|
+
/**
|
|
1308
|
+
* @typedef RawBreakup
|
|
1309
|
+
* @property {number} [cod_charge]
|
|
1310
|
+
* @property {number} [convenience_fee]
|
|
1311
|
+
* @property {number} [coupon]
|
|
1312
|
+
* @property {number} [delivery_charge]
|
|
1313
|
+
* @property {number} [discount]
|
|
1314
|
+
* @property {number} [fynd_cash]
|
|
1315
|
+
* @property {number} [gift_card]
|
|
1316
|
+
* @property {number} [gst_charges]
|
|
1317
|
+
* @property {number} [mrp_total]
|
|
1318
|
+
* @property {number} [subtotal]
|
|
1319
|
+
* @property {number} [total]
|
|
1320
|
+
* @property {number} [vog]
|
|
1321
|
+
* @property {number} [you_saved]
|
|
1322
|
+
*/
|
|
1323
|
+
/**
|
|
1324
|
+
* @typedef Restrictions
|
|
1325
|
+
* @property {BulkBundleRestriction} [bulk_bundle]
|
|
1326
|
+
* @property {boolean} [coupon_allowed]
|
|
1327
|
+
* @property {number[]} [ordering_stores]
|
|
1328
|
+
* @property {Object} [payments]
|
|
1329
|
+
* @property {string[]} [platforms]
|
|
1330
|
+
* @property {PostOrder} [post_order]
|
|
1331
|
+
* @property {PriceRange} [price_range]
|
|
1332
|
+
* @property {number[]} [user_groups]
|
|
1333
|
+
* @property {string} [user_type]
|
|
1334
|
+
* @property {UsesRestriction} [uses]
|
|
1335
|
+
*/
|
|
1336
|
+
/**
|
|
1337
|
+
* @typedef Restrictions1
|
|
1338
|
+
* @property {boolean} [anonymous_users]
|
|
1339
|
+
* @property {number} [order_quantity]
|
|
1340
|
+
* @property {number[]} [ordering_stores]
|
|
1341
|
+
* @property {PromotionPaymentModes[]} [payments]
|
|
1342
|
+
* @property {string[]} [platforms]
|
|
1343
|
+
* @property {PostOrder1} [post_order]
|
|
1344
|
+
* @property {number[]} [user_groups]
|
|
1345
|
+
* @property {string[]} [user_id]
|
|
1346
|
+
* @property {UserRegistered} [user_registered]
|
|
1347
|
+
* @property {UsesRestriction1} uses
|
|
1348
|
+
*/
|
|
1349
|
+
/**
|
|
1350
|
+
* @typedef Rule
|
|
1351
|
+
* @property {number} [discount_qty]
|
|
1352
|
+
* @property {number} [key]
|
|
1353
|
+
* @property {number} [max]
|
|
1354
|
+
* @property {number} [min]
|
|
1355
|
+
* @property {number} [value]
|
|
1356
|
+
*/
|
|
1357
|
+
/**
|
|
1358
|
+
* @typedef RuleDefinition
|
|
1359
|
+
* @property {string} applicable_on
|
|
1360
|
+
* @property {boolean} [auto_apply]
|
|
1361
|
+
* @property {string} calculate_on
|
|
1362
|
+
* @property {string} [currency_code]
|
|
1363
|
+
* @property {boolean} [is_exact]
|
|
1364
|
+
* @property {string[]} [scope]
|
|
1365
|
+
* @property {string} type
|
|
1366
|
+
* @property {string} value_type
|
|
1367
|
+
*/
|
|
1368
|
+
/**
|
|
1369
|
+
* @typedef SaveAddressResponse
|
|
1370
|
+
* @property {string} [id]
|
|
1371
|
+
* @property {boolean} [is_default_address]
|
|
1372
|
+
* @property {boolean} [success]
|
|
1373
|
+
*/
|
|
1374
|
+
/**
|
|
1375
|
+
* @typedef SharedCart
|
|
1376
|
+
* @property {CartBreakup} [breakup_values]
|
|
1377
|
+
* @property {boolean} [buy_now]
|
|
1378
|
+
* @property {number} [cart_id]
|
|
1379
|
+
* @property {string} [checkout_mode]
|
|
1380
|
+
* @property {string} [comment]
|
|
1381
|
+
* @property {string} [coupon_text]
|
|
1382
|
+
* @property {CartCurrency} [currency]
|
|
1383
|
+
* @property {string} [delivery_charge_info]
|
|
1384
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
1385
|
+
* @property {string} [gstin]
|
|
1386
|
+
* @property {string} [id]
|
|
1387
|
+
* @property {boolean} [is_valid]
|
|
1388
|
+
* @property {CartProductInfo[]} [items]
|
|
1389
|
+
* @property {string} [last_modified]
|
|
1390
|
+
* @property {string} [message]
|
|
1391
|
+
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
1392
|
+
* @property {boolean} [restrict_checkout]
|
|
1393
|
+
* @property {SharedCartDetails} [shared_cart_details]
|
|
1394
|
+
* @property {string} [uid]
|
|
1395
|
+
*/
|
|
1396
|
+
/**
|
|
1397
|
+
* @typedef SharedCartDetails
|
|
1398
|
+
* @property {string} [created_on]
|
|
1399
|
+
* @property {Object} [meta] - Meta data sent while generating share cart link
|
|
1400
|
+
* @property {Object} [source] - Share link device and other source information
|
|
1401
|
+
* @property {string} [token] - Short link id
|
|
1402
|
+
* @property {Object} [user] - User details of who generated share link
|
|
1403
|
+
*/
|
|
1404
|
+
/**
|
|
1405
|
+
* @typedef SharedCartResponse
|
|
1406
|
+
* @property {SharedCart} [cart]
|
|
1407
|
+
* @property {string} [error]
|
|
1408
|
+
*/
|
|
1409
|
+
/**
|
|
1410
|
+
* @typedef ShipmentArticle
|
|
1411
|
+
* @property {string} [article_id]
|
|
1412
|
+
* @property {string} [meta]
|
|
1413
|
+
* @property {string} [quantity]
|
|
1414
|
+
*/
|
|
1415
|
+
/**
|
|
1416
|
+
* @typedef ShipmentPromise
|
|
1417
|
+
* @property {PromiseFormatted} [formatted]
|
|
1418
|
+
* @property {PromiseTimestamp} [timestamp]
|
|
1419
|
+
*/
|
|
1420
|
+
/**
|
|
1421
|
+
* @typedef ShippingAddress
|
|
1422
|
+
* @property {string} [address]
|
|
1423
|
+
* @property {string} [address_type]
|
|
1424
|
+
* @property {string} [area]
|
|
1425
|
+
* @property {string} area_code
|
|
1426
|
+
* @property {string} [area_code_slug]
|
|
1427
|
+
* @property {string} [city]
|
|
1428
|
+
* @property {string} [country]
|
|
1429
|
+
* @property {string} [country_code]
|
|
1430
|
+
* @property {string} [country_iso_code]
|
|
1431
|
+
* @property {string} [country_phone_code]
|
|
1432
|
+
* @property {string} [email]
|
|
1433
|
+
* @property {string} [landmark]
|
|
1434
|
+
* @property {Object} [meta]
|
|
1435
|
+
* @property {string} [name]
|
|
1436
|
+
* @property {number} [phone]
|
|
1437
|
+
* @property {number} [pincode]
|
|
1438
|
+
* @property {string} [state]
|
|
1439
|
+
*/
|
|
1440
|
+
/**
|
|
1441
|
+
* @typedef StaffCheckout
|
|
1442
|
+
* @property {string} _id
|
|
1443
|
+
* @property {string} [employee_code]
|
|
1444
|
+
* @property {string} first_name
|
|
1445
|
+
* @property {string} last_name
|
|
1446
|
+
* @property {string} user
|
|
1447
|
+
*/
|
|
1448
|
+
/**
|
|
1449
|
+
* @typedef State
|
|
1450
|
+
* @property {boolean} [is_archived]
|
|
1451
|
+
* @property {boolean} [is_display]
|
|
1452
|
+
* @property {boolean} [is_public]
|
|
1453
|
+
*/
|
|
1454
|
+
/**
|
|
1455
|
+
* @typedef StoreDetailsResponse
|
|
1456
|
+
* @property {PickupStoreDetail[]} [items]
|
|
1457
|
+
*/
|
|
1458
|
+
/**
|
|
1459
|
+
* @typedef StoreInfo
|
|
1460
|
+
* @property {string} [name]
|
|
1461
|
+
* @property {string} [store_code]
|
|
1462
|
+
* @property {number} [uid]
|
|
1463
|
+
*/
|
|
1464
|
+
/**
|
|
1465
|
+
* @typedef SuccessMessage
|
|
1466
|
+
* @property {string} [message]
|
|
1467
|
+
* @property {boolean} [success]
|
|
1468
|
+
*/
|
|
1469
|
+
/**
|
|
1470
|
+
* @typedef Tags
|
|
1471
|
+
* @property {Object} [tags]
|
|
1472
|
+
*/
|
|
1473
|
+
/**
|
|
1474
|
+
* @typedef UpdateAddressResponse
|
|
1475
|
+
* @property {string} [id]
|
|
1476
|
+
* @property {boolean} [is_default_address]
|
|
1477
|
+
* @property {boolean} [is_updated]
|
|
1478
|
+
* @property {boolean} [success]
|
|
1479
|
+
*/
|
|
1480
|
+
/**
|
|
1481
|
+
* @typedef UpdateCartDetailResponse
|
|
1482
|
+
* @property {CartDetailResponse} [cart]
|
|
1483
|
+
* @property {string} [message]
|
|
1484
|
+
* @property {boolean} [success] - True if all items are added successfully.
|
|
1485
|
+
* False if partially added or not added.
|
|
1486
|
+
*/
|
|
1487
|
+
/**
|
|
1488
|
+
* @typedef UpdateCartPaymentRequest
|
|
1489
|
+
* @property {string} [address_id]
|
|
1490
|
+
* @property {string} [aggregator_name]
|
|
1491
|
+
* @property {string} [id]
|
|
1492
|
+
* @property {string} [merchant_code]
|
|
1493
|
+
* @property {string} [payment_identifier]
|
|
1494
|
+
* @property {string} [payment_mode]
|
|
1495
|
+
*/
|
|
1496
|
+
/**
|
|
1497
|
+
* @typedef UpdateCartPaymentRequestV2
|
|
1498
|
+
* @property {string} [address_id]
|
|
1499
|
+
* @property {string} [aggregator_name]
|
|
1500
|
+
* @property {string} [id]
|
|
1501
|
+
* @property {string} [merchant_code]
|
|
1502
|
+
* @property {string} [payment_identifier]
|
|
1503
|
+
* @property {PaymentMethod[]} [payment_methods]
|
|
1504
|
+
* @property {string} [payment_mode]
|
|
1505
|
+
*/
|
|
1506
|
+
/**
|
|
1507
|
+
* @typedef UpdateCartRequest
|
|
1508
|
+
* @property {UpdateProductCart[]} [items]
|
|
1509
|
+
* @property {string} operation
|
|
1510
|
+
*/
|
|
1511
|
+
/**
|
|
1512
|
+
* @typedef UpdateCartShipmentItem
|
|
1513
|
+
* @property {string} article_uid - Article mongo id
|
|
1514
|
+
* @property {number} [quantity] - Quantity of product in shipment
|
|
1515
|
+
* @property {string} shipment_type - Shipment delivery type
|
|
1516
|
+
*/
|
|
1517
|
+
/**
|
|
1518
|
+
* @typedef UpdateCartShipmentRequest
|
|
1519
|
+
* @property {UpdateCartShipmentItem[]} shipments
|
|
1520
|
+
*/
|
|
1521
|
+
/**
|
|
1522
|
+
* @typedef UpdateProductCart
|
|
1523
|
+
* @property {Object} [_custom_json]
|
|
1524
|
+
* @property {string} [article_id]
|
|
1525
|
+
* @property {Object} [extra_meta]
|
|
1526
|
+
* @property {CartProductIdentifer} identifiers
|
|
1527
|
+
* @property {number} [item_id]
|
|
1528
|
+
* @property {number} [item_index]
|
|
1529
|
+
* @property {string} [item_size]
|
|
1530
|
+
* @property {Object} [meta]
|
|
1531
|
+
* @property {Object} [parent_item_identifiers]
|
|
1532
|
+
* @property {number} [quantity]
|
|
1533
|
+
*/
|
|
1534
|
+
/**
|
|
1535
|
+
* @typedef UpdateUserCartMapping
|
|
1536
|
+
* @property {string} user_id
|
|
1537
|
+
*/
|
|
1538
|
+
/**
|
|
1539
|
+
* @typedef UserCartMappingResponse
|
|
1540
|
+
* @property {AppliedPromotion[]} [applied_promo_details]
|
|
1541
|
+
* @property {CartBreakup} [breakup_values]
|
|
1542
|
+
* @property {boolean} [buy_now]
|
|
1543
|
+
* @property {string} [checkout_mode]
|
|
1544
|
+
* @property {string} [comment]
|
|
1545
|
+
* @property {string} [coupon_text]
|
|
1546
|
+
* @property {CartCurrency} [currency]
|
|
1547
|
+
* @property {string} [delivery_charge_info]
|
|
1548
|
+
* @property {ShipmentPromise} [delivery_promise]
|
|
1549
|
+
* @property {string} [gstin]
|
|
1550
|
+
* @property {string} [id]
|
|
1551
|
+
* @property {boolean} [is_valid]
|
|
1552
|
+
* @property {CartProductInfo[]} [items]
|
|
1553
|
+
* @property {string} [last_modified]
|
|
1554
|
+
* @property {string} [message]
|
|
1555
|
+
* @property {Object} [pan_config]
|
|
1556
|
+
* @property {string} [pan_no]
|
|
1557
|
+
* @property {PaymentSelectionLock} [payment_selection_lock]
|
|
1558
|
+
* @property {boolean} [restrict_checkout]
|
|
1559
|
+
* @property {UserInfo} [user]
|
|
1560
|
+
*/
|
|
1561
|
+
/**
|
|
1562
|
+
* @typedef UserInfo
|
|
1563
|
+
* @property {string} [_id]
|
|
1564
|
+
* @property {string} [created_at]
|
|
1565
|
+
* @property {string} [external_id]
|
|
1566
|
+
* @property {string} [first_name]
|
|
1567
|
+
* @property {string} [gender]
|
|
1568
|
+
* @property {string} [last_name]
|
|
1569
|
+
* @property {string} [mobile]
|
|
1570
|
+
* @property {string} [modified_on]
|
|
1571
|
+
* @property {string} [uid]
|
|
1572
|
+
*/
|
|
1573
|
+
/**
|
|
1574
|
+
* @typedef UserRegistered
|
|
1575
|
+
* @property {string} [end]
|
|
1576
|
+
* @property {string} [start]
|
|
1577
|
+
*/
|
|
1578
|
+
/**
|
|
1579
|
+
* @typedef UsesRemaining
|
|
1580
|
+
* @property {number} [app]
|
|
1581
|
+
* @property {number} [total]
|
|
1582
|
+
* @property {number} [user]
|
|
1583
|
+
*/
|
|
1584
|
+
/**
|
|
1585
|
+
* @typedef UsesRemaining1
|
|
1586
|
+
* @property {number} [total]
|
|
1587
|
+
* @property {number} [user]
|
|
1588
|
+
*/
|
|
1589
|
+
/**
|
|
1590
|
+
* @typedef UsesRestriction
|
|
1591
|
+
* @property {UsesRemaining} [maximum]
|
|
1592
|
+
* @property {UsesRemaining} [remaining]
|
|
1593
|
+
*/
|
|
1594
|
+
/**
|
|
1595
|
+
* @typedef UsesRestriction1
|
|
1596
|
+
* @property {UsesRemaining1} [maximum]
|
|
1597
|
+
* @property {UsesRemaining1} [remaining]
|
|
1598
|
+
*/
|
|
1599
|
+
/**
|
|
1600
|
+
* @typedef Validation
|
|
1601
|
+
* @property {boolean} [anonymous]
|
|
1602
|
+
* @property {string[]} [app_id]
|
|
1603
|
+
* @property {string} [user_registered_after]
|
|
1604
|
+
*/
|
|
1605
|
+
/**
|
|
1606
|
+
* @typedef Validity
|
|
1607
|
+
* @property {number} [priority]
|
|
1608
|
+
*/
|
|
1609
|
+
/**
|
|
1610
|
+
* @typedef Visibility
|
|
1611
|
+
* @property {boolean} coupon_list
|
|
1612
|
+
* @property {boolean} pdp
|
|
1613
|
+
*/
|
|
1614
|
+
declare class CartPlatformModel {
|
|
176
1615
|
}
|
|
1616
|
+
declare namespace CartPlatformModel {
|
|
1617
|
+
export { AbandonedCart, AbandonedCartResponse, ActionQuery, ActivePromosResponse, AddCartDetailResponse, AddCartRequest, AddProductCart, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, Article, ArticlePriceInfo, BaseInfo, BasePrice, BulkBundleRestriction, BuyRules, CartBreakup, CartCheckoutResponse, CartCurrency, CartDeliveryModesResponse, CartDetailResponse, CartItem, CartItemCountResponse, CartItemMeta, CartList, CartMetaConfigAdd, CartMetaConfigUpdate, CartMetaMissingResponse, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CategoryInfo, Charges, CheckCart, Collection, CompareObject, Coupon, CouponAction, CouponAdd, CouponAuthor, CouponBreakup, CouponDateMeta, CouponDetails, CouponPartialUpdate, CouponSchedule, CouponsResponse, CouponUpdate, CouponValidity, DeleteAddressResponse, DeleteCartDetailResponse, DeleteCartRequest, DeliveryCharges, DiscountOffer, DiscountRule, DiscountRulesApp, DisplayBreakup, DisplayMeta, DisplayMeta1, DisplayMetaDict, Files, FreeGiftItem, GeoLocation, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, Identifier, ItemCriteria, LoyaltyPoints, MultiCartResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenapiCartDetailsRequest, OpenapiCartDetailsResponse, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiCheckoutResponse, OpenApiErrorResponse, OpenApiFiles, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OperationErrorResponse, OverrideCartItem, OverrideCartItemPromo, OverrideCheckoutReq, OverrideCheckoutResponse, Ownership, Ownership1, Ownership2, Page, PageCoupon, PaymentAllowValue, PaymentAllowValue1, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentModes, PaymentSelectionLock, PickupStoreDetail, PlatformAddCartRequest, PlatformAddress, PlatformCartCheckoutDetailRequest, PlatformCartCheckoutDetailV2Request, PlatformCartMetaRequest, PlatformCartShipmentsResponse, PlatformGetAddressesResponse, PlatformSelectCartAddressRequest, PlatformShipmentResponse, PlatformUpdateCartRequest, PostOrder, PostOrder1, PriceAdjustment, PriceAdjustmentAdd, PriceAdjustmentResponse, PriceAdjustmentUpdate, PriceRange, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionAction, PromotionAdd, PromotionAuthor, PromotionDateMeta, PromotionListItem, PromotionPartialUpdate, PromotionPaymentModes, PromotionSchedule, PromotionsResponse, PromotionUpdate, RawBreakup, Restrictions, Restrictions1, Rule, RuleDefinition, SaveAddressResponse, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentArticle, ShipmentPromise, ShippingAddress, StaffCheckout, State, StoreDetailsResponse, StoreInfo, SuccessMessage, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartPaymentRequestV2, UpdateCartRequest, UpdateCartShipmentItem, UpdateCartShipmentRequest, UpdateProductCart, UpdateUserCartMapping, UserCartMappingResponse, UserInfo, UserRegistered, UsesRemaining, UsesRemaining1, UsesRestriction, UsesRestriction1, Validation, Validity, Visibility };
|
|
1618
|
+
}
|
|
1619
|
+
/** @returns {AbandonedCart} */
|
|
1620
|
+
declare function AbandonedCart(): AbandonedCart;
|
|
1621
|
+
type AbandonedCart = {
|
|
1622
|
+
_id: string;
|
|
1623
|
+
app_id?: string;
|
|
1624
|
+
articles: any[];
|
|
1625
|
+
bulk_coupon_discount?: number;
|
|
1626
|
+
buy_now?: boolean;
|
|
1627
|
+
cart_value?: number;
|
|
1628
|
+
cashback: any;
|
|
1629
|
+
checkout_mode?: string;
|
|
1630
|
+
cod_charges?: any;
|
|
1631
|
+
comment?: string;
|
|
1632
|
+
coupon?: any;
|
|
1633
|
+
created_on: string;
|
|
1634
|
+
delivery_charges?: any;
|
|
1635
|
+
discount?: number;
|
|
1636
|
+
expire_at: string;
|
|
1637
|
+
fc_index_map?: number[];
|
|
1638
|
+
fynd_credits?: any;
|
|
1639
|
+
gstin?: string;
|
|
1640
|
+
is_active?: boolean;
|
|
1641
|
+
is_archive?: boolean;
|
|
1642
|
+
is_default: boolean;
|
|
1643
|
+
last_modified: string;
|
|
1644
|
+
merge_qty?: boolean;
|
|
1645
|
+
meta?: any;
|
|
1646
|
+
order_id?: string;
|
|
1647
|
+
payment_methods?: any[];
|
|
1648
|
+
payment_mode?: string;
|
|
1649
|
+
payments?: any;
|
|
1650
|
+
pick_up_customer_details?: any;
|
|
1651
|
+
promotion?: any;
|
|
1652
|
+
shipments?: any[];
|
|
1653
|
+
uid: number;
|
|
1654
|
+
user_id: string;
|
|
1655
|
+
};
|
|
1656
|
+
/** @returns {AbandonedCartResponse} */
|
|
1657
|
+
declare function AbandonedCartResponse(): AbandonedCartResponse;
|
|
1658
|
+
type AbandonedCartResponse = {
|
|
1659
|
+
items?: AbandonedCart[];
|
|
1660
|
+
/**
|
|
1661
|
+
* - Message of the response
|
|
1662
|
+
*/
|
|
1663
|
+
message?: string;
|
|
1664
|
+
page?: Page;
|
|
1665
|
+
result?: any;
|
|
1666
|
+
/**
|
|
1667
|
+
* - The request success is defined
|
|
1668
|
+
*/
|
|
1669
|
+
success?: boolean;
|
|
1670
|
+
};
|
|
1671
|
+
/** @returns {ActionQuery} */
|
|
1672
|
+
declare function ActionQuery(): ActionQuery;
|
|
1673
|
+
type ActionQuery = {
|
|
1674
|
+
/**
|
|
1675
|
+
* - Contains list of product slug
|
|
1676
|
+
*/
|
|
1677
|
+
product_slug?: string[];
|
|
1678
|
+
};
|
|
1679
|
+
/** @returns {ActivePromosResponse} */
|
|
1680
|
+
declare function ActivePromosResponse(): ActivePromosResponse;
|
|
1681
|
+
type ActivePromosResponse = {
|
|
1682
|
+
/**
|
|
1683
|
+
* - Coupon creation date
|
|
1684
|
+
*/
|
|
1685
|
+
created_on?: string;
|
|
1686
|
+
/**
|
|
1687
|
+
* - The description of the offer in the form of an HTML
|
|
1688
|
+
*/
|
|
1689
|
+
description?: string;
|
|
1690
|
+
entity_slug?: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* - Type of entity to be selected from :
|
|
1693
|
+
* ['coupon', 'promotion']
|
|
1694
|
+
*/
|
|
1695
|
+
entity_type?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* - Discount offers examples
|
|
1698
|
+
*/
|
|
1699
|
+
example?: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* - If the promo is active or not
|
|
1702
|
+
*/
|
|
1703
|
+
is_hidden?: boolean;
|
|
1704
|
+
/**
|
|
1705
|
+
* - Coupon modification date
|
|
1706
|
+
*/
|
|
1707
|
+
modified_on?: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* - Small description of the current offer
|
|
1710
|
+
*/
|
|
1711
|
+
subtitle?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* - Name of the promotion
|
|
1714
|
+
*/
|
|
1715
|
+
title?: string;
|
|
1716
|
+
/**
|
|
1717
|
+
* - Coupon type
|
|
1718
|
+
*/
|
|
1719
|
+
type?: string;
|
|
1720
|
+
};
|
|
1721
|
+
/** @returns {AddCartDetailResponse} */
|
|
1722
|
+
declare function AddCartDetailResponse(): AddCartDetailResponse;
|
|
1723
|
+
type AddCartDetailResponse = {
|
|
1724
|
+
cart?: CartDetailResponse;
|
|
1725
|
+
message?: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* - When adding multiple items check if all
|
|
1728
|
+
* added. True if only few are added.
|
|
1729
|
+
*/
|
|
1730
|
+
partial?: boolean;
|
|
1731
|
+
/**
|
|
1732
|
+
* - True if all items are added successfully.
|
|
1733
|
+
* False if partially added or not added.
|
|
1734
|
+
*/
|
|
1735
|
+
success?: boolean;
|
|
1736
|
+
};
|
|
1737
|
+
/** @returns {AddCartRequest} */
|
|
1738
|
+
declare function AddCartRequest(): AddCartRequest;
|
|
1739
|
+
type AddCartRequest = {
|
|
1740
|
+
items?: AddProductCart[];
|
|
1741
|
+
new_cart?: boolean;
|
|
1742
|
+
};
|
|
1743
|
+
/** @returns {AddProductCart} */
|
|
1744
|
+
declare function AddProductCart(): AddProductCart;
|
|
1745
|
+
type AddProductCart = {
|
|
1746
|
+
_custom_json?: any;
|
|
1747
|
+
article_assignment?: any;
|
|
1748
|
+
article_id?: string;
|
|
1749
|
+
display?: string;
|
|
1750
|
+
extra_meta?: any;
|
|
1751
|
+
item_id?: number;
|
|
1752
|
+
item_size?: string;
|
|
1753
|
+
meta?: any;
|
|
1754
|
+
parent_item_identifiers?: any[];
|
|
1755
|
+
pos?: boolean;
|
|
1756
|
+
product_group_tags?: string[];
|
|
1757
|
+
quantity?: number;
|
|
1758
|
+
seller_id?: number;
|
|
1759
|
+
store_id?: number;
|
|
1760
|
+
};
|
|
1761
|
+
/** @returns {AppliedFreeArticles} */
|
|
1762
|
+
declare function AppliedFreeArticles(): AppliedFreeArticles;
|
|
1763
|
+
type AppliedFreeArticles = {
|
|
1764
|
+
/**
|
|
1765
|
+
* - Free article id
|
|
1766
|
+
*/
|
|
1767
|
+
article_id?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* - Free gift items details
|
|
1770
|
+
*/
|
|
1771
|
+
free_gift_item_details?: FreeGiftItem;
|
|
1772
|
+
/**
|
|
1773
|
+
* - Parent item identifier for free article
|
|
1774
|
+
*/
|
|
1775
|
+
parent_item_identifier?: string;
|
|
1776
|
+
/**
|
|
1777
|
+
* - Free article quantity
|
|
1778
|
+
*/
|
|
1779
|
+
quantity?: number;
|
|
1780
|
+
};
|
|
1781
|
+
/** @returns {AppliedPromotion} */
|
|
1782
|
+
declare function AppliedPromotion(): AppliedPromotion;
|
|
1783
|
+
type AppliedPromotion = {
|
|
1784
|
+
/**
|
|
1785
|
+
* - Per unit discount amount applied with current promotion
|
|
1786
|
+
*/
|
|
1787
|
+
amount?: number;
|
|
1788
|
+
/**
|
|
1789
|
+
* - Applied free
|
|
1790
|
+
* article for free gift item promotions
|
|
1791
|
+
*/
|
|
1792
|
+
applied_free_articles?: AppliedFreeArticles[];
|
|
1793
|
+
/**
|
|
1794
|
+
* - Quantity of article on which
|
|
1795
|
+
* promotion is applicable
|
|
1796
|
+
*/
|
|
1797
|
+
article_quantity?: number;
|
|
1798
|
+
/**
|
|
1799
|
+
* - Buy rules for promotions
|
|
1800
|
+
*/
|
|
1801
|
+
buy_rules?: BuyRules[];
|
|
1802
|
+
/**
|
|
1803
|
+
* - Discount rules for promotions
|
|
1804
|
+
*/
|
|
1805
|
+
discount_rules?: DiscountRulesApp[];
|
|
1806
|
+
/**
|
|
1807
|
+
* - If applied promotion is applied on
|
|
1808
|
+
* product MRP or ESP
|
|
1809
|
+
*/
|
|
1810
|
+
mrp_promotion?: boolean;
|
|
1811
|
+
/**
|
|
1812
|
+
* - Offer text of current promotion
|
|
1813
|
+
*/
|
|
1814
|
+
offer_text?: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* - Ownership of promotion
|
|
1817
|
+
*/
|
|
1818
|
+
ownership?: Ownership2;
|
|
1819
|
+
/**
|
|
1820
|
+
* - Promotion id
|
|
1821
|
+
*/
|
|
1822
|
+
promo_id?: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* - Promotion group for the promotion
|
|
1825
|
+
*/
|
|
1826
|
+
promotion_group?: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* - Promotion name of current promotion
|
|
1829
|
+
*/
|
|
1830
|
+
promotion_name?: string;
|
|
1831
|
+
/**
|
|
1832
|
+
* - Promotion type of current promotion
|
|
1833
|
+
*/
|
|
1834
|
+
promotion_type?: string;
|
|
1835
|
+
};
|
|
1836
|
+
/** @returns {ApplyCouponRequest} */
|
|
1837
|
+
declare function ApplyCouponRequest(): ApplyCouponRequest;
|
|
1838
|
+
type ApplyCouponRequest = {
|
|
1839
|
+
/**
|
|
1840
|
+
* - Coupon code to be applied
|
|
1841
|
+
*/
|
|
1842
|
+
coupon_code: string;
|
|
1843
|
+
};
|
|
1844
|
+
/** @returns {Article} */
|
|
1845
|
+
declare function Article(): Article;
|
|
1846
|
+
type Article = {
|
|
1847
|
+
article_id: string;
|
|
1848
|
+
code?: string;
|
|
1849
|
+
meta?: any;
|
|
1850
|
+
type?: string;
|
|
1851
|
+
value?: number;
|
|
1852
|
+
};
|
|
1853
|
+
/** @returns {ArticlePriceInfo} */
|
|
1854
|
+
declare function ArticlePriceInfo(): ArticlePriceInfo;
|
|
1855
|
+
type ArticlePriceInfo = {
|
|
1856
|
+
base?: BasePrice;
|
|
1857
|
+
converted?: BasePrice;
|
|
1858
|
+
};
|
|
1859
|
+
/** @returns {BaseInfo} */
|
|
1860
|
+
declare function BaseInfo(): BaseInfo;
|
|
1861
|
+
type BaseInfo = {
|
|
1862
|
+
name?: string;
|
|
1863
|
+
uid?: number;
|
|
1864
|
+
};
|
|
1865
|
+
/** @returns {BasePrice} */
|
|
1866
|
+
declare function BasePrice(): BasePrice;
|
|
1867
|
+
type BasePrice = {
|
|
1868
|
+
currency_code?: string;
|
|
1869
|
+
currency_symbol?: string;
|
|
1870
|
+
effective?: number;
|
|
1871
|
+
marked?: number;
|
|
1872
|
+
};
|
|
1873
|
+
/** @returns {BulkBundleRestriction} */
|
|
1874
|
+
declare function BulkBundleRestriction(): BulkBundleRestriction;
|
|
1875
|
+
type BulkBundleRestriction = {
|
|
1876
|
+
multi_store_allowed: boolean;
|
|
1877
|
+
};
|
|
1878
|
+
/** @returns {BuyRules} */
|
|
1879
|
+
declare function BuyRules(): BuyRules;
|
|
1880
|
+
type BuyRules = {
|
|
1881
|
+
/**
|
|
1882
|
+
* - Cart conditions details for promotion
|
|
1883
|
+
*/
|
|
1884
|
+
cart_conditions?: any;
|
|
1885
|
+
/**
|
|
1886
|
+
* - Item criteria of promotion
|
|
1887
|
+
*/
|
|
1888
|
+
item_criteria?: any;
|
|
1889
|
+
};
|
|
1890
|
+
/** @returns {CartBreakup} */
|
|
1891
|
+
declare function CartBreakup(): CartBreakup;
|
|
1892
|
+
type CartBreakup = {
|
|
1893
|
+
coupon?: CouponBreakup;
|
|
1894
|
+
display?: DisplayBreakup[];
|
|
1895
|
+
loyalty_points?: LoyaltyPoints;
|
|
1896
|
+
raw?: RawBreakup;
|
|
1897
|
+
};
|
|
1898
|
+
/** @returns {CartCheckoutResponse} */
|
|
1899
|
+
declare function CartCheckoutResponse(): CartCheckoutResponse;
|
|
1900
|
+
type CartCheckoutResponse = {
|
|
1901
|
+
app_intercept_url?: string;
|
|
1902
|
+
callback_url?: string;
|
|
1903
|
+
cart?: CheckCart;
|
|
1904
|
+
data?: any;
|
|
1905
|
+
message?: string;
|
|
1906
|
+
order_id?: string;
|
|
1907
|
+
payment_confirm_url?: string;
|
|
1908
|
+
success?: boolean;
|
|
1909
|
+
};
|
|
1910
|
+
/** @returns {CartCurrency} */
|
|
1911
|
+
declare function CartCurrency(): CartCurrency;
|
|
1912
|
+
type CartCurrency = {
|
|
1913
|
+
/**
|
|
1914
|
+
* - Currency code defined by ISO 4217:2015
|
|
1915
|
+
*/
|
|
1916
|
+
code?: string;
|
|
1917
|
+
symbol?: string;
|
|
1918
|
+
};
|
|
1919
|
+
/** @returns {CartDeliveryModesResponse} */
|
|
1920
|
+
declare function CartDeliveryModesResponse(): CartDeliveryModesResponse;
|
|
1921
|
+
type CartDeliveryModesResponse = {
|
|
1922
|
+
/**
|
|
1923
|
+
* - Available delivery modes
|
|
1924
|
+
*/
|
|
1925
|
+
available_modes?: string[];
|
|
1926
|
+
/**
|
|
1927
|
+
* - Store pick up available store uids
|
|
1928
|
+
*/
|
|
1929
|
+
pickup_stores?: number[];
|
|
1930
|
+
};
|
|
1931
|
+
/** @returns {CartDetailResponse} */
|
|
1932
|
+
declare function CartDetailResponse(): CartDetailResponse;
|
|
1933
|
+
type CartDetailResponse = {
|
|
1934
|
+
applied_promo_details?: AppliedPromotion[];
|
|
1935
|
+
breakup_values?: CartBreakup;
|
|
1936
|
+
buy_now?: boolean;
|
|
1937
|
+
checkout_mode?: string;
|
|
1938
|
+
comment?: string;
|
|
1939
|
+
coupon_text?: string;
|
|
1940
|
+
currency?: CartCurrency;
|
|
1941
|
+
delivery_charge_info?: string;
|
|
1942
|
+
delivery_promise?: ShipmentPromise;
|
|
1943
|
+
gstin?: string;
|
|
1944
|
+
id?: string;
|
|
1945
|
+
is_valid?: boolean;
|
|
1946
|
+
items?: CartProductInfo[];
|
|
1947
|
+
last_modified?: string;
|
|
1948
|
+
message?: string;
|
|
1949
|
+
pan_config?: any;
|
|
1950
|
+
pan_no?: string;
|
|
1951
|
+
payment_selection_lock?: PaymentSelectionLock;
|
|
1952
|
+
restrict_checkout?: boolean;
|
|
1953
|
+
};
|
|
1954
|
+
/** @returns {CartItem} */
|
|
1955
|
+
declare function CartItem(): CartItem;
|
|
1956
|
+
type CartItem = {
|
|
1957
|
+
product_id: string;
|
|
1958
|
+
quantity?: number;
|
|
1959
|
+
size: string;
|
|
1960
|
+
};
|
|
1961
|
+
/** @returns {CartItemCountResponse} */
|
|
1962
|
+
declare function CartItemCountResponse(): CartItemCountResponse;
|
|
1963
|
+
type CartItemCountResponse = {
|
|
1964
|
+
/**
|
|
1965
|
+
* - Item count present in cart
|
|
1966
|
+
*/
|
|
1967
|
+
user_cart_items_count?: number;
|
|
1968
|
+
};
|
|
1969
|
+
/** @returns {CartItemMeta} */
|
|
1970
|
+
declare function CartItemMeta(): CartItemMeta;
|
|
1971
|
+
type CartItemMeta = {
|
|
1972
|
+
group_id?: string;
|
|
1973
|
+
primary_item?: boolean;
|
|
1974
|
+
};
|
|
1975
|
+
/** @returns {CartList} */
|
|
1976
|
+
declare function CartList(): CartList;
|
|
1977
|
+
type CartList = {
|
|
1978
|
+
cart_id?: string;
|
|
1979
|
+
cart_value?: number;
|
|
1980
|
+
created_on?: string;
|
|
1981
|
+
item_counts?: number;
|
|
1982
|
+
pick_up_customer_details?: any;
|
|
1983
|
+
user_id?: string;
|
|
1984
|
+
};
|
|
1985
|
+
/** @returns {CartMetaConfigAdd} */
|
|
1986
|
+
declare function CartMetaConfigAdd(): CartMetaConfigAdd;
|
|
1987
|
+
type CartMetaConfigAdd = {
|
|
1988
|
+
bulk_coupons?: boolean;
|
|
1989
|
+
delivery_charges?: DeliveryCharges;
|
|
1990
|
+
enabled?: boolean;
|
|
1991
|
+
gift_display_text?: string;
|
|
1992
|
+
gift_pricing?: number;
|
|
1993
|
+
max_cart_items?: number;
|
|
1994
|
+
min_cart_value?: number;
|
|
1995
|
+
revenue_engine_coupon?: boolean;
|
|
1996
|
+
};
|
|
1997
|
+
/** @returns {CartMetaConfigUpdate} */
|
|
1998
|
+
declare function CartMetaConfigUpdate(): CartMetaConfigUpdate;
|
|
1999
|
+
type CartMetaConfigUpdate = {
|
|
2000
|
+
bulk_coupons?: boolean;
|
|
2001
|
+
delivery_charges?: DeliveryCharges;
|
|
2002
|
+
enabled?: boolean;
|
|
2003
|
+
gift_display_text?: string;
|
|
2004
|
+
gift_pricing?: number;
|
|
2005
|
+
max_cart_items?: number;
|
|
2006
|
+
min_cart_value?: number;
|
|
2007
|
+
revenue_engine_coupon?: boolean;
|
|
2008
|
+
};
|
|
2009
|
+
/** @returns {CartMetaMissingResponse} */
|
|
2010
|
+
declare function CartMetaMissingResponse(): CartMetaMissingResponse;
|
|
2011
|
+
type CartMetaMissingResponse = {
|
|
2012
|
+
errors?: string[];
|
|
2013
|
+
};
|
|
2014
|
+
/** @returns {CartMetaResponse} */
|
|
2015
|
+
declare function CartMetaResponse(): CartMetaResponse;
|
|
2016
|
+
type CartMetaResponse = {
|
|
2017
|
+
is_valid?: boolean;
|
|
2018
|
+
message?: string;
|
|
2019
|
+
};
|
|
2020
|
+
/** @returns {CartProduct} */
|
|
2021
|
+
declare function CartProduct(): CartProduct;
|
|
2022
|
+
type CartProduct = {
|
|
2023
|
+
_custom_json?: any;
|
|
2024
|
+
action?: ProductAction;
|
|
2025
|
+
brand?: BaseInfo;
|
|
2026
|
+
categories?: CategoryInfo[];
|
|
2027
|
+
images?: ProductImage[];
|
|
2028
|
+
item_code?: string;
|
|
2029
|
+
name?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* - Unique product url name generated via product
|
|
2032
|
+
* name and other meta data
|
|
2033
|
+
*/
|
|
2034
|
+
slug?: string;
|
|
2035
|
+
tags?: string[];
|
|
2036
|
+
teaser_tag?: Tags;
|
|
2037
|
+
type?: string;
|
|
2038
|
+
uid?: number;
|
|
2039
|
+
};
|
|
2040
|
+
/** @returns {CartProductIdentifer} */
|
|
2041
|
+
declare function CartProductIdentifer(): CartProductIdentifer;
|
|
2042
|
+
type CartProductIdentifer = {
|
|
2043
|
+
/**
|
|
2044
|
+
* - Article idenfier generated by cart
|
|
2045
|
+
*/
|
|
2046
|
+
identifier?: string;
|
|
2047
|
+
};
|
|
2048
|
+
/** @returns {CartProductInfo} */
|
|
2049
|
+
declare function CartProductInfo(): CartProductInfo;
|
|
2050
|
+
type CartProductInfo = {
|
|
2051
|
+
article?: ProductArticle;
|
|
2052
|
+
availability?: ProductAvailability;
|
|
2053
|
+
bulk_offer?: any;
|
|
2054
|
+
coupon?: CouponDetails;
|
|
2055
|
+
coupon_message?: string;
|
|
2056
|
+
custom_order?: any;
|
|
2057
|
+
delivery_promise?: ShipmentPromise;
|
|
2058
|
+
discount?: string;
|
|
2059
|
+
identifiers: CartProductIdentifer;
|
|
2060
|
+
is_set?: boolean;
|
|
2061
|
+
key?: string;
|
|
2062
|
+
message?: string;
|
|
2063
|
+
moq?: any;
|
|
2064
|
+
parent_item_identifiers?: any;
|
|
2065
|
+
price?: ProductPriceInfo;
|
|
2066
|
+
price_per_unit?: ProductPriceInfo;
|
|
2067
|
+
product?: CartProduct;
|
|
2068
|
+
promo_meta?: PromoMeta;
|
|
2069
|
+
promotions_applied?: AppliedPromotion[];
|
|
2070
|
+
quantity?: number;
|
|
2071
|
+
};
|
|
2072
|
+
/** @returns {CategoryInfo} */
|
|
2073
|
+
declare function CategoryInfo(): CategoryInfo;
|
|
2074
|
+
type CategoryInfo = {
|
|
2075
|
+
name?: string;
|
|
2076
|
+
/**
|
|
2077
|
+
* - Product Category Id
|
|
2078
|
+
*/
|
|
2079
|
+
uid?: number;
|
|
2080
|
+
};
|
|
2081
|
+
/** @returns {Charges} */
|
|
2082
|
+
declare function Charges(): Charges;
|
|
2083
|
+
type Charges = {
|
|
2084
|
+
charges?: number;
|
|
2085
|
+
threshold?: number;
|
|
2086
|
+
};
|
|
2087
|
+
/** @returns {CheckCart} */
|
|
2088
|
+
declare function CheckCart(): CheckCart;
|
|
2089
|
+
type CheckCart = {
|
|
2090
|
+
breakup_values?: CartBreakup;
|
|
2091
|
+
buy_now?: boolean;
|
|
2092
|
+
cart_id?: number;
|
|
2093
|
+
checkout_mode?: string;
|
|
2094
|
+
cod_available?: boolean;
|
|
2095
|
+
cod_charges?: number;
|
|
2096
|
+
cod_message?: string;
|
|
2097
|
+
comment?: string;
|
|
2098
|
+
coupon_text?: string;
|
|
2099
|
+
currency?: CartCurrency;
|
|
2100
|
+
delivery_charge_info?: string;
|
|
2101
|
+
delivery_charge_order_value?: number;
|
|
2102
|
+
delivery_charges?: number;
|
|
2103
|
+
delivery_promise?: ShipmentPromise;
|
|
2104
|
+
error_message?: string;
|
|
2105
|
+
gstin?: string;
|
|
2106
|
+
id?: string;
|
|
2107
|
+
is_valid?: boolean;
|
|
2108
|
+
items?: CartProductInfo[];
|
|
2109
|
+
last_modified?: string;
|
|
2110
|
+
message?: string;
|
|
2111
|
+
order_id?: string;
|
|
2112
|
+
payment_selection_lock?: PaymentSelectionLock;
|
|
2113
|
+
restrict_checkout?: boolean;
|
|
2114
|
+
store_code?: string;
|
|
2115
|
+
store_emps?: any[];
|
|
2116
|
+
success?: boolean;
|
|
2117
|
+
uid?: string;
|
|
2118
|
+
user_type?: string;
|
|
2119
|
+
};
|
|
2120
|
+
/** @returns {Collection} */
|
|
2121
|
+
declare function Collection(): Collection;
|
|
2122
|
+
type Collection = {
|
|
2123
|
+
collected_by: string;
|
|
2124
|
+
refund_by: string;
|
|
2125
|
+
};
|
|
2126
|
+
/** @returns {CompareObject} */
|
|
2127
|
+
declare function CompareObject(): CompareObject;
|
|
2128
|
+
type CompareObject = {
|
|
2129
|
+
equals?: number;
|
|
2130
|
+
greater_than?: number;
|
|
2131
|
+
greater_than_equals?: number;
|
|
2132
|
+
less_than?: number;
|
|
2133
|
+
less_than_equals?: number;
|
|
2134
|
+
};
|
|
2135
|
+
/** @returns {Coupon} */
|
|
2136
|
+
declare function Coupon(): Coupon;
|
|
2137
|
+
type Coupon = {
|
|
2138
|
+
coupon_code?: string;
|
|
2139
|
+
coupon_type?: string;
|
|
2140
|
+
coupon_value?: number;
|
|
2141
|
+
description?: string;
|
|
2142
|
+
expires_on?: string;
|
|
2143
|
+
is_applicable?: boolean;
|
|
2144
|
+
is_applied?: boolean;
|
|
2145
|
+
max_discount_value?: number;
|
|
2146
|
+
message?: string;
|
|
2147
|
+
minimum_cart_value?: number;
|
|
2148
|
+
sub_title?: string;
|
|
2149
|
+
title?: string;
|
|
2150
|
+
};
|
|
2151
|
+
/** @returns {CouponAction} */
|
|
2152
|
+
declare function CouponAction(): CouponAction;
|
|
2153
|
+
type CouponAction = {
|
|
2154
|
+
action_date?: string;
|
|
2155
|
+
txn_mode?: string;
|
|
2156
|
+
};
|
|
2157
|
+
/** @returns {CouponAdd} */
|
|
2158
|
+
declare function CouponAdd(): CouponAdd;
|
|
2159
|
+
type CouponAdd = {
|
|
2160
|
+
_schedule?: CouponSchedule;
|
|
2161
|
+
action?: CouponAction;
|
|
2162
|
+
author?: CouponAuthor;
|
|
2163
|
+
code: string;
|
|
2164
|
+
date_meta?: CouponDateMeta;
|
|
2165
|
+
display_meta: DisplayMeta;
|
|
2166
|
+
identifiers: Identifier;
|
|
2167
|
+
ownership: Ownership;
|
|
2168
|
+
restrictions?: Restrictions;
|
|
2169
|
+
rule: Rule[];
|
|
2170
|
+
rule_definition: RuleDefinition;
|
|
2171
|
+
state?: State;
|
|
2172
|
+
tags?: string[];
|
|
2173
|
+
type_slug: string;
|
|
2174
|
+
validation?: Validation;
|
|
2175
|
+
validity: Validity;
|
|
2176
|
+
};
|
|
2177
|
+
/** @returns {CouponAuthor} */
|
|
2178
|
+
declare function CouponAuthor(): CouponAuthor;
|
|
2179
|
+
type CouponAuthor = {
|
|
2180
|
+
created_by?: string;
|
|
2181
|
+
modified_by?: string;
|
|
2182
|
+
};
|
|
2183
|
+
/** @returns {CouponBreakup} */
|
|
2184
|
+
declare function CouponBreakup(): CouponBreakup;
|
|
2185
|
+
type CouponBreakup = {
|
|
2186
|
+
code?: string;
|
|
2187
|
+
coupon_type?: string;
|
|
2188
|
+
coupon_value?: number;
|
|
2189
|
+
description?: string;
|
|
2190
|
+
is_applied?: boolean;
|
|
2191
|
+
max_discount_value?: number;
|
|
2192
|
+
message?: string;
|
|
2193
|
+
minimum_cart_value?: number;
|
|
2194
|
+
sub_title?: string;
|
|
2195
|
+
title?: string;
|
|
2196
|
+
type?: string;
|
|
2197
|
+
uid?: string;
|
|
2198
|
+
value?: number;
|
|
2199
|
+
};
|
|
2200
|
+
/** @returns {CouponDateMeta} */
|
|
2201
|
+
declare function CouponDateMeta(): CouponDateMeta;
|
|
2202
|
+
type CouponDateMeta = {
|
|
2203
|
+
created_on?: string;
|
|
2204
|
+
modified_on?: string;
|
|
2205
|
+
};
|
|
2206
|
+
/** @returns {CouponDetails} */
|
|
2207
|
+
declare function CouponDetails(): CouponDetails;
|
|
2208
|
+
type CouponDetails = {
|
|
2209
|
+
code?: string;
|
|
2210
|
+
discount_single_quantity?: number;
|
|
2211
|
+
discount_total_quantity?: number;
|
|
2212
|
+
};
|
|
2213
|
+
/** @returns {CouponPartialUpdate} */
|
|
2214
|
+
declare function CouponPartialUpdate(): CouponPartialUpdate;
|
|
2215
|
+
type CouponPartialUpdate = {
|
|
2216
|
+
/**
|
|
2217
|
+
* - Send true to unpublish coupon
|
|
2218
|
+
*/
|
|
2219
|
+
archive?: boolean;
|
|
2220
|
+
schedule?: CouponSchedule;
|
|
2221
|
+
};
|
|
2222
|
+
/** @returns {CouponSchedule} */
|
|
2223
|
+
declare function CouponSchedule(): CouponSchedule;
|
|
2224
|
+
type CouponSchedule = {
|
|
2225
|
+
cron?: string;
|
|
2226
|
+
duration?: number;
|
|
2227
|
+
end?: string;
|
|
2228
|
+
next_schedule?: any[];
|
|
2229
|
+
start?: string;
|
|
2230
|
+
};
|
|
2231
|
+
/** @returns {CouponsResponse} */
|
|
2232
|
+
declare function CouponsResponse(): CouponsResponse;
|
|
2233
|
+
type CouponsResponse = {
|
|
2234
|
+
items?: CouponAdd;
|
|
2235
|
+
page?: Page;
|
|
2236
|
+
};
|
|
2237
|
+
/** @returns {CouponUpdate} */
|
|
2238
|
+
declare function CouponUpdate(): CouponUpdate;
|
|
2239
|
+
type CouponUpdate = {
|
|
2240
|
+
_schedule?: CouponSchedule;
|
|
2241
|
+
action?: CouponAction;
|
|
2242
|
+
author?: CouponAuthor;
|
|
2243
|
+
code: string;
|
|
2244
|
+
date_meta?: CouponDateMeta;
|
|
2245
|
+
display_meta: DisplayMeta;
|
|
2246
|
+
identifiers: Identifier;
|
|
2247
|
+
ownership: Ownership;
|
|
2248
|
+
restrictions?: Restrictions;
|
|
2249
|
+
rule: Rule[];
|
|
2250
|
+
rule_definition: RuleDefinition;
|
|
2251
|
+
state?: State;
|
|
2252
|
+
tags?: string[];
|
|
2253
|
+
type_slug: string;
|
|
2254
|
+
validation?: Validation;
|
|
2255
|
+
validity: Validity;
|
|
2256
|
+
};
|
|
2257
|
+
/** @returns {CouponValidity} */
|
|
2258
|
+
declare function CouponValidity(): CouponValidity;
|
|
2259
|
+
type CouponValidity = {
|
|
2260
|
+
code?: string;
|
|
2261
|
+
discount?: number;
|
|
2262
|
+
display_message_en?: string;
|
|
2263
|
+
next_validation_required?: boolean;
|
|
2264
|
+
title?: string;
|
|
2265
|
+
valid?: boolean;
|
|
2266
|
+
};
|
|
2267
|
+
/** @returns {DeleteAddressResponse} */
|
|
2268
|
+
declare function DeleteAddressResponse(): DeleteAddressResponse;
|
|
2269
|
+
type DeleteAddressResponse = {
|
|
2270
|
+
id?: string;
|
|
2271
|
+
is_deleted?: boolean;
|
|
2272
|
+
};
|
|
2273
|
+
/** @returns {DeleteCartDetailResponse} */
|
|
2274
|
+
declare function DeleteCartDetailResponse(): DeleteCartDetailResponse;
|
|
2275
|
+
type DeleteCartDetailResponse = {
|
|
2276
|
+
message?: string;
|
|
2277
|
+
/**
|
|
2278
|
+
* - True if cart is archived successfully. False
|
|
2279
|
+
* if not archived.
|
|
2280
|
+
*/
|
|
2281
|
+
success?: boolean;
|
|
2282
|
+
};
|
|
2283
|
+
/** @returns {DeleteCartRequest} */
|
|
2284
|
+
declare function DeleteCartRequest(): DeleteCartRequest;
|
|
2285
|
+
type DeleteCartRequest = {
|
|
2286
|
+
cart_id_list?: string[];
|
|
2287
|
+
};
|
|
2288
|
+
/** @returns {DeliveryCharges} */
|
|
2289
|
+
declare function DeliveryCharges(): DeliveryCharges;
|
|
2290
|
+
type DeliveryCharges = {
|
|
2291
|
+
charges?: Charges[];
|
|
2292
|
+
enabled?: boolean;
|
|
2293
|
+
};
|
|
2294
|
+
/** @returns {DiscountOffer} */
|
|
2295
|
+
declare function DiscountOffer(): DiscountOffer;
|
|
2296
|
+
type DiscountOffer = {
|
|
2297
|
+
apportion_discount?: boolean;
|
|
2298
|
+
code?: string;
|
|
2299
|
+
discount_amount?: number;
|
|
2300
|
+
discount_percentage?: number;
|
|
2301
|
+
discount_price?: number;
|
|
2302
|
+
max_discount_amount?: number;
|
|
2303
|
+
max_offer_quantity?: number;
|
|
2304
|
+
max_usage_per_transaction?: number;
|
|
2305
|
+
min_offer_quantity?: number;
|
|
2306
|
+
partial_can_ret?: boolean;
|
|
2307
|
+
};
|
|
2308
|
+
/** @returns {DiscountRule} */
|
|
2309
|
+
declare function DiscountRule(): DiscountRule;
|
|
2310
|
+
type DiscountRule = {
|
|
2311
|
+
buy_condition: string;
|
|
2312
|
+
discount_type: string;
|
|
2313
|
+
item_criteria: ItemCriteria;
|
|
2314
|
+
offer: DiscountOffer;
|
|
2315
|
+
};
|
|
2316
|
+
/** @returns {DiscountRulesApp} */
|
|
2317
|
+
declare function DiscountRulesApp(): DiscountRulesApp;
|
|
2318
|
+
type DiscountRulesApp = {
|
|
2319
|
+
/**
|
|
2320
|
+
* - Item criteria of promotion
|
|
2321
|
+
*/
|
|
2322
|
+
item_criteria?: any;
|
|
2323
|
+
/**
|
|
2324
|
+
* - Matched buy rules for promotion
|
|
2325
|
+
*/
|
|
2326
|
+
matched_buy_rules?: string[];
|
|
2327
|
+
/**
|
|
2328
|
+
* - Offer for promotion
|
|
2329
|
+
*/
|
|
2330
|
+
offer?: any;
|
|
2331
|
+
/**
|
|
2332
|
+
* - Raw offer details for promotion
|
|
2333
|
+
*/
|
|
2334
|
+
raw_offer?: any;
|
|
2335
|
+
};
|
|
2336
|
+
/** @returns {DisplayBreakup} */
|
|
2337
|
+
declare function DisplayBreakup(): DisplayBreakup;
|
|
2338
|
+
type DisplayBreakup = {
|
|
2339
|
+
currency_code?: string;
|
|
2340
|
+
currency_symbol?: string;
|
|
2341
|
+
display?: string;
|
|
2342
|
+
key?: string;
|
|
2343
|
+
message?: string[];
|
|
2344
|
+
value?: number;
|
|
2345
|
+
};
|
|
2346
|
+
/** @returns {DisplayMeta} */
|
|
2347
|
+
declare function DisplayMeta(): DisplayMeta;
|
|
2348
|
+
type DisplayMeta = {
|
|
2349
|
+
apply?: DisplayMetaDict;
|
|
2350
|
+
auto?: DisplayMetaDict;
|
|
2351
|
+
description?: string;
|
|
2352
|
+
remove?: DisplayMetaDict;
|
|
2353
|
+
subtitle?: string;
|
|
2354
|
+
title?: string;
|
|
2355
|
+
};
|
|
2356
|
+
/** @returns {DisplayMeta1} */
|
|
2357
|
+
declare function DisplayMeta1(): DisplayMeta1;
|
|
2358
|
+
type DisplayMeta1 = {
|
|
2359
|
+
description?: string;
|
|
2360
|
+
name?: string;
|
|
2361
|
+
offer_label?: string;
|
|
2362
|
+
offer_text?: string;
|
|
2363
|
+
};
|
|
2364
|
+
/** @returns {DisplayMetaDict} */
|
|
2365
|
+
declare function DisplayMetaDict(): DisplayMetaDict;
|
|
2366
|
+
type DisplayMetaDict = {
|
|
2367
|
+
subtitle?: string;
|
|
2368
|
+
title?: string;
|
|
2369
|
+
};
|
|
2370
|
+
/** @returns {Files} */
|
|
2371
|
+
declare function Files(): Files;
|
|
2372
|
+
type Files = {
|
|
2373
|
+
key: string;
|
|
2374
|
+
values: string[];
|
|
2375
|
+
};
|
|
2376
|
+
/** @returns {FreeGiftItem} */
|
|
2377
|
+
declare function FreeGiftItem(): FreeGiftItem;
|
|
2378
|
+
type FreeGiftItem = {
|
|
2379
|
+
/**
|
|
2380
|
+
* - Item brand name
|
|
2381
|
+
*/
|
|
2382
|
+
item_brand_name?: string;
|
|
2383
|
+
/**
|
|
2384
|
+
* - Item id
|
|
2385
|
+
*/
|
|
2386
|
+
item_id?: number;
|
|
2387
|
+
/**
|
|
2388
|
+
* - Item images URL
|
|
2389
|
+
*/
|
|
2390
|
+
item_images_url?: string[];
|
|
2391
|
+
/**
|
|
2392
|
+
* - Item name
|
|
2393
|
+
*/
|
|
2394
|
+
item_name?: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* - Item price details
|
|
2397
|
+
*/
|
|
2398
|
+
item_price_details?: any;
|
|
2399
|
+
/**
|
|
2400
|
+
* - Item slug
|
|
2401
|
+
*/
|
|
2402
|
+
item_slug?: string;
|
|
2403
|
+
};
|
|
2404
|
+
/** @returns {GeoLocation} */
|
|
2405
|
+
declare function GeoLocation(): GeoLocation;
|
|
2406
|
+
type GeoLocation = {
|
|
2407
|
+
latitude?: number;
|
|
2408
|
+
longitude?: number;
|
|
2409
|
+
};
|
|
2410
|
+
/** @returns {GetCouponResponse} */
|
|
2411
|
+
declare function GetCouponResponse(): GetCouponResponse;
|
|
2412
|
+
type GetCouponResponse = {
|
|
2413
|
+
available_coupon_list?: Coupon[];
|
|
2414
|
+
page?: PageCoupon;
|
|
2415
|
+
};
|
|
2416
|
+
/** @returns {GetShareCartLinkRequest} */
|
|
2417
|
+
declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
|
|
2418
|
+
type GetShareCartLinkRequest = {
|
|
2419
|
+
/**
|
|
2420
|
+
* - Cart uid for generating sharing
|
|
2421
|
+
*/
|
|
2422
|
+
id?: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* - Staff, Ordering store or any other data. This
|
|
2425
|
+
* data will be used to generate link as well as sent as shared details.
|
|
2426
|
+
*/
|
|
2427
|
+
meta?: any;
|
|
2428
|
+
};
|
|
2429
|
+
/** @returns {GetShareCartLinkResponse} */
|
|
2430
|
+
declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
|
|
2431
|
+
type GetShareCartLinkResponse = {
|
|
2432
|
+
/**
|
|
2433
|
+
* - Short shareable final url
|
|
2434
|
+
*/
|
|
2435
|
+
share_url?: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* - Short url unique id
|
|
2438
|
+
*/
|
|
2439
|
+
token?: string;
|
|
2440
|
+
};
|
|
2441
|
+
/** @returns {Identifier} */
|
|
2442
|
+
declare function Identifier(): Identifier;
|
|
2443
|
+
type Identifier = {
|
|
2444
|
+
article_id?: string[];
|
|
2445
|
+
brand_id?: number[];
|
|
2446
|
+
category_id?: number[];
|
|
2447
|
+
collection_id?: string[];
|
|
2448
|
+
company_id?: number[];
|
|
2449
|
+
email_domain?: string[];
|
|
2450
|
+
exclude_brand_id?: number[];
|
|
2451
|
+
item_id?: number[];
|
|
2452
|
+
store_id?: number[];
|
|
2453
|
+
user_id?: string[];
|
|
2454
|
+
};
|
|
2455
|
+
/** @returns {ItemCriteria} */
|
|
2456
|
+
declare function ItemCriteria(): ItemCriteria;
|
|
2457
|
+
type ItemCriteria = {
|
|
2458
|
+
all_items?: boolean;
|
|
2459
|
+
available_zones?: string[];
|
|
2460
|
+
buy_rules?: string[];
|
|
2461
|
+
cart_quantity?: CompareObject;
|
|
2462
|
+
cart_total?: CompareObject;
|
|
2463
|
+
cart_unique_item_amount?: CompareObject;
|
|
2464
|
+
cart_unique_item_quantity?: CompareObject;
|
|
2465
|
+
item_brand?: number[];
|
|
2466
|
+
item_category?: number[];
|
|
2467
|
+
item_company?: number[];
|
|
2468
|
+
item_department?: number[];
|
|
2469
|
+
item_exclude_brand?: number[];
|
|
2470
|
+
item_exclude_category?: number[];
|
|
2471
|
+
item_exclude_company?: number[];
|
|
2472
|
+
item_exclude_department?: number[];
|
|
2473
|
+
item_exclude_id?: number[];
|
|
2474
|
+
item_exclude_l1_category?: number[];
|
|
2475
|
+
item_exclude_l2_category?: number[];
|
|
2476
|
+
item_exclude_sku?: string[];
|
|
2477
|
+
item_exclude_store?: number[];
|
|
2478
|
+
item_id?: number[];
|
|
2479
|
+
item_l1_category?: number[];
|
|
2480
|
+
item_l2_category?: number[];
|
|
2481
|
+
item_size?: string[];
|
|
2482
|
+
item_sku?: string[];
|
|
2483
|
+
item_store?: number[];
|
|
2484
|
+
item_tags?: string[];
|
|
2485
|
+
};
|
|
2486
|
+
/** @returns {LoyaltyPoints} */
|
|
2487
|
+
declare function LoyaltyPoints(): LoyaltyPoints;
|
|
2488
|
+
type LoyaltyPoints = {
|
|
2489
|
+
applicable?: number;
|
|
2490
|
+
description?: string;
|
|
2491
|
+
is_applied?: boolean;
|
|
2492
|
+
total?: number;
|
|
2493
|
+
};
|
|
2494
|
+
/** @returns {MultiCartResponse} */
|
|
2495
|
+
declare function MultiCartResponse(): MultiCartResponse;
|
|
2496
|
+
type MultiCartResponse = {
|
|
2497
|
+
data?: CartList[];
|
|
2498
|
+
success?: boolean;
|
|
2499
|
+
};
|
|
2500
|
+
/** @returns {MultiTenderPaymentMeta} */
|
|
2501
|
+
declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
|
|
2502
|
+
type MultiTenderPaymentMeta = {
|
|
2503
|
+
current_status?: string;
|
|
2504
|
+
extra_meta?: any;
|
|
2505
|
+
order_id?: string;
|
|
2506
|
+
payment_gateway?: string;
|
|
2507
|
+
payment_id?: string;
|
|
2508
|
+
};
|
|
2509
|
+
/** @returns {MultiTenderPaymentMethod} */
|
|
2510
|
+
declare function MultiTenderPaymentMethod(): MultiTenderPaymentMethod;
|
|
2511
|
+
type MultiTenderPaymentMethod = {
|
|
2512
|
+
/**
|
|
2513
|
+
* - Payment amount
|
|
2514
|
+
*/
|
|
2515
|
+
amount: number;
|
|
2516
|
+
meta?: MultiTenderPaymentMeta;
|
|
2517
|
+
mode: string;
|
|
2518
|
+
/**
|
|
2519
|
+
* - Payment mode name
|
|
2520
|
+
*/
|
|
2521
|
+
name?: string;
|
|
2522
|
+
};
|
|
2523
|
+
/** @returns {OpenapiCartDetailsRequest} */
|
|
2524
|
+
declare function OpenapiCartDetailsRequest(): OpenapiCartDetailsRequest;
|
|
2525
|
+
type OpenapiCartDetailsRequest = {
|
|
2526
|
+
cart_items: CartItem[];
|
|
2527
|
+
};
|
|
2528
|
+
/** @returns {OpenapiCartDetailsResponse} */
|
|
2529
|
+
declare function OpenapiCartDetailsResponse(): OpenapiCartDetailsResponse;
|
|
2530
|
+
type OpenapiCartDetailsResponse = {
|
|
2531
|
+
breakup_values?: CartBreakup;
|
|
2532
|
+
is_valid?: boolean;
|
|
2533
|
+
items?: CartProductInfo[];
|
|
2534
|
+
message?: string;
|
|
2535
|
+
};
|
|
2536
|
+
/** @returns {OpenApiCartServiceabilityRequest} */
|
|
2537
|
+
declare function OpenApiCartServiceabilityRequest(): OpenApiCartServiceabilityRequest;
|
|
2538
|
+
type OpenApiCartServiceabilityRequest = {
|
|
2539
|
+
cart_items: CartItem[];
|
|
2540
|
+
shipping_address: ShippingAddress;
|
|
2541
|
+
};
|
|
2542
|
+
/** @returns {OpenApiCartServiceabilityResponse} */
|
|
2543
|
+
declare function OpenApiCartServiceabilityResponse(): OpenApiCartServiceabilityResponse;
|
|
2544
|
+
type OpenApiCartServiceabilityResponse = {
|
|
2545
|
+
breakup_values?: CartBreakup;
|
|
2546
|
+
delivery_promise?: ShipmentPromise;
|
|
2547
|
+
is_valid?: boolean;
|
|
2548
|
+
items?: CartProductInfo[];
|
|
2549
|
+
message?: string;
|
|
2550
|
+
};
|
|
2551
|
+
/** @returns {OpenApiCheckoutResponse} */
|
|
2552
|
+
declare function OpenApiCheckoutResponse(): OpenApiCheckoutResponse;
|
|
2553
|
+
type OpenApiCheckoutResponse = {
|
|
2554
|
+
message?: string;
|
|
2555
|
+
/**
|
|
2556
|
+
* - Fynd order id
|
|
2557
|
+
*/
|
|
2558
|
+
order_id: string;
|
|
2559
|
+
/**
|
|
2560
|
+
* - Order id sent in request
|
|
2561
|
+
*/
|
|
2562
|
+
order_ref_id?: string;
|
|
2563
|
+
success?: boolean;
|
|
2564
|
+
};
|
|
2565
|
+
/** @returns {OpenApiErrorResponse} */
|
|
2566
|
+
declare function OpenApiErrorResponse(): OpenApiErrorResponse;
|
|
2567
|
+
type OpenApiErrorResponse = {
|
|
2568
|
+
/**
|
|
2569
|
+
* - Contains field name which has error as key and
|
|
2570
|
+
* error message as value
|
|
2571
|
+
*/
|
|
2572
|
+
errors?: any;
|
|
2573
|
+
message?: string;
|
|
2574
|
+
success?: boolean;
|
|
2575
|
+
};
|
|
2576
|
+
/** @returns {OpenApiFiles} */
|
|
2577
|
+
declare function OpenApiFiles(): OpenApiFiles;
|
|
2578
|
+
type OpenApiFiles = {
|
|
2579
|
+
key: string;
|
|
2580
|
+
values: string[];
|
|
2581
|
+
};
|
|
2582
|
+
/** @returns {OpenApiOrderItem} */
|
|
2583
|
+
declare function OpenApiOrderItem(): OpenApiOrderItem;
|
|
2584
|
+
type OpenApiOrderItem = {
|
|
2585
|
+
amount_paid: number;
|
|
2586
|
+
cashback_applied: number;
|
|
2587
|
+
cod_charges: number;
|
|
2588
|
+
coupon_effective_discount: number;
|
|
2589
|
+
delivery_charges: number;
|
|
2590
|
+
discount: number;
|
|
2591
|
+
employee_discount?: number;
|
|
2592
|
+
extra_meta?: any;
|
|
2593
|
+
files?: OpenApiFiles[];
|
|
2594
|
+
loyalty_discount?: number;
|
|
2595
|
+
meta?: CartItemMeta;
|
|
2596
|
+
payment_methods: MultiTenderPaymentMethod[];
|
|
2597
|
+
price_effective: number;
|
|
2598
|
+
price_marked: number;
|
|
2599
|
+
product_id: number;
|
|
2600
|
+
quantity?: number;
|
|
2601
|
+
size: string;
|
|
2602
|
+
};
|
|
2603
|
+
/** @returns {OpenApiPlatformCheckoutReq} */
|
|
2604
|
+
declare function OpenApiPlatformCheckoutReq(): OpenApiPlatformCheckoutReq;
|
|
2605
|
+
type OpenApiPlatformCheckoutReq = {
|
|
2606
|
+
affiliate_order_id?: string;
|
|
2607
|
+
billing_address: ShippingAddress;
|
|
2608
|
+
cart_items: OpenApiOrderItem[];
|
|
2609
|
+
cart_value: number;
|
|
2610
|
+
cashback_applied: number;
|
|
2611
|
+
cod_charges: number;
|
|
2612
|
+
comment?: string;
|
|
2613
|
+
coupon?: string;
|
|
2614
|
+
coupon_code: string;
|
|
2615
|
+
coupon_value: number;
|
|
2616
|
+
currency_code?: string;
|
|
2617
|
+
delivery_charges: number;
|
|
2618
|
+
employee_discount?: any;
|
|
2619
|
+
files?: OpenApiFiles[];
|
|
2620
|
+
gstin?: string;
|
|
2621
|
+
loyalty_discount?: number;
|
|
2622
|
+
order_id?: string;
|
|
2623
|
+
payment_methods: MultiTenderPaymentMethod[];
|
|
2624
|
+
payment_mode?: string;
|
|
2625
|
+
shipping_address?: ShippingAddress;
|
|
2626
|
+
};
|
|
2627
|
+
/** @returns {OperationErrorResponse} */
|
|
2628
|
+
declare function OperationErrorResponse(): OperationErrorResponse;
|
|
2629
|
+
type OperationErrorResponse = {
|
|
2630
|
+
message?: string;
|
|
2631
|
+
success?: boolean;
|
|
2632
|
+
};
|
|
2633
|
+
/** @returns {OverrideCartItem} */
|
|
2634
|
+
declare function OverrideCartItem(): OverrideCartItem;
|
|
2635
|
+
type OverrideCartItem = {
|
|
2636
|
+
amount_paid: number;
|
|
2637
|
+
discount: number;
|
|
2638
|
+
extra_meta?: any;
|
|
2639
|
+
item_id: number;
|
|
2640
|
+
price_effective: number;
|
|
2641
|
+
price_marked: number;
|
|
2642
|
+
promo_list?: OverrideCartItemPromo[];
|
|
2643
|
+
quantity?: number;
|
|
2644
|
+
seller_identifier?: string;
|
|
2645
|
+
size: string;
|
|
2646
|
+
};
|
|
2647
|
+
/** @returns {OverrideCartItemPromo} */
|
|
2648
|
+
declare function OverrideCartItemPromo(): OverrideCartItemPromo;
|
|
2649
|
+
type OverrideCartItemPromo = {
|
|
2650
|
+
item_list?: any[];
|
|
2651
|
+
promo_amount: string;
|
|
2652
|
+
promo_desc?: string;
|
|
2653
|
+
promo_id: string;
|
|
2654
|
+
rwrd_tndr?: string;
|
|
2655
|
+
};
|
|
2656
|
+
/** @returns {OverrideCheckoutReq} */
|
|
2657
|
+
declare function OverrideCheckoutReq(): OverrideCheckoutReq;
|
|
2658
|
+
type OverrideCheckoutReq = {
|
|
2659
|
+
aggregator: string;
|
|
2660
|
+
billing_address?: any;
|
|
2661
|
+
cart_id: string;
|
|
2662
|
+
cart_items: OverrideCartItem[];
|
|
2663
|
+
currency_code: string;
|
|
2664
|
+
merchant_code: string;
|
|
2665
|
+
order_type: string;
|
|
2666
|
+
ordering_store?: number;
|
|
2667
|
+
payment_identifier: string;
|
|
2668
|
+
payment_mode: string;
|
|
2669
|
+
shipping_address?: any;
|
|
2670
|
+
};
|
|
2671
|
+
/** @returns {OverrideCheckoutResponse} */
|
|
2672
|
+
declare function OverrideCheckoutResponse(): OverrideCheckoutResponse;
|
|
2673
|
+
type OverrideCheckoutResponse = {
|
|
2674
|
+
cart: any;
|
|
2675
|
+
data: any;
|
|
2676
|
+
message: string;
|
|
2677
|
+
order_id: string;
|
|
2678
|
+
success: string;
|
|
2679
|
+
};
|
|
2680
|
+
/** @returns {Ownership} */
|
|
2681
|
+
declare function Ownership(): Ownership;
|
|
2682
|
+
type Ownership = {
|
|
2683
|
+
payable_by: string;
|
|
2684
|
+
payable_category: string;
|
|
2685
|
+
};
|
|
2686
|
+
/** @returns {Ownership1} */
|
|
2687
|
+
declare function Ownership1(): Ownership1;
|
|
2688
|
+
type Ownership1 = {
|
|
2689
|
+
payable_by: string;
|
|
2690
|
+
payable_category: string;
|
|
2691
|
+
};
|
|
2692
|
+
/** @returns {Ownership2} */
|
|
2693
|
+
declare function Ownership2(): Ownership2;
|
|
2694
|
+
type Ownership2 = {
|
|
2695
|
+
/**
|
|
2696
|
+
* - Promo amount bearable party
|
|
2697
|
+
*/
|
|
2698
|
+
payable_by?: string;
|
|
2699
|
+
/**
|
|
2700
|
+
* - Promo amount payable category
|
|
2701
|
+
*/
|
|
2702
|
+
payable_category?: string;
|
|
2703
|
+
};
|
|
2704
|
+
/** @returns {Page} */
|
|
2705
|
+
declare function Page(): Page;
|
|
2706
|
+
type Page = {
|
|
2707
|
+
current?: number;
|
|
2708
|
+
has_next?: boolean;
|
|
2709
|
+
has_previous?: boolean;
|
|
2710
|
+
item_total?: number;
|
|
2711
|
+
next_id?: string;
|
|
2712
|
+
size?: number;
|
|
2713
|
+
type: string;
|
|
2714
|
+
};
|
|
2715
|
+
/** @returns {PageCoupon} */
|
|
2716
|
+
declare function PageCoupon(): PageCoupon;
|
|
2717
|
+
type PageCoupon = {
|
|
2718
|
+
current?: number;
|
|
2719
|
+
has_next?: boolean;
|
|
2720
|
+
has_previous?: boolean;
|
|
2721
|
+
total?: number;
|
|
2722
|
+
total_item_count?: number;
|
|
2723
|
+
};
|
|
2724
|
+
/** @returns {PaymentAllowValue} */
|
|
2725
|
+
declare function PaymentAllowValue(): PaymentAllowValue;
|
|
2726
|
+
type PaymentAllowValue = {
|
|
2727
|
+
max?: number;
|
|
2728
|
+
};
|
|
2729
|
+
/** @returns {PaymentAllowValue1} */
|
|
2730
|
+
declare function PaymentAllowValue1(): PaymentAllowValue1;
|
|
2731
|
+
type PaymentAllowValue1 = {
|
|
2732
|
+
max?: number;
|
|
2733
|
+
};
|
|
2734
|
+
/** @returns {PaymentCouponValidate} */
|
|
2735
|
+
declare function PaymentCouponValidate(): PaymentCouponValidate;
|
|
2736
|
+
type PaymentCouponValidate = {
|
|
2737
|
+
coupon_validity?: CouponValidity;
|
|
2738
|
+
message?: string;
|
|
2739
|
+
success: boolean;
|
|
2740
|
+
};
|
|
2741
|
+
/** @returns {PaymentMeta} */
|
|
2742
|
+
declare function PaymentMeta(): PaymentMeta;
|
|
2743
|
+
type PaymentMeta = {
|
|
2744
|
+
merchant_code?: string;
|
|
2745
|
+
payment_gateway?: string;
|
|
2746
|
+
payment_identifier?: string;
|
|
2747
|
+
type?: string;
|
|
2748
|
+
};
|
|
2749
|
+
/** @returns {PaymentMethod} */
|
|
2750
|
+
declare function PaymentMethod(): PaymentMethod;
|
|
2751
|
+
type PaymentMethod = {
|
|
2752
|
+
amount?: number;
|
|
2753
|
+
mode: string;
|
|
2754
|
+
name?: string;
|
|
2755
|
+
payment?: string;
|
|
2756
|
+
payment_meta: PaymentMeta;
|
|
2757
|
+
};
|
|
2758
|
+
/** @returns {PaymentModes} */
|
|
2759
|
+
declare function PaymentModes(): PaymentModes;
|
|
2760
|
+
type PaymentModes = {
|
|
2761
|
+
codes?: string[];
|
|
2762
|
+
iins?: string[];
|
|
2763
|
+
networks?: string[];
|
|
2764
|
+
types?: string[];
|
|
2765
|
+
uses?: PaymentAllowValue;
|
|
2766
|
+
};
|
|
2767
|
+
/** @returns {PaymentSelectionLock} */
|
|
2768
|
+
declare function PaymentSelectionLock(): PaymentSelectionLock;
|
|
2769
|
+
type PaymentSelectionLock = {
|
|
2770
|
+
default_options?: string;
|
|
2771
|
+
enabled?: boolean;
|
|
2772
|
+
payment_identifier?: string;
|
|
2773
|
+
};
|
|
2774
|
+
/** @returns {PickupStoreDetail} */
|
|
2775
|
+
declare function PickupStoreDetail(): PickupStoreDetail;
|
|
2776
|
+
type PickupStoreDetail = {
|
|
2777
|
+
address?: string;
|
|
2778
|
+
address_type?: string;
|
|
2779
|
+
area?: string;
|
|
2780
|
+
area_code?: string;
|
|
2781
|
+
area_code_slug?: string;
|
|
2782
|
+
city?: string;
|
|
2783
|
+
country?: string;
|
|
2784
|
+
email?: string;
|
|
2785
|
+
id?: number;
|
|
2786
|
+
landmark?: string;
|
|
2787
|
+
name?: string;
|
|
2788
|
+
phone?: string;
|
|
2789
|
+
pincode?: number;
|
|
2790
|
+
state?: string;
|
|
2791
|
+
store_code?: string;
|
|
2792
|
+
uid?: number;
|
|
2793
|
+
};
|
|
2794
|
+
/** @returns {PlatformAddCartRequest} */
|
|
2795
|
+
declare function PlatformAddCartRequest(): PlatformAddCartRequest;
|
|
2796
|
+
type PlatformAddCartRequest = {
|
|
2797
|
+
items?: AddProductCart[];
|
|
2798
|
+
new_cart?: boolean;
|
|
2799
|
+
user_id?: string;
|
|
2800
|
+
};
|
|
2801
|
+
/** @returns {PlatformAddress} */
|
|
2802
|
+
declare function PlatformAddress(): PlatformAddress;
|
|
2803
|
+
type PlatformAddress = {
|
|
2804
|
+
address?: string;
|
|
2805
|
+
address_type?: string;
|
|
2806
|
+
area?: string;
|
|
2807
|
+
area_code?: string;
|
|
2808
|
+
area_code_slug?: string;
|
|
2809
|
+
cart_id?: string;
|
|
2810
|
+
checkout_mode?: string;
|
|
2811
|
+
city?: string;
|
|
2812
|
+
country?: string;
|
|
2813
|
+
country_code?: string;
|
|
2814
|
+
created_by_user_id?: string;
|
|
2815
|
+
email?: string;
|
|
2816
|
+
geo_location?: GeoLocation;
|
|
2817
|
+
google_map_point?: any;
|
|
2818
|
+
id?: string;
|
|
2819
|
+
is_active?: boolean;
|
|
2820
|
+
is_default_address?: boolean;
|
|
2821
|
+
landmark?: string;
|
|
2822
|
+
meta?: any;
|
|
2823
|
+
name?: string;
|
|
2824
|
+
phone?: string;
|
|
2825
|
+
state?: string;
|
|
2826
|
+
tags?: string[];
|
|
2827
|
+
user_id?: string;
|
|
2828
|
+
};
|
|
2829
|
+
/** @returns {PlatformCartCheckoutDetailRequest} */
|
|
2830
|
+
declare function PlatformCartCheckoutDetailRequest(): PlatformCartCheckoutDetailRequest;
|
|
2831
|
+
type PlatformCartCheckoutDetailRequest = {
|
|
2832
|
+
address_id?: string;
|
|
2833
|
+
aggregator?: string;
|
|
2834
|
+
billing_address?: any;
|
|
2835
|
+
billing_address_id?: string;
|
|
2836
|
+
callback_url?: string;
|
|
2837
|
+
checkout_mode?: string;
|
|
2838
|
+
delivery_address?: any;
|
|
2839
|
+
device_id?: string;
|
|
2840
|
+
employee_code?: string;
|
|
2841
|
+
extra_meta?: any;
|
|
2842
|
+
/**
|
|
2843
|
+
* - List of file url
|
|
2844
|
+
*/
|
|
2845
|
+
files?: Files[];
|
|
2846
|
+
id: string;
|
|
2847
|
+
merchant_code?: string;
|
|
2848
|
+
meta?: any;
|
|
2849
|
+
order_type: string;
|
|
2850
|
+
ordering_store?: number;
|
|
2851
|
+
payment_auto_confirm?: boolean;
|
|
2852
|
+
payment_identifier?: string;
|
|
2853
|
+
payment_mode: string;
|
|
2854
|
+
payment_params?: any;
|
|
2855
|
+
pick_at_store_uid?: number;
|
|
2856
|
+
pos?: boolean;
|
|
2857
|
+
staff?: StaffCheckout;
|
|
2858
|
+
user_id: string;
|
|
2859
|
+
};
|
|
2860
|
+
/** @returns {PlatformCartCheckoutDetailV2Request} */
|
|
2861
|
+
declare function PlatformCartCheckoutDetailV2Request(): PlatformCartCheckoutDetailV2Request;
|
|
2862
|
+
type PlatformCartCheckoutDetailV2Request = {
|
|
2863
|
+
address_id?: string;
|
|
2864
|
+
aggregator?: string;
|
|
2865
|
+
billing_address?: any;
|
|
2866
|
+
billing_address_id?: string;
|
|
2867
|
+
callback_url?: string;
|
|
2868
|
+
checkout_mode?: string;
|
|
2869
|
+
custom_meta?: any;
|
|
2870
|
+
delivery_address?: any;
|
|
2871
|
+
device_id?: string;
|
|
2872
|
+
employee_code?: string;
|
|
2873
|
+
extra_meta?: any;
|
|
2874
|
+
/**
|
|
2875
|
+
* - List of file url
|
|
2876
|
+
*/
|
|
2877
|
+
files?: Files[];
|
|
2878
|
+
id: string;
|
|
2879
|
+
merchant_code?: string;
|
|
2880
|
+
meta?: any;
|
|
2881
|
+
order_type: string;
|
|
2882
|
+
ordering_store?: number;
|
|
2883
|
+
payment_auto_confirm?: boolean;
|
|
2884
|
+
payment_identifier?: string;
|
|
2885
|
+
payment_methods: PaymentMethod[];
|
|
2886
|
+
payment_mode?: string;
|
|
2887
|
+
payment_params?: any;
|
|
2888
|
+
pick_at_store_uid?: number;
|
|
2889
|
+
pos?: boolean;
|
|
2890
|
+
staff?: StaffCheckout;
|
|
2891
|
+
user_id: string;
|
|
2892
|
+
};
|
|
2893
|
+
/** @returns {PlatformCartMetaRequest} */
|
|
2894
|
+
declare function PlatformCartMetaRequest(): PlatformCartMetaRequest;
|
|
2895
|
+
type PlatformCartMetaRequest = {
|
|
2896
|
+
checkout_mode?: string;
|
|
2897
|
+
comment?: string;
|
|
2898
|
+
gift_details?: any;
|
|
2899
|
+
gstin?: string;
|
|
2900
|
+
pan_no?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* - Customer contact details for
|
|
2903
|
+
* customer pickup at store
|
|
2904
|
+
*/
|
|
2905
|
+
pick_up_customer_details?: any;
|
|
2906
|
+
/**
|
|
2907
|
+
* - Staff user id
|
|
2908
|
+
*/
|
|
2909
|
+
staff_user_id?: string;
|
|
2910
|
+
};
|
|
2911
|
+
/** @returns {PlatformCartShipmentsResponse} */
|
|
2912
|
+
declare function PlatformCartShipmentsResponse(): PlatformCartShipmentsResponse;
|
|
2913
|
+
type PlatformCartShipmentsResponse = {
|
|
2914
|
+
applied_promo_details?: AppliedPromotion[];
|
|
2915
|
+
breakup_values?: CartBreakup;
|
|
2916
|
+
buy_now?: boolean;
|
|
2917
|
+
checkout_mode?: string;
|
|
2918
|
+
comment?: string;
|
|
2919
|
+
coupon_text?: string;
|
|
2920
|
+
currency?: CartCurrency;
|
|
2921
|
+
delivery_charge_info?: string;
|
|
2922
|
+
delivery_promise?: ShipmentPromise;
|
|
2923
|
+
error?: boolean;
|
|
2924
|
+
gstin?: string;
|
|
2925
|
+
id?: string;
|
|
2926
|
+
is_valid?: boolean;
|
|
2927
|
+
items?: CartProductInfo[];
|
|
2928
|
+
last_modified?: string;
|
|
2929
|
+
message?: string;
|
|
2930
|
+
pan_config?: any;
|
|
2931
|
+
pan_no?: string;
|
|
2932
|
+
payment_selection_lock?: PaymentSelectionLock;
|
|
2933
|
+
restrict_checkout?: boolean;
|
|
2934
|
+
shipments?: PlatformShipmentResponse[];
|
|
2935
|
+
staff_user_id?: string;
|
|
2936
|
+
};
|
|
2937
|
+
/** @returns {PlatformGetAddressesResponse} */
|
|
2938
|
+
declare function PlatformGetAddressesResponse(): PlatformGetAddressesResponse;
|
|
2939
|
+
type PlatformGetAddressesResponse = {
|
|
2940
|
+
address?: PlatformAddress[];
|
|
2941
|
+
};
|
|
2942
|
+
/** @returns {PlatformSelectCartAddressRequest} */
|
|
2943
|
+
declare function PlatformSelectCartAddressRequest(): PlatformSelectCartAddressRequest;
|
|
2944
|
+
type PlatformSelectCartAddressRequest = {
|
|
2945
|
+
billing_address_id?: string;
|
|
2946
|
+
cart_id?: string;
|
|
2947
|
+
checkout_mode?: string;
|
|
2948
|
+
id?: string;
|
|
2949
|
+
user_id?: string;
|
|
2950
|
+
};
|
|
2951
|
+
/** @returns {PlatformShipmentResponse} */
|
|
2952
|
+
declare function PlatformShipmentResponse(): PlatformShipmentResponse;
|
|
2953
|
+
type PlatformShipmentResponse = {
|
|
2954
|
+
articles?: ShipmentArticle[];
|
|
2955
|
+
box_type?: string;
|
|
2956
|
+
dp_id?: string;
|
|
2957
|
+
dp_options?: any;
|
|
2958
|
+
fulfillment_id?: number;
|
|
2959
|
+
fulfillment_type?: string;
|
|
2960
|
+
items?: CartProductInfo[];
|
|
2961
|
+
order_type?: string;
|
|
2962
|
+
promise?: ShipmentPromise;
|
|
2963
|
+
shipment_type?: string;
|
|
2964
|
+
shipments?: number;
|
|
2965
|
+
};
|
|
2966
|
+
/** @returns {PlatformUpdateCartRequest} */
|
|
2967
|
+
declare function PlatformUpdateCartRequest(): PlatformUpdateCartRequest;
|
|
2968
|
+
type PlatformUpdateCartRequest = {
|
|
2969
|
+
items?: UpdateProductCart[];
|
|
2970
|
+
operation: string;
|
|
2971
|
+
user_id?: string;
|
|
2972
|
+
};
|
|
2973
|
+
/** @returns {PostOrder} */
|
|
2974
|
+
declare function PostOrder(): PostOrder;
|
|
2975
|
+
type PostOrder = {
|
|
2976
|
+
cancellation_allowed?: boolean;
|
|
2977
|
+
return_allowed?: boolean;
|
|
2978
|
+
};
|
|
2979
|
+
/** @returns {PostOrder1} */
|
|
2980
|
+
declare function PostOrder1(): PostOrder1;
|
|
2981
|
+
type PostOrder1 = {
|
|
2982
|
+
cancellation_allowed?: boolean;
|
|
2983
|
+
return_allowed?: boolean;
|
|
2984
|
+
};
|
|
2985
|
+
/** @returns {PriceAdjustment} */
|
|
2986
|
+
declare function PriceAdjustment(): PriceAdjustment;
|
|
2987
|
+
type PriceAdjustment = {
|
|
2988
|
+
allowed_refund?: boolean;
|
|
2989
|
+
apply_expiry?: string;
|
|
2990
|
+
article_ids: Article[];
|
|
2991
|
+
article_level_distribution: boolean;
|
|
2992
|
+
cart_id: string;
|
|
2993
|
+
cart_value?: number;
|
|
2994
|
+
collection: Collection;
|
|
2995
|
+
id?: string;
|
|
2996
|
+
is_authenticated: boolean;
|
|
2997
|
+
message: string;
|
|
2998
|
+
meta?: any;
|
|
2999
|
+
type: string;
|
|
3000
|
+
value: number;
|
|
3001
|
+
};
|
|
3002
|
+
/** @returns {PriceAdjustmentAdd} */
|
|
3003
|
+
declare function PriceAdjustmentAdd(): PriceAdjustmentAdd;
|
|
3004
|
+
type PriceAdjustmentAdd = {
|
|
3005
|
+
allowed_refund?: boolean;
|
|
3006
|
+
apply_expiry?: string;
|
|
3007
|
+
article_ids: Article[];
|
|
3008
|
+
article_level_distribution: boolean;
|
|
3009
|
+
cart_id: string;
|
|
3010
|
+
cart_value?: number;
|
|
3011
|
+
collection: Collection;
|
|
3012
|
+
created_by?: string;
|
|
3013
|
+
is_authenticated: boolean;
|
|
3014
|
+
message: string;
|
|
3015
|
+
meta?: any;
|
|
3016
|
+
type: string;
|
|
3017
|
+
value: number;
|
|
3018
|
+
};
|
|
3019
|
+
/** @returns {PriceAdjustmentResponse} */
|
|
3020
|
+
declare function PriceAdjustmentResponse(): PriceAdjustmentResponse;
|
|
3021
|
+
type PriceAdjustmentResponse = {
|
|
3022
|
+
data?: PriceAdjustment;
|
|
3023
|
+
};
|
|
3024
|
+
/** @returns {PriceAdjustmentUpdate} */
|
|
3025
|
+
declare function PriceAdjustmentUpdate(): PriceAdjustmentUpdate;
|
|
3026
|
+
type PriceAdjustmentUpdate = {
|
|
3027
|
+
allowed_refund?: boolean;
|
|
3028
|
+
apply_expiry?: string;
|
|
3029
|
+
article_ids: Article[];
|
|
3030
|
+
article_level_distribution: boolean;
|
|
3031
|
+
cart_id: string;
|
|
3032
|
+
cart_value?: number;
|
|
3033
|
+
collection: Collection;
|
|
3034
|
+
is_authenticated: boolean;
|
|
3035
|
+
message: string;
|
|
3036
|
+
meta?: any;
|
|
3037
|
+
modified_by?: string;
|
|
3038
|
+
type: string;
|
|
3039
|
+
value: number;
|
|
3040
|
+
};
|
|
3041
|
+
/** @returns {PriceRange} */
|
|
3042
|
+
declare function PriceRange(): PriceRange;
|
|
3043
|
+
type PriceRange = {
|
|
3044
|
+
max?: number;
|
|
3045
|
+
min?: number;
|
|
3046
|
+
};
|
|
3047
|
+
/** @returns {ProductAction} */
|
|
3048
|
+
declare function ProductAction(): ProductAction;
|
|
3049
|
+
type ProductAction = {
|
|
3050
|
+
query?: ActionQuery;
|
|
3051
|
+
type?: string;
|
|
3052
|
+
url?: string;
|
|
3053
|
+
};
|
|
3054
|
+
/** @returns {ProductArticle} */
|
|
3055
|
+
declare function ProductArticle(): ProductArticle;
|
|
3056
|
+
type ProductArticle = {
|
|
3057
|
+
_custom_json?: any;
|
|
3058
|
+
cart_item_meta?: any;
|
|
3059
|
+
extra_meta?: any;
|
|
3060
|
+
gift_card?: any;
|
|
3061
|
+
identifier?: any;
|
|
3062
|
+
is_gift_visible?: boolean;
|
|
3063
|
+
meta?: any;
|
|
3064
|
+
mto_quantity?: number;
|
|
3065
|
+
parent_item_identifiers?: any;
|
|
3066
|
+
price?: ArticlePriceInfo;
|
|
3067
|
+
product_group_tags?: string[];
|
|
3068
|
+
quantity?: number;
|
|
3069
|
+
seller?: BaseInfo;
|
|
3070
|
+
seller_identifier?: string;
|
|
3071
|
+
size?: string;
|
|
3072
|
+
store?: StoreInfo;
|
|
3073
|
+
type?: string;
|
|
3074
|
+
uid?: string;
|
|
3075
|
+
};
|
|
3076
|
+
/** @returns {ProductAvailability} */
|
|
3077
|
+
declare function ProductAvailability(): ProductAvailability;
|
|
3078
|
+
type ProductAvailability = {
|
|
3079
|
+
available_sizes?: ProductAvailabilitySize[];
|
|
3080
|
+
deliverable?: boolean;
|
|
3081
|
+
is_valid?: boolean;
|
|
3082
|
+
other_store_quantity?: number;
|
|
3083
|
+
out_of_stock?: boolean;
|
|
3084
|
+
sizes?: string[];
|
|
3085
|
+
};
|
|
3086
|
+
/** @returns {ProductAvailabilitySize} */
|
|
3087
|
+
declare function ProductAvailabilitySize(): ProductAvailabilitySize;
|
|
3088
|
+
type ProductAvailabilitySize = {
|
|
3089
|
+
display?: string;
|
|
3090
|
+
is_available?: boolean;
|
|
3091
|
+
value?: string;
|
|
3092
|
+
};
|
|
3093
|
+
/** @returns {ProductImage} */
|
|
3094
|
+
declare function ProductImage(): ProductImage;
|
|
3095
|
+
type ProductImage = {
|
|
3096
|
+
aspect_ratio?: string;
|
|
3097
|
+
secure_url?: string;
|
|
3098
|
+
url?: string;
|
|
3099
|
+
};
|
|
3100
|
+
/** @returns {ProductPrice} */
|
|
3101
|
+
declare function ProductPrice(): ProductPrice;
|
|
3102
|
+
type ProductPrice = {
|
|
3103
|
+
add_on?: number;
|
|
3104
|
+
currency_code?: string;
|
|
3105
|
+
currency_symbol?: string;
|
|
3106
|
+
effective?: number;
|
|
3107
|
+
marked?: number;
|
|
3108
|
+
selling?: number;
|
|
3109
|
+
};
|
|
3110
|
+
/** @returns {ProductPriceInfo} */
|
|
3111
|
+
declare function ProductPriceInfo(): ProductPriceInfo;
|
|
3112
|
+
type ProductPriceInfo = {
|
|
3113
|
+
base?: ProductPrice;
|
|
3114
|
+
converted?: ProductPrice;
|
|
3115
|
+
};
|
|
3116
|
+
/** @returns {PromiseFormatted} */
|
|
3117
|
+
declare function PromiseFormatted(): PromiseFormatted;
|
|
3118
|
+
type PromiseFormatted = {
|
|
3119
|
+
max?: string;
|
|
3120
|
+
min?: string;
|
|
3121
|
+
};
|
|
3122
|
+
/** @returns {PromiseTimestamp} */
|
|
3123
|
+
declare function PromiseTimestamp(): PromiseTimestamp;
|
|
3124
|
+
type PromiseTimestamp = {
|
|
3125
|
+
max?: number;
|
|
3126
|
+
min?: number;
|
|
3127
|
+
};
|
|
3128
|
+
/** @returns {PromoMeta} */
|
|
3129
|
+
declare function PromoMeta(): PromoMeta;
|
|
3130
|
+
type PromoMeta = {
|
|
3131
|
+
message?: string;
|
|
3132
|
+
};
|
|
3133
|
+
/** @returns {PromotionAction} */
|
|
3134
|
+
declare function PromotionAction(): PromotionAction;
|
|
3135
|
+
type PromotionAction = {
|
|
3136
|
+
action_date: string;
|
|
3137
|
+
action_type: string;
|
|
3138
|
+
};
|
|
3139
|
+
/** @returns {PromotionAdd} */
|
|
3140
|
+
declare function PromotionAdd(): PromotionAdd;
|
|
3141
|
+
type PromotionAdd = {
|
|
3142
|
+
_custom_json?: any;
|
|
3143
|
+
_schedule?: PromotionSchedule;
|
|
3144
|
+
application_id: string;
|
|
3145
|
+
apply_all_discount?: boolean;
|
|
3146
|
+
apply_exclusive?: string;
|
|
3147
|
+
apply_priority?: number;
|
|
3148
|
+
author?: PromotionAuthor;
|
|
3149
|
+
buy_rules: any;
|
|
3150
|
+
/**
|
|
3151
|
+
* - Only available for Contract pricing and
|
|
3152
|
+
* Ladder pricing promotion type
|
|
3153
|
+
*/
|
|
3154
|
+
calculate_on?: string;
|
|
3155
|
+
code?: string;
|
|
3156
|
+
currency?: string;
|
|
3157
|
+
date_meta?: PromotionDateMeta;
|
|
3158
|
+
discount_rules: DiscountRule[];
|
|
3159
|
+
display_meta: DisplayMeta1;
|
|
3160
|
+
mode: string;
|
|
3161
|
+
ownership: Ownership1;
|
|
3162
|
+
post_order_action?: PromotionAction;
|
|
3163
|
+
promo_group: string;
|
|
3164
|
+
promotion_type: string;
|
|
3165
|
+
restrictions?: Restrictions1;
|
|
3166
|
+
stackable?: boolean;
|
|
3167
|
+
visiblility?: Visibility;
|
|
3168
|
+
};
|
|
3169
|
+
/** @returns {PromotionAuthor} */
|
|
3170
|
+
declare function PromotionAuthor(): PromotionAuthor;
|
|
3171
|
+
type PromotionAuthor = {
|
|
3172
|
+
created_by?: string;
|
|
3173
|
+
modified_by?: string;
|
|
3174
|
+
};
|
|
3175
|
+
/** @returns {PromotionDateMeta} */
|
|
3176
|
+
declare function PromotionDateMeta(): PromotionDateMeta;
|
|
3177
|
+
type PromotionDateMeta = {
|
|
3178
|
+
created_on?: string;
|
|
3179
|
+
modified_on?: string;
|
|
3180
|
+
};
|
|
3181
|
+
/** @returns {PromotionListItem} */
|
|
3182
|
+
declare function PromotionListItem(): PromotionListItem;
|
|
3183
|
+
type PromotionListItem = {
|
|
3184
|
+
_custom_json?: any;
|
|
3185
|
+
_schedule?: PromotionSchedule;
|
|
3186
|
+
application_id: string;
|
|
3187
|
+
apply_all_discount?: boolean;
|
|
3188
|
+
apply_exclusive?: string;
|
|
3189
|
+
apply_priority?: number;
|
|
3190
|
+
author?: PromotionAuthor;
|
|
3191
|
+
buy_rules: any;
|
|
3192
|
+
/**
|
|
3193
|
+
* - Only available for Contract pricing and
|
|
3194
|
+
* Ladder pricing promotion type
|
|
3195
|
+
*/
|
|
3196
|
+
calculate_on?: string;
|
|
3197
|
+
code?: string;
|
|
3198
|
+
currency?: string;
|
|
3199
|
+
date_meta?: PromotionDateMeta;
|
|
3200
|
+
discount_rules: DiscountRule[];
|
|
3201
|
+
display_meta: DisplayMeta1;
|
|
3202
|
+
mode: string;
|
|
3203
|
+
ownership: Ownership1;
|
|
3204
|
+
post_order_action?: PromotionAction;
|
|
3205
|
+
promo_group: string;
|
|
3206
|
+
promotion_type: string;
|
|
3207
|
+
restrictions?: Restrictions1;
|
|
3208
|
+
stackable?: boolean;
|
|
3209
|
+
visiblility?: Visibility;
|
|
3210
|
+
};
|
|
3211
|
+
/** @returns {PromotionPartialUpdate} */
|
|
3212
|
+
declare function PromotionPartialUpdate(): PromotionPartialUpdate;
|
|
3213
|
+
type PromotionPartialUpdate = {
|
|
3214
|
+
/**
|
|
3215
|
+
* - Send true to unpublish promotion
|
|
3216
|
+
*/
|
|
3217
|
+
archive?: boolean;
|
|
3218
|
+
schedule?: PromotionSchedule;
|
|
3219
|
+
};
|
|
3220
|
+
/** @returns {PromotionPaymentModes} */
|
|
3221
|
+
declare function PromotionPaymentModes(): PromotionPaymentModes;
|
|
3222
|
+
type PromotionPaymentModes = {
|
|
3223
|
+
codes?: string[];
|
|
3224
|
+
type: string;
|
|
3225
|
+
uses?: PaymentAllowValue1;
|
|
3226
|
+
};
|
|
3227
|
+
/** @returns {PromotionSchedule} */
|
|
3228
|
+
declare function PromotionSchedule(): PromotionSchedule;
|
|
3229
|
+
type PromotionSchedule = {
|
|
3230
|
+
cron?: string;
|
|
3231
|
+
duration?: number;
|
|
3232
|
+
end: string;
|
|
3233
|
+
next_schedule?: any[];
|
|
3234
|
+
published: boolean;
|
|
3235
|
+
start: string;
|
|
3236
|
+
};
|
|
3237
|
+
/** @returns {PromotionsResponse} */
|
|
3238
|
+
declare function PromotionsResponse(): PromotionsResponse;
|
|
3239
|
+
type PromotionsResponse = {
|
|
3240
|
+
items?: PromotionListItem[];
|
|
3241
|
+
page?: Page;
|
|
3242
|
+
};
|
|
3243
|
+
/** @returns {PromotionUpdate} */
|
|
3244
|
+
declare function PromotionUpdate(): PromotionUpdate;
|
|
3245
|
+
type PromotionUpdate = {
|
|
3246
|
+
_custom_json?: any;
|
|
3247
|
+
_schedule?: PromotionSchedule;
|
|
3248
|
+
application_id: string;
|
|
3249
|
+
apply_all_discount?: boolean;
|
|
3250
|
+
apply_exclusive?: string;
|
|
3251
|
+
apply_priority?: number;
|
|
3252
|
+
author?: PromotionAuthor;
|
|
3253
|
+
buy_rules: any;
|
|
3254
|
+
/**
|
|
3255
|
+
* - Only available for Contract pricing and
|
|
3256
|
+
* Ladder pricing promotion type
|
|
3257
|
+
*/
|
|
3258
|
+
calculate_on?: string;
|
|
3259
|
+
code?: string;
|
|
3260
|
+
currency?: string;
|
|
3261
|
+
date_meta?: PromotionDateMeta;
|
|
3262
|
+
discount_rules: DiscountRule[];
|
|
3263
|
+
display_meta: DisplayMeta1;
|
|
3264
|
+
mode: string;
|
|
3265
|
+
ownership: Ownership1;
|
|
3266
|
+
post_order_action?: PromotionAction;
|
|
3267
|
+
promo_group: string;
|
|
3268
|
+
promotion_type: string;
|
|
3269
|
+
restrictions?: Restrictions1;
|
|
3270
|
+
stackable?: boolean;
|
|
3271
|
+
visiblility?: Visibility;
|
|
3272
|
+
};
|
|
3273
|
+
/** @returns {RawBreakup} */
|
|
3274
|
+
declare function RawBreakup(): RawBreakup;
|
|
3275
|
+
type RawBreakup = {
|
|
3276
|
+
cod_charge?: number;
|
|
3277
|
+
convenience_fee?: number;
|
|
3278
|
+
coupon?: number;
|
|
3279
|
+
delivery_charge?: number;
|
|
3280
|
+
discount?: number;
|
|
3281
|
+
fynd_cash?: number;
|
|
3282
|
+
gift_card?: number;
|
|
3283
|
+
gst_charges?: number;
|
|
3284
|
+
mrp_total?: number;
|
|
3285
|
+
subtotal?: number;
|
|
3286
|
+
total?: number;
|
|
3287
|
+
vog?: number;
|
|
3288
|
+
you_saved?: number;
|
|
3289
|
+
};
|
|
3290
|
+
/** @returns {Restrictions} */
|
|
3291
|
+
declare function Restrictions(): Restrictions;
|
|
3292
|
+
type Restrictions = {
|
|
3293
|
+
bulk_bundle?: BulkBundleRestriction;
|
|
3294
|
+
coupon_allowed?: boolean;
|
|
3295
|
+
ordering_stores?: number[];
|
|
3296
|
+
payments?: any;
|
|
3297
|
+
platforms?: string[];
|
|
3298
|
+
post_order?: PostOrder;
|
|
3299
|
+
price_range?: PriceRange;
|
|
3300
|
+
user_groups?: number[];
|
|
3301
|
+
user_type?: string;
|
|
3302
|
+
uses?: UsesRestriction;
|
|
3303
|
+
};
|
|
3304
|
+
/** @returns {Restrictions1} */
|
|
3305
|
+
declare function Restrictions1(): Restrictions1;
|
|
3306
|
+
type Restrictions1 = {
|
|
3307
|
+
anonymous_users?: boolean;
|
|
3308
|
+
order_quantity?: number;
|
|
3309
|
+
ordering_stores?: number[];
|
|
3310
|
+
payments?: PromotionPaymentModes[];
|
|
3311
|
+
platforms?: string[];
|
|
3312
|
+
post_order?: PostOrder1;
|
|
3313
|
+
user_groups?: number[];
|
|
3314
|
+
user_id?: string[];
|
|
3315
|
+
user_registered?: UserRegistered;
|
|
3316
|
+
uses: UsesRestriction1;
|
|
3317
|
+
};
|
|
3318
|
+
/** @returns {Rule} */
|
|
3319
|
+
declare function Rule(): Rule;
|
|
3320
|
+
type Rule = {
|
|
3321
|
+
discount_qty?: number;
|
|
3322
|
+
key?: number;
|
|
3323
|
+
max?: number;
|
|
3324
|
+
min?: number;
|
|
3325
|
+
value?: number;
|
|
3326
|
+
};
|
|
3327
|
+
/** @returns {RuleDefinition} */
|
|
3328
|
+
declare function RuleDefinition(): RuleDefinition;
|
|
3329
|
+
type RuleDefinition = {
|
|
3330
|
+
applicable_on: string;
|
|
3331
|
+
auto_apply?: boolean;
|
|
3332
|
+
calculate_on: string;
|
|
3333
|
+
currency_code?: string;
|
|
3334
|
+
is_exact?: boolean;
|
|
3335
|
+
scope?: string[];
|
|
3336
|
+
type: string;
|
|
3337
|
+
value_type: string;
|
|
3338
|
+
};
|
|
3339
|
+
/** @returns {SaveAddressResponse} */
|
|
3340
|
+
declare function SaveAddressResponse(): SaveAddressResponse;
|
|
3341
|
+
type SaveAddressResponse = {
|
|
3342
|
+
id?: string;
|
|
3343
|
+
is_default_address?: boolean;
|
|
3344
|
+
success?: boolean;
|
|
3345
|
+
};
|
|
3346
|
+
/** @returns {SharedCart} */
|
|
3347
|
+
declare function SharedCart(): SharedCart;
|
|
3348
|
+
type SharedCart = {
|
|
3349
|
+
breakup_values?: CartBreakup;
|
|
3350
|
+
buy_now?: boolean;
|
|
3351
|
+
cart_id?: number;
|
|
3352
|
+
checkout_mode?: string;
|
|
3353
|
+
comment?: string;
|
|
3354
|
+
coupon_text?: string;
|
|
3355
|
+
currency?: CartCurrency;
|
|
3356
|
+
delivery_charge_info?: string;
|
|
3357
|
+
delivery_promise?: ShipmentPromise;
|
|
3358
|
+
gstin?: string;
|
|
3359
|
+
id?: string;
|
|
3360
|
+
is_valid?: boolean;
|
|
3361
|
+
items?: CartProductInfo[];
|
|
3362
|
+
last_modified?: string;
|
|
3363
|
+
message?: string;
|
|
3364
|
+
payment_selection_lock?: PaymentSelectionLock;
|
|
3365
|
+
restrict_checkout?: boolean;
|
|
3366
|
+
shared_cart_details?: SharedCartDetails;
|
|
3367
|
+
uid?: string;
|
|
3368
|
+
};
|
|
3369
|
+
/** @returns {SharedCartDetails} */
|
|
3370
|
+
declare function SharedCartDetails(): SharedCartDetails;
|
|
3371
|
+
type SharedCartDetails = {
|
|
3372
|
+
created_on?: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* - Meta data sent while generating share cart link
|
|
3375
|
+
*/
|
|
3376
|
+
meta?: any;
|
|
3377
|
+
/**
|
|
3378
|
+
* - Share link device and other source information
|
|
3379
|
+
*/
|
|
3380
|
+
source?: any;
|
|
3381
|
+
/**
|
|
3382
|
+
* - Short link id
|
|
3383
|
+
*/
|
|
3384
|
+
token?: string;
|
|
3385
|
+
/**
|
|
3386
|
+
* - User details of who generated share link
|
|
3387
|
+
*/
|
|
3388
|
+
user?: any;
|
|
3389
|
+
};
|
|
3390
|
+
/** @returns {SharedCartResponse} */
|
|
3391
|
+
declare function SharedCartResponse(): SharedCartResponse;
|
|
3392
|
+
type SharedCartResponse = {
|
|
3393
|
+
cart?: SharedCart;
|
|
3394
|
+
error?: string;
|
|
3395
|
+
};
|
|
3396
|
+
/** @returns {ShipmentArticle} */
|
|
3397
|
+
declare function ShipmentArticle(): ShipmentArticle;
|
|
3398
|
+
type ShipmentArticle = {
|
|
3399
|
+
article_id?: string;
|
|
3400
|
+
meta?: string;
|
|
3401
|
+
quantity?: string;
|
|
3402
|
+
};
|
|
3403
|
+
/** @returns {ShipmentPromise} */
|
|
3404
|
+
declare function ShipmentPromise(): ShipmentPromise;
|
|
3405
|
+
type ShipmentPromise = {
|
|
3406
|
+
formatted?: PromiseFormatted;
|
|
3407
|
+
timestamp?: PromiseTimestamp;
|
|
3408
|
+
};
|
|
3409
|
+
/** @returns {ShippingAddress} */
|
|
3410
|
+
declare function ShippingAddress(): ShippingAddress;
|
|
3411
|
+
type ShippingAddress = {
|
|
3412
|
+
address?: string;
|
|
3413
|
+
address_type?: string;
|
|
3414
|
+
area?: string;
|
|
3415
|
+
area_code: string;
|
|
3416
|
+
area_code_slug?: string;
|
|
3417
|
+
city?: string;
|
|
3418
|
+
country?: string;
|
|
3419
|
+
country_code?: string;
|
|
3420
|
+
country_iso_code?: string;
|
|
3421
|
+
country_phone_code?: string;
|
|
3422
|
+
email?: string;
|
|
3423
|
+
landmark?: string;
|
|
3424
|
+
meta?: any;
|
|
3425
|
+
name?: string;
|
|
3426
|
+
phone?: number;
|
|
3427
|
+
pincode?: number;
|
|
3428
|
+
state?: string;
|
|
3429
|
+
};
|
|
3430
|
+
/** @returns {StaffCheckout} */
|
|
3431
|
+
declare function StaffCheckout(): StaffCheckout;
|
|
3432
|
+
type StaffCheckout = {
|
|
3433
|
+
_id: string;
|
|
3434
|
+
employee_code?: string;
|
|
3435
|
+
first_name: string;
|
|
3436
|
+
last_name: string;
|
|
3437
|
+
user: string;
|
|
3438
|
+
};
|
|
3439
|
+
/** @returns {State} */
|
|
3440
|
+
declare function State(): State;
|
|
3441
|
+
type State = {
|
|
3442
|
+
is_archived?: boolean;
|
|
3443
|
+
is_display?: boolean;
|
|
3444
|
+
is_public?: boolean;
|
|
3445
|
+
};
|
|
3446
|
+
/** @returns {StoreDetailsResponse} */
|
|
3447
|
+
declare function StoreDetailsResponse(): StoreDetailsResponse;
|
|
3448
|
+
type StoreDetailsResponse = {
|
|
3449
|
+
items?: PickupStoreDetail[];
|
|
3450
|
+
};
|
|
3451
|
+
/** @returns {StoreInfo} */
|
|
3452
|
+
declare function StoreInfo(): StoreInfo;
|
|
3453
|
+
type StoreInfo = {
|
|
3454
|
+
name?: string;
|
|
3455
|
+
store_code?: string;
|
|
3456
|
+
uid?: number;
|
|
3457
|
+
};
|
|
3458
|
+
/** @returns {SuccessMessage} */
|
|
3459
|
+
declare function SuccessMessage(): SuccessMessage;
|
|
3460
|
+
type SuccessMessage = {
|
|
3461
|
+
message?: string;
|
|
3462
|
+
success?: boolean;
|
|
3463
|
+
};
|
|
3464
|
+
/** @returns {Tags} */
|
|
3465
|
+
declare function Tags(): Tags;
|
|
3466
|
+
type Tags = {
|
|
3467
|
+
tags?: any;
|
|
3468
|
+
};
|
|
3469
|
+
/** @returns {UpdateAddressResponse} */
|
|
3470
|
+
declare function UpdateAddressResponse(): UpdateAddressResponse;
|
|
3471
|
+
type UpdateAddressResponse = {
|
|
3472
|
+
id?: string;
|
|
3473
|
+
is_default_address?: boolean;
|
|
3474
|
+
is_updated?: boolean;
|
|
3475
|
+
success?: boolean;
|
|
3476
|
+
};
|
|
3477
|
+
/** @returns {UpdateCartDetailResponse} */
|
|
3478
|
+
declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
|
|
3479
|
+
type UpdateCartDetailResponse = {
|
|
3480
|
+
cart?: CartDetailResponse;
|
|
3481
|
+
message?: string;
|
|
3482
|
+
/**
|
|
3483
|
+
* - True if all items are added successfully.
|
|
3484
|
+
* False if partially added or not added.
|
|
3485
|
+
*/
|
|
3486
|
+
success?: boolean;
|
|
3487
|
+
};
|
|
3488
|
+
/** @returns {UpdateCartPaymentRequest} */
|
|
3489
|
+
declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
|
|
3490
|
+
type UpdateCartPaymentRequest = {
|
|
3491
|
+
address_id?: string;
|
|
3492
|
+
aggregator_name?: string;
|
|
3493
|
+
id?: string;
|
|
3494
|
+
merchant_code?: string;
|
|
3495
|
+
payment_identifier?: string;
|
|
3496
|
+
payment_mode?: string;
|
|
3497
|
+
};
|
|
3498
|
+
/** @returns {UpdateCartPaymentRequestV2} */
|
|
3499
|
+
declare function UpdateCartPaymentRequestV2(): UpdateCartPaymentRequestV2;
|
|
3500
|
+
type UpdateCartPaymentRequestV2 = {
|
|
3501
|
+
address_id?: string;
|
|
3502
|
+
aggregator_name?: string;
|
|
3503
|
+
id?: string;
|
|
3504
|
+
merchant_code?: string;
|
|
3505
|
+
payment_identifier?: string;
|
|
3506
|
+
payment_methods?: PaymentMethod[];
|
|
3507
|
+
payment_mode?: string;
|
|
3508
|
+
};
|
|
3509
|
+
/** @returns {UpdateCartRequest} */
|
|
3510
|
+
declare function UpdateCartRequest(): UpdateCartRequest;
|
|
3511
|
+
type UpdateCartRequest = {
|
|
3512
|
+
items?: UpdateProductCart[];
|
|
3513
|
+
operation: string;
|
|
3514
|
+
};
|
|
3515
|
+
/** @returns {UpdateCartShipmentItem} */
|
|
3516
|
+
declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
|
|
3517
|
+
type UpdateCartShipmentItem = {
|
|
3518
|
+
/**
|
|
3519
|
+
* - Article mongo id
|
|
3520
|
+
*/
|
|
3521
|
+
article_uid: string;
|
|
3522
|
+
/**
|
|
3523
|
+
* - Quantity of product in shipment
|
|
3524
|
+
*/
|
|
3525
|
+
quantity?: number;
|
|
3526
|
+
/**
|
|
3527
|
+
* - Shipment delivery type
|
|
3528
|
+
*/
|
|
3529
|
+
shipment_type: string;
|
|
3530
|
+
};
|
|
3531
|
+
/** @returns {UpdateCartShipmentRequest} */
|
|
3532
|
+
declare function UpdateCartShipmentRequest(): UpdateCartShipmentRequest;
|
|
3533
|
+
type UpdateCartShipmentRequest = {
|
|
3534
|
+
shipments: UpdateCartShipmentItem[];
|
|
3535
|
+
};
|
|
3536
|
+
/** @returns {UpdateProductCart} */
|
|
3537
|
+
declare function UpdateProductCart(): UpdateProductCart;
|
|
3538
|
+
type UpdateProductCart = {
|
|
3539
|
+
_custom_json?: any;
|
|
3540
|
+
article_id?: string;
|
|
3541
|
+
extra_meta?: any;
|
|
3542
|
+
identifiers: CartProductIdentifer;
|
|
3543
|
+
item_id?: number;
|
|
3544
|
+
item_index?: number;
|
|
3545
|
+
item_size?: string;
|
|
3546
|
+
meta?: any;
|
|
3547
|
+
parent_item_identifiers?: any;
|
|
3548
|
+
quantity?: number;
|
|
3549
|
+
};
|
|
3550
|
+
/** @returns {UpdateUserCartMapping} */
|
|
3551
|
+
declare function UpdateUserCartMapping(): UpdateUserCartMapping;
|
|
3552
|
+
type UpdateUserCartMapping = {
|
|
3553
|
+
user_id: string;
|
|
3554
|
+
};
|
|
3555
|
+
/** @returns {UserCartMappingResponse} */
|
|
3556
|
+
declare function UserCartMappingResponse(): UserCartMappingResponse;
|
|
3557
|
+
type UserCartMappingResponse = {
|
|
3558
|
+
applied_promo_details?: AppliedPromotion[];
|
|
3559
|
+
breakup_values?: CartBreakup;
|
|
3560
|
+
buy_now?: boolean;
|
|
3561
|
+
checkout_mode?: string;
|
|
3562
|
+
comment?: string;
|
|
3563
|
+
coupon_text?: string;
|
|
3564
|
+
currency?: CartCurrency;
|
|
3565
|
+
delivery_charge_info?: string;
|
|
3566
|
+
delivery_promise?: ShipmentPromise;
|
|
3567
|
+
gstin?: string;
|
|
3568
|
+
id?: string;
|
|
3569
|
+
is_valid?: boolean;
|
|
3570
|
+
items?: CartProductInfo[];
|
|
3571
|
+
last_modified?: string;
|
|
3572
|
+
message?: string;
|
|
3573
|
+
pan_config?: any;
|
|
3574
|
+
pan_no?: string;
|
|
3575
|
+
payment_selection_lock?: PaymentSelectionLock;
|
|
3576
|
+
restrict_checkout?: boolean;
|
|
3577
|
+
user?: UserInfo;
|
|
3578
|
+
};
|
|
3579
|
+
/** @returns {UserInfo} */
|
|
3580
|
+
declare function UserInfo(): UserInfo;
|
|
3581
|
+
type UserInfo = {
|
|
3582
|
+
_id?: string;
|
|
3583
|
+
created_at?: string;
|
|
3584
|
+
external_id?: string;
|
|
3585
|
+
first_name?: string;
|
|
3586
|
+
gender?: string;
|
|
3587
|
+
last_name?: string;
|
|
3588
|
+
mobile?: string;
|
|
3589
|
+
modified_on?: string;
|
|
3590
|
+
uid?: string;
|
|
3591
|
+
};
|
|
3592
|
+
/** @returns {UserRegistered} */
|
|
3593
|
+
declare function UserRegistered(): UserRegistered;
|
|
3594
|
+
type UserRegistered = {
|
|
3595
|
+
end?: string;
|
|
3596
|
+
start?: string;
|
|
3597
|
+
};
|
|
3598
|
+
/** @returns {UsesRemaining} */
|
|
3599
|
+
declare function UsesRemaining(): UsesRemaining;
|
|
3600
|
+
type UsesRemaining = {
|
|
3601
|
+
app?: number;
|
|
3602
|
+
total?: number;
|
|
3603
|
+
user?: number;
|
|
3604
|
+
};
|
|
3605
|
+
/** @returns {UsesRemaining1} */
|
|
3606
|
+
declare function UsesRemaining1(): UsesRemaining1;
|
|
3607
|
+
type UsesRemaining1 = {
|
|
3608
|
+
total?: number;
|
|
3609
|
+
user?: number;
|
|
3610
|
+
};
|
|
3611
|
+
/** @returns {UsesRestriction} */
|
|
3612
|
+
declare function UsesRestriction(): UsesRestriction;
|
|
3613
|
+
type UsesRestriction = {
|
|
3614
|
+
maximum?: UsesRemaining;
|
|
3615
|
+
remaining?: UsesRemaining;
|
|
3616
|
+
};
|
|
3617
|
+
/** @returns {UsesRestriction1} */
|
|
3618
|
+
declare function UsesRestriction1(): UsesRestriction1;
|
|
3619
|
+
type UsesRestriction1 = {
|
|
3620
|
+
maximum?: UsesRemaining1;
|
|
3621
|
+
remaining?: UsesRemaining1;
|
|
3622
|
+
};
|
|
3623
|
+
/** @returns {Validation} */
|
|
3624
|
+
declare function Validation(): Validation;
|
|
3625
|
+
type Validation = {
|
|
3626
|
+
anonymous?: boolean;
|
|
3627
|
+
app_id?: string[];
|
|
3628
|
+
user_registered_after?: string;
|
|
3629
|
+
};
|
|
3630
|
+
/** @returns {Validity} */
|
|
3631
|
+
declare function Validity(): Validity;
|
|
3632
|
+
type Validity = {
|
|
3633
|
+
priority?: number;
|
|
3634
|
+
};
|
|
3635
|
+
/** @returns {Visibility} */
|
|
3636
|
+
declare function Visibility(): Visibility;
|
|
3637
|
+
type Visibility = {
|
|
3638
|
+
coupon_list: boolean;
|
|
3639
|
+
pdp: boolean;
|
|
3640
|
+
};
|