@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -9,8 +9,8 @@ declare class Cart {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
11
11
|
* @name addAddress
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Create a new address
|
|
13
|
+
* @description: Customers can add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
14
14
|
*/
|
|
15
15
|
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
16
16
|
/**
|
|
@@ -19,8 +19,8 @@ declare class Cart {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
21
21
|
* @name addItems
|
|
22
|
-
* @summary: Add items to
|
|
23
|
-
* @description: Add items to the shopping cart
|
|
22
|
+
* @summary: Add items to cart
|
|
23
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
24
24
|
*/
|
|
25
25
|
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
26
26
|
/**
|
|
@@ -29,8 +29,8 @@ declare class Cart {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
31
31
|
* @name addPriceAdjustment
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description:
|
|
32
|
+
* @summary: Create price adjustments
|
|
33
|
+
* @description: Create custom price adjustments for items in the cart, facilitating the application of discounts or promotions. Price adjustments can be tailored based on specific sales channel contexts, enhancing flexibility in pricing strategies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
34
34
|
*/
|
|
35
35
|
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
36
36
|
/**
|
|
@@ -39,8 +39,8 @@ declare class Cart {
|
|
|
39
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
41
41
|
* @name applyCoupon
|
|
42
|
-
* @summary: Apply
|
|
43
|
-
* @description: Apply a
|
|
42
|
+
* @summary: Apply coupon
|
|
43
|
+
* @description: Apply a coupon code to the customer's cart to trigger discounts on eligible items - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
|
|
44
44
|
*/
|
|
45
45
|
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
46
46
|
/**
|
|
@@ -54,7 +54,7 @@ declare class Cart {
|
|
|
54
54
|
*
|
|
55
55
|
* @name checkCartServiceability
|
|
56
56
|
* @summary: Check cart serviceability
|
|
57
|
-
* @description: Verify
|
|
57
|
+
* @description: Verify the serviceability of items in the cart at a specific pin code and ensure accurate delivery promises. System checks each item's availability and delivery feasibility, providing real-time information on serviceability and estimated delivery times. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
58
58
|
*/
|
|
59
59
|
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
60
60
|
/**
|
|
@@ -63,8 +63,8 @@ declare class Cart {
|
|
|
63
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
65
65
|
* @name checkoutCart
|
|
66
|
-
* @summary:
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Checkout cart
|
|
67
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
68
68
|
*/
|
|
69
69
|
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
70
70
|
/**
|
|
@@ -75,8 +75,8 @@ declare class Cart {
|
|
|
75
75
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
76
76
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
77
77
|
* @name createCartMetaConfig
|
|
78
|
-
* @summary: Create new cart meta
|
|
79
|
-
* @description: Create
|
|
78
|
+
* @summary: Create a new cart meta
|
|
79
|
+
* @description: Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCartMetaConfig/).
|
|
80
80
|
*/
|
|
81
81
|
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
82
82
|
/**
|
|
@@ -85,8 +85,8 @@ declare class Cart {
|
|
|
85
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
86
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
87
87
|
* @name createCoupon
|
|
88
|
-
* @summary: Create a
|
|
89
|
-
* @description:
|
|
88
|
+
* @summary: Create a coupon
|
|
89
|
+
* @description: Creates a new coupon based on the selected coupon type. Sellers can choose from multiple supported coupon types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable coupon criteria to meet specific business requirements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
90
90
|
*/
|
|
91
91
|
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
92
92
|
/**
|
|
@@ -95,8 +95,8 @@ declare class Cart {
|
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
96
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
97
97
|
* @name createPromotion
|
|
98
|
-
* @summary: Create a
|
|
99
|
-
* @description:
|
|
98
|
+
* @summary: Create a promotion
|
|
99
|
+
* @description: Creates a new promotion based on the selected promotion type. Sellers can choose from multiple supported promotion types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable promotion criteria to meet specific business requirements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
100
100
|
*/
|
|
101
101
|
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
102
102
|
/**
|
|
@@ -106,7 +106,7 @@ declare class Cart {
|
|
|
106
106
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
107
107
|
* @name deleteCart
|
|
108
108
|
* @summary: Delete a cart
|
|
109
|
-
* @description: Delete
|
|
109
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
110
110
|
*/
|
|
111
111
|
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
112
112
|
/**
|
|
@@ -117,8 +117,8 @@ declare class Cart {
|
|
|
117
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
118
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
119
119
|
* @name fetchAndvalidateCartItems
|
|
120
|
-
* @summary:
|
|
121
|
-
* @description: Retrieve and validate
|
|
120
|
+
* @summary: Get and validate cart items
|
|
121
|
+
* @description: Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
122
122
|
*/
|
|
123
123
|
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
124
124
|
/**
|
|
@@ -127,8 +127,8 @@ declare class Cart {
|
|
|
127
127
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
128
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
129
129
|
* @name fetchCartMetaConfig
|
|
130
|
-
* @summary:
|
|
131
|
-
* @description:
|
|
130
|
+
* @summary: Get cart meta
|
|
131
|
+
* @description: Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchCartMetaConfig/).
|
|
132
132
|
*/
|
|
133
133
|
fetchCartMetaConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
134
134
|
/**
|
|
@@ -137,8 +137,8 @@ declare class Cart {
|
|
|
137
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
138
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
139
139
|
* @name getAbandonedCart
|
|
140
|
-
* @summary:
|
|
141
|
-
* @description: Retrieve abandoned carts for
|
|
140
|
+
* @summary: Get abandoned carts
|
|
141
|
+
* @description: Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
142
142
|
*/
|
|
143
143
|
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
144
144
|
/**
|
|
@@ -150,7 +150,7 @@ declare class Cart {
|
|
|
150
150
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
151
151
|
* @name getAbandonedCartDetails
|
|
152
152
|
* @summary: Get abandoned cart details
|
|
153
|
-
* @description:
|
|
153
|
+
* @description: Retrieves abandoned cart details 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://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
154
154
|
*/
|
|
155
155
|
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
156
156
|
/**
|
|
@@ -159,8 +159,8 @@ declare class Cart {
|
|
|
159
159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
160
|
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
161
161
|
* @name getAddressById
|
|
162
|
-
* @summary:
|
|
163
|
-
* @description:
|
|
162
|
+
* @summary: Get a address
|
|
163
|
+
* @description: Retrieve 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://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
|
|
164
164
|
*/
|
|
165
165
|
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformAddress>;
|
|
166
166
|
/**
|
|
@@ -170,8 +170,8 @@ declare class Cart {
|
|
|
170
170
|
* @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
|
|
171
171
|
* Success response
|
|
172
172
|
* @name getAddresses
|
|
173
|
-
* @summary:
|
|
174
|
-
* @description:
|
|
173
|
+
* @summary: List customer addresses
|
|
174
|
+
* @description: Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
|
|
175
175
|
*/
|
|
176
176
|
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
|
|
177
177
|
/**
|
|
@@ -180,8 +180,8 @@ declare class Cart {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
182
182
|
* @name getAppCoupons
|
|
183
|
-
* @summary:
|
|
184
|
-
* @description: Retrieve coupons
|
|
183
|
+
* @summary: List coupons
|
|
184
|
+
* @description: Retrieve a list of 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://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
185
185
|
*/
|
|
186
186
|
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
187
187
|
/**
|
|
@@ -192,8 +192,8 @@ declare class Cart {
|
|
|
192
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
193
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
194
194
|
* @name getAvailableDeliveryModes
|
|
195
|
-
* @summary: Get
|
|
196
|
-
* @description: Retrieve a list of
|
|
195
|
+
* @summary: Get delivery modes
|
|
196
|
+
* @description: Retrieve a list of delivery modes (home delivery/store pickup) along with a list of available pickup stores for a given cart at a specified PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
197
197
|
*/
|
|
198
198
|
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
199
199
|
/**
|
|
@@ -202,8 +202,8 @@ declare class Cart {
|
|
|
202
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
204
204
|
* @name getCart
|
|
205
|
-
* @summary: Get cart
|
|
206
|
-
* @description: Retrieve
|
|
205
|
+
* @summary: Get a cart
|
|
206
|
+
* @description: Retrieve details of a cart linked to a specific customer using either the customer's ID or 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://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
207
207
|
*/
|
|
208
208
|
getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
209
209
|
/**
|
|
@@ -212,8 +212,8 @@ declare class Cart {
|
|
|
212
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
214
214
|
* @name getCartList
|
|
215
|
-
* @summary:
|
|
216
|
-
* @description: Retrieve
|
|
215
|
+
* @summary: List carts
|
|
216
|
+
* @description: Retrieve the list of active carts associated with a specific customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
217
217
|
*/
|
|
218
218
|
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
219
219
|
/**
|
|
@@ -222,8 +222,8 @@ declare class Cart {
|
|
|
222
222
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
223
223
|
* @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
|
|
224
224
|
* @name getCartShareLink
|
|
225
|
-
* @summary:
|
|
226
|
-
* @description:
|
|
225
|
+
* @summary: Share cart link
|
|
226
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/getCartShareLink/).
|
|
227
227
|
*/
|
|
228
228
|
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetShareCartLinkResponse>;
|
|
229
229
|
/**
|
|
@@ -232,8 +232,8 @@ declare class Cart {
|
|
|
232
232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
233
233
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
234
234
|
* @name getCartSharedItems
|
|
235
|
-
* @summary:
|
|
236
|
-
* @description: Retrieve the items shared
|
|
235
|
+
* @summary: List shared cart items
|
|
236
|
+
* @description: Retrieve the cart items from the shared cart link based on unique token. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
237
237
|
*/
|
|
238
238
|
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
239
239
|
/**
|
|
@@ -242,8 +242,8 @@ declare class Cart {
|
|
|
242
242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
243
243
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
244
244
|
* @name getCouponById
|
|
245
|
-
* @summary: Get coupon
|
|
246
|
-
* @description: Retrieve
|
|
245
|
+
* @summary: Get a coupon
|
|
246
|
+
* @description: Retrieve details of a specific coupon by providing its unique identifier to obtain information such as coupon type, rules, validity period and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
247
247
|
*/
|
|
248
248
|
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
249
249
|
/**
|
|
@@ -252,8 +252,8 @@ declare class Cart {
|
|
|
252
252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
253
253
|
* @returns {Promise<Object>} - Success response
|
|
254
254
|
* @name getCouponCodeExists
|
|
255
|
-
* @summary: Check
|
|
256
|
-
* @description:
|
|
255
|
+
* @summary: Check coupon code exists
|
|
256
|
+
* @description: Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
257
257
|
*/
|
|
258
258
|
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
259
259
|
/**
|
|
@@ -265,7 +265,7 @@ declare class Cart {
|
|
|
265
265
|
* @returns {Promise<Object>} - Success response
|
|
266
266
|
* @name getCouponOptionValues
|
|
267
267
|
* @summary: Get coupon option values
|
|
268
|
-
* @description:
|
|
268
|
+
* @description: Retrieves the available values for coupon options used to create and update coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
269
269
|
*/
|
|
270
270
|
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
271
271
|
/**
|
|
@@ -274,8 +274,8 @@ declare class Cart {
|
|
|
274
274
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
275
275
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
276
276
|
* @name getCoupons
|
|
277
|
-
* @summary:
|
|
278
|
-
* @description: Retrieve a list of
|
|
277
|
+
* @summary: List coupons
|
|
278
|
+
* @description: Retrieve a list of all created coupons for specific sales channel. It also supports searching based on text search, pagination and other flags to filter coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
279
279
|
*/
|
|
280
280
|
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
281
281
|
/**
|
|
@@ -284,8 +284,8 @@ declare class Cart {
|
|
|
284
284
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
285
285
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
286
286
|
* @name getItemCount
|
|
287
|
-
* @summary: Get
|
|
288
|
-
* @description: Retrieve the total
|
|
287
|
+
* @summary: Get a cart items count
|
|
288
|
+
* @description: Retrieve the total count of items currently present in the customer's cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
289
289
|
*/
|
|
290
290
|
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
291
291
|
/**
|
|
@@ -296,8 +296,8 @@ declare class Cart {
|
|
|
296
296
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
297
297
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
298
298
|
* @name getPromosCouponConfig
|
|
299
|
-
* @summary: Get promotion and coupon
|
|
300
|
-
* @description: Retrieve configuration settings
|
|
299
|
+
* @summary: Get promotion and coupon type
|
|
300
|
+
* @description: Retrieve the configuration settings related to promotions and coupons for a specific seller. It provides details of the supported types of coupons and promotions along with their descriptions, examples, and related attributes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
301
301
|
*/
|
|
302
302
|
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
303
303
|
/**
|
|
@@ -306,8 +306,8 @@ declare class Cart {
|
|
|
306
306
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
307
307
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
308
308
|
* @name getPromotionById
|
|
309
|
-
* @summary: Get promotion
|
|
310
|
-
* @description: Retrieve
|
|
309
|
+
* @summary: Get a promotion
|
|
310
|
+
* @description: Retrieve details of a specific promotion by providing its unique identifier to obtain information such as promotion type, rules, validity period and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
311
311
|
*/
|
|
312
312
|
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
313
313
|
/**
|
|
@@ -318,8 +318,8 @@ declare class Cart {
|
|
|
318
318
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
319
319
|
* @returns {Promise<Object>} - Success response
|
|
320
320
|
* @name getPromotionCodeExists
|
|
321
|
-
* @summary: Check
|
|
322
|
-
* @description:
|
|
321
|
+
* @summary: Check promotion code exists
|
|
322
|
+
* @description: Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
323
323
|
*/
|
|
324
324
|
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
325
325
|
/**
|
|
@@ -328,8 +328,8 @@ declare class Cart {
|
|
|
328
328
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
329
329
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
330
330
|
* @name getPromotions
|
|
331
|
-
* @summary:
|
|
332
|
-
* @description: Retrieve a list of
|
|
331
|
+
* @summary: List promotions
|
|
332
|
+
* @description: Retrieve a list of all created promotions for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized promotion listing for streamlined navigation and management. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
333
333
|
*/
|
|
334
334
|
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
335
335
|
/**
|
|
@@ -339,7 +339,7 @@ declare class Cart {
|
|
|
339
339
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
340
340
|
* Success response
|
|
341
341
|
* @name getShipments
|
|
342
|
-
* @summary: Get
|
|
342
|
+
* @summary: Get shipments details
|
|
343
343
|
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getShipments/).
|
|
344
344
|
*/
|
|
345
345
|
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
@@ -351,8 +351,8 @@ declare class Cart {
|
|
|
351
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
352
352
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
353
353
|
* @name getStoreAddressByUid
|
|
354
|
-
* @summary: Get
|
|
355
|
-
* @description: Retrieve
|
|
354
|
+
* @summary: Get Store Address
|
|
355
|
+
* @description: Retrieve store details by entering the unique identifier of the pickup stores. Store details include the seller's name, contact information such as email address or phone number and business address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
356
356
|
*/
|
|
357
357
|
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
358
358
|
/**
|
|
@@ -361,8 +361,8 @@ declare class Cart {
|
|
|
361
361
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
362
362
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
363
363
|
* @name overrideCart
|
|
364
|
-
* @summary:
|
|
365
|
-
* @description:
|
|
364
|
+
* @summary: Update cart checkout
|
|
365
|
+
* @description: Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
366
366
|
*/
|
|
367
367
|
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
368
368
|
/**
|
|
@@ -371,8 +371,8 @@ declare class Cart {
|
|
|
371
371
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
372
372
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
373
373
|
* @name platformAddItems
|
|
374
|
-
* @summary: Add items
|
|
375
|
-
* @description: Add items to the cart
|
|
374
|
+
* @summary: Add items to cart
|
|
375
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
376
376
|
*/
|
|
377
377
|
platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
378
378
|
/**
|
|
@@ -383,8 +383,8 @@ declare class Cart {
|
|
|
383
383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
384
384
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
385
385
|
* @name platformCheckoutCart
|
|
386
|
-
* @summary:
|
|
387
|
-
* @description:
|
|
386
|
+
* @summary: Checkout cart
|
|
387
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
388
388
|
*/
|
|
389
389
|
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
390
390
|
/**
|
|
@@ -395,8 +395,8 @@ declare class Cart {
|
|
|
395
395
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
396
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
397
397
|
* @name platformCheckoutCartV2
|
|
398
|
-
* @summary:
|
|
399
|
-
* @description:
|
|
398
|
+
* @summary: Cart checkout (latest)
|
|
399
|
+
* @description: Checkout process that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
400
400
|
*/
|
|
401
401
|
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
402
402
|
/**
|
|
@@ -405,8 +405,8 @@ declare class Cart {
|
|
|
405
405
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
406
406
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
407
407
|
* @name platformUpdateCart
|
|
408
|
-
* @summary: Update
|
|
409
|
-
* @description:
|
|
408
|
+
* @summary: Update cart items
|
|
409
|
+
* @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
|
|
410
410
|
*/
|
|
411
411
|
platformUpdateCart({ body, id, i, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
412
412
|
/**
|
|
@@ -415,8 +415,8 @@ declare class Cart {
|
|
|
415
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
416
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
417
417
|
* @name removeAddress
|
|
418
|
-
* @summary:
|
|
419
|
-
* @description:
|
|
418
|
+
* @summary: Delete a address
|
|
419
|
+
* @description: Remove an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
420
420
|
*/
|
|
421
421
|
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
422
422
|
/**
|
|
@@ -425,8 +425,8 @@ declare class Cart {
|
|
|
425
425
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
426
426
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
427
427
|
* @name removeCoupon
|
|
428
|
-
* @summary: Remove
|
|
429
|
-
* @description: Remove
|
|
428
|
+
* @summary: Remove coupon
|
|
429
|
+
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
430
430
|
*/
|
|
431
431
|
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
432
432
|
/**
|
|
@@ -438,7 +438,7 @@ declare class Cart {
|
|
|
438
438
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
439
439
|
* @name removePriceAdjustment
|
|
440
440
|
* @summary: Remove price adjustments
|
|
441
|
-
* @description: Remove price adjustments
|
|
441
|
+
* @description: Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
442
442
|
*/
|
|
443
443
|
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
444
444
|
/**
|
|
@@ -447,8 +447,8 @@ declare class Cart {
|
|
|
447
447
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
448
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
449
449
|
* @name selectAddress
|
|
450
|
-
* @summary:
|
|
451
|
-
* @description: Select
|
|
450
|
+
* @summary: select a delivery address
|
|
451
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
|
|
452
452
|
*/
|
|
453
453
|
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
454
454
|
/**
|
|
@@ -457,8 +457,8 @@ declare class Cart {
|
|
|
457
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
458
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
459
459
|
* @name selectPaymentMode
|
|
460
|
-
* @summary: Select
|
|
461
|
-
* @description:
|
|
460
|
+
* @summary: Select payment mode
|
|
461
|
+
* @description: Customers can 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://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
462
462
|
*/
|
|
463
463
|
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
464
464
|
/**
|
|
@@ -467,8 +467,8 @@ declare class Cart {
|
|
|
467
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
468
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
469
469
|
* @name selectPaymentModeV2
|
|
470
|
-
* @summary: Select
|
|
471
|
-
* @description:
|
|
470
|
+
* @summary: Select payment mode (latest)
|
|
471
|
+
* @description: Selection of payment mode that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
472
472
|
*/
|
|
473
473
|
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
474
474
|
/**
|
|
@@ -478,7 +478,7 @@ declare class Cart {
|
|
|
478
478
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
479
479
|
* @name updateAddress
|
|
480
480
|
* @summary: Update address
|
|
481
|
-
* @description:
|
|
481
|
+
* @description: Update the user address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
482
482
|
*/
|
|
483
483
|
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
484
484
|
/**
|
|
@@ -488,7 +488,7 @@ declare class Cart {
|
|
|
488
488
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
489
489
|
* @name updateCart
|
|
490
490
|
* @summary: Update cart items
|
|
491
|
-
* @description:
|
|
491
|
+
* @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
492
492
|
*/
|
|
493
493
|
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
494
494
|
/**
|
|
@@ -498,7 +498,7 @@ declare class Cart {
|
|
|
498
498
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
499
499
|
* @name updateCartMeta
|
|
500
500
|
* @summary: Update cart metadata
|
|
501
|
-
* @description:
|
|
501
|
+
* @description: Add or modify 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://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
502
502
|
*/
|
|
503
503
|
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
504
504
|
/**
|
|
@@ -509,8 +509,8 @@ declare class Cart {
|
|
|
509
509
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
510
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
511
511
|
* @name updateCartMetaConfig
|
|
512
|
-
* @summary: Update cart
|
|
513
|
-
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
512
|
+
* @summary: Update cart meta
|
|
513
|
+
* @description: Modify the configuration settings for cart metadata associated with a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
514
514
|
*/
|
|
515
515
|
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
516
516
|
/**
|
|
@@ -519,8 +519,8 @@ declare class Cart {
|
|
|
519
519
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
520
520
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
521
521
|
* @name updateCartUser
|
|
522
|
-
* @summary: Update
|
|
523
|
-
* @description: Modify user
|
|
522
|
+
* @summary: Update user of a cart
|
|
523
|
+
* @description: Modify the cart user to a new valid customer for the provided customer ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
524
524
|
*/
|
|
525
525
|
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
526
526
|
/**
|
|
@@ -531,8 +531,8 @@ declare class Cart {
|
|
|
531
531
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
532
532
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
533
533
|
* @name updateCartWithSharedItems
|
|
534
|
-
* @summary: Update cart
|
|
535
|
-
* @description:
|
|
534
|
+
* @summary: Update shared cart items
|
|
535
|
+
* @description: Customer can either merge or replace shared cart items with existing cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
536
536
|
*/
|
|
537
537
|
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
538
538
|
/**
|
|
@@ -542,7 +542,7 @@ declare class Cart {
|
|
|
542
542
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
543
543
|
* @name updateCoupon
|
|
544
544
|
* @summary: Update a coupon
|
|
545
|
-
* @description:
|
|
545
|
+
* @description: Update the details of an existing coupon by specifying its unique identifier. This includes modifying coupon attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
546
546
|
*/
|
|
547
547
|
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
548
548
|
/**
|
|
@@ -553,8 +553,8 @@ declare class Cart {
|
|
|
553
553
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
554
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
555
555
|
* @name updateCouponPartially
|
|
556
|
-
* @summary:
|
|
557
|
-
* @description:
|
|
556
|
+
* @summary: Update a coupon partially
|
|
557
|
+
* @description: Seller can make partial adjustments of an existing coupon by specifying its unique identifier. It enables businesses to modify specific attributes of the coupon while preserving other details intact. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
558
558
|
*/
|
|
559
559
|
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
560
560
|
/**
|
|
@@ -566,7 +566,7 @@ declare class Cart {
|
|
|
566
566
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
567
567
|
* @name updatePriceAdjustment
|
|
568
568
|
* @summary: Update price adjustments
|
|
569
|
-
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
569
|
+
* @description: Modify price adjustments for specific items in the cart. By providing the seller ID, sales channel ID, and price adjustment ID, seller can apply discounts or other adjustments to the prices of cart items, facilitating dynamic pricing strategies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
570
570
|
*/
|
|
571
571
|
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
572
572
|
/**
|
|
@@ -576,7 +576,7 @@ declare class Cart {
|
|
|
576
576
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
577
577
|
* @name updatePromotion
|
|
578
578
|
* @summary: Update a promotion
|
|
579
|
-
* @description:
|
|
579
|
+
* @description: Update the details of an existing promotion by specifying its unique identifier. This includes modifying promotion attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
580
580
|
*/
|
|
581
581
|
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
582
582
|
/**
|
|
@@ -587,8 +587,8 @@ declare class Cart {
|
|
|
587
587
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
588
588
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
589
589
|
* @name updatePromotionPartially
|
|
590
|
-
* @summary:
|
|
591
|
-
* @description:
|
|
590
|
+
* @summary: Update a promotion partially
|
|
591
|
+
* @description: Seller can make partial adjustments of an existing promotion by specifying its unique identifier. It enables businesses to modify specific attributes of the promotion while preserving other details intact. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
592
592
|
*/
|
|
593
593
|
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
594
594
|
/**
|
|
@@ -598,8 +598,8 @@ declare class Cart {
|
|
|
598
598
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
599
599
|
* Success response
|
|
600
600
|
* @name updateShipments
|
|
601
|
-
* @summary: Update
|
|
602
|
-
* @description:
|
|
601
|
+
* @summary: Update shipments
|
|
602
|
+
* @description: Update the quantity or delivery type of the shipments. Customers can switch the order type from Home Delivery to Pick At Store and vice versa. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
603
603
|
*/
|
|
604
604
|
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
605
605
|
/**
|
|
@@ -610,8 +610,8 @@ declare class Cart {
|
|
|
610
610
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
611
611
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
612
612
|
* @name validateCouponForPayment
|
|
613
|
-
* @summary: Validate
|
|
614
|
-
* @description:
|
|
613
|
+
* @summary: Validate applied coupon
|
|
614
|
+
* @description: Validates 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://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
615
615
|
*/
|
|
616
616
|
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
617
617
|
}
|