@gofynd/fdk-client-javascript 3.9.0 → 3.10.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.9.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.10.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.9.0",
+  "version": "3.10.0",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -730,7 +730,6 @@ export = CartPlatformModel;
  * @property {Object} [meta] - Meta data related to article
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
  *   allowed at article level
- * @property {number} [article_index] - Index of the line item in the cart
  * @property {number} [min_price_threshold] - Minimum allowed net price for the
  *   article. If the article's price after all discounts and adjustments falls
  *   below this threshold, the price adjustment will be automatically removed.
@@ -4279,10 +4278,6 @@ type Article = {
      * allowed at article level
      */
     allowed_refund?: boolean;
-    /**
-     * - Index of the line item in the cart
-     */
-    article_index?: number;
     /**
      * - Minimum allowed net price for the
      * article. If the article's price after all discounts and adjustments falls

package/sdk/platform/Cart/CartPlatformModel.js

@@ -793,7 +793,6 @@ const Joi = require("joi");
  * @property {Object} [meta] - Meta data related to article
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
  *   allowed at article level
- * @property {number} [article_index] - Index of the line item in the cart
  * @property {number} [min_price_threshold] - Minimum allowed net price for the
  *   article. If the article's price after all discounts and adjustments falls
  *   below this threshold, the price adjustment will be automatically removed.
@@ -3526,7 +3525,6 @@ class CartPlatformModel {
       quantity: Joi.number(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
       allowed_refund: Joi.boolean(),
-      article_index: Joi.number(),
       min_price_threshold: Joi.number(),
     });
   }

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts

@@ -400,10 +400,12 @@ export = CompanyProfilePlatformModel;
  */
 /**
  * @typedef LocationSchema
- * @property {string} code
+ * @property {string} code - A unique identifier for the store location. Must be
+ *   a non-empty string with a maximum length of 100 characters.
  * @property {InvoiceDetailsSchema} [gst_credentials]
  * @property {SellerPhoneNumber[]} [contact_numbers]
- * @property {string} name
+ * @property {string} name - The value of the name. Should be a non-empty string
+ *   and length should not exceed 300 characters.
  * @property {Object} [_custom_json]
  * @property {Object} [warnings]
  * @property {AddressSchema} address
@@ -418,7 +420,8 @@ export = CompanyProfilePlatformModel;
  * @property {boolean} [credit_note]
  * @property {HolidaySchemaSchema[]} [holiday]
  * @property {ProductReturnConfigSchema} [product_return_config]
- * @property {string} display_name
+ * @property {string} display_name - The value of the display_name. Should be a
+ *   non-empty string and length should not exceed 300 characters.
  * @property {string[]} [notification_emails]
  * @property {string[]} [tags]
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
@@ -921,9 +924,17 @@ type AddressSchema = {
 /** @returns {LocationSchema} */
 declare function LocationSchema(): LocationSchema;
 type LocationSchema = {
+    /**
+     * - A unique identifier for the store location. Must be
+     * a non-empty string with a maximum length of 100 characters.
+     */
     code: string;
     gst_credentials?: InvoiceDetailsSchema;
     contact_numbers?: SellerPhoneNumber[];
+    /**
+     * - The value of the name. Should be a non-empty string
+     * and length should not exceed 300 characters.
+     */
     name: string;
     _custom_json?: any;
     warnings?: any;
@@ -939,6 +950,10 @@ type LocationSchema = {
     credit_note?: boolean;
     holiday?: HolidaySchemaSchema[];
     product_return_config?: ProductReturnConfigSchema;
+    /**
+     * - The value of the display_name. Should be a
+     * non-empty string and length should not exceed 300 characters.
+     */
     display_name: string;
     notification_emails?: string[];
     tags?: string[];

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js

@@ -442,10 +442,12 @@ const Joi = require("joi");
 
 /**
  * @typedef LocationSchema
- * @property {string} code
+ * @property {string} code - A unique identifier for the store location. Must be
+ *   a non-empty string with a maximum length of 100 characters.
  * @property {InvoiceDetailsSchema} [gst_credentials]
  * @property {SellerPhoneNumber[]} [contact_numbers]
- * @property {string} name
+ * @property {string} name - The value of the name. Should be a non-empty string
+ *   and length should not exceed 300 characters.
  * @property {Object} [_custom_json]
  * @property {Object} [warnings]
  * @property {AddressSchema} address
@@ -460,7 +462,8 @@ const Joi = require("joi");
  * @property {boolean} [credit_note]
  * @property {HolidaySchemaSchema[]} [holiday]
  * @property {ProductReturnConfigSchema} [product_return_config]
- * @property {string} display_name
+ * @property {string} display_name - The value of the display_name. Should be a
+ *   non-empty string and length should not exceed 300 characters.
  * @property {string[]} [notification_emails]
  * @property {string[]} [tags]
  * @property {boolean} [default_order_acceptance_timing] - Flag to set

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -901,6 +901,7 @@ export = OrderPlatformModel;
  * @property {string} [ordering_channel_logo]
  * @property {Prices} [prices]
  * @property {PriceAdjustmentCharge[]} [charges]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 /**
  * @typedef Meta
@@ -2815,6 +2816,8 @@ export = OrderPlatformModel;
  *   used in the transaction.
  * @property {number} [amount_to_be_collected] - Total amount to be collected in
  *   scenarios involving multiple payment methods.
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 /**
  * @typedef ChargeDistributionSchema
@@ -2897,6 +2900,8 @@ export = OrderPlatformModel;
  *   purchased by the customer, usable for future transactions.
  * @property {number} [amount_to_be_collected] - Amount to be collected from the
  *   customer when multiple payment methods are utilized for a single order.
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 /**
  * @typedef Identifier
@@ -2988,6 +2993,8 @@ export = OrderPlatformModel;
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
  *   been added to Fynd cash for future use.
  * @property {TaxComponent[]} [taxes] - Applied Tax Components
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 /**
  * @typedef GSTDetailsData
@@ -3541,6 +3548,16 @@ export = OrderPlatformModel;
  * @property {Object} [links] - An object containing additional links relevant
  *   to the invoice, which may include related documents or resources.
  */
+/**
+ * @typedef LoyaltyDiscountDetails
+ * @property {number} [discount] - Discount amount applied by redeeming loyalty
+ *   points while placing the order. Represents the monetary value of loyalty
+ *   points redeemed.
+ * @property {string} [ownership] - Indicates who bears the cost of the loyalty
+ *   discount, such as the seller or the marketplace.
+ * @property {boolean} [is_applied] - Specifies whether the loyalty discount has
+ *   been applied to the order.
+ */
 /**
  * @typedef OrderDetailsData
  * @property {string} [order_date] - Represents the date and time when the order
@@ -3570,6 +3587,7 @@ export = OrderPlatformModel;
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
  *   through which order has been placed (e.g, marketplace, gofynd).
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  * @property {Object} [meta] - Meta data of the order contains additional,
  *   potentially dynamic information about the order.
  */
@@ -4369,6 +4387,7 @@ export = OrderPlatformModel;
  *   is created, including mobile applications, web interfaces, social media
  *   integrations, or external APIs.
  * @property {CurrencySchema} [currency]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 /**
  * @typedef OrderDetailsResponseSchema
@@ -4437,6 +4456,7 @@ export = OrderPlatformModel;
  * @property {CurrencyInfo} [currency_info]
  * @property {Prices} [prices]
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 /**
  * @typedef OrderListingResponseSchema
@@ -5100,7 +5120,7 @@ export = OrderPlatformModel;
 declare class OrderPlatformModel {
 }
 declare namespace OrderPlatformModel {
-    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
+    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, LoyaltyDiscountDetails, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
 }
 /** @returns {InvalidateShipmentCachePayload} */
 declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -6853,6 +6873,7 @@ type OrderDetails = {
     ordering_channel_logo?: string;
     prices?: Prices;
     charges?: PriceAdjustmentCharge[];
+    loyalty_discount_details?: LoyaltyDiscountDetails;
 };
 /** @returns {Meta} */
 declare function Meta(): Meta;
@@ -10815,6 +10836,11 @@ type Prices = {
      * scenarios involving multiple payment methods.
      */
     amount_to_be_collected?: number;
+    /**
+     * - Amount reduced from the payable price
+     * when the customer applies loyalty program points while placing the order.
+     */
+    loyalty_discount?: number;
 };
 /** @returns {ChargeDistributionSchema} */
 declare function ChargeDistributionSchema(): ChargeDistributionSchema;
@@ -10993,6 +11019,11 @@ type OrderingCurrencyPrices = {
      * customer when multiple payment methods are utilized for a single order.
      */
     amount_to_be_collected?: number;
+    /**
+     * - Amount reduced from the payable price
+     * when the customer applies loyalty program points while placing the order.
+     */
+    loyalty_discount?: number;
 };
 /** @returns {Identifier} */
 declare function Identifier(): Identifier;
@@ -11198,6 +11229,11 @@ type FinancialBreakup = {
      * - Applied Tax Components
      */
     taxes?: TaxComponent[];
+    /**
+     * - Amount reduced from the payable price
+     * when the customer applies loyalty program points while placing the order.
+     */
+    loyalty_discount?: number;
 };
 /** @returns {GSTDetailsData} */
 declare function GSTDetailsData(): GSTDetailsData;
@@ -12384,6 +12420,26 @@ type InvoiceInfo = {
      */
     links?: any;
 };
+/** @returns {LoyaltyDiscountDetails} */
+declare function LoyaltyDiscountDetails(): LoyaltyDiscountDetails;
+type LoyaltyDiscountDetails = {
+    /**
+     * - Discount amount applied by redeeming loyalty
+     * points while placing the order. Represents the monetary value of loyalty
+     * points redeemed.
+     */
+    discount?: number;
+    /**
+     * - Indicates who bears the cost of the loyalty
+     * discount, such as the seller or the marketplace.
+     */
+    ownership?: string;
+    /**
+     * - Specifies whether the loyalty discount has
+     * been applied to the order.
+     */
+    is_applied?: boolean;
+};
 /** @returns {OrderDetailsData} */
 declare function OrderDetailsData(): OrderDetailsData;
 type OrderDetailsData = {
@@ -12450,6 +12506,7 @@ type OrderDetailsData = {
      * through which order has been placed (e.g, marketplace, gofynd).
      */
     ordering_source?: string;
+    loyalty_discount_details?: LoyaltyDiscountDetails;
     /**
      * - Meta data of the order contains additional,
      * potentially dynamic information about the order.
@@ -14151,6 +14208,7 @@ type OrderData = {
      */
     source?: string;
     currency?: CurrencySchema;
+    loyalty_discount_details?: LoyaltyDiscountDetails;
 };
 /** @returns {OrderDetailsResponseSchema} */
 declare function OrderDetailsResponseSchema(): OrderDetailsResponseSchema;
@@ -14262,6 +14320,7 @@ type PlatformOrderItems = {
     currency_info?: CurrencyInfo;
     prices?: Prices;
     ordering_currency_prices?: OrderingCurrencyPrices;
+    loyalty_discount_details?: LoyaltyDiscountDetails;
 };
 /** @returns {OrderListingResponseSchema} */
 declare function OrderListingResponseSchema(): OrderListingResponseSchema;

package/sdk/platform/Order/OrderPlatformModel.js

@@ -988,6 +988,7 @@ const Joi = require("joi");
  * @property {string} [ordering_channel_logo]
  * @property {Prices} [prices]
  * @property {PriceAdjustmentCharge[]} [charges]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 
 /**
@@ -3061,6 +3062,8 @@ const Joi = require("joi");
  *   used in the transaction.
  * @property {number} [amount_to_be_collected] - Total amount to be collected in
  *   scenarios involving multiple payment methods.
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 
 /**
@@ -3149,6 +3152,8 @@ const Joi = require("joi");
  *   purchased by the customer, usable for future transactions.
  * @property {number} [amount_to_be_collected] - Amount to be collected from the
  *   customer when multiple payment methods are utilized for a single order.
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 
 /**
@@ -3243,6 +3248,8 @@ const Joi = require("joi");
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
  *   been added to Fynd cash for future use.
  * @property {TaxComponent[]} [taxes] - Applied Tax Components
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
+ *   when the customer applies loyalty program points while placing the order.
  */
 
 /**
@@ -3822,6 +3829,17 @@ const Joi = require("joi");
  *   to the invoice, which may include related documents or resources.
  */
 
+/**
+ * @typedef LoyaltyDiscountDetails
+ * @property {number} [discount] - Discount amount applied by redeeming loyalty
+ *   points while placing the order. Represents the monetary value of loyalty
+ *   points redeemed.
+ * @property {string} [ownership] - Indicates who bears the cost of the loyalty
+ *   discount, such as the seller or the marketplace.
+ * @property {boolean} [is_applied] - Specifies whether the loyalty discount has
+ *   been applied to the order.
+ */
+
 /**
  * @typedef OrderDetailsData
  * @property {string} [order_date] - Represents the date and time when the order
@@ -3851,6 +3869,7 @@ const Joi = require("joi");
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
  *   through which order has been placed (e.g, marketplace, gofynd).
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  * @property {Object} [meta] - Meta data of the order contains additional,
  *   potentially dynamic information about the order.
  */
@@ -4692,6 +4711,7 @@ const Joi = require("joi");
  *   is created, including mobile applications, web interfaces, social media
  *   integrations, or external APIs.
  * @property {CurrencySchema} [currency]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 
 /**
@@ -4767,6 +4787,7 @@ const Joi = require("joi");
  * @property {CurrencyInfo} [currency_info]
  * @property {Prices} [prices]
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
  */
 
 /**
@@ -6432,6 +6453,7 @@ class OrderPlatformModel {
       ordering_channel_logo: Joi.string().allow("").allow(null),
       prices: OrderPlatformModel.Prices(),
       charges: Joi.array().items(OrderPlatformModel.PriceAdjustmentCharge()),
+      loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
     });
   }
 
@@ -8251,6 +8273,7 @@ class OrderPlatformModel {
       fynd_credits: Joi.number().allow(null),
       gift_price: Joi.number().allow(null),
       amount_to_be_collected: Joi.number().allow(null),
+      loyalty_discount: Joi.number(),
     });
   }
 
@@ -8322,6 +8345,7 @@ class OrderPlatformModel {
       fynd_credits: Joi.number().allow(null),
       gift_price: Joi.number().allow(null),
       amount_to_be_collected: Joi.number().allow(null),
+      loyalty_discount: Joi.number(),
     });
   }
 
@@ -8378,6 +8402,7 @@ class OrderPlatformModel {
       total_units: Joi.number().required(),
       added_to_fynd_cash: Joi.boolean().required(),
       taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
+      loyalty_discount: Joi.number(),
     });
   }
 
@@ -8522,7 +8547,7 @@ class OrderPlatformModel {
       box_type: Joi.string().allow("").allow(null),
       quantity: Joi.number().allow(null),
       size_level_total_qty: Joi.number().allow(null),
-      loyalty_discount: Joi.number().allow(null),
+      loyalty_discount: Joi.number(),
       replacement_details: OrderPlatformModel.ReplacementDetails(),
       channel_shipment_id: Joi.string().allow("").allow(null),
       marketplace_invoice_id: Joi.string().allow("").allow(null),
@@ -8542,7 +8567,7 @@ class OrderPlatformModel {
       affiliate_order_id: Joi.string().allow("").required(),
       employee_discount: Joi.number().allow(null),
       affiliate_bag_id: Joi.string().allow("").required(),
-      loyalty_discount: Joi.number().allow(null),
+      loyalty_discount: Joi.number(),
     });
   }
 
@@ -8774,6 +8799,15 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {LoyaltyDiscountDetails} */
+  static LoyaltyDiscountDetails() {
+    return Joi.object({
+      discount: Joi.number(),
+      ownership: Joi.string().allow(""),
+      is_applied: Joi.boolean(),
+    });
+  }
+
   /** @returns {OrderDetailsData} */
   static OrderDetailsData() {
     return Joi.object({
@@ -8791,6 +8825,7 @@ class OrderPlatformModel {
       order_value: Joi.string().allow("").allow(null),
       ordering_channel: Joi.string().allow("").allow(null),
       ordering_source: Joi.string().allow(""),
+      loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
@@ -9426,6 +9461,7 @@ class OrderPlatformModel {
       affiliate_id: Joi.string().allow(""),
       source: Joi.string().allow(""),
       currency: OrderPlatformModel.CurrencySchema(),
+      loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
     });
   }
 
@@ -9503,6 +9539,7 @@ class OrderPlatformModel {
       currency_info: OrderPlatformModel.CurrencyInfo(),
       prices: OrderPlatformModel.Prices(),
       ordering_currency_prices: OrderPlatformModel.OrderingCurrencyPrices(),
+      loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
     });
   }