@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.6' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -42,7 +42,7 @@ declare class Cart {
|
|
|
42
42
|
* @returns {Promise<SaveAddressResult>} - Success response
|
|
43
43
|
* @name addAddress
|
|
44
44
|
* @summary: Creates a new address for a customer
|
|
45
|
-
* @description: Add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://
|
|
45
|
+
* @description: Add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/addAddress/).
|
|
46
46
|
*/
|
|
47
47
|
addAddress({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SaveAddressResult>;
|
|
48
48
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Cart {
|
|
|
51
51
|
* @returns {Promise<AddCartDetailResult>} - Success response
|
|
52
52
|
* @name addItems
|
|
53
53
|
* @summary: Add items to a cart
|
|
54
|
-
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://
|
|
54
|
+
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/addItems/).
|
|
55
55
|
*/
|
|
56
56
|
addItems({ body, xOrderingSource, i, b, areaCode, buyNow, id, orderType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AddCartDetailResult>;
|
|
57
57
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Cart {
|
|
|
60
60
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
61
61
|
* @name applyCoupon
|
|
62
62
|
* @summary: Apply coupon
|
|
63
|
-
* @description: Apply a coupon code to the cart to trigger discounts on eligible items. - Check out [method documentation](https://
|
|
63
|
+
* @description: Apply a coupon code to the cart to trigger discounts on eligible items. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/applyCoupon/).
|
|
64
64
|
*/
|
|
65
65
|
applyCoupon({ body, xOrderingSource, i, b, p, id, buyNow, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
66
66
|
/**
|
|
@@ -69,7 +69,7 @@ declare class Cart {
|
|
|
69
69
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
70
70
|
* @name applyRewardPoints
|
|
71
71
|
* @summary: Use reward points
|
|
72
|
-
* @description: Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases. - Check out [method documentation](https://
|
|
72
|
+
* @description: Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/applyRewardPoints/).
|
|
73
73
|
*/
|
|
74
74
|
applyRewardPoints({ body, xOrderingSource, id, i, b, buyNow, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
75
75
|
/**
|
|
@@ -78,7 +78,7 @@ declare class Cart {
|
|
|
78
78
|
* @returns {Promise<CartCheckoutResult>} - Success response
|
|
79
79
|
* @name checkoutCart
|
|
80
80
|
* @summary: Checkout cart
|
|
81
|
-
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://
|
|
81
|
+
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/checkoutCart/).
|
|
82
82
|
*/
|
|
83
83
|
checkoutCart({ body, xOrderingSource, buyNow, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartCheckoutResult>;
|
|
84
84
|
/**
|
|
@@ -87,7 +87,7 @@ declare class Cart {
|
|
|
87
87
|
* @returns {Promise<CartCheckoutResult>} - Success response
|
|
88
88
|
* @name checkoutCartV2
|
|
89
89
|
* @summary: Checkout cart
|
|
90
|
-
* @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://
|
|
90
|
+
* @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/checkoutCartV2/).
|
|
91
91
|
*/
|
|
92
92
|
checkoutCartV2({ body, xOrderingSource, buyNow, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartCheckoutResult>;
|
|
93
93
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Cart {
|
|
|
96
96
|
* @returns {Promise<DeleteCartDetailResult>} - Success response
|
|
97
97
|
* @name deleteCart
|
|
98
98
|
* @summary: Delete a cart
|
|
99
|
-
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://
|
|
99
|
+
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/deleteCart/).
|
|
100
100
|
*/
|
|
101
101
|
deleteCart({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DeleteCartDetailResult>;
|
|
102
102
|
/**
|
|
@@ -105,7 +105,7 @@ declare class Cart {
|
|
|
105
105
|
* @returns {Promise<Address>} - Success response
|
|
106
106
|
* @name getAddressById
|
|
107
107
|
* @summary: Get details for a single customer address
|
|
108
|
-
* @description: Get a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://
|
|
108
|
+
* @description: Get a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getAddressById/).
|
|
109
109
|
*/
|
|
110
110
|
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Address>;
|
|
111
111
|
/**
|
|
@@ -114,7 +114,7 @@ declare class Cart {
|
|
|
114
114
|
* @returns {Promise<GetAddressesResult>} - Success response
|
|
115
115
|
* @name getAddresses
|
|
116
116
|
* @summary: Get a list of addresses for a customer
|
|
117
|
-
* @description: List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://
|
|
117
|
+
* @description: List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getAddresses/).
|
|
118
118
|
*/
|
|
119
119
|
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetAddressesResult>;
|
|
120
120
|
/**
|
|
@@ -123,7 +123,7 @@ declare class Cart {
|
|
|
123
123
|
* @returns {Promise<BulkPriceResult>} - Success response
|
|
124
124
|
* @name getBulkDiscountOffers
|
|
125
125
|
* @summary: List bulk discounts
|
|
126
|
-
* @description: List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list. - Check out [method documentation](https://
|
|
126
|
+
* @description: List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getBulkDiscountOffers/).
|
|
127
127
|
*/
|
|
128
128
|
getBulkDiscountOffers({ itemId, articleId, uid, slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BulkPriceResult>;
|
|
129
129
|
/**
|
|
@@ -132,7 +132,7 @@ declare class Cart {
|
|
|
132
132
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
133
133
|
* @name getCart
|
|
134
134
|
* @summary: Get a cart
|
|
135
|
-
* @description: Get details of a cart linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://
|
|
135
|
+
* @description: Get details of a cart linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCart/).
|
|
136
136
|
*/
|
|
137
137
|
getCart({ xOrderingSource, id, i, b, c, assignCardId, areaCode, buyNow, orderType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
138
138
|
/**
|
|
@@ -141,7 +141,7 @@ declare class Cart {
|
|
|
141
141
|
* @returns {Promise<any>} - Success response
|
|
142
142
|
* @name getCartLastModified
|
|
143
143
|
* @summary: Get last modified timestamp of a cart
|
|
144
|
-
* @description: Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties. - Check out [method documentation](https://
|
|
144
|
+
* @description: Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartLastModified/).
|
|
145
145
|
*/
|
|
146
146
|
getCartLastModified({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<any>;
|
|
147
147
|
/**
|
|
@@ -150,7 +150,7 @@ declare class Cart {
|
|
|
150
150
|
* @returns {Promise<GetShareCartLinkResult>} - Success response
|
|
151
151
|
* @name getCartShareLink
|
|
152
152
|
* @summary: Create share cart link
|
|
153
|
-
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://
|
|
153
|
+
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartShareLink/).
|
|
154
154
|
*/
|
|
155
155
|
getCartShareLink({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetShareCartLinkResult>;
|
|
156
156
|
/**
|
|
@@ -159,7 +159,7 @@ declare class Cart {
|
|
|
159
159
|
* @returns {Promise<SharedCartResult>} - Success response
|
|
160
160
|
* @name getCartSharedItems
|
|
161
161
|
* @summary: List shared cart items
|
|
162
|
-
* @description: Get cart items from the shared cart link based on unique token. - Check out [method documentation](https://
|
|
162
|
+
* @description: Get cart items from the shared cart link based on unique token. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartSharedItems/).
|
|
163
163
|
*/
|
|
164
164
|
getCartSharedItems({ token, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SharedCartResult>;
|
|
165
165
|
/**
|
|
@@ -168,7 +168,7 @@ declare class Cart {
|
|
|
168
168
|
* @returns {Promise<GetCouponResult>} - Success response
|
|
169
169
|
* @name getCoupons
|
|
170
170
|
* @summary: List available coupons
|
|
171
|
-
* @description: List all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://
|
|
171
|
+
* @description: List all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCoupons/).
|
|
172
172
|
*/
|
|
173
173
|
getCoupons({ id, buyNow, productSlug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCouponResult>;
|
|
174
174
|
/**
|
|
@@ -177,7 +177,7 @@ declare class Cart {
|
|
|
177
177
|
* @returns {Promise<CartItemCountResult>} - Success response
|
|
178
178
|
* @name getItemCount
|
|
179
179
|
* @summary: Get a cart items count
|
|
180
|
-
* @description: Get total count of items currently present in the customer's cart. - Check out [method documentation](https://
|
|
180
|
+
* @description: Get total count of items currently present in the customer's cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getItemCount/).
|
|
181
181
|
*/
|
|
182
182
|
getItemCount({ id, buyNow, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartItemCountResult>;
|
|
183
183
|
/**
|
|
@@ -186,7 +186,7 @@ declare class Cart {
|
|
|
186
186
|
* @returns {Promise<LadderPriceOffers>} - Success response
|
|
187
187
|
* @name getLadderOffers
|
|
188
188
|
* @summary: List ladder offers
|
|
189
|
-
* @description: Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals. - Check out [method documentation](https://
|
|
189
|
+
* @description: Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getLadderOffers/).
|
|
190
190
|
*/
|
|
191
191
|
getLadderOffers({ slug, storeId, promotionId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LadderPriceOffers>;
|
|
192
192
|
/**
|
|
@@ -195,7 +195,7 @@ declare class Cart {
|
|
|
195
195
|
* @returns {Promise<PromotionOffersResult>} - Success response
|
|
196
196
|
* @name getPromotionOffers
|
|
197
197
|
* @summary: List available promotion offers
|
|
198
|
-
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://
|
|
198
|
+
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getPromotionOffers/).
|
|
199
199
|
*/
|
|
200
200
|
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, promotionType, cartId, autoApply, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionOffersResult>;
|
|
201
201
|
/**
|
|
@@ -204,7 +204,7 @@ declare class Cart {
|
|
|
204
204
|
* @returns {Promise<PromotionPaymentOffersResult>} - Success response
|
|
205
205
|
* @name getPromotionPaymentOffers
|
|
206
206
|
* @summary: Fetch available promotions payment offers
|
|
207
|
-
* @description: Use this API to get top 5 payment offers available for current product. - Check out [method documentation](https://
|
|
207
|
+
* @description: Use this API to get top 5 payment offers available for current product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getPromotionPaymentOffers/).
|
|
208
208
|
*/
|
|
209
209
|
getPromotionPaymentOffers({ id, uid, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionPaymentOffersResult>;
|
|
210
210
|
/**
|
|
@@ -213,7 +213,7 @@ declare class Cart {
|
|
|
213
213
|
* @returns {Promise<CartShipmentsResult>} - Success response
|
|
214
214
|
* @name getShipments
|
|
215
215
|
* @summary: List shipments
|
|
216
|
-
* @description: Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information. - Check out [method documentation](https://
|
|
216
|
+
* @description: Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getShipments/).
|
|
217
217
|
*/
|
|
218
218
|
getShipments({ p, id, buyNow, addressId, areaCode, orderType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartShipmentsResult>;
|
|
219
219
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Cart {
|
|
|
222
222
|
* @returns {Promise<DeleteAddressResult>} - Success response
|
|
223
223
|
* @name removeAddress
|
|
224
224
|
* @summary: Removes an address from a customer's address list
|
|
225
|
-
* @description: Delete an existing customer address from the system. - Check out [method documentation](https://
|
|
225
|
+
* @description: Delete an existing customer address from the system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/removeAddress/).
|
|
226
226
|
*/
|
|
227
227
|
removeAddress({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<DeleteAddressResult>;
|
|
228
228
|
/**
|
|
@@ -231,7 +231,7 @@ declare class Cart {
|
|
|
231
231
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
232
232
|
* @name removeCoupon
|
|
233
233
|
* @summary: Remove coupon
|
|
234
|
-
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://
|
|
234
|
+
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/removeCoupon/).
|
|
235
235
|
*/
|
|
236
236
|
removeCoupon({ xOrderingSource, id, buyNow, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
237
237
|
/**
|
|
@@ -240,7 +240,7 @@ declare class Cart {
|
|
|
240
240
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
241
241
|
* @name selectAddress
|
|
242
242
|
* @summary: Select customer address for order processing
|
|
243
|
-
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://
|
|
243
|
+
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/selectAddress/).
|
|
244
244
|
*/
|
|
245
245
|
selectAddress({ body, xOrderingSource, cartId, buyNow, i, b, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
246
246
|
/**
|
|
@@ -249,7 +249,7 @@ declare class Cart {
|
|
|
249
249
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
250
250
|
* @name selectPaymentMode
|
|
251
251
|
* @summary: Select payment mode
|
|
252
|
-
* @description: Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://
|
|
252
|
+
* @description: Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/selectPaymentMode/).
|
|
253
253
|
*/
|
|
254
254
|
selectPaymentMode({ body, xOrderingSource, id, buyNow, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartDetailResult>;
|
|
255
255
|
/**
|
|
@@ -258,7 +258,7 @@ declare class Cart {
|
|
|
258
258
|
* @returns {Promise<UpdateAddressResult>} - Success response
|
|
259
259
|
* @name updateAddress
|
|
260
260
|
* @summary: Updates an existing customer address
|
|
261
|
-
* @description: Customer can modify the details of a previously saved addresses. - Check out [method documentation](https://
|
|
261
|
+
* @description: Customer can modify the details of a previously saved addresses. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateAddress/).
|
|
262
262
|
*/
|
|
263
263
|
updateAddress({ id, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<UpdateAddressResult>;
|
|
264
264
|
/**
|
|
@@ -267,7 +267,7 @@ declare class Cart {
|
|
|
267
267
|
* @returns {Promise<UpdateCartDetailResult>} - Success response
|
|
268
268
|
* @name updateCart
|
|
269
269
|
* @summary: Update cart items
|
|
270
|
-
* @description: Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://
|
|
270
|
+
* @description: Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCart/).
|
|
271
271
|
*/
|
|
272
272
|
updateCart({ body, xOrderingSource, id, i, b, areaCode, buyNow, cartType, orderType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UpdateCartDetailResult>;
|
|
273
273
|
/**
|
|
@@ -276,7 +276,7 @@ declare class Cart {
|
|
|
276
276
|
* @returns {Promise<UpdateCartDetailResult>} - Success response
|
|
277
277
|
* @name updateCartBreakup
|
|
278
278
|
* @summary: Update store credits into cart and their items
|
|
279
|
-
* @description: Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed. - Check out [method documentation](https://
|
|
279
|
+
* @description: Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartBreakup/).
|
|
280
280
|
*/
|
|
281
281
|
updateCartBreakup({ body, xOrderingSource, id, i, b, buyNow, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UpdateCartDetailResult>;
|
|
282
282
|
/**
|
|
@@ -285,7 +285,7 @@ declare class Cart {
|
|
|
285
285
|
* @returns {Promise<CartMetaResult>} - Success response
|
|
286
286
|
* @name updateCartMeta
|
|
287
287
|
* @summary: Update cart metadata
|
|
288
|
-
* @description: Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://
|
|
288
|
+
* @description: Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartMeta/).
|
|
289
289
|
*/
|
|
290
290
|
updateCartMeta({ body, id, buyNow, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CartMetaResult>;
|
|
291
291
|
/**
|
|
@@ -294,7 +294,7 @@ declare class Cart {
|
|
|
294
294
|
* @returns {Promise<SharedCartResult>} - Success response
|
|
295
295
|
* @name updateCartWithSharedItems
|
|
296
296
|
* @summary: Update with shared items
|
|
297
|
-
* @description: Merge or replace shared cart items with existing cart. - Check out [method documentation](https://
|
|
297
|
+
* @description: Merge or replace shared cart items with existing cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartWithSharedItems/).
|
|
298
298
|
*/
|
|
299
299
|
updateCartWithSharedItems({ token, action, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SharedCartResult>;
|
|
300
300
|
/**
|
|
@@ -303,7 +303,7 @@ declare class Cart {
|
|
|
303
303
|
* @returns {Promise<PaymentCouponValidate>} - Success response
|
|
304
304
|
* @name validateCouponForPayment
|
|
305
305
|
* @summary: Validate applied coupon
|
|
306
|
-
* @description: Validate the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions. - Check out [method documentation](https://
|
|
306
|
+
* @description: Validate the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/validateCouponForPayment/).
|
|
307
307
|
*/
|
|
308
308
|
validateCouponForPayment({ xOrderingSource, id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, iin, network, type, cardId, cartType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentCouponValidate>;
|
|
309
309
|
}
|
|
@@ -68,7 +68,7 @@ class Cart {
|
|
|
68
68
|
* @returns {Promise<SaveAddressResult>} - Success response
|
|
69
69
|
* @name addAddress
|
|
70
70
|
* @summary: Creates a new address for a customer
|
|
71
|
-
* @description: Add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://
|
|
71
|
+
* @description: Add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/addAddress/).
|
|
72
72
|
*/
|
|
73
73
|
async addAddress(
|
|
74
74
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,7 +105,7 @@ class Cart {
|
|
|
105
105
|
* @returns {Promise<AddCartDetailResult>} - Success response
|
|
106
106
|
* @name addItems
|
|
107
107
|
* @summary: Add items to a cart
|
|
108
|
-
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://
|
|
108
|
+
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/addItems/).
|
|
109
109
|
*/
|
|
110
110
|
async addItems(
|
|
111
111
|
{
|
|
@@ -159,7 +159,7 @@ class Cart {
|
|
|
159
159
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
160
160
|
* @name applyCoupon
|
|
161
161
|
* @summary: Apply coupon
|
|
162
|
-
* @description: Apply a coupon code to the cart to trigger discounts on eligible items. - Check out [method documentation](https://
|
|
162
|
+
* @description: Apply a coupon code to the cart to trigger discounts on eligible items. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/applyCoupon/).
|
|
163
163
|
*/
|
|
164
164
|
async applyCoupon(
|
|
165
165
|
{ body, xOrderingSource, i, b, p, id, buyNow, cartType, requestHeaders } = {
|
|
@@ -205,7 +205,7 @@ class Cart {
|
|
|
205
205
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
206
206
|
* @name applyRewardPoints
|
|
207
207
|
* @summary: Use reward points
|
|
208
|
-
* @description: Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases. - Check out [method documentation](https://
|
|
208
|
+
* @description: Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/applyRewardPoints/).
|
|
209
209
|
*/
|
|
210
210
|
async applyRewardPoints(
|
|
211
211
|
{ body, xOrderingSource, id, i, b, buyNow, requestHeaders } = {
|
|
@@ -249,7 +249,7 @@ class Cart {
|
|
|
249
249
|
* @returns {Promise<CartCheckoutResult>} - Success response
|
|
250
250
|
* @name checkoutCart
|
|
251
251
|
* @summary: Checkout cart
|
|
252
|
-
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://
|
|
252
|
+
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/checkoutCart/).
|
|
253
253
|
*/
|
|
254
254
|
async checkoutCart(
|
|
255
255
|
{ body, xOrderingSource, buyNow, cartType, requestHeaders } = {
|
|
@@ -291,7 +291,7 @@ class Cart {
|
|
|
291
291
|
* @returns {Promise<CartCheckoutResult>} - Success response
|
|
292
292
|
* @name checkoutCartV2
|
|
293
293
|
* @summary: Checkout cart
|
|
294
|
-
* @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://
|
|
294
|
+
* @description: The checkout cart initiates the order creation process based on the items in the user's cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/checkoutCartV2/).
|
|
295
295
|
*/
|
|
296
296
|
async checkoutCartV2(
|
|
297
297
|
{ body, xOrderingSource, buyNow, cartType, requestHeaders } = {
|
|
@@ -333,7 +333,7 @@ class Cart {
|
|
|
333
333
|
* @returns {Promise<DeleteCartDetailResult>} - Success response
|
|
334
334
|
* @name deleteCart
|
|
335
335
|
* @summary: Delete a cart
|
|
336
|
-
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://
|
|
336
|
+
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/deleteCart/).
|
|
337
337
|
*/
|
|
338
338
|
async deleteCart(
|
|
339
339
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -371,7 +371,7 @@ class Cart {
|
|
|
371
371
|
* @returns {Promise<Address>} - Success response
|
|
372
372
|
* @name getAddressById
|
|
373
373
|
* @summary: Get details for a single customer address
|
|
374
|
-
* @description: Get a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://
|
|
374
|
+
* @description: Get a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getAddressById/).
|
|
375
375
|
*/
|
|
376
376
|
async getAddressById(
|
|
377
377
|
{
|
|
@@ -432,7 +432,7 @@ class Cart {
|
|
|
432
432
|
* @returns {Promise<GetAddressesResult>} - Success response
|
|
433
433
|
* @name getAddresses
|
|
434
434
|
* @summary: Get a list of addresses for a customer
|
|
435
|
-
* @description: List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://
|
|
435
|
+
* @description: List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getAddresses/).
|
|
436
436
|
*/
|
|
437
437
|
async getAddresses(
|
|
438
438
|
{
|
|
@@ -483,7 +483,7 @@ class Cart {
|
|
|
483
483
|
* @returns {Promise<BulkPriceResult>} - Success response
|
|
484
484
|
* @name getBulkDiscountOffers
|
|
485
485
|
* @summary: List bulk discounts
|
|
486
|
-
* @description: List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list. - Check out [method documentation](https://
|
|
486
|
+
* @description: List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getBulkDiscountOffers/).
|
|
487
487
|
*/
|
|
488
488
|
async getBulkDiscountOffers(
|
|
489
489
|
{ itemId, articleId, uid, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -524,7 +524,7 @@ class Cart {
|
|
|
524
524
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
525
525
|
* @name getCart
|
|
526
526
|
* @summary: Get a cart
|
|
527
|
-
* @description: Get details of a cart linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://
|
|
527
|
+
* @description: Get details of a cart linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCart/).
|
|
528
528
|
*/
|
|
529
529
|
async getCart(
|
|
530
530
|
{
|
|
@@ -581,7 +581,7 @@ class Cart {
|
|
|
581
581
|
* @returns {Promise<any>} - Success response
|
|
582
582
|
* @name getCartLastModified
|
|
583
583
|
* @summary: Get last modified timestamp of a cart
|
|
584
|
-
* @description: Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties. - Check out [method documentation](https://
|
|
584
|
+
* @description: Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartLastModified/).
|
|
585
585
|
*/
|
|
586
586
|
async getCartLastModified(
|
|
587
587
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -619,7 +619,7 @@ class Cart {
|
|
|
619
619
|
* @returns {Promise<GetShareCartLinkResult>} - Success response
|
|
620
620
|
* @name getCartShareLink
|
|
621
621
|
* @summary: Create share cart link
|
|
622
|
-
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://
|
|
622
|
+
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartShareLink/).
|
|
623
623
|
*/
|
|
624
624
|
async getCartShareLink(
|
|
625
625
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -656,7 +656,7 @@ class Cart {
|
|
|
656
656
|
* @returns {Promise<SharedCartResult>} - Success response
|
|
657
657
|
* @name getCartSharedItems
|
|
658
658
|
* @summary: List shared cart items
|
|
659
|
-
* @description: Get cart items from the shared cart link based on unique token. - Check out [method documentation](https://
|
|
659
|
+
* @description: Get cart items from the shared cart link based on unique token. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCartSharedItems/).
|
|
660
660
|
*/
|
|
661
661
|
async getCartSharedItems(
|
|
662
662
|
{ token, requestHeaders } = { requestHeaders: {} },
|
|
@@ -702,7 +702,7 @@ class Cart {
|
|
|
702
702
|
* @returns {Promise<GetCouponResult>} - Success response
|
|
703
703
|
* @name getCoupons
|
|
704
704
|
* @summary: List available coupons
|
|
705
|
-
* @description: List all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://
|
|
705
|
+
* @description: List all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getCoupons/).
|
|
706
706
|
*/
|
|
707
707
|
async getCoupons(
|
|
708
708
|
{ id, buyNow, productSlug, storeId, requestHeaders } = {
|
|
@@ -745,7 +745,7 @@ class Cart {
|
|
|
745
745
|
* @returns {Promise<CartItemCountResult>} - Success response
|
|
746
746
|
* @name getItemCount
|
|
747
747
|
* @summary: Get a cart items count
|
|
748
|
-
* @description: Get total count of items currently present in the customer's cart. - Check out [method documentation](https://
|
|
748
|
+
* @description: Get total count of items currently present in the customer's cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getItemCount/).
|
|
749
749
|
*/
|
|
750
750
|
async getItemCount(
|
|
751
751
|
{ id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -784,7 +784,7 @@ class Cart {
|
|
|
784
784
|
* @returns {Promise<LadderPriceOffers>} - Success response
|
|
785
785
|
* @name getLadderOffers
|
|
786
786
|
* @summary: List ladder offers
|
|
787
|
-
* @description: Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals. - Check out [method documentation](https://
|
|
787
|
+
* @description: Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getLadderOffers/).
|
|
788
788
|
*/
|
|
789
789
|
async getLadderOffers(
|
|
790
790
|
{ slug, storeId, promotionId, pageSize, requestHeaders } = {
|
|
@@ -827,7 +827,7 @@ class Cart {
|
|
|
827
827
|
* @returns {Promise<PromotionOffersResult>} - Success response
|
|
828
828
|
* @name getPromotionOffers
|
|
829
829
|
* @summary: List available promotion offers
|
|
830
|
-
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://
|
|
830
|
+
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getPromotionOffers/).
|
|
831
831
|
*/
|
|
832
832
|
async getPromotionOffers(
|
|
833
833
|
{
|
|
@@ -882,7 +882,7 @@ class Cart {
|
|
|
882
882
|
* @returns {Promise<PromotionPaymentOffersResult>} - Success response
|
|
883
883
|
* @name getPromotionPaymentOffers
|
|
884
884
|
* @summary: Fetch available promotions payment offers
|
|
885
|
-
* @description: Use this API to get top 5 payment offers available for current product. - Check out [method documentation](https://
|
|
885
|
+
* @description: Use this API to get top 5 payment offers available for current product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getPromotionPaymentOffers/).
|
|
886
886
|
*/
|
|
887
887
|
async getPromotionPaymentOffers(
|
|
888
888
|
{ id, uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -921,7 +921,7 @@ class Cart {
|
|
|
921
921
|
* @returns {Promise<CartShipmentsResult>} - Success response
|
|
922
922
|
* @name getShipments
|
|
923
923
|
* @summary: List shipments
|
|
924
|
-
* @description: Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information. - Check out [method documentation](https://
|
|
924
|
+
* @description: Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/getShipments/).
|
|
925
925
|
*/
|
|
926
926
|
async getShipments(
|
|
927
927
|
{ p, id, buyNow, addressId, areaCode, orderType, requestHeaders } = {
|
|
@@ -966,7 +966,7 @@ class Cart {
|
|
|
966
966
|
* @returns {Promise<DeleteAddressResult>} - Success response
|
|
967
967
|
* @name removeAddress
|
|
968
968
|
* @summary: Removes an address from a customer's address list
|
|
969
|
-
* @description: Delete an existing customer address from the system. - Check out [method documentation](https://
|
|
969
|
+
* @description: Delete an existing customer address from the system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/removeAddress/).
|
|
970
970
|
*/
|
|
971
971
|
async removeAddress(
|
|
972
972
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1012,7 +1012,7 @@ class Cart {
|
|
|
1012
1012
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
1013
1013
|
* @name removeCoupon
|
|
1014
1014
|
* @summary: Remove coupon
|
|
1015
|
-
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://
|
|
1015
|
+
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/removeCoupon/).
|
|
1016
1016
|
*/
|
|
1017
1017
|
async removeCoupon(
|
|
1018
1018
|
{ xOrderingSource, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1052,7 +1052,7 @@ class Cart {
|
|
|
1052
1052
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
1053
1053
|
* @name selectAddress
|
|
1054
1054
|
* @summary: Select customer address for order processing
|
|
1055
|
-
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://
|
|
1055
|
+
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/selectAddress/).
|
|
1056
1056
|
*/
|
|
1057
1057
|
async selectAddress(
|
|
1058
1058
|
{ body, xOrderingSource, cartId, buyNow, i, b, requestHeaders } = {
|
|
@@ -1096,7 +1096,7 @@ class Cart {
|
|
|
1096
1096
|
* @returns {Promise<CartDetailResult>} - Success response
|
|
1097
1097
|
* @name selectPaymentMode
|
|
1098
1098
|
* @summary: Select payment mode
|
|
1099
|
-
* @description: Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://
|
|
1099
|
+
* @description: Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/selectPaymentMode/).
|
|
1100
1100
|
*/
|
|
1101
1101
|
async selectPaymentMode(
|
|
1102
1102
|
{ body, xOrderingSource, id, buyNow, requestHeaders } = {
|
|
@@ -1138,7 +1138,7 @@ class Cart {
|
|
|
1138
1138
|
* @returns {Promise<UpdateAddressResult>} - Success response
|
|
1139
1139
|
* @name updateAddress
|
|
1140
1140
|
* @summary: Updates an existing customer address
|
|
1141
|
-
* @description: Customer can modify the details of a previously saved addresses. - Check out [method documentation](https://
|
|
1141
|
+
* @description: Customer can modify the details of a previously saved addresses. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateAddress/).
|
|
1142
1142
|
*/
|
|
1143
1143
|
async updateAddress(
|
|
1144
1144
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1184,7 +1184,7 @@ class Cart {
|
|
|
1184
1184
|
* @returns {Promise<UpdateCartDetailResult>} - Success response
|
|
1185
1185
|
* @name updateCart
|
|
1186
1186
|
* @summary: Update cart items
|
|
1187
|
-
* @description: Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://
|
|
1187
|
+
* @description: Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCart/).
|
|
1188
1188
|
*/
|
|
1189
1189
|
async updateCart(
|
|
1190
1190
|
{
|
|
@@ -1240,7 +1240,7 @@ class Cart {
|
|
|
1240
1240
|
* @returns {Promise<UpdateCartDetailResult>} - Success response
|
|
1241
1241
|
* @name updateCartBreakup
|
|
1242
1242
|
* @summary: Update store credits into cart and their items
|
|
1243
|
-
* @description: Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed. - Check out [method documentation](https://
|
|
1243
|
+
* @description: Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartBreakup/).
|
|
1244
1244
|
*/
|
|
1245
1245
|
async updateCartBreakup(
|
|
1246
1246
|
{ body, xOrderingSource, id, i, b, buyNow, cartType, requestHeaders } = {
|
|
@@ -1285,7 +1285,7 @@ class Cart {
|
|
|
1285
1285
|
* @returns {Promise<CartMetaResult>} - Success response
|
|
1286
1286
|
* @name updateCartMeta
|
|
1287
1287
|
* @summary: Update cart metadata
|
|
1288
|
-
* @description: Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://
|
|
1288
|
+
* @description: Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartMeta/).
|
|
1289
1289
|
*/
|
|
1290
1290
|
async updateCartMeta(
|
|
1291
1291
|
{ body, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1324,7 +1324,7 @@ class Cart {
|
|
|
1324
1324
|
* @returns {Promise<SharedCartResult>} - Success response
|
|
1325
1325
|
* @name updateCartWithSharedItems
|
|
1326
1326
|
* @summary: Update with shared items
|
|
1327
|
-
* @description: Merge or replace shared cart items with existing cart. - Check out [method documentation](https://
|
|
1327
|
+
* @description: Merge or replace shared cart items with existing cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/updateCartWithSharedItems/).
|
|
1328
1328
|
*/
|
|
1329
1329
|
async updateCartWithSharedItems(
|
|
1330
1330
|
{ token, action, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1370,7 +1370,7 @@ class Cart {
|
|
|
1370
1370
|
* @returns {Promise<PaymentCouponValidate>} - Success response
|
|
1371
1371
|
* @name validateCouponForPayment
|
|
1372
1372
|
* @summary: Validate applied coupon
|
|
1373
|
-
* @description: Validate the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions. - Check out [method documentation](https://
|
|
1373
|
+
* @description: Validate the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/cart/validateCouponForPayment/).
|
|
1374
1374
|
*/
|
|
1375
1375
|
async validateCouponForPayment(
|
|
1376
1376
|
{
|