@gofynd/fdk-client-javascript 1.4.10-beta.1 → 1.4.11

package/README.md

@@ -127,9 +127,9 @@ getData();
 
 ---
 
-### Sample Usage - Fetch function.
+### Sample Usage - Request function.
  
-The fetch function allows you to make custom API requests with ease. It is available on both `platform` and `application` client.
+The request function allows you to make custom API requests with ease. It is available on both `platform` and `application` client.
 
 ```javascript
 
@@ -140,7 +140,7 @@ let auditLog = await client.request({
 
 ```
 
-The `fetch` function accepts an object with the following possible keys:
+The `request` function accepts an object with the following possible keys:
 
 - **method** (string): The HTTP method to use (e.g., 'GET', 'POST', 'PUT', 'DELETE').
 - **url** (string): The URL endpoint for the request.
@@ -237,7 +237,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: 1.4.10-beta.1' --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: 1.4.11' --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": "1.4.10-beta.1",
+  "version": "1.4.11",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -295,7 +295,7 @@ declare class Catalog {
      * @summary: Get category return configuration
      * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
      */
-    getAppCategoryReturnConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
+    getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -1746,13 +1746,17 @@ class Catalog {
    * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
    */
   async getAppCategoryReturnConfig(
-    { requestHeaders } = { requestHeaders: {} },
+    { q, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
     } = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
-      {},
+      {
+        q,
+        pageNo,
+        pageSize,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -1763,7 +1767,11 @@ class Catalog {
     const {
       error: warrning,
     } = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
-      {},
+      {
+        q,
+        pageNo,
+        pageSize,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -1774,6 +1782,9 @@ class Catalog {
     }
 
     const query_params = {};
+    query_params["q"] = q;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
 
     const response = await PlatformAPIClient.execute(
       this.config,

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

@@ -96,7 +96,15 @@ export = CatalogPlatformApplicationValidator;
  *   Default is 12.
  */
 /** @typedef GetAllSearchKeywordParam */
-/** @typedef GetAppCategoryReturnConfigParam */
+/**
+ * @typedef GetAppCategoryReturnConfigParam
+ * @property {string} [q] - Get return configurations for categories by matching
+ *   the search string with category names.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ */
 /**
  * @typedef GetAppInventoryParam
  * @property {number[]} [itemIds] - The Item Id of the product.
@@ -465,7 +473,7 @@ declare class CatalogPlatformApplicationValidator {
     /** @returns {GetAllSearchKeywordParam} */
     static getAllSearchKeyword(): any;
     /** @returns {GetAppCategoryReturnConfigParam} */
-    static getAppCategoryReturnConfig(): any;
+    static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
     /** @returns {GetAppInventoryParam} */
     static getAppInventory(): GetAppInventoryParam;
     /** @returns {GetAppLocationsParam} */
@@ -691,6 +699,23 @@ type GetAllCollectionsParam = {
      */
     pageSize?: number;
 };
+type GetAppCategoryReturnConfigParam = {
+    /**
+     * - Get return configurations for categories by matching
+     * the search string with category names.
+     */
+    q?: string;
+    /**
+     * - The page number to navigate through the given
+     * set of results
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 10.
+     */
+    pageSize?: number;
+};
 type GetAppInventoryParam = {
     /**
      * - The Item Id of the product.
@@ -1289,7 +1314,6 @@ type UpdateSearchKeywordsParam = {
 };
 type DeleteSearchConfigurationParam = any;
 type GetAllSearchKeywordParam = any;
-type GetAppCategoryReturnConfigParam = any;
 type GetAppReturnConfigurationParam = any;
 type GetAutocompleteConfigParam = any;
 type GetCatalogConfigurationParam = any;

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -119,7 +119,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /** @typedef GetAllSearchKeywordParam */
 
-/** @typedef GetAppCategoryReturnConfigParam */
+/**
+ * @typedef GetAppCategoryReturnConfigParam
+ * @property {string} [q] - Get return configurations for categories by matching
+ *   the search string with category names.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ */
 
 /**
  * @typedef GetAppInventoryParam
@@ -643,7 +651,11 @@ class CatalogPlatformApplicationValidator {
 
   /** @returns {GetAppCategoryReturnConfigParam} */
   static getAppCategoryReturnConfig() {
-    return Joi.object({}).required();
+    return Joi.object({
+      q: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
   }
 
   /** @returns {GetAppInventoryParam} */

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

@@ -435,6 +435,33 @@ export = OrderPlatformModel;
  * @property {string} [store_lookup]
  * @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
  */
+/**
+ * @typedef DPConfiguration
+ * @property {string} [shipping_by] - Shipping_by denotes dp assignment
+ *   strategy- if shipping_by is fynd dp assignment would be handled by OMS
+ */
+/**
+ * @typedef PaymentConfig
+ * @property {string} [mode_of_payment] - Specifies the mode through which the
+ *   payment was collected, serving as an identifier for the payment's origin.
+ * @property {string} [source] - The source field identifies the channel through
+ *   which the order was placed, such as MARKETPLACE, ECOMM.
+ */
+/**
+ * @typedef CreateOrderConfig
+ * @property {DPConfiguration} [dp_configuration]
+ * @property {string} [integration_type] - Flag denotes integration type which
+ *   is used to retrieve specific configurations and application details
+ *   relevant to channel fulfillment.
+ * @property {boolean} [location_reassignment] - Flag denotes if the location
+ *   for the store needs to be reassigned post cancellation.
+ * @property {PaymentConfig} [payment]
+ * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
+ *   breaking strategy. If the flag is set true, the shipment is created using
+ *   optimal shipment creation strategy based on the servicability & packaging
+ *   dimensions by OMS .If false, shipment details, including location_id, must
+ *   be passed to FDK for processing.
+ */
 /**
  * @typedef CreateOrderPayload
  * @property {string} affiliate_id
@@ -683,8 +710,12 @@ export = OrderPlatformModel;
  * @property {ProcessingDates} [processing_dates]
  * @property {Object} [meta] - Meta data of the shipment.
  * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {number} location_id - Location Identifier or Store/Fulfillment
- *   Identifier of the shipment.
+ * @property {number} [location_id] - Location Identifier or Store/Fulfillment
+ *   Identifier of the shipment- This field is mandatory when
+ *   optimal_shipment_creation flag is set to false, indicating that shipments
+ *   must be associated with a specific location. When
+ *   `optimal_shipment_creation` is true, the optimal location for order
+ *   creation would be assigned, location_id becomes optional.
  * @property {string} [order_type] - The order type of shipment HomeDelivery -
  *   If the customer wants the order home-delivered PickAtStore - If the
  *   customer wants the handover of an order at the store itself.
@@ -716,16 +747,6 @@ export = OrderPlatformModel;
  * @property {Prices} [price]
  * @property {ShipmentGstDetails} [gst]
  */
-/**
- * @typedef ShipmentRequestData
- * @property {LineItem[]} line_items
- * @property {ProcessingDates} [processing_dates]
- * @property {Object} [meta] - Meta data of the shipment.
- * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {string} [order_type] - The order type of shipment HomeDelivery -
- *   If the customer wants the order home-delivered PickAtStore - If the
- *   customer wants the handover of an order at the store itself.
- */
 /**
  * @typedef ShippingInfo
  * @property {string} [alternate_mobile_number]
@@ -820,7 +841,6 @@ export = OrderPlatformModel;
 /**
  * @typedef CreateOrderAPI
  * @property {Shipment[]} shipments
- * @property {ShipmentRequestData} [shipment_request_data]
  * @property {ShippingInfo} shipping_info
  * @property {BillingInfo} billing_info
  * @property {Object} [currency_info]
@@ -829,7 +849,7 @@ export = OrderPlatformModel;
  * @property {string} [external_creation_date]
  * @property {Object} [meta]
  * @property {TaxInfo} [tax_info]
- * @property {Object} [config]
+ * @property {CreateOrderConfig} [config]
  * @property {PaymentInfo} payment_info
  * @property {UserInfo} [user_info]
  * @property {number} [ordering_store_id]
@@ -3086,7 +3106,7 @@ export = OrderPlatformModel;
 declare class OrderPlatformModel {
 }
 declare namespace OrderPlatformModel {
-    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShipmentRequestData, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, ConfigData, ConfigUpdatedResponse, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, 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, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
+    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, DPConfiguration, PaymentConfig, CreateOrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, ConfigData, ConfigUpdatedResponse, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, 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, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
 }
 /** @returns {InvalidateShipmentCachePayload} */
 declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -3738,6 +3758,54 @@ type OrderConfig = {
     store_lookup?: string;
     affiliate_store_id_mapping: AffiliateStoreIdMapping[];
 };
+/** @returns {DPConfiguration} */
+declare function DPConfiguration(): DPConfiguration;
+type DPConfiguration = {
+    /**
+     * - Shipping_by denotes dp assignment
+     * strategy- if shipping_by is fynd dp assignment would be handled by OMS
+     */
+    shipping_by?: string;
+};
+/** @returns {PaymentConfig} */
+declare function PaymentConfig(): PaymentConfig;
+type PaymentConfig = {
+    /**
+     * - Specifies the mode through which the
+     * payment was collected, serving as an identifier for the payment's origin.
+     */
+    mode_of_payment?: string;
+    /**
+     * - The source field identifies the channel through
+     * which the order was placed, such as MARKETPLACE, ECOMM.
+     */
+    source?: string;
+};
+/** @returns {CreateOrderConfig} */
+declare function CreateOrderConfig(): CreateOrderConfig;
+type CreateOrderConfig = {
+    dp_configuration?: DPConfiguration;
+    /**
+     * - Flag denotes integration type which
+     * is used to retrieve specific configurations and application details
+     * relevant to channel fulfillment.
+     */
+    integration_type?: string;
+    /**
+     * - Flag denotes if the location
+     * for the store needs to be reassigned post cancellation.
+     */
+    location_reassignment?: boolean;
+    payment?: PaymentConfig;
+    /**
+     * - Denotes the shipment
+     * breaking strategy. If the flag is set true, the shipment is created using
+     * optimal shipment creation strategy based on the servicability & packaging
+     * dimensions by OMS .If false, shipment details, including location_id, must
+     * be passed to FDK for processing.
+     */
+    optimal_shipment_creation?: boolean;
+};
 /** @returns {CreateOrderPayload} */
 declare function CreateOrderPayload(): CreateOrderPayload;
 type CreateOrderPayload = {
@@ -4131,9 +4199,13 @@ type Shipment = {
     priority?: number;
     /**
      * - Location Identifier or Store/Fulfillment
-     * Identifier of the shipment.
+     * Identifier of the shipment- This field is mandatory when
+     * optimal_shipment_creation flag is set to false, indicating that shipments
+     * must be associated with a specific location. When
+     * `optimal_shipment_creation` is true, the optimal location for order
+     * creation would be assigned, location_id becomes optional.
      */
-    location_id: number;
+    location_id?: number;
     /**
      * - The order type of shipment HomeDelivery -
      * If the customer wants the order home-delivered PickAtStore - If the
@@ -4168,26 +4240,6 @@ type Shipment = {
     price?: Prices;
     gst?: ShipmentGstDetails;
 };
-/** @returns {ShipmentRequestData} */
-declare function ShipmentRequestData(): ShipmentRequestData;
-type ShipmentRequestData = {
-    line_items: LineItem[];
-    processing_dates?: ProcessingDates;
-    /**
-     * - Meta data of the shipment.
-     */
-    meta?: any;
-    /**
-     * - Integer value indicating high and low priority.
-     */
-    priority?: number;
-    /**
-     * - The order type of shipment HomeDelivery -
-     * If the customer wants the order home-delivered PickAtStore - If the
-     * customer wants the handover of an order at the store itself.
-     */
-    order_type?: string;
-};
 /** @returns {ShippingInfo} */
 declare function ShippingInfo(): ShippingInfo;
 type ShippingInfo = {
@@ -4295,7 +4347,6 @@ type PaymentInfo = {
 declare function CreateOrderAPI(): CreateOrderAPI;
 type CreateOrderAPI = {
     shipments: Shipment[];
-    shipment_request_data?: ShipmentRequestData;
     shipping_info: ShippingInfo;
     billing_info: BillingInfo;
     currency_info?: any;
@@ -4304,7 +4355,7 @@ type CreateOrderAPI = {
     external_creation_date?: string;
     meta?: any;
     tax_info?: TaxInfo;
-    config?: any;
+    config?: CreateOrderConfig;
     payment_info: PaymentInfo;
     user_info?: UserInfo;
     ordering_store_id?: number;

package/sdk/platform/Order/OrderPlatformModel.js

@@ -494,6 +494,36 @@ const Joi = require("joi");
  * @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
  */
 
+/**
+ * @typedef DPConfiguration
+ * @property {string} [shipping_by] - Shipping_by denotes dp assignment
+ *   strategy- if shipping_by is fynd dp assignment would be handled by OMS
+ */
+
+/**
+ * @typedef PaymentConfig
+ * @property {string} [mode_of_payment] - Specifies the mode through which the
+ *   payment was collected, serving as an identifier for the payment's origin.
+ * @property {string} [source] - The source field identifies the channel through
+ *   which the order was placed, such as MARKETPLACE, ECOMM.
+ */
+
+/**
+ * @typedef CreateOrderConfig
+ * @property {DPConfiguration} [dp_configuration]
+ * @property {string} [integration_type] - Flag denotes integration type which
+ *   is used to retrieve specific configurations and application details
+ *   relevant to channel fulfillment.
+ * @property {boolean} [location_reassignment] - Flag denotes if the location
+ *   for the store needs to be reassigned post cancellation.
+ * @property {PaymentConfig} [payment]
+ * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
+ *   breaking strategy. If the flag is set true, the shipment is created using
+ *   optimal shipment creation strategy based on the servicability & packaging
+ *   dimensions by OMS .If false, shipment details, including location_id, must
+ *   be passed to FDK for processing.
+ */
+
 /**
  * @typedef CreateOrderPayload
  * @property {string} affiliate_id
@@ -770,8 +800,12 @@ const Joi = require("joi");
  * @property {ProcessingDates} [processing_dates]
  * @property {Object} [meta] - Meta data of the shipment.
  * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {number} location_id - Location Identifier or Store/Fulfillment
- *   Identifier of the shipment.
+ * @property {number} [location_id] - Location Identifier or Store/Fulfillment
+ *   Identifier of the shipment- This field is mandatory when
+ *   optimal_shipment_creation flag is set to false, indicating that shipments
+ *   must be associated with a specific location. When
+ *   `optimal_shipment_creation` is true, the optimal location for order
+ *   creation would be assigned, location_id becomes optional.
  * @property {string} [order_type] - The order type of shipment HomeDelivery -
  *   If the customer wants the order home-delivered PickAtStore - If the
  *   customer wants the handover of an order at the store itself.
@@ -804,17 +838,6 @@ const Joi = require("joi");
  * @property {ShipmentGstDetails} [gst]
  */
 
-/**
- * @typedef ShipmentRequestData
- * @property {LineItem[]} line_items
- * @property {ProcessingDates} [processing_dates]
- * @property {Object} [meta] - Meta data of the shipment.
- * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {string} [order_type] - The order type of shipment HomeDelivery -
- *   If the customer wants the order home-delivered PickAtStore - If the
- *   customer wants the handover of an order at the store itself.
- */
-
 /**
  * @typedef ShippingInfo
  * @property {string} [alternate_mobile_number]
@@ -915,7 +938,6 @@ const Joi = require("joi");
 /**
  * @typedef CreateOrderAPI
  * @property {Shipment[]} shipments
- * @property {ShipmentRequestData} [shipment_request_data]
  * @property {ShippingInfo} shipping_info
  * @property {BillingInfo} billing_info
  * @property {Object} [currency_info]
@@ -924,7 +946,7 @@ const Joi = require("joi");
  * @property {string} [external_creation_date]
  * @property {Object} [meta]
  * @property {TaxInfo} [tax_info]
- * @property {Object} [config]
+ * @property {CreateOrderConfig} [config]
  * @property {PaymentInfo} payment_info
  * @property {UserInfo} [user_info]
  * @property {number} [ordering_store_id]
@@ -4016,6 +4038,32 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {DPConfiguration} */
+  static DPConfiguration() {
+    return Joi.object({
+      shipping_by: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PaymentConfig} */
+  static PaymentConfig() {
+    return Joi.object({
+      mode_of_payment: Joi.string().allow(""),
+      source: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CreateOrderConfig} */
+  static CreateOrderConfig() {
+    return Joi.object({
+      dp_configuration: OrderPlatformModel.DPConfiguration(),
+      integration_type: Joi.string().allow(""),
+      location_reassignment: Joi.boolean(),
+      payment: OrderPlatformModel.PaymentConfig(),
+      optimal_shipment_creation: Joi.boolean(),
+    });
+  }
+
   /** @returns {CreateOrderPayload} */
   static CreateOrderPayload() {
     return Joi.object({
@@ -4346,7 +4394,7 @@ class OrderPlatformModel {
       processing_dates: OrderPlatformModel.ProcessingDates(),
       meta: Joi.any().allow(null),
       priority: Joi.number(),
-      location_id: Joi.number().required(),
+      location_id: Joi.number(),
       order_type: Joi.string().allow(""),
       parent_type: Joi.string().allow("").allow(null),
       store_invoice_id: Joi.string().allow("").allow(null),
@@ -4378,17 +4426,6 @@ class OrderPlatformModel {
     });
   }
 
-  /** @returns {ShipmentRequestData} */
-  static ShipmentRequestData() {
-    return Joi.object({
-      line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
-      processing_dates: OrderPlatformModel.ProcessingDates(),
-      meta: Joi.any(),
-      priority: Joi.number(),
-      order_type: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {ShippingInfo} */
   static ShippingInfo() {
     return Joi.object({
@@ -4502,7 +4539,6 @@ class OrderPlatformModel {
   static CreateOrderAPI() {
     return Joi.object({
       shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
-      shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
       shipping_info: OrderPlatformModel.ShippingInfo().required(),
       billing_info: OrderPlatformModel.BillingInfo().required(),
       currency_info: Joi.any(),
@@ -4511,7 +4547,7 @@ class OrderPlatformModel {
       external_creation_date: Joi.string().allow(""),
       meta: Joi.any(),
       tax_info: OrderPlatformModel.TaxInfo(),
-      config: Joi.any(),
+      config: OrderPlatformModel.CreateOrderConfig(),
       payment_info: OrderPlatformModel.PaymentInfo().required(),
       user_info: OrderPlatformModel.UserInfo(),
       ordering_store_id: Joi.number(),