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