@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
|
@@ -21,8 +21,8 @@ class Cart {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
23
23
|
* @name addAddress
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Create a new address
|
|
25
|
+
* @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/).
|
|
26
26
|
*/
|
|
27
27
|
async addAddress(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -98,8 +98,8 @@ class Cart {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
100
100
|
* @name addItems
|
|
101
|
-
* @summary: Add items to
|
|
102
|
-
* @description: Add items to the shopping cart
|
|
101
|
+
* @summary: Add items to cart
|
|
102
|
+
* @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/).
|
|
103
103
|
*/
|
|
104
104
|
async addItems(
|
|
105
105
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,8 +180,8 @@ class Cart {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
182
182
|
* @name addPriceAdjustment
|
|
183
|
-
* @summary:
|
|
184
|
-
* @description:
|
|
183
|
+
* @summary: Create price adjustments
|
|
184
|
+
* @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/).
|
|
185
185
|
*/
|
|
186
186
|
async addPriceAdjustment(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -259,8 +259,8 @@ class Cart {
|
|
|
259
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
260
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
261
261
|
* @name applyCoupon
|
|
262
|
-
* @summary: Apply
|
|
263
|
-
* @description: Apply a
|
|
262
|
+
* @summary: Apply coupon
|
|
263
|
+
* @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/).
|
|
264
264
|
*/
|
|
265
265
|
async applyCoupon(
|
|
266
266
|
{ body, i, b, p, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -356,7 +356,7 @@ class Cart {
|
|
|
356
356
|
*
|
|
357
357
|
* @name checkCartServiceability
|
|
358
358
|
* @summary: Check cart serviceability
|
|
359
|
-
* @description: Verify
|
|
359
|
+
* @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/).
|
|
360
360
|
*/
|
|
361
361
|
async checkCartServiceability(
|
|
362
362
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -434,8 +434,8 @@ class Cart {
|
|
|
434
434
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
435
435
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
436
436
|
* @name checkoutCart
|
|
437
|
-
* @summary:
|
|
438
|
-
* @description:
|
|
437
|
+
* @summary: Checkout cart
|
|
438
|
+
* @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/).
|
|
439
439
|
*/
|
|
440
440
|
async checkoutCart(
|
|
441
441
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -513,8 +513,8 @@ class Cart {
|
|
|
513
513
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
514
514
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
515
515
|
* @name createCartMetaConfig
|
|
516
|
-
* @summary: Create new cart meta
|
|
517
|
-
* @description: Create
|
|
516
|
+
* @summary: Create a new cart meta
|
|
517
|
+
* @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/).
|
|
518
518
|
*/
|
|
519
519
|
async createCartMetaConfig(
|
|
520
520
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -592,8 +592,8 @@ class Cart {
|
|
|
592
592
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
593
593
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
594
594
|
* @name createCoupon
|
|
595
|
-
* @summary: Create a
|
|
596
|
-
* @description:
|
|
595
|
+
* @summary: Create a coupon
|
|
596
|
+
* @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/).
|
|
597
597
|
*/
|
|
598
598
|
async createCoupon(
|
|
599
599
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -669,8 +669,8 @@ class Cart {
|
|
|
669
669
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
670
670
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
671
671
|
* @name createPromotion
|
|
672
|
-
* @summary: Create a
|
|
673
|
-
* @description:
|
|
672
|
+
* @summary: Create a promotion
|
|
673
|
+
* @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/).
|
|
674
674
|
*/
|
|
675
675
|
async createPromotion(
|
|
676
676
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -749,7 +749,7 @@ class Cart {
|
|
|
749
749
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
750
750
|
* @name deleteCart
|
|
751
751
|
* @summary: Delete a cart
|
|
752
|
-
* @description: Delete
|
|
752
|
+
* @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/).
|
|
753
753
|
*/
|
|
754
754
|
async deleteCart(
|
|
755
755
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -830,8 +830,8 @@ class Cart {
|
|
|
830
830
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
831
831
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
832
832
|
* @name fetchAndvalidateCartItems
|
|
833
|
-
* @summary:
|
|
834
|
-
* @description: Retrieve and validate
|
|
833
|
+
* @summary: Get and validate cart items
|
|
834
|
+
* @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/).
|
|
835
835
|
*/
|
|
836
836
|
async fetchAndvalidateCartItems(
|
|
837
837
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -909,8 +909,8 @@ class Cart {
|
|
|
909
909
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
910
910
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
911
911
|
* @name fetchCartMetaConfig
|
|
912
|
-
* @summary:
|
|
913
|
-
* @description:
|
|
912
|
+
* @summary: Get cart meta
|
|
913
|
+
* @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/).
|
|
914
914
|
*/
|
|
915
915
|
async fetchCartMetaConfig(
|
|
916
916
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -984,8 +984,8 @@ class Cart {
|
|
|
984
984
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
985
985
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
986
986
|
* @name getAbandonedCart
|
|
987
|
-
* @summary:
|
|
988
|
-
* @description: Retrieve abandoned carts for
|
|
987
|
+
* @summary: Get abandoned carts
|
|
988
|
+
* @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/).
|
|
989
989
|
*/
|
|
990
990
|
async getAbandonedCart(
|
|
991
991
|
{
|
|
@@ -1094,7 +1094,7 @@ class Cart {
|
|
|
1094
1094
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
1095
1095
|
* @name getAbandonedCartDetails
|
|
1096
1096
|
* @summary: Get abandoned cart details
|
|
1097
|
-
* @description:
|
|
1097
|
+
* @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/).
|
|
1098
1098
|
*/
|
|
1099
1099
|
async getAbandonedCartDetails(
|
|
1100
1100
|
{ id, i, b, c, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1182,8 +1182,8 @@ class Cart {
|
|
|
1182
1182
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1183
1183
|
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
1184
1184
|
* @name getAddressById
|
|
1185
|
-
* @summary:
|
|
1186
|
-
* @description:
|
|
1185
|
+
* @summary: Get a address
|
|
1186
|
+
* @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/).
|
|
1187
1187
|
*/
|
|
1188
1188
|
async getAddressById(
|
|
1189
1189
|
{
|
|
@@ -1293,8 +1293,8 @@ class Cart {
|
|
|
1293
1293
|
* @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
|
|
1294
1294
|
* Success response
|
|
1295
1295
|
* @name getAddresses
|
|
1296
|
-
* @summary:
|
|
1297
|
-
* @description:
|
|
1296
|
+
* @summary: List customer addresses
|
|
1297
|
+
* @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/).
|
|
1298
1298
|
*/
|
|
1299
1299
|
async getAddresses(
|
|
1300
1300
|
{
|
|
@@ -1398,8 +1398,8 @@ class Cart {
|
|
|
1398
1398
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1399
1399
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
1400
1400
|
* @name getAppCoupons
|
|
1401
|
-
* @summary:
|
|
1402
|
-
* @description: Retrieve coupons
|
|
1401
|
+
* @summary: List coupons
|
|
1402
|
+
* @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/).
|
|
1403
1403
|
*/
|
|
1404
1404
|
async getAppCoupons(
|
|
1405
1405
|
{ id, buyNow, slug, storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1487,8 +1487,8 @@ class Cart {
|
|
|
1487
1487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1488
1488
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
1489
1489
|
* @name getAvailableDeliveryModes
|
|
1490
|
-
* @summary: Get
|
|
1491
|
-
* @description: Retrieve a list of
|
|
1490
|
+
* @summary: Get delivery modes
|
|
1491
|
+
* @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/).
|
|
1492
1492
|
*/
|
|
1493
1493
|
async getAvailableDeliveryModes(
|
|
1494
1494
|
{ areaCode, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1570,8 +1570,8 @@ class Cart {
|
|
|
1570
1570
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1571
1571
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
1572
1572
|
* @name getCart
|
|
1573
|
-
* @summary: Get cart
|
|
1574
|
-
* @description: Retrieve
|
|
1573
|
+
* @summary: Get a cart
|
|
1574
|
+
* @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/).
|
|
1575
1575
|
*/
|
|
1576
1576
|
async getCart(
|
|
1577
1577
|
{ id, userId, i, b, assignCardId, buyNow, requestHeaders } = {
|
|
@@ -1665,8 +1665,8 @@ class Cart {
|
|
|
1665
1665
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1666
1666
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
1667
1667
|
* @name getCartList
|
|
1668
|
-
* @summary:
|
|
1669
|
-
* @description: Retrieve
|
|
1668
|
+
* @summary: List carts
|
|
1669
|
+
* @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/).
|
|
1670
1670
|
*/
|
|
1671
1671
|
async getCartList(
|
|
1672
1672
|
{ fromDate, toDate, filterOn, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1749,8 +1749,8 @@ class Cart {
|
|
|
1749
1749
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1750
1750
|
* @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
|
|
1751
1751
|
* @name getCartShareLink
|
|
1752
|
-
* @summary:
|
|
1753
|
-
* @description:
|
|
1752
|
+
* @summary: Share cart link
|
|
1753
|
+
* @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/).
|
|
1754
1754
|
*/
|
|
1755
1755
|
async getCartShareLink(
|
|
1756
1756
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1828,8 +1828,8 @@ class Cart {
|
|
|
1828
1828
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1829
1829
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
1830
1830
|
* @name getCartSharedItems
|
|
1831
|
-
* @summary:
|
|
1832
|
-
* @description: Retrieve the items shared
|
|
1831
|
+
* @summary: List shared cart items
|
|
1832
|
+
* @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/).
|
|
1833
1833
|
*/
|
|
1834
1834
|
async getCartSharedItems(
|
|
1835
1835
|
{ token, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1907,8 +1907,8 @@ class Cart {
|
|
|
1907
1907
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1908
1908
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
1909
1909
|
* @name getCouponById
|
|
1910
|
-
* @summary: Get coupon
|
|
1911
|
-
* @description: Retrieve
|
|
1910
|
+
* @summary: Get a coupon
|
|
1911
|
+
* @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/).
|
|
1912
1912
|
*/
|
|
1913
1913
|
async getCouponById(
|
|
1914
1914
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1984,8 +1984,8 @@ class Cart {
|
|
|
1984
1984
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1985
1985
|
* @returns {Promise<Object>} - Success response
|
|
1986
1986
|
* @name getCouponCodeExists
|
|
1987
|
-
* @summary: Check
|
|
1988
|
-
* @description:
|
|
1987
|
+
* @summary: Check coupon code exists
|
|
1988
|
+
* @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/).
|
|
1989
1989
|
*/
|
|
1990
1990
|
async getCouponCodeExists(
|
|
1991
1991
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2065,7 +2065,7 @@ class Cart {
|
|
|
2065
2065
|
* @returns {Promise<Object>} - Success response
|
|
2066
2066
|
* @name getCouponOptionValues
|
|
2067
2067
|
* @summary: Get coupon option values
|
|
2068
|
-
* @description:
|
|
2068
|
+
* @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/).
|
|
2069
2069
|
*/
|
|
2070
2070
|
async getCouponOptionValues(
|
|
2071
2071
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2137,8 +2137,8 @@ class Cart {
|
|
|
2137
2137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2138
2138
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
2139
2139
|
* @name getCoupons
|
|
2140
|
-
* @summary:
|
|
2141
|
-
* @description: Retrieve a list of
|
|
2140
|
+
* @summary: List coupons
|
|
2141
|
+
* @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/).
|
|
2142
2142
|
*/
|
|
2143
2143
|
async getCoupons(
|
|
2144
2144
|
{
|
|
@@ -2246,8 +2246,8 @@ class Cart {
|
|
|
2246
2246
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2247
2247
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
2248
2248
|
* @name getItemCount
|
|
2249
|
-
* @summary: Get
|
|
2250
|
-
* @description: Retrieve the total
|
|
2249
|
+
* @summary: Get a cart items count
|
|
2250
|
+
* @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/).
|
|
2251
2251
|
*/
|
|
2252
2252
|
async getItemCount(
|
|
2253
2253
|
{ id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2329,8 +2329,8 @@ class Cart {
|
|
|
2329
2329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2330
2330
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
2331
2331
|
* @name getPromosCouponConfig
|
|
2332
|
-
* @summary: Get promotion and coupon
|
|
2333
|
-
* @description: Retrieve configuration settings
|
|
2332
|
+
* @summary: Get promotion and coupon type
|
|
2333
|
+
* @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/).
|
|
2334
2334
|
*/
|
|
2335
2335
|
async getPromosCouponConfig(
|
|
2336
2336
|
{ entityType, isHidden, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2412,8 +2412,8 @@ class Cart {
|
|
|
2412
2412
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2413
2413
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
2414
2414
|
* @name getPromotionById
|
|
2415
|
-
* @summary: Get promotion
|
|
2416
|
-
* @description: Retrieve
|
|
2415
|
+
* @summary: Get a promotion
|
|
2416
|
+
* @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/).
|
|
2417
2417
|
*/
|
|
2418
2418
|
async getPromotionById(
|
|
2419
2419
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2493,8 +2493,8 @@ class Cart {
|
|
|
2493
2493
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2494
2494
|
* @returns {Promise<Object>} - Success response
|
|
2495
2495
|
* @name getPromotionCodeExists
|
|
2496
|
-
* @summary: Check
|
|
2497
|
-
* @description:
|
|
2496
|
+
* @summary: Check promotion code exists
|
|
2497
|
+
* @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/).
|
|
2498
2498
|
*/
|
|
2499
2499
|
async getPromotionCodeExists(
|
|
2500
2500
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2571,8 +2571,8 @@ class Cart {
|
|
|
2571
2571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2572
2572
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
2573
2573
|
* @name getPromotions
|
|
2574
|
-
* @summary:
|
|
2575
|
-
* @description: Retrieve a list of
|
|
2574
|
+
* @summary: List promotions
|
|
2575
|
+
* @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/).
|
|
2576
2576
|
*/
|
|
2577
2577
|
async getPromotions(
|
|
2578
2578
|
{
|
|
@@ -2681,7 +2681,7 @@ class Cart {
|
|
|
2681
2681
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
2682
2682
|
* Success response
|
|
2683
2683
|
* @name getShipments
|
|
2684
|
-
* @summary: Get
|
|
2684
|
+
* @summary: Get shipments details
|
|
2685
2685
|
* @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/).
|
|
2686
2686
|
*/
|
|
2687
2687
|
async getShipments(
|
|
@@ -2792,8 +2792,8 @@ class Cart {
|
|
|
2792
2792
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2793
2793
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
2794
2794
|
* @name getStoreAddressByUid
|
|
2795
|
-
* @summary: Get
|
|
2796
|
-
* @description: Retrieve
|
|
2795
|
+
* @summary: Get Store Address
|
|
2796
|
+
* @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/).
|
|
2797
2797
|
*/
|
|
2798
2798
|
async getStoreAddressByUid(
|
|
2799
2799
|
{ storeUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2872,8 +2872,8 @@ class Cart {
|
|
|
2872
2872
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2873
2873
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
2874
2874
|
* @name overrideCart
|
|
2875
|
-
* @summary:
|
|
2876
|
-
* @description:
|
|
2875
|
+
* @summary: Update cart checkout
|
|
2876
|
+
* @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/).
|
|
2877
2877
|
*/
|
|
2878
2878
|
async overrideCart(
|
|
2879
2879
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2949,8 +2949,8 @@ class Cart {
|
|
|
2949
2949
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2950
2950
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
2951
2951
|
* @name platformAddItems
|
|
2952
|
-
* @summary: Add items
|
|
2953
|
-
* @description: Add items to the cart
|
|
2952
|
+
* @summary: Add items to cart
|
|
2953
|
+
* @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/).
|
|
2954
2954
|
*/
|
|
2955
2955
|
async platformAddItems(
|
|
2956
2956
|
{ body, i, b, buyNow, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3042,8 +3042,8 @@ class Cart {
|
|
|
3042
3042
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3043
3043
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
3044
3044
|
* @name platformCheckoutCart
|
|
3045
|
-
* @summary:
|
|
3046
|
-
* @description:
|
|
3045
|
+
* @summary: Checkout cart
|
|
3046
|
+
* @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/).
|
|
3047
3047
|
*/
|
|
3048
3048
|
async platformCheckoutCart(
|
|
3049
3049
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3126,8 +3126,8 @@ class Cart {
|
|
|
3126
3126
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3127
3127
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
3128
3128
|
* @name platformCheckoutCartV2
|
|
3129
|
-
* @summary:
|
|
3130
|
-
* @description:
|
|
3129
|
+
* @summary: Cart checkout (latest)
|
|
3130
|
+
* @description: Checkout process that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
3131
3131
|
*/
|
|
3132
3132
|
async platformCheckoutCartV2(
|
|
3133
3133
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3208,8 +3208,8 @@ class Cart {
|
|
|
3208
3208
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3209
3209
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
3210
3210
|
* @name platformUpdateCart
|
|
3211
|
-
* @summary: Update
|
|
3212
|
-
* @description:
|
|
3211
|
+
* @summary: Update cart items
|
|
3212
|
+
* @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/).
|
|
3213
3213
|
*/
|
|
3214
3214
|
async platformUpdateCart(
|
|
3215
3215
|
{ body, id, i, b, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3299,8 +3299,8 @@ class Cart {
|
|
|
3299
3299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3300
3300
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
3301
3301
|
* @name removeAddress
|
|
3302
|
-
* @summary:
|
|
3303
|
-
* @description:
|
|
3302
|
+
* @summary: Delete a address
|
|
3303
|
+
* @description: Remove an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
3304
3304
|
*/
|
|
3305
3305
|
async removeAddress(
|
|
3306
3306
|
{ id, userId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3379,8 +3379,8 @@ class Cart {
|
|
|
3379
3379
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3380
3380
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3381
3381
|
* @name removeCoupon
|
|
3382
|
-
* @summary: Remove
|
|
3383
|
-
* @description: Remove
|
|
3382
|
+
* @summary: Remove coupon
|
|
3383
|
+
* @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/).
|
|
3384
3384
|
*/
|
|
3385
3385
|
async removeCoupon(
|
|
3386
3386
|
{ uid, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3463,7 +3463,7 @@ class Cart {
|
|
|
3463
3463
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
3464
3464
|
* @name removePriceAdjustment
|
|
3465
3465
|
* @summary: Remove price adjustments
|
|
3466
|
-
* @description: Remove price adjustments
|
|
3466
|
+
* @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/).
|
|
3467
3467
|
*/
|
|
3468
3468
|
async removePriceAdjustment(
|
|
3469
3469
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3541,8 +3541,8 @@ class Cart {
|
|
|
3541
3541
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3542
3542
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3543
3543
|
* @name selectAddress
|
|
3544
|
-
* @summary:
|
|
3545
|
-
* @description: Select
|
|
3544
|
+
* @summary: select a delivery address
|
|
3545
|
+
* @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/).
|
|
3546
3546
|
*/
|
|
3547
3547
|
async selectAddress(
|
|
3548
3548
|
{ body, cartId, buyNow, i, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3630,8 +3630,8 @@ class Cart {
|
|
|
3630
3630
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3631
3631
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3632
3632
|
* @name selectPaymentMode
|
|
3633
|
-
* @summary: Select
|
|
3634
|
-
* @description:
|
|
3633
|
+
* @summary: Select payment mode
|
|
3634
|
+
* @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/).
|
|
3635
3635
|
*/
|
|
3636
3636
|
async selectPaymentMode(
|
|
3637
3637
|
{ body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3718,8 +3718,8 @@ class Cart {
|
|
|
3718
3718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3719
3719
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3720
3720
|
* @name selectPaymentModeV2
|
|
3721
|
-
* @summary: Select
|
|
3722
|
-
* @description:
|
|
3721
|
+
* @summary: Select payment mode (latest)
|
|
3722
|
+
* @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/).
|
|
3723
3723
|
*/
|
|
3724
3724
|
async selectPaymentModeV2(
|
|
3725
3725
|
{ body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3807,7 +3807,7 @@ class Cart {
|
|
|
3807
3807
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
3808
3808
|
* @name updateAddress
|
|
3809
3809
|
* @summary: Update address
|
|
3810
|
-
* @description:
|
|
3810
|
+
* @description: Update the user address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
3811
3811
|
*/
|
|
3812
3812
|
async updateAddress(
|
|
3813
3813
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3886,7 +3886,7 @@ class Cart {
|
|
|
3886
3886
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
3887
3887
|
* @name updateCart
|
|
3888
3888
|
* @summary: Update cart items
|
|
3889
|
-
* @description:
|
|
3889
|
+
* @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/).
|
|
3890
3890
|
*/
|
|
3891
3891
|
async updateCart(
|
|
3892
3892
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3968,7 +3968,7 @@ class Cart {
|
|
|
3968
3968
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
3969
3969
|
* @name updateCartMeta
|
|
3970
3970
|
* @summary: Update cart metadata
|
|
3971
|
-
* @description:
|
|
3971
|
+
* @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/).
|
|
3972
3972
|
*/
|
|
3973
3973
|
async updateCartMeta(
|
|
3974
3974
|
{ body, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4054,8 +4054,8 @@ class Cart {
|
|
|
4054
4054
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4055
4055
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
4056
4056
|
* @name updateCartMetaConfig
|
|
4057
|
-
* @summary: Update cart
|
|
4058
|
-
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
4057
|
+
* @summary: Update cart meta
|
|
4058
|
+
* @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/).
|
|
4059
4059
|
*/
|
|
4060
4060
|
async updateCartMetaConfig(
|
|
4061
4061
|
{ cartMetaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4135,8 +4135,8 @@ class Cart {
|
|
|
4135
4135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4136
4136
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
4137
4137
|
* @name updateCartUser
|
|
4138
|
-
* @summary: Update
|
|
4139
|
-
* @description: Modify user
|
|
4138
|
+
* @summary: Update user of a cart
|
|
4139
|
+
* @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/).
|
|
4140
4140
|
*/
|
|
4141
4141
|
async updateCartUser(
|
|
4142
4142
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4219,8 +4219,8 @@ class Cart {
|
|
|
4219
4219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4220
4220
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
4221
4221
|
* @name updateCartWithSharedItems
|
|
4222
|
-
* @summary: Update cart
|
|
4223
|
-
* @description:
|
|
4222
|
+
* @summary: Update shared cart items
|
|
4223
|
+
* @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/).
|
|
4224
4224
|
*/
|
|
4225
4225
|
async updateCartWithSharedItems(
|
|
4226
4226
|
{ token, action, cartId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4304,7 +4304,7 @@ class Cart {
|
|
|
4304
4304
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4305
4305
|
* @name updateCoupon
|
|
4306
4306
|
* @summary: Update a coupon
|
|
4307
|
-
* @description:
|
|
4307
|
+
* @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/).
|
|
4308
4308
|
*/
|
|
4309
4309
|
async updateCoupon(
|
|
4310
4310
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4384,8 +4384,8 @@ class Cart {
|
|
|
4384
4384
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4385
4385
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4386
4386
|
* @name updateCouponPartially
|
|
4387
|
-
* @summary:
|
|
4388
|
-
* @description:
|
|
4387
|
+
* @summary: Update a coupon partially
|
|
4388
|
+
* @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/).
|
|
4389
4389
|
*/
|
|
4390
4390
|
async updateCouponPartially(
|
|
4391
4391
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4468,7 +4468,7 @@ class Cart {
|
|
|
4468
4468
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
4469
4469
|
* @name updatePriceAdjustment
|
|
4470
4470
|
* @summary: Update price adjustments
|
|
4471
|
-
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
4471
|
+
* @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/).
|
|
4472
4472
|
*/
|
|
4473
4473
|
async updatePriceAdjustment(
|
|
4474
4474
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4549,7 +4549,7 @@ class Cart {
|
|
|
4549
4549
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
4550
4550
|
* @name updatePromotion
|
|
4551
4551
|
* @summary: Update a promotion
|
|
4552
|
-
* @description:
|
|
4552
|
+
* @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/).
|
|
4553
4553
|
*/
|
|
4554
4554
|
async updatePromotion(
|
|
4555
4555
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4631,8 +4631,8 @@ class Cart {
|
|
|
4631
4631
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4632
4632
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4633
4633
|
* @name updatePromotionPartially
|
|
4634
|
-
* @summary:
|
|
4635
|
-
* @description:
|
|
4634
|
+
* @summary: Update a promotion partially
|
|
4635
|
+
* @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/).
|
|
4636
4636
|
*/
|
|
4637
4637
|
async updatePromotionPartially(
|
|
4638
4638
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4713,8 +4713,8 @@ class Cart {
|
|
|
4713
4713
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
4714
4714
|
* Success response
|
|
4715
4715
|
* @name updateShipments
|
|
4716
|
-
* @summary: Update
|
|
4717
|
-
* @description:
|
|
4716
|
+
* @summary: Update shipments
|
|
4717
|
+
* @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/).
|
|
4718
4718
|
*/
|
|
4719
4719
|
async updateShipments(
|
|
4720
4720
|
{ body, i, p, id, addressId, areaCode, orderType, requestHeaders } = {
|
|
@@ -4814,8 +4814,8 @@ class Cart {
|
|
|
4814
4814
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4815
4815
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
4816
4816
|
* @name validateCouponForPayment
|
|
4817
|
-
* @summary: Validate
|
|
4818
|
-
* @description:
|
|
4817
|
+
* @summary: Validate applied coupon
|
|
4818
|
+
* @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/).
|
|
4819
4819
|
*/
|
|
4820
4820
|
async validateCouponForPayment(
|
|
4821
4821
|
{
|