@gofynd/fdk-client-javascript 3.3.6 → 3.4.1
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/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +115 -47
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +454 -12
- package/sdk/platform/Cart/CartPlatformModel.js +457 -10
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
- package/sdk/platform/Content/ContentPlatformModel.js +6 -20
- package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
- package/sdk/platform/Order/OrderPlatformModel.js +388 -14
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
- package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
|
@@ -356,6 +356,58 @@ const Joi = require("joi");
|
|
|
356
356
|
* @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
|
|
357
357
|
*/
|
|
358
358
|
|
|
359
|
+
/**
|
|
360
|
+
* @typedef BuyRuleItemCriteria
|
|
361
|
+
* @property {CompareObject} [cart_quantity]
|
|
362
|
+
* @property {string[]} [available_zones] - List of all zones on which promotion
|
|
363
|
+
* is applicable
|
|
364
|
+
* @property {number[]} [item_exclude_company] - List of all company id on which
|
|
365
|
+
* promotion is not applicable
|
|
366
|
+
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
367
|
+
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
368
|
+
* promotion is applicable
|
|
369
|
+
* @property {CompareObject} [cart_total]
|
|
370
|
+
* @property {CompareObject} [cart_unique_item_quantity]
|
|
371
|
+
* @property {CompareObject} [cart_unique_item_amount]
|
|
372
|
+
* @property {number[]} [item_exclude_id] - List of all item ids on which
|
|
373
|
+
* promotion is not applicable
|
|
374
|
+
* @property {boolean} [all_items] - Boolean flag set true to applicable the
|
|
375
|
+
* promotion for all products
|
|
376
|
+
* @property {number[]} [item_exclude_l1_category] - List of all item ids on
|
|
377
|
+
* which promotion is not applicable
|
|
378
|
+
* @property {string[]} [item_size] - List of all item sizes on which promotion
|
|
379
|
+
* is applicable
|
|
380
|
+
* @property {number[]} [item_store] - List of all item store ids on which
|
|
381
|
+
* promotion is applicable
|
|
382
|
+
* @property {string[]} [item_exclude_sku] - List of all item sku on which
|
|
383
|
+
* promotion is not applicable
|
|
384
|
+
* @property {number[]} [item_department] - List of all departments ids on which
|
|
385
|
+
* promotion is applicable
|
|
386
|
+
* @property {number[]} [item_exclude_store] - List of all item store ids on
|
|
387
|
+
* which promotion is not applicable
|
|
388
|
+
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
389
|
+
* is applicable
|
|
390
|
+
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
391
|
+
* on which promotion is not applicable
|
|
392
|
+
* @property {number[]} [item_exclude_category] - List of all L3 category on
|
|
393
|
+
* which promotion is not applicable
|
|
394
|
+
* @property {number[]} [item_category] - List of all L3 category on which
|
|
395
|
+
* promotion is applicable
|
|
396
|
+
* @property {string[]} [buy_rules]
|
|
397
|
+
* @property {number[]} [item_exclude_brand] - List of all brand ids on which
|
|
398
|
+
* promotion is not applicable
|
|
399
|
+
* @property {number[]} [item_l2_category] - List of all L2 category on which
|
|
400
|
+
* promotion is applicable
|
|
401
|
+
* @property {number[]} [item_company] - List of all company ids on which
|
|
402
|
+
* promotion is applicable
|
|
403
|
+
* @property {string[]} [item_tags] - List of all product tags on which
|
|
404
|
+
* promotion is applicable
|
|
405
|
+
* @property {number[]} [item_exclude_l2_category] - List of all L2 category on
|
|
406
|
+
* which promotion is not applicable
|
|
407
|
+
* @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
|
|
408
|
+
* @property {ItemSizeMapping} [meta]
|
|
409
|
+
*/
|
|
410
|
+
|
|
359
411
|
/**
|
|
360
412
|
* @typedef DiscountOffer
|
|
361
413
|
* @property {number} [max_discount_amount] - Maximum discount amount in promotion
|
|
@@ -546,7 +598,7 @@ const Joi = require("joi");
|
|
|
546
598
|
* @property {PromotionAuthor} [author]
|
|
547
599
|
* @property {Visibility} [visiblility]
|
|
548
600
|
* @property {string} application_id - Current application id of sales channel
|
|
549
|
-
* @property {
|
|
601
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
550
602
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
551
603
|
* @property {PromotionDateMeta} [date_meta]
|
|
552
604
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
@@ -653,7 +705,7 @@ const Joi = require("joi");
|
|
|
653
705
|
* @property {PromotionAuthor} [author]
|
|
654
706
|
* @property {Visibility} [visiblility]
|
|
655
707
|
* @property {string} application_id - Current application id of sales channel
|
|
656
|
-
* @property {
|
|
708
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
657
709
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
658
710
|
* @property {PromotionDateMeta} [date_meta]
|
|
659
711
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
@@ -1035,6 +1087,43 @@ const Joi = require("joi");
|
|
|
1035
1087
|
* often used for internal reference
|
|
1036
1088
|
*/
|
|
1037
1089
|
|
|
1090
|
+
/**
|
|
1091
|
+
* @typedef FulfillmentOptionSchema
|
|
1092
|
+
* @property {string} [slug] - Unique identifier for the delivery type.
|
|
1093
|
+
* @property {string} [description] - Description of the delivery service.
|
|
1094
|
+
* @property {boolean} [is_default] - Indicates if this is the default delivery option.
|
|
1095
|
+
* @property {string} [id] - Unique ID of the delivery service.
|
|
1096
|
+
* @property {string} [type] - Type of fulfillment option.
|
|
1097
|
+
* @property {string} [name] - Name of the delivery service.
|
|
1098
|
+
*/
|
|
1099
|
+
|
|
1100
|
+
/**
|
|
1101
|
+
* @typedef StoreTimingSchema
|
|
1102
|
+
* @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
|
|
1103
|
+
* @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
|
|
1104
|
+
*/
|
|
1105
|
+
|
|
1106
|
+
/**
|
|
1107
|
+
* @typedef StoreHoursSchema
|
|
1108
|
+
* @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
|
|
1109
|
+
* @property {StoreTimingSchema} [opening]
|
|
1110
|
+
* @property {StoreTimingSchema} [closing]
|
|
1111
|
+
* @property {boolean} [open] - Indicates whether the store is open on the
|
|
1112
|
+
* specified weekday.
|
|
1113
|
+
*/
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* @typedef PickupStoreDetailSchema
|
|
1117
|
+
* @property {number} [store_id] - A unique identifier for the store.
|
|
1118
|
+
* @property {string} [name] - The name of the store or pickup location.
|
|
1119
|
+
* @property {string} [pincode] - The postal code of the store's location.
|
|
1120
|
+
* @property {number} [distance] - The distance between the store and the
|
|
1121
|
+
* customer's location.
|
|
1122
|
+
* @property {string} [address] - The full address of the store.
|
|
1123
|
+
* @property {Object} [store_hours] - The store's operational hours for each day
|
|
1124
|
+
* of the week.
|
|
1125
|
+
*/
|
|
1126
|
+
|
|
1038
1127
|
/**
|
|
1039
1128
|
* @typedef ProductArticle
|
|
1040
1129
|
* @property {string} [seller_identifier] - List of identifiers used by sellers
|
|
@@ -1066,6 +1155,8 @@ const Joi = require("joi");
|
|
|
1066
1155
|
* @property {Object} [meta] - Meta data of article in cart
|
|
1067
1156
|
* @property {string} [size] - Size of the article added in cart
|
|
1068
1157
|
* @property {StoreInfo} [store]
|
|
1158
|
+
* @property {FulfillmentOptionSchema} [fulfillment_option]
|
|
1159
|
+
* @property {PickupStoreDetailSchema} [pickup_store_detail]
|
|
1069
1160
|
* @property {number} [item_index] - Specify the index of article in cart.
|
|
1070
1161
|
* @property {string[]} [tags] - A list of article tags
|
|
1071
1162
|
*/
|
|
@@ -1276,7 +1367,7 @@ const Joi = require("joi");
|
|
|
1276
1367
|
* @property {string} [state] - State of the address
|
|
1277
1368
|
* @property {string} [city] - City of the address
|
|
1278
1369
|
* @property {number} [phone] - Phone number for address
|
|
1279
|
-
* @property {string} area_code - Area code of the address
|
|
1370
|
+
* @property {string} [area_code] - Area code of the address
|
|
1280
1371
|
* @property {string} [country_iso_code] - Country iso code for address
|
|
1281
1372
|
* @property {string} [country_phone_code] - Country phone code for address
|
|
1282
1373
|
* @property {Object} [meta] - Metadata of the address
|
|
@@ -1511,6 +1602,17 @@ const Joi = require("joi");
|
|
|
1511
1602
|
* @property {DeliveryChargesConfig} [delivery_charges_config]
|
|
1512
1603
|
*/
|
|
1513
1604
|
|
|
1605
|
+
/**
|
|
1606
|
+
* @typedef PlatformAlternatePickupPerson
|
|
1607
|
+
* @property {boolean} [enabled] - Indicates whether an alternate pickup person
|
|
1608
|
+
* is enabled.
|
|
1609
|
+
* @property {string} [name] - Name of the alternate pickup person.
|
|
1610
|
+
* @property {string} [email] - Email address of the alternate pickup person.
|
|
1611
|
+
* @property {string} [phone] - Phone number of the alternate pickup person.
|
|
1612
|
+
* @property {string} [country_phone_code] - Country phone code of the alternate
|
|
1613
|
+
* pickup person (e.g., "+91").
|
|
1614
|
+
*/
|
|
1615
|
+
|
|
1514
1616
|
/**
|
|
1515
1617
|
* @typedef CartDetailResult
|
|
1516
1618
|
* @property {number} [cart_id] - Unique identifier of the user cart
|
|
@@ -1552,6 +1654,7 @@ const Joi = require("joi");
|
|
|
1552
1654
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1553
1655
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
1554
1656
|
* checkout API payload
|
|
1657
|
+
* @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
|
|
1555
1658
|
* @property {boolean} [free_gift_selection_available] - Determines if the cart
|
|
1556
1659
|
* has available promotion free gift items to choose on its added items
|
|
1557
1660
|
*/
|
|
@@ -1584,6 +1687,10 @@ const Joi = require("joi");
|
|
|
1584
1687
|
* @property {boolean} [pos] - Filed to determine whether user is making request
|
|
1585
1688
|
* from pos or not
|
|
1586
1689
|
* @property {string} [seller_identifier] - Add items using seller identifier for store os
|
|
1690
|
+
* @property {string} [fulfillment_option_slug] - Specifies the fulfillment
|
|
1691
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
1692
|
+
* @property {number} [pickup_store_id] - Unique identifier of the pickup store
|
|
1693
|
+
* selected by the user from which user wants to pickup the product.
|
|
1587
1694
|
*/
|
|
1588
1695
|
|
|
1589
1696
|
/**
|
|
@@ -1634,6 +1741,10 @@ const Joi = require("joi");
|
|
|
1634
1741
|
* product falls to be updated
|
|
1635
1742
|
* @property {CartProductIdentifer} identifiers
|
|
1636
1743
|
* @property {string} [article_id] - Article id of the product in cart
|
|
1744
|
+
* @property {string} [fulfillment_option_slug] - Specifies the fulfillment
|
|
1745
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
1746
|
+
* @property {number} [pickup_store_id] - Unique identifier of the pickup store
|
|
1747
|
+
* selected by the user from which user
|
|
1637
1748
|
*/
|
|
1638
1749
|
|
|
1639
1750
|
/**
|
|
@@ -1804,7 +1915,8 @@ const Joi = require("joi");
|
|
|
1804
1915
|
|
|
1805
1916
|
/**
|
|
1806
1917
|
* @typedef UpdateUserCartMapping
|
|
1807
|
-
* @property {string} user_id -
|
|
1918
|
+
* @property {string} [user_id] - Customer user ID to associate with the cart.
|
|
1919
|
+
* Send null to remove existing mapping of customer from cart.
|
|
1808
1920
|
*/
|
|
1809
1921
|
|
|
1810
1922
|
/**
|
|
@@ -2069,6 +2181,7 @@ const Joi = require("joi");
|
|
|
2069
2181
|
* @property {string} [dp_id] - Delivery partner id of the shipment
|
|
2070
2182
|
* @property {string} [fulfillment_type] - Fulfilment type of shipment
|
|
2071
2183
|
* @property {ShipmentArticle[]} [articles] - List of articles in shipment
|
|
2184
|
+
* @property {FulfillmentOptionSchema} [fulfillment_option]
|
|
2072
2185
|
*/
|
|
2073
2186
|
|
|
2074
2187
|
/**
|
|
@@ -2129,6 +2242,7 @@ const Joi = require("joi");
|
|
|
2129
2242
|
* @property {string} [gstin] - GSTIN number to be added in user cart
|
|
2130
2243
|
* @property {Object} [pick_up_customer_details] - Customer contact details for
|
|
2131
2244
|
* customer pickup at store
|
|
2245
|
+
* @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
|
|
2132
2246
|
* @property {string} [checkout_mode] - Checkout mode of user cart
|
|
2133
2247
|
* @property {Object} [gift_details] - Gift details is open json which can
|
|
2134
2248
|
* include gift message
|
|
@@ -2552,9 +2666,88 @@ const Joi = require("joi");
|
|
|
2552
2666
|
* | "kiosk"
|
|
2553
2667
|
* | "scan_go"
|
|
2554
2668
|
* | "smart_trolley"
|
|
2669
|
+
* | "gofynd"
|
|
2670
|
+
* | "uniket"
|
|
2555
2671
|
* | "marketplace"
|
|
2556
2672
|
* | "social_commerce"
|
|
2557
|
-
* | "ondc"
|
|
2673
|
+
* | "ondc"
|
|
2674
|
+
* | "nexus"
|
|
2675
|
+
* | "nykaa_fashion"
|
|
2676
|
+
* | "etsy"
|
|
2677
|
+
* | "vuivui"
|
|
2678
|
+
* | "zilingo"
|
|
2679
|
+
* | "firstcry"
|
|
2680
|
+
* | "bukalapak"
|
|
2681
|
+
* | "myntra_ppmp"
|
|
2682
|
+
* | "lazada"
|
|
2683
|
+
* | "tiktok"
|
|
2684
|
+
* | "sfcc"
|
|
2685
|
+
* | "debenhams"
|
|
2686
|
+
* | "prestomall"
|
|
2687
|
+
* | "meesho"
|
|
2688
|
+
* | "amazon_vdf"
|
|
2689
|
+
* | "bigcommerce"
|
|
2690
|
+
* | "sendo"
|
|
2691
|
+
* | "storehippo"
|
|
2692
|
+
* | "cdiscount"
|
|
2693
|
+
* | "nykaa"
|
|
2694
|
+
* | "trendyol"
|
|
2695
|
+
* | "weloveshopping"
|
|
2696
|
+
* | "jollee"
|
|
2697
|
+
* | "wish"
|
|
2698
|
+
* | "tiki"
|
|
2699
|
+
* | "central_online"
|
|
2700
|
+
* | "q10"
|
|
2701
|
+
* | "cred"
|
|
2702
|
+
* | "walmart"
|
|
2703
|
+
* | "snapdeal"
|
|
2704
|
+
* | "flipkart"
|
|
2705
|
+
* | "blibli"
|
|
2706
|
+
* | "ajio_jit"
|
|
2707
|
+
* | "pharmeasy"
|
|
2708
|
+
* | "ezmall"
|
|
2709
|
+
* | "adobe_commerce"
|
|
2710
|
+
* | "kartmax"
|
|
2711
|
+
* | "shopee"
|
|
2712
|
+
* | "zalora"
|
|
2713
|
+
* | "prestashop"
|
|
2714
|
+
* | "smytten"
|
|
2715
|
+
* | "amazon_sc"
|
|
2716
|
+
* | "urbanpiper"
|
|
2717
|
+
* | "flipkart_quick"
|
|
2718
|
+
* | "woocommerce"
|
|
2719
|
+
* | "zivame"
|
|
2720
|
+
* | "lelong"
|
|
2721
|
+
* | "facebook"
|
|
2722
|
+
* | "jiomart"
|
|
2723
|
+
* | "gmc"
|
|
2724
|
+
* | "robins"
|
|
2725
|
+
* | "akulaku"
|
|
2726
|
+
* | "noon"
|
|
2727
|
+
* | "tatacliq"
|
|
2728
|
+
* | "kartrocket"
|
|
2729
|
+
* | "inorbit"
|
|
2730
|
+
* | "ajio_business"
|
|
2731
|
+
* | "swiggy"
|
|
2732
|
+
* | "asos"
|
|
2733
|
+
* | "tokopedia"
|
|
2734
|
+
* | "limeroad"
|
|
2735
|
+
* | "myntra_omni"
|
|
2736
|
+
* | "spoyl"
|
|
2737
|
+
* | "amazon_mlf"
|
|
2738
|
+
* | "fulfilled_by_lazada"
|
|
2739
|
+
* | "ebay"
|
|
2740
|
+
* | "jd"
|
|
2741
|
+
* | "amazon_pharmacy"
|
|
2742
|
+
* | "ajio_vms"
|
|
2743
|
+
* | "daraz"
|
|
2744
|
+
* | "oker"
|
|
2745
|
+
* | "flipkart_b2b"
|
|
2746
|
+
* | "amazon_mlf_ss"
|
|
2747
|
+
* | "woovly"
|
|
2748
|
+
* | "tata1mg"
|
|
2749
|
+
* | "zomato"
|
|
2750
|
+
* | "shopify"} OrderingSource
|
|
2558
2751
|
*/
|
|
2559
2752
|
|
|
2560
2753
|
class CartPlatformModel {
|
|
@@ -2945,6 +3138,40 @@ class CartPlatformModel {
|
|
|
2945
3138
|
});
|
|
2946
3139
|
}
|
|
2947
3140
|
|
|
3141
|
+
/** @returns {BuyRuleItemCriteria} */
|
|
3142
|
+
static BuyRuleItemCriteria() {
|
|
3143
|
+
return Joi.object({
|
|
3144
|
+
cart_quantity: CartPlatformModel.CompareObject(),
|
|
3145
|
+
available_zones: Joi.array().items(Joi.string().allow("")),
|
|
3146
|
+
item_exclude_company: Joi.array().items(Joi.number()),
|
|
3147
|
+
item_id: Joi.array().items(Joi.number()),
|
|
3148
|
+
item_l1_category: Joi.array().items(Joi.number()),
|
|
3149
|
+
cart_total: CartPlatformModel.CompareObject(),
|
|
3150
|
+
cart_unique_item_quantity: CartPlatformModel.CompareObject(),
|
|
3151
|
+
cart_unique_item_amount: CartPlatformModel.CompareObject(),
|
|
3152
|
+
item_exclude_id: Joi.array().items(Joi.number()),
|
|
3153
|
+
all_items: Joi.boolean(),
|
|
3154
|
+
item_exclude_l1_category: Joi.array().items(Joi.number()),
|
|
3155
|
+
item_size: Joi.array().items(Joi.string().allow("")),
|
|
3156
|
+
item_store: Joi.array().items(Joi.number()),
|
|
3157
|
+
item_exclude_sku: Joi.array().items(Joi.string().allow("")),
|
|
3158
|
+
item_department: Joi.array().items(Joi.number()),
|
|
3159
|
+
item_exclude_store: Joi.array().items(Joi.number()),
|
|
3160
|
+
item_brand: Joi.array().items(Joi.number()),
|
|
3161
|
+
item_exclude_department: Joi.array().items(Joi.number()),
|
|
3162
|
+
item_exclude_category: Joi.array().items(Joi.number()),
|
|
3163
|
+
item_category: Joi.array().items(Joi.number()),
|
|
3164
|
+
buy_rules: Joi.array().items(Joi.string().allow("")),
|
|
3165
|
+
item_exclude_brand: Joi.array().items(Joi.number()),
|
|
3166
|
+
item_l2_category: Joi.array().items(Joi.number()),
|
|
3167
|
+
item_company: Joi.array().items(Joi.number()),
|
|
3168
|
+
item_tags: Joi.array().items(Joi.string().allow("")),
|
|
3169
|
+
item_exclude_l2_category: Joi.array().items(Joi.number()),
|
|
3170
|
+
item_sku: Joi.array().items(Joi.string().allow("")),
|
|
3171
|
+
meta: CartPlatformModel.ItemSizeMapping(),
|
|
3172
|
+
});
|
|
3173
|
+
}
|
|
3174
|
+
|
|
2948
3175
|
/** @returns {DiscountOffer} */
|
|
2949
3176
|
static DiscountOffer() {
|
|
2950
3177
|
return Joi.object({
|
|
@@ -3151,7 +3378,7 @@ class CartPlatformModel {
|
|
|
3151
3378
|
author: CartPlatformModel.PromotionAuthor(),
|
|
3152
3379
|
visiblility: CartPlatformModel.Visibility(),
|
|
3153
3380
|
application_id: Joi.string().allow("").required(),
|
|
3154
|
-
buy_rules: CartPlatformModel.
|
|
3381
|
+
buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
|
|
3155
3382
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3156
3383
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3157
3384
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3245,7 +3472,7 @@ class CartPlatformModel {
|
|
|
3245
3472
|
author: CartPlatformModel.PromotionAuthor(),
|
|
3246
3473
|
visiblility: CartPlatformModel.Visibility(),
|
|
3247
3474
|
application_id: Joi.string().allow("").required(),
|
|
3248
|
-
buy_rules: CartPlatformModel.
|
|
3475
|
+
buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
|
|
3249
3476
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3250
3477
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3251
3478
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
@@ -3648,6 +3875,48 @@ class CartPlatformModel {
|
|
|
3648
3875
|
});
|
|
3649
3876
|
}
|
|
3650
3877
|
|
|
3878
|
+
/** @returns {FulfillmentOptionSchema} */
|
|
3879
|
+
static FulfillmentOptionSchema() {
|
|
3880
|
+
return Joi.object({
|
|
3881
|
+
slug: Joi.string().allow(""),
|
|
3882
|
+
description: Joi.string().allow(""),
|
|
3883
|
+
is_default: Joi.boolean(),
|
|
3884
|
+
id: Joi.string().allow(""),
|
|
3885
|
+
type: Joi.string().allow(""),
|
|
3886
|
+
name: Joi.string().allow(""),
|
|
3887
|
+
});
|
|
3888
|
+
}
|
|
3889
|
+
|
|
3890
|
+
/** @returns {StoreTimingSchema} */
|
|
3891
|
+
static StoreTimingSchema() {
|
|
3892
|
+
return Joi.object({
|
|
3893
|
+
hour: Joi.number(),
|
|
3894
|
+
minute: Joi.number(),
|
|
3895
|
+
});
|
|
3896
|
+
}
|
|
3897
|
+
|
|
3898
|
+
/** @returns {StoreHoursSchema} */
|
|
3899
|
+
static StoreHoursSchema() {
|
|
3900
|
+
return Joi.object({
|
|
3901
|
+
weekday: Joi.string().allow(""),
|
|
3902
|
+
opening: CartPlatformModel.StoreTimingSchema(),
|
|
3903
|
+
closing: CartPlatformModel.StoreTimingSchema(),
|
|
3904
|
+
open: Joi.boolean(),
|
|
3905
|
+
});
|
|
3906
|
+
}
|
|
3907
|
+
|
|
3908
|
+
/** @returns {PickupStoreDetailSchema} */
|
|
3909
|
+
static PickupStoreDetailSchema() {
|
|
3910
|
+
return Joi.object({
|
|
3911
|
+
store_id: Joi.number(),
|
|
3912
|
+
name: Joi.string().allow(""),
|
|
3913
|
+
pincode: Joi.string().allow(""),
|
|
3914
|
+
distance: Joi.number(),
|
|
3915
|
+
address: Joi.string().allow(""),
|
|
3916
|
+
store_hours: Joi.any(),
|
|
3917
|
+
});
|
|
3918
|
+
}
|
|
3919
|
+
|
|
3651
3920
|
/** @returns {ProductArticle} */
|
|
3652
3921
|
static ProductArticle() {
|
|
3653
3922
|
return Joi.object({
|
|
@@ -3670,6 +3939,8 @@ class CartPlatformModel {
|
|
|
3670
3939
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
3671
3940
|
size: Joi.string().allow(""),
|
|
3672
3941
|
store: CartPlatformModel.StoreInfo(),
|
|
3942
|
+
fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
|
|
3943
|
+
pickup_store_detail: CartPlatformModel.PickupStoreDetailSchema(),
|
|
3673
3944
|
item_index: Joi.number(),
|
|
3674
3945
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3675
3946
|
});
|
|
@@ -3900,7 +4171,7 @@ class CartPlatformModel {
|
|
|
3900
4171
|
state: Joi.string().allow("").allow(null),
|
|
3901
4172
|
city: Joi.string().allow("").allow(null),
|
|
3902
4173
|
phone: Joi.number(),
|
|
3903
|
-
area_code: Joi.string().allow("")
|
|
4174
|
+
area_code: Joi.string().allow(""),
|
|
3904
4175
|
country_iso_code: Joi.string().allow(""),
|
|
3905
4176
|
country_phone_code: Joi.string().allow(""),
|
|
3906
4177
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -4151,6 +4422,17 @@ class CartPlatformModel {
|
|
|
4151
4422
|
});
|
|
4152
4423
|
}
|
|
4153
4424
|
|
|
4425
|
+
/** @returns {PlatformAlternatePickupPerson} */
|
|
4426
|
+
static PlatformAlternatePickupPerson() {
|
|
4427
|
+
return Joi.object({
|
|
4428
|
+
enabled: Joi.boolean(),
|
|
4429
|
+
name: Joi.string().allow(""),
|
|
4430
|
+
email: Joi.string().allow(""),
|
|
4431
|
+
phone: Joi.string().allow(""),
|
|
4432
|
+
country_phone_code: Joi.string().allow(""),
|
|
4433
|
+
});
|
|
4434
|
+
}
|
|
4435
|
+
|
|
4154
4436
|
/** @returns {CartDetailResult} */
|
|
4155
4437
|
static CartDetailResult() {
|
|
4156
4438
|
return Joi.object({
|
|
@@ -4183,6 +4465,7 @@ class CartPlatformModel {
|
|
|
4183
4465
|
),
|
|
4184
4466
|
pan_no: Joi.string().allow(""),
|
|
4185
4467
|
custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4468
|
+
alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
|
|
4186
4469
|
free_gift_selection_available: Joi.boolean(),
|
|
4187
4470
|
});
|
|
4188
4471
|
}
|
|
@@ -4208,6 +4491,8 @@ class CartPlatformModel {
|
|
|
4208
4491
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4209
4492
|
pos: Joi.boolean(),
|
|
4210
4493
|
seller_identifier: Joi.string().allow(""),
|
|
4494
|
+
fulfillment_option_slug: Joi.string().allow(""),
|
|
4495
|
+
pickup_store_id: Joi.number(),
|
|
4211
4496
|
});
|
|
4212
4497
|
}
|
|
4213
4498
|
|
|
@@ -4256,6 +4541,8 @@ class CartPlatformModel {
|
|
|
4256
4541
|
item_index: Joi.number(),
|
|
4257
4542
|
identifiers: CartPlatformModel.CartProductIdentifer().required(),
|
|
4258
4543
|
article_id: Joi.string().allow(""),
|
|
4544
|
+
fulfillment_option_slug: Joi.string().allow(""),
|
|
4545
|
+
pickup_store_id: Joi.number(),
|
|
4259
4546
|
});
|
|
4260
4547
|
}
|
|
4261
4548
|
|
|
@@ -4434,7 +4721,7 @@ class CartPlatformModel {
|
|
|
4434
4721
|
/** @returns {UpdateUserCartMapping} */
|
|
4435
4722
|
static UpdateUserCartMapping() {
|
|
4436
4723
|
return Joi.object({
|
|
4437
|
-
user_id: Joi.string().allow("").
|
|
4724
|
+
user_id: Joi.string().allow("").allow(null),
|
|
4438
4725
|
});
|
|
4439
4726
|
}
|
|
4440
4727
|
|
|
@@ -4702,6 +4989,7 @@ class CartPlatformModel {
|
|
|
4702
4989
|
dp_id: Joi.string().allow("").allow(null),
|
|
4703
4990
|
fulfillment_type: Joi.string().allow(""),
|
|
4704
4991
|
articles: Joi.array().items(CartPlatformModel.ShipmentArticle()),
|
|
4992
|
+
fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
|
|
4705
4993
|
});
|
|
4706
4994
|
}
|
|
4707
4995
|
|
|
@@ -4761,6 +5049,7 @@ class CartPlatformModel {
|
|
|
4761
5049
|
return Joi.object({
|
|
4762
5050
|
gstin: Joi.string().allow(""),
|
|
4763
5051
|
pick_up_customer_details: Joi.object().pattern(/\S/, Joi.any()),
|
|
5052
|
+
alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
|
|
4764
5053
|
checkout_mode: Joi.string().allow(""),
|
|
4765
5054
|
gift_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
4766
5055
|
pan_no: Joi.string().allow(""),
|
|
@@ -5200,11 +5489,169 @@ class CartPlatformModel {
|
|
|
5200
5489
|
|
|
5201
5490
|
"smart_trolley",
|
|
5202
5491
|
|
|
5492
|
+
"gofynd",
|
|
5493
|
+
|
|
5494
|
+
"uniket",
|
|
5495
|
+
|
|
5203
5496
|
"marketplace",
|
|
5204
5497
|
|
|
5205
5498
|
"social_commerce",
|
|
5206
5499
|
|
|
5207
|
-
"ondc"
|
|
5500
|
+
"ondc",
|
|
5501
|
+
|
|
5502
|
+
"nexus",
|
|
5503
|
+
|
|
5504
|
+
"nykaa_fashion",
|
|
5505
|
+
|
|
5506
|
+
"etsy",
|
|
5507
|
+
|
|
5508
|
+
"vuivui",
|
|
5509
|
+
|
|
5510
|
+
"zilingo",
|
|
5511
|
+
|
|
5512
|
+
"firstcry",
|
|
5513
|
+
|
|
5514
|
+
"bukalapak",
|
|
5515
|
+
|
|
5516
|
+
"myntra_ppmp",
|
|
5517
|
+
|
|
5518
|
+
"lazada",
|
|
5519
|
+
|
|
5520
|
+
"tiktok",
|
|
5521
|
+
|
|
5522
|
+
"sfcc",
|
|
5523
|
+
|
|
5524
|
+
"debenhams",
|
|
5525
|
+
|
|
5526
|
+
"prestomall",
|
|
5527
|
+
|
|
5528
|
+
"meesho",
|
|
5529
|
+
|
|
5530
|
+
"amazon_vdf",
|
|
5531
|
+
|
|
5532
|
+
"bigcommerce",
|
|
5533
|
+
|
|
5534
|
+
"sendo",
|
|
5535
|
+
|
|
5536
|
+
"storehippo",
|
|
5537
|
+
|
|
5538
|
+
"cdiscount",
|
|
5539
|
+
|
|
5540
|
+
"nykaa",
|
|
5541
|
+
|
|
5542
|
+
"trendyol",
|
|
5543
|
+
|
|
5544
|
+
"weloveshopping",
|
|
5545
|
+
|
|
5546
|
+
"jollee",
|
|
5547
|
+
|
|
5548
|
+
"wish",
|
|
5549
|
+
|
|
5550
|
+
"tiki",
|
|
5551
|
+
|
|
5552
|
+
"central_online",
|
|
5553
|
+
|
|
5554
|
+
"q10",
|
|
5555
|
+
|
|
5556
|
+
"cred",
|
|
5557
|
+
|
|
5558
|
+
"walmart",
|
|
5559
|
+
|
|
5560
|
+
"snapdeal",
|
|
5561
|
+
|
|
5562
|
+
"flipkart",
|
|
5563
|
+
|
|
5564
|
+
"blibli",
|
|
5565
|
+
|
|
5566
|
+
"ajio_jit",
|
|
5567
|
+
|
|
5568
|
+
"pharmeasy",
|
|
5569
|
+
|
|
5570
|
+
"ezmall",
|
|
5571
|
+
|
|
5572
|
+
"adobe_commerce",
|
|
5573
|
+
|
|
5574
|
+
"kartmax",
|
|
5575
|
+
|
|
5576
|
+
"shopee",
|
|
5577
|
+
|
|
5578
|
+
"zalora",
|
|
5579
|
+
|
|
5580
|
+
"prestashop",
|
|
5581
|
+
|
|
5582
|
+
"smytten",
|
|
5583
|
+
|
|
5584
|
+
"amazon_sc",
|
|
5585
|
+
|
|
5586
|
+
"urbanpiper",
|
|
5587
|
+
|
|
5588
|
+
"flipkart_quick",
|
|
5589
|
+
|
|
5590
|
+
"woocommerce",
|
|
5591
|
+
|
|
5592
|
+
"zivame",
|
|
5593
|
+
|
|
5594
|
+
"lelong",
|
|
5595
|
+
|
|
5596
|
+
"facebook",
|
|
5597
|
+
|
|
5598
|
+
"jiomart",
|
|
5599
|
+
|
|
5600
|
+
"gmc",
|
|
5601
|
+
|
|
5602
|
+
"robins",
|
|
5603
|
+
|
|
5604
|
+
"akulaku",
|
|
5605
|
+
|
|
5606
|
+
"noon",
|
|
5607
|
+
|
|
5608
|
+
"tatacliq",
|
|
5609
|
+
|
|
5610
|
+
"kartrocket",
|
|
5611
|
+
|
|
5612
|
+
"inorbit",
|
|
5613
|
+
|
|
5614
|
+
"ajio_business",
|
|
5615
|
+
|
|
5616
|
+
"swiggy",
|
|
5617
|
+
|
|
5618
|
+
"asos",
|
|
5619
|
+
|
|
5620
|
+
"tokopedia",
|
|
5621
|
+
|
|
5622
|
+
"limeroad",
|
|
5623
|
+
|
|
5624
|
+
"myntra_omni",
|
|
5625
|
+
|
|
5626
|
+
"spoyl",
|
|
5627
|
+
|
|
5628
|
+
"amazon_mlf",
|
|
5629
|
+
|
|
5630
|
+
"fulfilled_by_lazada",
|
|
5631
|
+
|
|
5632
|
+
"ebay",
|
|
5633
|
+
|
|
5634
|
+
"jd",
|
|
5635
|
+
|
|
5636
|
+
"amazon_pharmacy",
|
|
5637
|
+
|
|
5638
|
+
"ajio_vms",
|
|
5639
|
+
|
|
5640
|
+
"daraz",
|
|
5641
|
+
|
|
5642
|
+
"oker",
|
|
5643
|
+
|
|
5644
|
+
"flipkart_b2b",
|
|
5645
|
+
|
|
5646
|
+
"amazon_mlf_ss",
|
|
5647
|
+
|
|
5648
|
+
"woovly",
|
|
5649
|
+
|
|
5650
|
+
"tata1mg",
|
|
5651
|
+
|
|
5652
|
+
"zomato",
|
|
5653
|
+
|
|
5654
|
+
"shopify"
|
|
5208
5655
|
);
|
|
5209
5656
|
}
|
|
5210
5657
|
}
|
|
@@ -758,7 +758,7 @@ declare class Catalog {
|
|
|
758
758
|
* @summary: Get configuration
|
|
759
759
|
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationByType/).
|
|
760
760
|
*/
|
|
761
|
-
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
761
|
+
getConfigurationByType({ type, includeInactive, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
762
762
|
/**
|
|
763
763
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationMetadataParam} arg
|
|
764
764
|
* - Arg object
|
|
@@ -4021,7 +4021,7 @@ class Catalog {
|
|
|
4021
4021
|
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationByType/).
|
|
4022
4022
|
*/
|
|
4023
4023
|
async getConfigurationByType(
|
|
4024
|
-
{ type, requestHeaders } = { requestHeaders: {} },
|
|
4024
|
+
{ type, includeInactive, requestHeaders } = { requestHeaders: {} },
|
|
4025
4025
|
{ responseHeaders } = { responseHeaders: false }
|
|
4026
4026
|
) {
|
|
4027
4027
|
const {
|
|
@@ -4029,6 +4029,7 @@ class Catalog {
|
|
|
4029
4029
|
} = CatalogPlatformApplicationValidator.getConfigurationByType().validate(
|
|
4030
4030
|
{
|
|
4031
4031
|
type,
|
|
4032
|
+
includeInactive,
|
|
4032
4033
|
},
|
|
4033
4034
|
{ abortEarly: false, allowUnknown: true }
|
|
4034
4035
|
);
|
|
@@ -4042,6 +4043,7 @@ class Catalog {
|
|
|
4042
4043
|
} = CatalogPlatformApplicationValidator.getConfigurationByType().validate(
|
|
4043
4044
|
{
|
|
4044
4045
|
type,
|
|
4046
|
+
includeInactive,
|
|
4045
4047
|
},
|
|
4046
4048
|
{ abortEarly: false, allowUnknown: false }
|
|
4047
4049
|
);
|
|
@@ -4053,6 +4055,7 @@ class Catalog {
|
|
|
4053
4055
|
}
|
|
4054
4056
|
|
|
4055
4057
|
const query_params = {};
|
|
4058
|
+
query_params["include_inactive"] = includeInactive;
|
|
4056
4059
|
|
|
4057
4060
|
const response = await PlatformAPIClient.execute(
|
|
4058
4061
|
this.config,
|