@gofynd/fdk-client-javascript 3.26.0 → 3.28.0

package/README.md

@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.26.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.28.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.26.0",
+  "version": "3.28.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts

@@ -39,7 +39,7 @@ declare class Configuration {
      * @summary: List staff members
      * @description: List all staff members of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffList/).
      */
-    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponseSchema>;
+    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, appPermissions, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
@@ -50,16 +50,18 @@ declare class Configuration {
      * @param {string} [arg.user] - ID of the staff. Helps in retrieving the
      *   details of a particular staff member.
      * @param {string} [arg.userName] - Username of the member.
+     * @param {string} [arg.appPermissions] - App permissions.
      * @returns {Paginator<AppStaffListResponseSchema>}
      * @summary: List staff members
      * @description: List all staff members of the sales channel.
      */
-    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, }?: {
+    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, appPermissions, }?: {
         pageSize?: number;
         orderIncent?: boolean;
         orderingStore?: number;
         user?: string;
         userName?: string;
+        appPermissions?: string;
     }): Paginator<AppStaffListResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/application/Configuration/ConfigurationApplicationClient.js

@@ -102,6 +102,7 @@ class Configuration {
       orderingStore,
       user,
       userName,
+      appPermissions,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -113,6 +114,7 @@ class Configuration {
     query_params["ordering_store"] = orderingStore;
     query_params["user"] = user;
     query_params["user_name"] = userName;
+    query_params["app_permissions"] = appPermissions;
 
     const xHeaders = {};
 
@@ -147,6 +149,7 @@ class Configuration {
    * @param {string} [arg.user] - ID of the staff. Helps in retrieving the
    *   details of a particular staff member.
    * @param {string} [arg.userName] - Username of the member.
+   * @param {string} [arg.appPermissions] - App permissions.
    * @returns {Paginator<AppStaffListResponseSchema>}
    * @summary: List staff members
    * @description: List all staff members of the sales channel.
@@ -157,6 +160,7 @@ class Configuration {
     orderingStore,
     user,
     userName,
+    appPermissions,
   } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
@@ -170,6 +174,7 @@ class Configuration {
         orderingStore: orderingStore,
         user: user,
         userName: userName,
+        appPermissions: appPermissions,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,

package/sdk/application/Payment/PaymentApplicationClient.d.ts

@@ -27,6 +27,7 @@ declare class Payment {
         getActiveUserCards: string;
         getAggregatorsConfig: string;
         getOrderBeneficiariesDetail: string;
+        getOrderTransactions: string;
         getPaymentLink: string;
         getPaymentModeRoutes: string;
         getPaymentModeRoutesPaymentLink: string;
@@ -271,6 +272,15 @@ declare class Payment {
      * @description: Get beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getOrderBeneficiariesDetail/).
      */
     getOrderBeneficiariesDetail({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderBeneficiaryFetchDetails>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<OrderTransactionList>} - Success response
+     * @name getOrderTransactions
+     * @summary: List all transactions for an order
+     * @description: Returns all payment transactions for the given order ID, ordered by creation timestamp ascending. Each entry includes merchant transaction ID, payment mode name, logo, amount, latest status, and created_on. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getOrderTransactions/).
+     */
+    getOrderTransactions({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderTransactionList>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -306,7 +316,7 @@ declare class Payment {
      * @summary: POS payment modes
      * @description: Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPosPaymentModeRoutes/).
      */
-    getPosPaymentModeRoutes({ amount, cartId, pincode, orderType, checkoutMode, refresh, cardReference, fulfillmentOption, userDetails, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentModeRouteDetails>;
+    getPosPaymentModeRoutes({ amount, cartId, pincode, orderType, checkoutMode, refresh, cardReference, fulfillmentOption, userDetails, displaySplit, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentModeRouteDetails>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options

package/sdk/application/Payment/PaymentApplicationClient.js

@@ -52,6 +52,8 @@ class Payment {
         "/service/application/payment/v1.0/config/aggregators/key",
       getOrderBeneficiariesDetail:
         "/service/application/payment/v1.0/refund/order/beneficiaries",
+      getOrderTransactions:
+        "/service/application/payment/v1.0/orders/{order_id}/transactions",
       getPaymentLink: "/service/application/payment/v1.0/create-payment-link/",
       getPaymentModeRoutes: "/service/application/payment/v1.0/payment/options",
       getPaymentModeRoutesPaymentLink:
@@ -1026,6 +1028,52 @@ class Payment {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<OrderTransactionList>} - Success response
+   * @name getOrderTransactions
+   * @summary: List all transactions for an order
+   * @description: Returns all payment transactions for the given order ID, ordered by creation timestamp ascending. Each entry includes merchant transaction ID, payment mode name, logo, amount, latest status, and created_on. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getOrderTransactions/).
+   */
+  async getOrderTransactions(
+    { orderId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const errors = validateRequiredParams(arguments[0], ["orderId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getOrderTransactions"],
+        params: { orderId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
@@ -1182,6 +1230,7 @@ class Payment {
       cardReference,
       fulfillmentOption,
       userDetails,
+      displaySplit,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -1196,6 +1245,7 @@ class Payment {
     query_params["order_type"] = orderType;
     query_params["fulfillment_option"] = fulfillmentOption;
     query_params["user_details"] = userDetails;
+    query_params["display_split"] = displaySplit;
 
     const xHeaders = {};
 

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -3,6 +3,9 @@ export = CartPlatformModel;
  * @typedef RedeemLoyaltyPoints
  * @property {boolean} redeem_points - Marks if engage points are to be redeemed
  *   for the given cart.
+ * @property {Object} [meta] - Free-form metadata forwarded to the loyalty
+ *   engine. Any field can be passed (e.g. points, redeem_rule_id). Engage reads
+ *   from this dict when processing redemption.
  */
 /**
  * @typedef CouponDateMeta
@@ -945,6 +948,9 @@ export = CartPlatformModel;
  * @property {string} [title] - Unique title for loyalty program applicable.
  * @property {number} [discount_amount] - Engage discount amount applied on the
  *   cart as payment mode
+ * @property {Object} [meta] - Free-form metadata returned by the loyalty engine
+ *   in its response. Structure varies; may include rule details, campaign info,
+ *   or any additional fields Engage sends back.
  */
 /**
  * @typedef RawBreakup
@@ -1608,12 +1614,17 @@ export = CartPlatformModel;
  * @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
  *   is doing fast checkout for the cart using buy now
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
  *   promotions data to cart which includes promotion id, promotion name, offer
  *   text, description, buy rules, discount rules and promotion type
  * @property {string} [pan_no] - Permanent Account Number of the user
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
+ * @property {Object} [loyalty_meta] - Free-form metadata stored against the
+ *   loyalty redemption for this cart. Contains fields passed via the
+ *   applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is
+ *   forwarded to the loyalty engine on each cart calculation.
  * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
  *   has available promotion free gift items to choose on its added items
@@ -1840,6 +1851,7 @@ export = CartPlatformModel;
  * @property {boolean} [buy_now] - Buy now flag of user cart
  * @property {number} [cart_id] - Cart id of user cart for generating cart sharing token
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [custom_cart_meta] - Custom cart meta of user cart added
  *   via update cart meta API
  */
@@ -1909,6 +1921,7 @@ export = CartPlatformModel;
  * @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
  *   is doing fast checkout for the cart using buy now
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
@@ -2155,6 +2168,7 @@ export = CartPlatformModel;
  * @property {string} [last_modified] - Last modified timestamp of cart
  * @property {boolean} [buy_now] - Buy now flag of user cart
  * @property {string} [gstin] - GSTIN number added in cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
  *   promotions data to cart which includes promotion id, promotion name, offer
  *   text, description, buy rules, discount rules and promotion type
@@ -2178,9 +2192,16 @@ export = CartPlatformModel;
  *   includes shipment data like shipment items, shipment promise, Shipment
  *   type, shipment order type, shipment dp options etc
  */
+/**
+ * @typedef ShipToGstDetails
+ * @property {string} [gstin] - Ship-to GSTIN for bill-to ship-to e-way bill generation.
+ * @property {string} [trade_name] - Ship-to trade name for bill-to ship-to
+ *   e-way bill generation.
+ */
 /**
  * @typedef PlatformCartMetaCreation
  * @property {string} [gstin] - GSTIN number to be added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [pick_up_customer_details] - Customer contact details for
  *   customer pickup at store
  * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
@@ -2309,6 +2330,7 @@ export = CartPlatformModel;
  * @property {number} [cart_id] - Cart id of the user cart for which the order placed
  * @property {Object[]} [store_emps] - Store employees data
  * @property {string} [gstin] - GSTIN number added in cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {boolean} [cod_available] - Whether Cash On Delivery available
  * @property {number} [delivery_charges] - Delivery charges of the order placed
  *   via checkout API
@@ -2856,7 +2878,7 @@ export = CartPlatformModel;
 declare class CartPlatformModel {
 }
 declare namespace CartPlatformModel {
-    export { RedeemLoyaltyPoints, 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, DiscountItemCriteria, 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, CurrencyValue, ChargesAmount, ArticleCharges, 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, OverrideCheckoutData, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, UpdateCartBreakup, 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, CartCheckoutDetailsData, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OfferUser, OfferItemCriteria, DiscountRuleOffer, OfferDiscountRule, OfferUsesRemaining, OfferUsesRestriction, OfferRestrictionFulfillmentOptions, OfferRestrictions, OfferDisplayMeta, OfferCouponConfiguration, OfferOwnership, OfferSchema, OfferPartialUpdate, OfferAuthor, OfferDateMeta, OfferSchedule, OfferListItem, OfferListResult };
+    export { RedeemLoyaltyPoints, 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, DiscountItemCriteria, 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, CurrencyValue, ChargesAmount, ArticleCharges, 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, OverrideCheckoutData, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, UpdateCartBreakup, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, ShipToGstDetails, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetailsData, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OfferUser, OfferItemCriteria, DiscountRuleOffer, OfferDiscountRule, OfferUsesRemaining, OfferUsesRestriction, OfferRestrictionFulfillmentOptions, OfferRestrictions, OfferDisplayMeta, OfferCouponConfiguration, OfferOwnership, OfferSchema, OfferPartialUpdate, OfferAuthor, OfferDateMeta, OfferSchedule, OfferListItem, OfferListResult };
 }
 /** @returns {RedeemLoyaltyPoints} */
 declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
@@ -2866,6 +2888,12 @@ type RedeemLoyaltyPoints = {
      * for the given cart.
      */
     redeem_points: boolean;
+    /**
+     * - Free-form metadata forwarded to the loyalty
+     * engine. Any field can be passed (e.g. points, redeem_rule_id). Engage reads
+     * from this dict when processing redemption.
+     */
+    meta?: any;
 };
 /** @returns {CouponDateMeta} */
 declare function CouponDateMeta(): CouponDateMeta;
@@ -5182,6 +5210,12 @@ type LoyaltyPoints = {
      * cart as payment mode
      */
     discount_amount?: number;
+    /**
+     * - Free-form metadata returned by the loyalty engine
+     * in its response. Structure varies; may include rule details, campaign info,
+     * or any additional fields Engage sends back.
+     */
+    meta?: any;
 };
 /** @returns {RawBreakup} */
 declare function RawBreakup(): RawBreakup;
@@ -6879,6 +6913,7 @@ type CartDetailResult = {
      * - GSTIN added in user cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - List of applied
      * promotions data to cart which includes promotion id, promotion name, offer
@@ -6894,6 +6929,13 @@ type CartDetailResult = {
      * checkout API payload
      */
     custom_cart_meta?: any;
+    /**
+     * - Free-form metadata stored against the
+     * loyalty redemption for this cart. Contains fields passed via the
+     * applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is
+     * forwarded to the loyalty engine on each cart calculation.
+     */
+    loyalty_meta?: any;
     alternate_pickup_person?: PlatformAlternatePickupPerson;
     /**
      * - Determines if the cart
@@ -7479,6 +7521,7 @@ type SharedCart = {
      * - GSTIN added in user cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - Custom cart meta of user cart added
      * via update cart meta API
@@ -7656,6 +7699,7 @@ type UserCartMappingResult = {
      * - GSTIN added in user cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - Custom meta details added cart
      * checkout API payload
@@ -8278,6 +8322,7 @@ type PlatformCartShipmentsResult = {
      * - GSTIN number added in cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - List of applied
      * promotions data to cart which includes promotion id, promotion name, offer
@@ -8333,6 +8378,19 @@ type UpdateCartShipmentCreation = {
      */
     shipments: UpdateCartShipmentItem[];
 };
+/** @returns {ShipToGstDetails} */
+declare function ShipToGstDetails(): ShipToGstDetails;
+type ShipToGstDetails = {
+    /**
+     * - Ship-to GSTIN for bill-to ship-to e-way bill generation.
+     */
+    gstin?: string;
+    /**
+     * - Ship-to trade name for bill-to ship-to
+     * e-way bill generation.
+     */
+    trade_name?: string;
+};
 /** @returns {PlatformCartMetaCreation} */
 declare function PlatformCartMetaCreation(): PlatformCartMetaCreation;
 type PlatformCartMetaCreation = {
@@ -8340,6 +8398,7 @@ type PlatformCartMetaCreation = {
      * - GSTIN number to be added in user cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - Customer contact details for
      * customer pickup at store
@@ -8630,6 +8689,7 @@ type CheckCart = {
      * - GSTIN number added in cart
      */
     gstin?: string;
+    ship_to_gst_details?: ShipToGstDetails;
     /**
      * - Whether Cash On Delivery available
      */

package/sdk/platform/Cart/CartPlatformModel.js

@@ -4,6 +4,9 @@ const Joi = require("joi");
  * @typedef RedeemLoyaltyPoints
  * @property {boolean} redeem_points - Marks if engage points are to be redeemed
  *   for the given cart.
+ * @property {Object} [meta] - Free-form metadata forwarded to the loyalty
+ *   engine. Any field can be passed (e.g. points, redeem_rule_id). Engage reads
+ *   from this dict when processing redemption.
  */
 
 /**
@@ -1024,6 +1027,9 @@ const Joi = require("joi");
  * @property {string} [title] - Unique title for loyalty program applicable.
  * @property {number} [discount_amount] - Engage discount amount applied on the
  *   cart as payment mode
+ * @property {Object} [meta] - Free-form metadata returned by the loyalty engine
+ *   in its response. Structure varies; may include rule details, campaign info,
+ *   or any additional fields Engage sends back.
  */
 
 /**
@@ -1749,12 +1755,17 @@ const Joi = require("joi");
  * @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
  *   is doing fast checkout for the cart using buy now
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
  *   promotions data to cart which includes promotion id, promotion name, offer
  *   text, description, buy rules, discount rules and promotion type
  * @property {string} [pan_no] - Permanent Account Number of the user
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
+ * @property {Object} [loyalty_meta] - Free-form metadata stored against the
+ *   loyalty redemption for this cart. Contains fields passed via the
+ *   applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is
+ *   forwarded to the loyalty engine on each cart calculation.
  * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
  *   has available promotion free gift items to choose on its added items
@@ -1998,6 +2009,7 @@ const Joi = require("joi");
  * @property {boolean} [buy_now] - Buy now flag of user cart
  * @property {number} [cart_id] - Cart id of user cart for generating cart sharing token
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [custom_cart_meta] - Custom cart meta of user cart added
  *   via update cart meta API
  */
@@ -2073,6 +2085,7 @@ const Joi = require("joi");
  * @property {boolean} [buy_now] - Buy now flag for the cart which denotes user
  *   is doing fast checkout for the cart using buy now
  * @property {string} [gstin] - GSTIN added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
@@ -2341,6 +2354,7 @@ const Joi = require("joi");
  * @property {string} [last_modified] - Last modified timestamp of cart
  * @property {boolean} [buy_now] - Buy now flag of user cart
  * @property {string} [gstin] - GSTIN number added in cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {AppliedPromotion[]} [applied_promo_details] - List of applied
  *   promotions data to cart which includes promotion id, promotion name, offer
  *   text, description, buy rules, discount rules and promotion type
@@ -2367,9 +2381,17 @@ const Joi = require("joi");
  *   type, shipment order type, shipment dp options etc
  */
 
+/**
+ * @typedef ShipToGstDetails
+ * @property {string} [gstin] - Ship-to GSTIN for bill-to ship-to e-way bill generation.
+ * @property {string} [trade_name] - Ship-to trade name for bill-to ship-to
+ *   e-way bill generation.
+ */
+
 /**
  * @typedef PlatformCartMetaCreation
  * @property {string} [gstin] - GSTIN number to be added in user cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {Object} [pick_up_customer_details] - Customer contact details for
  *   customer pickup at store
  * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
@@ -2507,6 +2529,7 @@ const Joi = require("joi");
  * @property {number} [cart_id] - Cart id of the user cart for which the order placed
  * @property {Object[]} [store_emps] - Store employees data
  * @property {string} [gstin] - GSTIN number added in cart
+ * @property {ShipToGstDetails} [ship_to_gst_details]
  * @property {boolean} [cod_available] - Whether Cash On Delivery available
  * @property {number} [delivery_charges] - Delivery charges of the order placed
  *   via checkout API
@@ -3098,6 +3121,7 @@ class CartPlatformModel {
   static RedeemLoyaltyPoints() {
     return Joi.object({
       redeem_points: Joi.boolean().required(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -4120,6 +4144,7 @@ class CartPlatformModel {
       earn_title: Joi.string().allow(""),
       title: Joi.string().allow(""),
       discount_amount: Joi.number(),
+      meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
     });
   }
 
@@ -4883,11 +4908,13 @@ class CartPlatformModel {
       last_modified: Joi.string().allow(""),
       buy_now: Joi.boolean(),
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       applied_promo_details: Joi.array().items(
         CartPlatformModel.AppliedPromotion()
       ),
       pan_no: Joi.string().allow(""),
       custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
+      loyalty_meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
       free_gift_selection_available: Joi.boolean(),
     });
@@ -5125,6 +5152,7 @@ class CartPlatformModel {
       buy_now: Joi.boolean(),
       cart_id: Joi.number(),
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
@@ -5201,6 +5229,7 @@ class CartPlatformModel {
       last_modified: Joi.string().allow(""),
       buy_now: Joi.boolean(),
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
       applied_promo_details: Joi.array().items(
         CartPlatformModel.AppliedPromotion()
@@ -5464,6 +5493,7 @@ class CartPlatformModel {
       last_modified: Joi.string().allow(""),
       buy_now: Joi.boolean(),
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       applied_promo_details: Joi.array().items(
         CartPlatformModel.AppliedPromotion()
       ),
@@ -5493,10 +5523,19 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {ShipToGstDetails} */
+  static ShipToGstDetails() {
+    return Joi.object({
+      gstin: Joi.string().allow("").allow(null),
+      trade_name: Joi.string().allow("").allow(null),
+    }).allow(null);
+  }
+
   /** @returns {PlatformCartMetaCreation} */
   static PlatformCartMetaCreation() {
     return Joi.object({
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       pick_up_customer_details: Joi.object().pattern(/\S/, Joi.any()),
       alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
       checkout_mode: Joi.string().allow(""),
@@ -5638,6 +5677,7 @@ class CartPlatformModel {
       cart_id: Joi.number(),
       store_emps: Joi.array().items(Joi.any()),
       gstin: Joi.string().allow(""),
+      ship_to_gst_details: CartPlatformModel.ShipToGstDetails(),
       cod_available: Joi.boolean(),
       delivery_charges: Joi.number(),
       custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),

package/sdk/platform/Catalog/CatalogPlatformClient.d.ts

@@ -32,6 +32,16 @@ declare class Catalog {
      * @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/bulkHsnCode/).
      */
     bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
+    /**
+     * @param {CatalogPlatformValidator.CbsOnboardGetParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CatalogPlatformModel.GetCompanySchema>} - Success response
+     * @name cbsOnboardGet
+     * @summary: Get company profile
+     * @description: Retrieves the seller-facing company profile for the specified company. The response includes onboarding metadata, contact and address details, legal documents, and deployment region metadata for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/cbsOnboardGet/).
+     */
+    cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCompanySchema>;
     /**
      * @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`