@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.
Files changed (54) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
  5. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  7. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +115 -47
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
  9. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  10. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformModel.d.ts +454 -12
  12. package/sdk/platform/Cart/CartPlatformModel.js +457 -10
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
  16. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
  17. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  18. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  19. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  20. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  21. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  22. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  23. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  24. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  25. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  26. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  27. package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
  28. package/sdk/platform/Content/ContentPlatformModel.js +6 -20
  29. package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
  30. package/sdk/platform/Order/OrderPlatformModel.js +388 -14
  31. package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
  32. package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
  33. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
  34. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
  35. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
  36. package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
  37. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  38. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  39. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  40. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  41. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  42. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  43. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
  44. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
  45. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  46. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  47. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  48. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  49. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  50. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  51. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  52. package/sdk/platform/User/UserPlatformModel.js +276 -7
  53. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  54. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
@@ -321,6 +321,57 @@ export = CartPlatformModel;
321
321
  * which promotion is not applicable
322
322
  * @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
323
323
  */
324
+ /**
325
+ * @typedef BuyRuleItemCriteria
326
+ * @property {CompareObject} [cart_quantity]
327
+ * @property {string[]} [available_zones] - List of all zones on which promotion
328
+ * is applicable
329
+ * @property {number[]} [item_exclude_company] - List of all company id on which
330
+ * promotion is not applicable
331
+ * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
332
+ * @property {number[]} [item_l1_category] - List of all L1 category on which
333
+ * promotion is applicable
334
+ * @property {CompareObject} [cart_total]
335
+ * @property {CompareObject} [cart_unique_item_quantity]
336
+ * @property {CompareObject} [cart_unique_item_amount]
337
+ * @property {number[]} [item_exclude_id] - List of all item ids on which
338
+ * promotion is not applicable
339
+ * @property {boolean} [all_items] - Boolean flag set true to applicable the
340
+ * promotion for all products
341
+ * @property {number[]} [item_exclude_l1_category] - List of all item ids on
342
+ * which promotion is not applicable
343
+ * @property {string[]} [item_size] - List of all item sizes on which promotion
344
+ * is applicable
345
+ * @property {number[]} [item_store] - List of all item store ids on which
346
+ * promotion is applicable
347
+ * @property {string[]} [item_exclude_sku] - List of all item sku on which
348
+ * promotion is not applicable
349
+ * @property {number[]} [item_department] - List of all departments ids on which
350
+ * promotion is applicable
351
+ * @property {number[]} [item_exclude_store] - List of all item store ids on
352
+ * which promotion is not applicable
353
+ * @property {number[]} [item_brand] - List of all brand ids on which promotion
354
+ * is applicable
355
+ * @property {number[]} [item_exclude_department] - List of all department ids
356
+ * on which promotion is not applicable
357
+ * @property {number[]} [item_exclude_category] - List of all L3 category on
358
+ * which promotion is not applicable
359
+ * @property {number[]} [item_category] - List of all L3 category on which
360
+ * promotion is applicable
361
+ * @property {string[]} [buy_rules]
362
+ * @property {number[]} [item_exclude_brand] - List of all brand ids on which
363
+ * promotion is not applicable
364
+ * @property {number[]} [item_l2_category] - List of all L2 category on which
365
+ * promotion is applicable
366
+ * @property {number[]} [item_company] - List of all company ids on which
367
+ * promotion is applicable
368
+ * @property {string[]} [item_tags] - List of all product tags on which
369
+ * promotion is applicable
370
+ * @property {number[]} [item_exclude_l2_category] - List of all L2 category on
371
+ * which promotion is not applicable
372
+ * @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
373
+ * @property {ItemSizeMapping} [meta]
374
+ */
324
375
  /**
325
376
  * @typedef DiscountOffer
326
377
  * @property {number} [max_discount_amount] - Maximum discount amount in promotion
@@ -495,7 +546,7 @@ export = CartPlatformModel;
495
546
  * @property {PromotionAuthor} [author]
496
547
  * @property {Visibility} [visiblility]
497
548
  * @property {string} application_id - Current application id of sales channel
498
- * @property {ItemCriteria} [buy_rules]
549
+ * @property {BuyRuleItemCriteria} [buy_rules]
499
550
  * @property {Object} [_custom_json] - Set extra properties in promotion
500
551
  * @property {PromotionDateMeta} [date_meta]
501
552
  * @property {string[]} [tags] - List of tags applicable for promotion
@@ -599,7 +650,7 @@ export = CartPlatformModel;
599
650
  * @property {PromotionAuthor} [author]
600
651
  * @property {Visibility} [visiblility]
601
652
  * @property {string} application_id - Current application id of sales channel
602
- * @property {ItemCriteria} [buy_rules]
653
+ * @property {BuyRuleItemCriteria} [buy_rules]
603
654
  * @property {Object} [_custom_json] - Set extra properties in promotion
604
655
  * @property {PromotionDateMeta} [date_meta]
605
656
  * @property {string[]} [tags] - List of tags applicable for promotion
@@ -944,6 +995,39 @@ export = CartPlatformModel;
944
995
  * @property {string} [store_code] - A unique code or identifier for the store,
945
996
  * often used for internal reference
946
997
  */
998
+ /**
999
+ * @typedef FulfillmentOptionSchema
1000
+ * @property {string} [slug] - Unique identifier for the delivery type.
1001
+ * @property {string} [description] - Description of the delivery service.
1002
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
1003
+ * @property {string} [id] - Unique ID of the delivery service.
1004
+ * @property {string} [type] - Type of fulfillment option.
1005
+ * @property {string} [name] - Name of the delivery service.
1006
+ */
1007
+ /**
1008
+ * @typedef StoreTimingSchema
1009
+ * @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
1010
+ * @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
1011
+ */
1012
+ /**
1013
+ * @typedef StoreHoursSchema
1014
+ * @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
1015
+ * @property {StoreTimingSchema} [opening]
1016
+ * @property {StoreTimingSchema} [closing]
1017
+ * @property {boolean} [open] - Indicates whether the store is open on the
1018
+ * specified weekday.
1019
+ */
1020
+ /**
1021
+ * @typedef PickupStoreDetailSchema
1022
+ * @property {number} [store_id] - A unique identifier for the store.
1023
+ * @property {string} [name] - The name of the store or pickup location.
1024
+ * @property {string} [pincode] - The postal code of the store's location.
1025
+ * @property {number} [distance] - The distance between the store and the
1026
+ * customer's location.
1027
+ * @property {string} [address] - The full address of the store.
1028
+ * @property {Object} [store_hours] - The store's operational hours for each day
1029
+ * of the week.
1030
+ */
947
1031
  /**
948
1032
  * @typedef ProductArticle
949
1033
  * @property {string} [seller_identifier] - List of identifiers used by sellers
@@ -975,6 +1059,8 @@ export = CartPlatformModel;
975
1059
  * @property {Object} [meta] - Meta data of article in cart
976
1060
  * @property {string} [size] - Size of the article added in cart
977
1061
  * @property {StoreInfo} [store]
1062
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
1063
+ * @property {PickupStoreDetailSchema} [pickup_store_detail]
978
1064
  * @property {number} [item_index] - Specify the index of article in cart.
979
1065
  * @property {string[]} [tags] - A list of article tags
980
1066
  */
@@ -1164,7 +1250,7 @@ export = CartPlatformModel;
1164
1250
  * @property {string} [state] - State of the address
1165
1251
  * @property {string} [city] - City of the address
1166
1252
  * @property {number} [phone] - Phone number for address
1167
- * @property {string} area_code - Area code of the address
1253
+ * @property {string} [area_code] - Area code of the address
1168
1254
  * @property {string} [country_iso_code] - Country iso code for address
1169
1255
  * @property {string} [country_phone_code] - Country phone code for address
1170
1256
  * @property {Object} [meta] - Metadata of the address
@@ -1381,6 +1467,16 @@ export = CartPlatformModel;
1381
1467
  * @typedef CartCommonConfig
1382
1468
  * @property {DeliveryChargesConfig} [delivery_charges_config]
1383
1469
  */
1470
+ /**
1471
+ * @typedef PlatformAlternatePickupPerson
1472
+ * @property {boolean} [enabled] - Indicates whether an alternate pickup person
1473
+ * is enabled.
1474
+ * @property {string} [name] - Name of the alternate pickup person.
1475
+ * @property {string} [email] - Email address of the alternate pickup person.
1476
+ * @property {string} [phone] - Phone number of the alternate pickup person.
1477
+ * @property {string} [country_phone_code] - Country phone code of the alternate
1478
+ * pickup person (e.g., "+91").
1479
+ */
1384
1480
  /**
1385
1481
  * @typedef CartDetailResult
1386
1482
  * @property {number} [cart_id] - Unique identifier of the user cart
@@ -1422,6 +1518,7 @@ export = CartPlatformModel;
1422
1518
  * @property {string} [pan_no] - Permanent Account Number of the user
1423
1519
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
1424
1520
  * checkout API payload
1521
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
1425
1522
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
1426
1523
  * has available promotion free gift items to choose on its added items
1427
1524
  */
@@ -1453,6 +1550,10 @@ export = CartPlatformModel;
1453
1550
  * @property {boolean} [pos] - Filed to determine whether user is making request
1454
1551
  * from pos or not
1455
1552
  * @property {string} [seller_identifier] - Add items using seller identifier for store os
1553
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1554
+ * method, indicating whether an order is for home delivery or store pickup
1555
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1556
+ * selected by the user from which user wants to pickup the product.
1456
1557
  */
1457
1558
  /**
1458
1559
  * @typedef AddCartCreation
@@ -1499,6 +1600,10 @@ export = CartPlatformModel;
1499
1600
  * product falls to be updated
1500
1601
  * @property {CartProductIdentifer} identifiers
1501
1602
  * @property {string} [article_id] - Article id of the product in cart
1603
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1604
+ * method, indicating whether an order is for home delivery or store pickup
1605
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1606
+ * selected by the user from which user
1502
1607
  */
1503
1608
  /**
1504
1609
  * @typedef FreeGiftItemCreation
@@ -1654,7 +1759,8 @@ export = CartPlatformModel;
1654
1759
  */
1655
1760
  /**
1656
1761
  * @typedef UpdateUserCartMapping
1657
- * @property {string} user_id - User Id of user for which we map with the cart
1762
+ * @property {string} [user_id] - Customer user ID to associate with the cart.
1763
+ * Send null to remove existing mapping of customer from cart.
1658
1764
  */
1659
1765
  /**
1660
1766
  * @typedef UserInfo
@@ -1897,6 +2003,7 @@ export = CartPlatformModel;
1897
2003
  * @property {string} [dp_id] - Delivery partner id of the shipment
1898
2004
  * @property {string} [fulfillment_type] - Fulfilment type of shipment
1899
2005
  * @property {ShipmentArticle[]} [articles] - List of articles in shipment
2006
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
1900
2007
  */
1901
2008
  /**
1902
2009
  * @typedef PlatformCartShipmentsResult
@@ -1953,6 +2060,7 @@ export = CartPlatformModel;
1953
2060
  * @property {string} [gstin] - GSTIN number to be added in user cart
1954
2061
  * @property {Object} [pick_up_customer_details] - Customer contact details for
1955
2062
  * customer pickup at store
2063
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
1956
2064
  * @property {string} [checkout_mode] - Checkout mode of user cart
1957
2065
  * @property {Object} [gift_details] - Gift details is open json which can
1958
2066
  * include gift message
@@ -2345,14 +2453,93 @@ export = CartPlatformModel;
2345
2453
  * | "kiosk"
2346
2454
  * | "scan_go"
2347
2455
  * | "smart_trolley"
2456
+ * | "gofynd"
2457
+ * | "uniket"
2348
2458
  * | "marketplace"
2349
2459
  * | "social_commerce"
2350
- * | "ondc"} OrderingSource
2460
+ * | "ondc"
2461
+ * | "nexus"
2462
+ * | "nykaa_fashion"
2463
+ * | "etsy"
2464
+ * | "vuivui"
2465
+ * | "zilingo"
2466
+ * | "firstcry"
2467
+ * | "bukalapak"
2468
+ * | "myntra_ppmp"
2469
+ * | "lazada"
2470
+ * | "tiktok"
2471
+ * | "sfcc"
2472
+ * | "debenhams"
2473
+ * | "prestomall"
2474
+ * | "meesho"
2475
+ * | "amazon_vdf"
2476
+ * | "bigcommerce"
2477
+ * | "sendo"
2478
+ * | "storehippo"
2479
+ * | "cdiscount"
2480
+ * | "nykaa"
2481
+ * | "trendyol"
2482
+ * | "weloveshopping"
2483
+ * | "jollee"
2484
+ * | "wish"
2485
+ * | "tiki"
2486
+ * | "central_online"
2487
+ * | "q10"
2488
+ * | "cred"
2489
+ * | "walmart"
2490
+ * | "snapdeal"
2491
+ * | "flipkart"
2492
+ * | "blibli"
2493
+ * | "ajio_jit"
2494
+ * | "pharmeasy"
2495
+ * | "ezmall"
2496
+ * | "adobe_commerce"
2497
+ * | "kartmax"
2498
+ * | "shopee"
2499
+ * | "zalora"
2500
+ * | "prestashop"
2501
+ * | "smytten"
2502
+ * | "amazon_sc"
2503
+ * | "urbanpiper"
2504
+ * | "flipkart_quick"
2505
+ * | "woocommerce"
2506
+ * | "zivame"
2507
+ * | "lelong"
2508
+ * | "facebook"
2509
+ * | "jiomart"
2510
+ * | "gmc"
2511
+ * | "robins"
2512
+ * | "akulaku"
2513
+ * | "noon"
2514
+ * | "tatacliq"
2515
+ * | "kartrocket"
2516
+ * | "inorbit"
2517
+ * | "ajio_business"
2518
+ * | "swiggy"
2519
+ * | "asos"
2520
+ * | "tokopedia"
2521
+ * | "limeroad"
2522
+ * | "myntra_omni"
2523
+ * | "spoyl"
2524
+ * | "amazon_mlf"
2525
+ * | "fulfilled_by_lazada"
2526
+ * | "ebay"
2527
+ * | "jd"
2528
+ * | "amazon_pharmacy"
2529
+ * | "ajio_vms"
2530
+ * | "daraz"
2531
+ * | "oker"
2532
+ * | "flipkart_b2b"
2533
+ * | "amazon_mlf_ss"
2534
+ * | "woovly"
2535
+ * | "tata1mg"
2536
+ * | "zomato"
2537
+ * | "shopify"} OrderingSource
2351
2538
  */
2352
2539
  declare class CartPlatformModel {
2353
2540
  }
2354
2541
  declare namespace CartPlatformModel {
2355
- export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
2542
+ export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, BuyRuleItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, PlatformAlternatePickupPerson, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
2356
2543
  }
2357
2544
  /** @returns {CouponDateMeta} */
2358
2545
  declare function CouponDateMeta(): CouponDateMeta;
@@ -3124,6 +3311,124 @@ type ItemCriteria = {
3124
3311
  */
3125
3312
  item_sku?: string[];
3126
3313
  };
3314
+ /** @returns {BuyRuleItemCriteria} */
3315
+ declare function BuyRuleItemCriteria(): BuyRuleItemCriteria;
3316
+ type BuyRuleItemCriteria = {
3317
+ cart_quantity?: CompareObject;
3318
+ /**
3319
+ * - List of all zones on which promotion
3320
+ * is applicable
3321
+ */
3322
+ available_zones?: string[];
3323
+ /**
3324
+ * - List of all company id on which
3325
+ * promotion is not applicable
3326
+ */
3327
+ item_exclude_company?: number[];
3328
+ /**
3329
+ * - List of all item ids on which promotion is applicable
3330
+ */
3331
+ item_id?: number[];
3332
+ /**
3333
+ * - List of all L1 category on which
3334
+ * promotion is applicable
3335
+ */
3336
+ item_l1_category?: number[];
3337
+ cart_total?: CompareObject;
3338
+ cart_unique_item_quantity?: CompareObject;
3339
+ cart_unique_item_amount?: CompareObject;
3340
+ /**
3341
+ * - List of all item ids on which
3342
+ * promotion is not applicable
3343
+ */
3344
+ item_exclude_id?: number[];
3345
+ /**
3346
+ * - Boolean flag set true to applicable the
3347
+ * promotion for all products
3348
+ */
3349
+ all_items?: boolean;
3350
+ /**
3351
+ * - List of all item ids on
3352
+ * which promotion is not applicable
3353
+ */
3354
+ item_exclude_l1_category?: number[];
3355
+ /**
3356
+ * - List of all item sizes on which promotion
3357
+ * is applicable
3358
+ */
3359
+ item_size?: string[];
3360
+ /**
3361
+ * - List of all item store ids on which
3362
+ * promotion is applicable
3363
+ */
3364
+ item_store?: number[];
3365
+ /**
3366
+ * - List of all item sku on which
3367
+ * promotion is not applicable
3368
+ */
3369
+ item_exclude_sku?: string[];
3370
+ /**
3371
+ * - List of all departments ids on which
3372
+ * promotion is applicable
3373
+ */
3374
+ item_department?: number[];
3375
+ /**
3376
+ * - List of all item store ids on
3377
+ * which promotion is not applicable
3378
+ */
3379
+ item_exclude_store?: number[];
3380
+ /**
3381
+ * - List of all brand ids on which promotion
3382
+ * is applicable
3383
+ */
3384
+ item_brand?: number[];
3385
+ /**
3386
+ * - List of all department ids
3387
+ * on which promotion is not applicable
3388
+ */
3389
+ item_exclude_department?: number[];
3390
+ /**
3391
+ * - List of all L3 category on
3392
+ * which promotion is not applicable
3393
+ */
3394
+ item_exclude_category?: number[];
3395
+ /**
3396
+ * - List of all L3 category on which
3397
+ * promotion is applicable
3398
+ */
3399
+ item_category?: number[];
3400
+ buy_rules?: string[];
3401
+ /**
3402
+ * - List of all brand ids on which
3403
+ * promotion is not applicable
3404
+ */
3405
+ item_exclude_brand?: number[];
3406
+ /**
3407
+ * - List of all L2 category on which
3408
+ * promotion is applicable
3409
+ */
3410
+ item_l2_category?: number[];
3411
+ /**
3412
+ * - List of all company ids on which
3413
+ * promotion is applicable
3414
+ */
3415
+ item_company?: number[];
3416
+ /**
3417
+ * - List of all product tags on which
3418
+ * promotion is applicable
3419
+ */
3420
+ item_tags?: string[];
3421
+ /**
3422
+ * - List of all L2 category on
3423
+ * which promotion is not applicable
3424
+ */
3425
+ item_exclude_l2_category?: number[];
3426
+ /**
3427
+ * - List of all item sku on which promotion is applicable
3428
+ */
3429
+ item_sku?: string[];
3430
+ meta?: ItemSizeMapping;
3431
+ };
3127
3432
  /** @returns {DiscountOffer} */
3128
3433
  declare function DiscountOffer(): DiscountOffer;
3129
3434
  type DiscountOffer = {
@@ -3549,7 +3854,7 @@ type PromotionAdd = {
3549
3854
  * - Current application id of sales channel
3550
3855
  */
3551
3856
  application_id: string;
3552
- buy_rules?: ItemCriteria;
3857
+ buy_rules?: BuyRuleItemCriteria;
3553
3858
  /**
3554
3859
  * - Set extra properties in promotion
3555
3860
  */
@@ -3803,7 +4108,7 @@ type PromotionUpdateResult = {
3803
4108
  * - Current application id of sales channel
3804
4109
  */
3805
4110
  application_id: string;
3806
- buy_rules?: ItemCriteria;
4111
+ buy_rules?: BuyRuleItemCriteria;
3807
4112
  /**
3808
4113
  * - Set extra properties in promotion
3809
4114
  */
@@ -4658,6 +4963,91 @@ type StoreInfo = {
4658
4963
  */
4659
4964
  store_code?: string;
4660
4965
  };
4966
+ /** @returns {FulfillmentOptionSchema} */
4967
+ declare function FulfillmentOptionSchema(): FulfillmentOptionSchema;
4968
+ type FulfillmentOptionSchema = {
4969
+ /**
4970
+ * - Unique identifier for the delivery type.
4971
+ */
4972
+ slug?: string;
4973
+ /**
4974
+ * - Description of the delivery service.
4975
+ */
4976
+ description?: string;
4977
+ /**
4978
+ * - Indicates if this is the default delivery option.
4979
+ */
4980
+ is_default?: boolean;
4981
+ /**
4982
+ * - Unique ID of the delivery service.
4983
+ */
4984
+ id?: string;
4985
+ /**
4986
+ * - Type of fulfillment option.
4987
+ */
4988
+ type?: string;
4989
+ /**
4990
+ * - Name of the delivery service.
4991
+ */
4992
+ name?: string;
4993
+ };
4994
+ /** @returns {StoreTimingSchema} */
4995
+ declare function StoreTimingSchema(): StoreTimingSchema;
4996
+ type StoreTimingSchema = {
4997
+ /**
4998
+ * - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
4999
+ */
5000
+ hour?: number;
5001
+ /**
5002
+ * - The minute of the store (e.g., 30 for 9:30 AM).
5003
+ */
5004
+ minute?: number;
5005
+ };
5006
+ /** @returns {StoreHoursSchema} */
5007
+ declare function StoreHoursSchema(): StoreHoursSchema;
5008
+ type StoreHoursSchema = {
5009
+ /**
5010
+ * - The day of the week (e.g., "Monday", "Tuesday").
5011
+ */
5012
+ weekday?: string;
5013
+ opening?: StoreTimingSchema;
5014
+ closing?: StoreTimingSchema;
5015
+ /**
5016
+ * - Indicates whether the store is open on the
5017
+ * specified weekday.
5018
+ */
5019
+ open?: boolean;
5020
+ };
5021
+ /** @returns {PickupStoreDetailSchema} */
5022
+ declare function PickupStoreDetailSchema(): PickupStoreDetailSchema;
5023
+ type PickupStoreDetailSchema = {
5024
+ /**
5025
+ * - A unique identifier for the store.
5026
+ */
5027
+ store_id?: number;
5028
+ /**
5029
+ * - The name of the store or pickup location.
5030
+ */
5031
+ name?: string;
5032
+ /**
5033
+ * - The postal code of the store's location.
5034
+ */
5035
+ pincode?: string;
5036
+ /**
5037
+ * - The distance between the store and the
5038
+ * customer's location.
5039
+ */
5040
+ distance?: number;
5041
+ /**
5042
+ * - The full address of the store.
5043
+ */
5044
+ address?: string;
5045
+ /**
5046
+ * - The store's operational hours for each day
5047
+ * of the week.
5048
+ */
5049
+ store_hours?: any;
5050
+ };
4661
5051
  /** @returns {ProductArticle} */
4662
5052
  declare function ProductArticle(): ProductArticle;
4663
5053
  type ProductArticle = {
@@ -4738,6 +5128,8 @@ type ProductArticle = {
4738
5128
  */
4739
5129
  size?: string;
4740
5130
  store?: StoreInfo;
5131
+ fulfillment_option?: FulfillmentOptionSchema;
5132
+ pickup_store_detail?: PickupStoreDetailSchema;
4741
5133
  /**
4742
5134
  * - Specify the index of article in cart.
4743
5135
  */
@@ -5194,7 +5586,7 @@ type ShippingAddress = {
5194
5586
  /**
5195
5587
  * - Area code of the address
5196
5588
  */
5197
- area_code: string;
5589
+ area_code?: string;
5198
5590
  /**
5199
5591
  * - Country iso code for address
5200
5592
  */
@@ -5812,6 +6204,32 @@ declare function CartCommonConfig(): CartCommonConfig;
5812
6204
  type CartCommonConfig = {
5813
6205
  delivery_charges_config?: DeliveryChargesConfig;
5814
6206
  };
6207
+ /** @returns {PlatformAlternatePickupPerson} */
6208
+ declare function PlatformAlternatePickupPerson(): PlatformAlternatePickupPerson;
6209
+ type PlatformAlternatePickupPerson = {
6210
+ /**
6211
+ * - Indicates whether an alternate pickup person
6212
+ * is enabled.
6213
+ */
6214
+ enabled?: boolean;
6215
+ /**
6216
+ * - Name of the alternate pickup person.
6217
+ */
6218
+ name?: string;
6219
+ /**
6220
+ * - Email address of the alternate pickup person.
6221
+ */
6222
+ email?: string;
6223
+ /**
6224
+ * - Phone number of the alternate pickup person.
6225
+ */
6226
+ phone?: string;
6227
+ /**
6228
+ * - Country phone code of the alternate
6229
+ * pickup person (e.g., "+91").
6230
+ */
6231
+ country_phone_code?: string;
6232
+ };
5815
6233
  /** @returns {CartDetailResult} */
5816
6234
  declare function CartDetailResult(): CartDetailResult;
5817
6235
  type CartDetailResult = {
@@ -5917,6 +6335,7 @@ type CartDetailResult = {
5917
6335
  * checkout API payload
5918
6336
  */
5919
6337
  custom_cart_meta?: any;
6338
+ alternate_pickup_person?: PlatformAlternatePickupPerson;
5920
6339
  /**
5921
6340
  * - Determines if the cart
5922
6341
  * has available promotion free gift items to choose on its added items
@@ -6000,6 +6419,16 @@ type AddProductCart = {
6000
6419
  * - Add items using seller identifier for store os
6001
6420
  */
6002
6421
  seller_identifier?: string;
6422
+ /**
6423
+ * - Specifies the fulfillment
6424
+ * method, indicating whether an order is for home delivery or store pickup
6425
+ */
6426
+ fulfillment_option_slug?: string;
6427
+ /**
6428
+ * - Unique identifier of the pickup store
6429
+ * selected by the user from which user wants to pickup the product.
6430
+ */
6431
+ pickup_store_id?: number;
6003
6432
  };
6004
6433
  /** @returns {AddCartCreation} */
6005
6434
  declare function AddCartCreation(): AddCartCreation;
@@ -6116,6 +6545,16 @@ type UpdateProductCart = {
6116
6545
  * - Article id of the product in cart
6117
6546
  */
6118
6547
  article_id?: string;
6548
+ /**
6549
+ * - Specifies the fulfillment
6550
+ * method, indicating whether an order is for home delivery or store pickup
6551
+ */
6552
+ fulfillment_option_slug?: string;
6553
+ /**
6554
+ * - Unique identifier of the pickup store
6555
+ * selected by the user from which user
6556
+ */
6557
+ pickup_store_id?: number;
6119
6558
  };
6120
6559
  /** @returns {FreeGiftItemCreation} */
6121
6560
  declare function FreeGiftItemCreation(): FreeGiftItemCreation;
@@ -6512,9 +6951,10 @@ type MultiCartResult = {
6512
6951
  declare function UpdateUserCartMapping(): UpdateUserCartMapping;
6513
6952
  type UpdateUserCartMapping = {
6514
6953
  /**
6515
- * - User Id of user for which we map with the cart
6954
+ * - Customer user ID to associate with the cart.
6955
+ * Send null to remove existing mapping of customer from cart.
6516
6956
  */
6517
- user_id: string;
6957
+ user_id?: string;
6518
6958
  };
6519
6959
  /** @returns {UserInfo} */
6520
6960
  declare function UserInfo(): UserInfo;
@@ -7145,6 +7585,7 @@ type PlatformShipmentDetails = {
7145
7585
  * - List of articles in shipment
7146
7586
  */
7147
7587
  articles?: ShipmentArticle[];
7588
+ fulfillment_option?: FulfillmentOptionSchema;
7148
7589
  };
7149
7590
  /** @returns {PlatformCartShipmentsResult} */
7150
7591
  declare function PlatformCartShipmentsResult(): PlatformCartShipmentsResult;
@@ -7286,6 +7727,7 @@ type PlatformCartMetaCreation = {
7286
7727
  * customer pickup at store
7287
7728
  */
7288
7729
  pick_up_customer_details?: any;
7730
+ alternate_pickup_person?: PlatformAlternatePickupPerson;
7289
7731
  /**
7290
7732
  * - Checkout mode of user cart
7291
7733
  */
@@ -8245,4 +8687,4 @@ type ValidationError = {
8245
8687
  * @returns {OrderingSource}
8246
8688
  */
8247
8689
  declare function OrderingSource(): OrderingSource;
8248
- type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "marketplace" | "social_commerce" | "ondc";
8690
+ type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";