@gofynd/fdk-client-javascript 3.3.5 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -22,7 +22,7 @@ class Cart {
|
|
|
22
22
|
* @returns {Promise<CartPlatformModel.SaveAddressDetails>} - Success response
|
|
23
23
|
* @name addAddress
|
|
24
24
|
* @summary: Creates a new address for a customer
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/cart/addAddress/).
|
|
26
26
|
*/
|
|
27
27
|
async addAddress(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,7 +99,7 @@ class Cart {
|
|
|
99
99
|
* @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
|
|
100
100
|
* @name addItems
|
|
101
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/cart/addItems/).
|
|
103
103
|
*/
|
|
104
104
|
async addItems(
|
|
105
105
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,7 +181,7 @@ class Cart {
|
|
|
181
181
|
* @returns {Promise<CartPlatformModel.GetPriceAdjustmentResult>} - Success response
|
|
182
182
|
* @name addPriceAdjustment
|
|
183
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/cart/addPriceAdjustment/).
|
|
185
185
|
*/
|
|
186
186
|
async addPriceAdjustment(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,7 +260,7 @@ class Cart {
|
|
|
260
260
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
261
261
|
* @name applyCoupon
|
|
262
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://
|
|
263
|
+
* @description: Apply a coupon code to the customer's cart to trigger discounts on eligible items - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/applyCoupon/).
|
|
264
264
|
*/
|
|
265
265
|
async applyCoupon(
|
|
266
266
|
{ body, xOrderingSource, i, b, p, id, buyNow, requestHeaders } = {
|
|
@@ -359,7 +359,7 @@ class Cart {
|
|
|
359
359
|
* Success response
|
|
360
360
|
* @name checkCartServiceability
|
|
361
361
|
* @summary: Check cart serviceability
|
|
362
|
-
* @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://
|
|
362
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/checkCartServiceability/).
|
|
363
363
|
*/
|
|
364
364
|
async checkCartServiceability(
|
|
365
365
|
{ body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
|
|
@@ -440,7 +440,7 @@ class Cart {
|
|
|
440
440
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResult>} - Success response
|
|
441
441
|
* @name checkoutCart
|
|
442
442
|
* @summary: Checkout cart
|
|
443
|
-
* @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://
|
|
443
|
+
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/checkoutCart/).
|
|
444
444
|
*/
|
|
445
445
|
async checkoutCart(
|
|
446
446
|
{ body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
|
|
@@ -521,7 +521,7 @@ class Cart {
|
|
|
521
521
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
522
522
|
* @name createCartMetaConfig
|
|
523
523
|
* @summary: Create a new cart meta
|
|
524
|
-
* @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://
|
|
524
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/createCartMetaConfig/).
|
|
525
525
|
*/
|
|
526
526
|
async createCartMetaConfig(
|
|
527
527
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -600,7 +600,7 @@ class Cart {
|
|
|
600
600
|
* @returns {Promise<CartPlatformModel.CouponCreateResult>} - Success response
|
|
601
601
|
* @name createCoupon
|
|
602
602
|
* @summary: Create a coupon
|
|
603
|
-
* @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://
|
|
603
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/createCoupon/).
|
|
604
604
|
*/
|
|
605
605
|
async createCoupon(
|
|
606
606
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -677,7 +677,7 @@ class Cart {
|
|
|
677
677
|
* @returns {Promise<CartPlatformModel.PromotionAddResult>} - Success response
|
|
678
678
|
* @name createPromotion
|
|
679
679
|
* @summary: Create a promotion
|
|
680
|
-
* @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://
|
|
680
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/createPromotion/).
|
|
681
681
|
*/
|
|
682
682
|
async createPromotion(
|
|
683
683
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -756,7 +756,7 @@ class Cart {
|
|
|
756
756
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResult>} - Success response
|
|
757
757
|
* @name deleteCart
|
|
758
758
|
* @summary: Delete a cart
|
|
759
|
-
* @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://
|
|
759
|
+
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/deleteCart/).
|
|
760
760
|
*/
|
|
761
761
|
async deleteCart(
|
|
762
762
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -836,7 +836,7 @@ class Cart {
|
|
|
836
836
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
837
837
|
* @name deleteCoupon
|
|
838
838
|
* @summary: Delete a coupon which is in draft state
|
|
839
|
-
* @description: Delete details of a draft coupon by providing its unique identifier to delete information such as coupon type, rules, validity period and other related information. - Check out [method documentation](https://
|
|
839
|
+
* @description: Delete details of a draft coupon by providing its unique identifier to delete information such as coupon type, rules, validity period and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/deleteCoupon/).
|
|
840
840
|
*/
|
|
841
841
|
async deleteCoupon(
|
|
842
842
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -913,7 +913,7 @@ class Cart {
|
|
|
913
913
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
914
914
|
* @name deletePromotion
|
|
915
915
|
* @summary: Delete a promotion which is in draft state
|
|
916
|
-
* @description: Delete details of a draft promotion by providing its unique identifier to delete information such as promotion type, rules, validity period and other related information. - Check out [method documentation](https://
|
|
916
|
+
* @description: Delete details of a draft promotion by providing its unique identifier to delete information such as promotion type, rules, validity period and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/deletePromotion/).
|
|
917
917
|
*/
|
|
918
918
|
async deletePromotion(
|
|
919
919
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -994,7 +994,7 @@ class Cart {
|
|
|
994
994
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResult>} - Success response
|
|
995
995
|
* @name fetchAndvalidateCartItems
|
|
996
996
|
* @summary: Get and validate cart items
|
|
997
|
-
* @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://
|
|
997
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
998
998
|
*/
|
|
999
999
|
async fetchAndvalidateCartItems(
|
|
1000
1000
|
{ body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1075,7 +1075,7 @@ class Cart {
|
|
|
1075
1075
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
1076
1076
|
* @name fetchCartMetaConfig
|
|
1077
1077
|
* @summary: Get cart meta
|
|
1078
|
-
* @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://
|
|
1078
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/fetchCartMetaConfig/).
|
|
1079
1079
|
*/
|
|
1080
1080
|
async fetchCartMetaConfig(
|
|
1081
1081
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1150,7 +1150,7 @@ class Cart {
|
|
|
1150
1150
|
* @returns {Promise<CartPlatformModel.AbandonedCartResult>} - Success response
|
|
1151
1151
|
* @name getAbandonedCart
|
|
1152
1152
|
* @summary: Get abandoned carts
|
|
1153
|
-
* @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://
|
|
1153
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAbandonedCart/).
|
|
1154
1154
|
*/
|
|
1155
1155
|
async getAbandonedCart(
|
|
1156
1156
|
{
|
|
@@ -1259,7 +1259,7 @@ class Cart {
|
|
|
1259
1259
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
1260
1260
|
* @name getAbandonedCartDetails
|
|
1261
1261
|
* @summary: Get abandoned cart details
|
|
1262
|
-
* @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://
|
|
1262
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAbandonedCartDetails/).
|
|
1263
1263
|
*/
|
|
1264
1264
|
async getAbandonedCartDetails(
|
|
1265
1265
|
{ id, i, b, c, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1348,7 +1348,7 @@ class Cart {
|
|
|
1348
1348
|
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
1349
1349
|
* @name getAddressById
|
|
1350
1350
|
* @summary: Get details for a single customer address
|
|
1351
|
-
* @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://
|
|
1351
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAddressById/).
|
|
1352
1352
|
*/
|
|
1353
1353
|
async getAddressById(
|
|
1354
1354
|
{
|
|
@@ -1459,7 +1459,7 @@ class Cart {
|
|
|
1459
1459
|
* Success response
|
|
1460
1460
|
* @name getAddresses
|
|
1461
1461
|
* @summary: Get a list of addresses for a customer
|
|
1462
|
-
* @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://
|
|
1462
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAddresses/).
|
|
1463
1463
|
*/
|
|
1464
1464
|
async getAddresses(
|
|
1465
1465
|
{
|
|
@@ -1564,7 +1564,7 @@ class Cart {
|
|
|
1564
1564
|
* @returns {Promise<CartPlatformModel.GetCouponResult>} - Success response
|
|
1565
1565
|
* @name getAppCoupons
|
|
1566
1566
|
* @summary: List of coupons
|
|
1567
|
-
* @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://
|
|
1567
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAppCoupons/).
|
|
1568
1568
|
*/
|
|
1569
1569
|
async getAppCoupons(
|
|
1570
1570
|
{ id, buyNow, slug, storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1653,7 +1653,7 @@ class Cart {
|
|
|
1653
1653
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesDetails>} - Success response
|
|
1654
1654
|
* @name getAvailableDeliveryModes
|
|
1655
1655
|
* @summary: Get delivery modes
|
|
1656
|
-
* @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://
|
|
1656
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
1657
1657
|
*/
|
|
1658
1658
|
async getAvailableDeliveryModes(
|
|
1659
1659
|
{ areaCode, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1736,7 +1736,7 @@ class Cart {
|
|
|
1736
1736
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
1737
1737
|
* @name getCart
|
|
1738
1738
|
* @summary: Get a cart
|
|
1739
|
-
* @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://
|
|
1739
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getCart/).
|
|
1740
1740
|
*/
|
|
1741
1741
|
async getCart(
|
|
1742
1742
|
{
|
|
@@ -1844,7 +1844,7 @@ class Cart {
|
|
|
1844
1844
|
* @returns {Promise<CartPlatformModel.MultiCartResult>} - Success response
|
|
1845
1845
|
* @name getCartList
|
|
1846
1846
|
* @summary: List of carts
|
|
1847
|
-
* @description: Retrieve the list of active carts associated with a specific customer. - Check out [method documentation](https://
|
|
1847
|
+
* @description: Retrieve the list of active carts associated with a specific customer. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getCartList/).
|
|
1848
1848
|
*/
|
|
1849
1849
|
async getCartList(
|
|
1850
1850
|
{ fromDate, toDate, filterOn, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1928,7 +1928,7 @@ class Cart {
|
|
|
1928
1928
|
* @returns {Promise<CartPlatformModel.GetShareCartLinkResult>} - Success response
|
|
1929
1929
|
* @name getCartShareLink
|
|
1930
1930
|
* @summary: Share cart link
|
|
1931
|
-
* @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://
|
|
1931
|
+
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getCartShareLink/).
|
|
1932
1932
|
*/
|
|
1933
1933
|
async getCartShareLink(
|
|
1934
1934
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2007,7 +2007,7 @@ class Cart {
|
|
|
2007
2007
|
* @returns {Promise<CartPlatformModel.SharedCartResult>} - Success response
|
|
2008
2008
|
* @name getCartSharedItems
|
|
2009
2009
|
* @summary: List shared cart items
|
|
2010
|
-
* @description: Retrieve the cart items from the shared cart link based on unique token. - Check out [method documentation](https://
|
|
2010
|
+
* @description: Retrieve the cart items from the shared cart link based on unique token. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getCartSharedItems/).
|
|
2011
2011
|
*/
|
|
2012
2012
|
async getCartSharedItems(
|
|
2013
2013
|
{ token, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2086,7 +2086,7 @@ class Cart {
|
|
|
2086
2086
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
2087
2087
|
* @name getCouponById
|
|
2088
2088
|
* @summary: Get a coupon
|
|
2089
|
-
* @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://
|
|
2089
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getCouponById/).
|
|
2090
2090
|
*/
|
|
2091
2091
|
async getCouponById(
|
|
2092
2092
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2163,7 +2163,7 @@ class Cart {
|
|
|
2163
2163
|
* @returns {Promise<Object>} - Success response
|
|
2164
2164
|
* @name getCouponCodeExists
|
|
2165
2165
|
* @summary: Check coupon code exists
|
|
2166
|
-
* @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://
|
|
2166
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getCouponCodeExists/).
|
|
2167
2167
|
*/
|
|
2168
2168
|
async getCouponCodeExists(
|
|
2169
2169
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2243,7 +2243,7 @@ class Cart {
|
|
|
2243
2243
|
* @returns {Promise<Object>} - Success response
|
|
2244
2244
|
* @name getCouponOptionValues
|
|
2245
2245
|
* @summary: Get coupon option values
|
|
2246
|
-
* @description: Retrieves the available values for coupon options used to create and update coupons. - Check out [method documentation](https://
|
|
2246
|
+
* @description: Retrieves the available values for coupon options used to create and update coupons. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getCouponOptionValues/).
|
|
2247
2247
|
*/
|
|
2248
2248
|
async getCouponOptionValues(
|
|
2249
2249
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2316,7 +2316,7 @@ class Cart {
|
|
|
2316
2316
|
* @returns {Promise<CartPlatformModel.CouponsResult>} - Success response
|
|
2317
2317
|
* @name getCoupons
|
|
2318
2318
|
* @summary: List of coupons
|
|
2319
|
-
* @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://
|
|
2319
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getCoupons/).
|
|
2320
2320
|
*/
|
|
2321
2321
|
async getCoupons(
|
|
2322
2322
|
{
|
|
@@ -2453,7 +2453,7 @@ class Cart {
|
|
|
2453
2453
|
* @returns {Promise<CartPlatformModel.CartItemCountResult>} - Success response
|
|
2454
2454
|
* @name getItemCount
|
|
2455
2455
|
* @summary: Get a cart items count
|
|
2456
|
-
* @description: Retrieve the total count of items currently present in the customer's cart. - Check out [method documentation](https://
|
|
2456
|
+
* @description: Retrieve the total count of items currently present in the customer's cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getItemCount/).
|
|
2457
2457
|
*/
|
|
2458
2458
|
async getItemCount(
|
|
2459
2459
|
{ id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2534,7 +2534,7 @@ class Cart {
|
|
|
2534
2534
|
* @returns {Promise<CartPlatformModel.GetPriceAdjustmentResult>} - Success response
|
|
2535
2535
|
* @name getPriceAdjustments
|
|
2536
2536
|
* @summary: Get a list of all price adjustments associated with a cart
|
|
2537
|
-
* @description: This API helps to get price adjustments data associated to a particular cart - Check out [method documentation](https://
|
|
2537
|
+
* @description: This API helps to get price adjustments data associated to a particular cart - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getPriceAdjustments/).
|
|
2538
2538
|
*/
|
|
2539
2539
|
async getPriceAdjustments(
|
|
2540
2540
|
{ cartId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2616,7 +2616,7 @@ class Cart {
|
|
|
2616
2616
|
* @returns {Promise<CartPlatformModel.ActivePromosResult>} - Success response
|
|
2617
2617
|
* @name getPromosCouponConfig
|
|
2618
2618
|
* @summary: Get promotion and coupon type
|
|
2619
|
-
* @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://
|
|
2619
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromosCouponConfig/).
|
|
2620
2620
|
*/
|
|
2621
2621
|
async getPromosCouponConfig(
|
|
2622
2622
|
{ entityType, isHidden, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2699,7 +2699,7 @@ class Cart {
|
|
|
2699
2699
|
* @returns {Promise<CartPlatformModel.PromotionUpdateResult>} - Success response
|
|
2700
2700
|
* @name getPromotionById
|
|
2701
2701
|
* @summary: Get a specific promotion
|
|
2702
|
-
* @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://
|
|
2702
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromotionById/).
|
|
2703
2703
|
*/
|
|
2704
2704
|
async getPromotionById(
|
|
2705
2705
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2780,7 +2780,7 @@ class Cart {
|
|
|
2780
2780
|
* @returns {Promise<Object>} - Success response
|
|
2781
2781
|
* @name getPromotionCodeExists
|
|
2782
2782
|
* @summary: Check promotion code exists
|
|
2783
|
-
* @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://
|
|
2783
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromotionCodeExists/).
|
|
2784
2784
|
*/
|
|
2785
2785
|
async getPromotionCodeExists(
|
|
2786
2786
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2858,7 +2858,7 @@ class Cart {
|
|
|
2858
2858
|
* @returns {Promise<CartPlatformModel.PromotionOffersDetails>} - Success response
|
|
2859
2859
|
* @name getPromotionOffers
|
|
2860
2860
|
* @summary: List of all available promotion offers
|
|
2861
|
-
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://
|
|
2861
|
+
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromotionOffers/).
|
|
2862
2862
|
*/
|
|
2863
2863
|
async getPromotionOffers(
|
|
2864
2864
|
{
|
|
@@ -2972,7 +2972,7 @@ class Cart {
|
|
|
2972
2972
|
* Success response
|
|
2973
2973
|
* @name getPromotionPaymentOffers
|
|
2974
2974
|
* @summary: Fetch available promotions payment offers
|
|
2975
|
-
* @description: Use this API to get top 5 payment offers available for current product - Check out [method documentation](https://
|
|
2975
|
+
* @description: Use this API to get top 5 payment offers available for current product - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromotionPaymentOffers/).
|
|
2976
2976
|
*/
|
|
2977
2977
|
async getPromotionPaymentOffers(
|
|
2978
2978
|
{ id, uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3055,7 +3055,7 @@ class Cart {
|
|
|
3055
3055
|
* @returns {Promise<CartPlatformModel.PromotionsResult>} - Success response
|
|
3056
3056
|
* @name getPromotions
|
|
3057
3057
|
* @summary: List of promotions
|
|
3058
|
-
* @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://
|
|
3058
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getPromotions/).
|
|
3059
3059
|
*/
|
|
3060
3060
|
async getPromotions(
|
|
3061
3061
|
{
|
|
@@ -3193,7 +3193,7 @@ class Cart {
|
|
|
3193
3193
|
* Success response
|
|
3194
3194
|
* @name getShipments
|
|
3195
3195
|
* @summary: Get shipments details
|
|
3196
|
-
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://
|
|
3196
|
+
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/getShipments/).
|
|
3197
3197
|
*/
|
|
3198
3198
|
async getShipments(
|
|
3199
3199
|
{
|
|
@@ -3304,7 +3304,7 @@ class Cart {
|
|
|
3304
3304
|
* @returns {Promise<CartPlatformModel.StoreDetails>} - Success response
|
|
3305
3305
|
* @name getStoreAddressByUid
|
|
3306
3306
|
* @summary: Get Store Address
|
|
3307
|
-
* @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://
|
|
3307
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/getStoreAddressByUid/).
|
|
3308
3308
|
*/
|
|
3309
3309
|
async getStoreAddressByUid(
|
|
3310
3310
|
{ storeUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3384,7 +3384,7 @@ class Cart {
|
|
|
3384
3384
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResult>} - Success response
|
|
3385
3385
|
* @name overrideCart
|
|
3386
3386
|
* @summary: Update cart checkout
|
|
3387
|
-
* @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://
|
|
3387
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/overrideCart/).
|
|
3388
3388
|
*/
|
|
3389
3389
|
async overrideCart(
|
|
3390
3390
|
{ body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3463,7 +3463,7 @@ class Cart {
|
|
|
3463
3463
|
* @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
|
|
3464
3464
|
* @name platformAddItems
|
|
3465
3465
|
* @summary: Add items to cart
|
|
3466
|
-
* @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://
|
|
3466
|
+
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
|
|
3467
3467
|
*/
|
|
3468
3468
|
async platformAddItems(
|
|
3469
3469
|
{ body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders } = {
|
|
@@ -3563,7 +3563,7 @@ class Cart {
|
|
|
3563
3563
|
* @returns {Promise<CartPlatformModel.CartCheckoutResult>} - Success response
|
|
3564
3564
|
* @name platformCheckoutCart
|
|
3565
3565
|
* @summary: Checkout cart
|
|
3566
|
-
* @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://
|
|
3566
|
+
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformCheckoutCart/).
|
|
3567
3567
|
*/
|
|
3568
3568
|
async platformCheckoutCart(
|
|
3569
3569
|
{ body, xOrderingSource, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3649,7 +3649,7 @@ class Cart {
|
|
|
3649
3649
|
* @returns {Promise<CartPlatformModel.CartCheckoutDetails>} - Success response
|
|
3650
3650
|
* @name platformCheckoutCartV2
|
|
3651
3651
|
* @summary: Checkout cart
|
|
3652
|
-
* @description: The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://
|
|
3652
|
+
* @description: The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformCheckoutCartV2/).
|
|
3653
3653
|
*/
|
|
3654
3654
|
async platformCheckoutCartV2(
|
|
3655
3655
|
{ body, xOrderingSource, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3733,7 +3733,7 @@ class Cart {
|
|
|
3733
3733
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResult>} - Success response
|
|
3734
3734
|
* @name platformUpdateCart
|
|
3735
3735
|
* @summary: Update cart items
|
|
3736
|
-
* @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://
|
|
3736
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/platformUpdateCart/).
|
|
3737
3737
|
*/
|
|
3738
3738
|
async platformUpdateCart(
|
|
3739
3739
|
{ body, xOrderingSource, id, i, orderType, b, buyNow, requestHeaders } = {
|
|
@@ -3831,7 +3831,7 @@ class Cart {
|
|
|
3831
3831
|
* @returns {Promise<CartPlatformModel.DeleteAddressResult>} - Success response
|
|
3832
3832
|
* @name removeAddress
|
|
3833
3833
|
* @summary: Removes an address from a customer's address list
|
|
3834
|
-
* @description: Remove an existing customer address from the system. - Check out [method documentation](https://
|
|
3834
|
+
* @description: Remove an existing customer address from the system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/removeAddress/).
|
|
3835
3835
|
*/
|
|
3836
3836
|
async removeAddress(
|
|
3837
3837
|
{ id, userId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3911,7 +3911,7 @@ class Cart {
|
|
|
3911
3911
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
3912
3912
|
* @name removeCoupon
|
|
3913
3913
|
* @summary: Remove coupon
|
|
3914
|
-
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://
|
|
3914
|
+
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/removeCoupon/).
|
|
3915
3915
|
*/
|
|
3916
3916
|
async removeCoupon(
|
|
3917
3917
|
{ xOrderingSource, uid, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3996,7 +3996,7 @@ class Cart {
|
|
|
3996
3996
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
3997
3997
|
* @name removePriceAdjustment
|
|
3998
3998
|
* @summary: Remove price adjustments
|
|
3999
|
-
* @description: Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID. - Check out [method documentation](https://
|
|
3999
|
+
* @description: Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/removePriceAdjustment/).
|
|
4000
4000
|
*/
|
|
4001
4001
|
async removePriceAdjustment(
|
|
4002
4002
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4075,7 +4075,7 @@ class Cart {
|
|
|
4075
4075
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
4076
4076
|
* @name selectAddress
|
|
4077
4077
|
* @summary: Select customer address for order processing
|
|
4078
|
-
* @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://
|
|
4078
|
+
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/selectAddress/).
|
|
4079
4079
|
*/
|
|
4080
4080
|
async selectAddress(
|
|
4081
4081
|
{ body, xOrderingSource, cartId, buyNow, i, b, requestHeaders } = {
|
|
@@ -4168,7 +4168,7 @@ class Cart {
|
|
|
4168
4168
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
4169
4169
|
* @name selectPaymentMode
|
|
4170
4170
|
* @summary: Select payment mode
|
|
4171
|
-
* @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://
|
|
4171
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/selectPaymentMode/).
|
|
4172
4172
|
*/
|
|
4173
4173
|
async selectPaymentMode(
|
|
4174
4174
|
{ body, xOrderingSource, id, buyNow, orderType, requestHeaders } = {
|
|
@@ -4260,7 +4260,7 @@ class Cart {
|
|
|
4260
4260
|
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
4261
4261
|
* @name selectPaymentModeV2
|
|
4262
4262
|
* @summary: Select payment mode (latest)
|
|
4263
|
-
* @description: Selection of payment mode that supports multiple MOP(mode of payment). - Check out [method documentation](https://
|
|
4263
|
+
* @description: Selection of payment mode that supports multiple MOP(mode of payment). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/selectPaymentModeV2/).
|
|
4264
4264
|
*/
|
|
4265
4265
|
async selectPaymentModeV2(
|
|
4266
4266
|
{ body, xOrderingSource, id, buyNow, orderType, requestHeaders } = {
|
|
@@ -4352,7 +4352,7 @@ class Cart {
|
|
|
4352
4352
|
* @returns {Promise<CartPlatformModel.UpdateAddressDetails>} - Success response
|
|
4353
4353
|
* @name updateAddress
|
|
4354
4354
|
* @summary: Updates an existing customer address
|
|
4355
|
-
* @description: Update the user address - Check out [method documentation](https://
|
|
4355
|
+
* @description: Update the user address - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/updateAddress/).
|
|
4356
4356
|
*/
|
|
4357
4357
|
async updateAddress(
|
|
4358
4358
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4431,7 +4431,7 @@ class Cart {
|
|
|
4431
4431
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResult>} - Success response
|
|
4432
4432
|
* @name updateCart
|
|
4433
4433
|
* @summary: Update cart items
|
|
4434
|
-
* @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://
|
|
4434
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCart/).
|
|
4435
4435
|
*/
|
|
4436
4436
|
async updateCart(
|
|
4437
4437
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4513,7 +4513,7 @@ class Cart {
|
|
|
4513
4513
|
* @returns {Promise<CartPlatformModel.CartMetaDetails>} - Success response
|
|
4514
4514
|
* @name updateCartMeta
|
|
4515
4515
|
* @summary: Update cart metadata
|
|
4516
|
-
* @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://
|
|
4516
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCartMeta/).
|
|
4517
4517
|
*/
|
|
4518
4518
|
async updateCartMeta(
|
|
4519
4519
|
{ body, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4600,7 +4600,7 @@ class Cart {
|
|
|
4600
4600
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
4601
4601
|
* @name updateCartMetaConfig
|
|
4602
4602
|
* @summary: Update cart meta
|
|
4603
|
-
* @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://
|
|
4603
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCartMetaConfig/).
|
|
4604
4604
|
*/
|
|
4605
4605
|
async updateCartMetaConfig(
|
|
4606
4606
|
{ cartMetaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4681,7 +4681,7 @@ class Cart {
|
|
|
4681
4681
|
* @returns {Promise<CartPlatformModel.UserCartMappingResult>} - Success response
|
|
4682
4682
|
* @name updateCartUser
|
|
4683
4683
|
* @summary: Update user of a cart
|
|
4684
|
-
* @description: Modify the cart user to a new valid customer for the provided customer ID. - Check out [method documentation](https://
|
|
4684
|
+
* @description: Modify the cart user to a new valid customer for the provided customer ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCartUser/).
|
|
4685
4685
|
*/
|
|
4686
4686
|
async updateCartUser(
|
|
4687
4687
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4765,7 +4765,7 @@ class Cart {
|
|
|
4765
4765
|
* @returns {Promise<CartPlatformModel.SharedCartResult>} - Success response
|
|
4766
4766
|
* @name updateCartWithSharedItems
|
|
4767
4767
|
* @summary: Update shared cart items
|
|
4768
|
-
* @description: Customer can either merge or replace shared cart items with existing cart. - Check out [method documentation](https://
|
|
4768
|
+
* @description: Customer can either merge or replace shared cart items with existing cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCartWithSharedItems/).
|
|
4769
4769
|
*/
|
|
4770
4770
|
async updateCartWithSharedItems(
|
|
4771
4771
|
{ token, action, cartId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4849,7 +4849,7 @@ class Cart {
|
|
|
4849
4849
|
* @returns {Promise<CartPlatformModel.CouponCreateResult>} - Success response
|
|
4850
4850
|
* @name updateCoupon
|
|
4851
4851
|
* @summary: Update a coupon
|
|
4852
|
-
* @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://
|
|
4852
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCoupon/).
|
|
4853
4853
|
*/
|
|
4854
4854
|
async updateCoupon(
|
|
4855
4855
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4930,7 +4930,7 @@ class Cart {
|
|
|
4930
4930
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4931
4931
|
* @name updateCouponPartially
|
|
4932
4932
|
* @summary: Update a coupon partially
|
|
4933
|
-
* @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://
|
|
4933
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCouponPartially/).
|
|
4934
4934
|
*/
|
|
4935
4935
|
async updateCouponPartially(
|
|
4936
4936
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5013,7 +5013,7 @@ class Cart {
|
|
|
5013
5013
|
* @returns {Promise<CartPlatformModel.GetPriceAdjustmentResult>} - Success response
|
|
5014
5014
|
* @name updatePriceAdjustment
|
|
5015
5015
|
* @summary: Update price adjustments
|
|
5016
|
-
* @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://
|
|
5016
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updatePriceAdjustment/).
|
|
5017
5017
|
*/
|
|
5018
5018
|
async updatePriceAdjustment(
|
|
5019
5019
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5094,7 +5094,7 @@ class Cart {
|
|
|
5094
5094
|
* @returns {Promise<CartPlatformModel.PromotionUpdateResult>} - Success response
|
|
5095
5095
|
* @name updatePromotion
|
|
5096
5096
|
* @summary: Update a promotion
|
|
5097
|
-
* @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://
|
|
5097
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updatePromotion/).
|
|
5098
5098
|
*/
|
|
5099
5099
|
async updatePromotion(
|
|
5100
5100
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5177,7 +5177,7 @@ class Cart {
|
|
|
5177
5177
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
5178
5178
|
* @name updatePromotionPartially
|
|
5179
5179
|
* @summary: Update a promotion partially
|
|
5180
|
-
* @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://
|
|
5180
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updatePromotionPartially/).
|
|
5181
5181
|
*/
|
|
5182
5182
|
async updatePromotionPartially(
|
|
5183
5183
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5259,7 +5259,7 @@ class Cart {
|
|
|
5259
5259
|
* Success response
|
|
5260
5260
|
* @name updateShipments
|
|
5261
5261
|
* @summary: Update shipments
|
|
5262
|
-
* @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://
|
|
5262
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/updateShipments/).
|
|
5263
5263
|
*/
|
|
5264
5264
|
async updateShipments(
|
|
5265
5265
|
{ body, i, p, id, addressId, areaCode, orderType, requestHeaders } = {
|
|
@@ -5360,7 +5360,7 @@ class Cart {
|
|
|
5360
5360
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
5361
5361
|
* @name validateCouponForPayment
|
|
5362
5362
|
* @summary: Validate applied coupon
|
|
5363
|
-
* @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://
|
|
5363
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/cart/validateCouponForPayment/).
|
|
5364
5364
|
*/
|
|
5365
5365
|
async validateCouponForPayment(
|
|
5366
5366
|
{
|