@gofynd/fdk-client-javascript 3.23.0 → 3.25.0

package/sdk/platform/Content/ContentPlatformModel.d.ts

@@ -1,4 +1,37 @@
 export = ContentPlatformModel;
+/**
+ * @typedef AppAssociationDeleted
+ * @property {string} [message] - Operation status string (e.g. "deleted").
+ * @property {string} [application_id] - The application_id whose record was deleted.
+ */
+/**
+ * @typedef AppAssociationIosPayload
+ * @property {Object} [applinks] - Universal Links configuration.
+ * @property {Object} [appclips] - App Clips configuration.
+ * @property {Object} [webcredentials] - Shared Web Credentials.
+ * @property {Object} [activitycontinuation] - Handoff. Deprecated in iOS 14+.
+ */
+/**
+ * @typedef AppAssociationAndroidStatement
+ * @property {string[]} [relation] - Permission relations granted by this statement.
+ * @property {Object} [target] - Subject of the statement (android_app or web).
+ */
+/**
+ * @typedef AppAssociationWriteBody
+ * @property {AppAssociationIosPayload} [ios_payload] - Apple App Site
+ *   Association JSON. Null to clear.
+ * @property {AppAssociationAndroidStatement[]} [android_payload] - Digital
+ *   Asset Links JSON (array of statements). Null to clear.
+ */
+/**
+ * @typedef AppAssociationRecord
+ * @property {AppAssociationIosPayload} [ios_payload]
+ * @property {AppAssociationAndroidStatement[]} [android_payload]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {string} [created_by]
+ * @property {string} [modified_by]
+ */
 /**
  * @typedef ValidationError
  * @property {string} message - A brief description of the error encountered.
@@ -1629,8 +1662,76 @@ export = ContentPlatformModel;
 declare class ContentPlatformModel {
 }
 declare namespace ContentPlatformModel {
-    export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, TemplateSchema, TemplateField, CreateTagRequestSchema, DataLoaderSchema, TagsTemplateSchema, TagTemplateItem, TemplateLayout, FieldDefinition, FieldValidation, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, SeoTranslate, MetaTag, MetaTagItem, ResourceTranslation, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
+    export { AppAssociationDeleted, AppAssociationIosPayload, AppAssociationAndroidStatement, AppAssociationWriteBody, AppAssociationRecord, ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, TemplateSchema, TemplateField, CreateTagRequestSchema, DataLoaderSchema, TagsTemplateSchema, TagTemplateItem, TemplateLayout, FieldDefinition, FieldValidation, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, SeoTranslate, MetaTag, MetaTagItem, ResourceTranslation, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
 }
+/** @returns {AppAssociationDeleted} */
+declare function AppAssociationDeleted(): AppAssociationDeleted;
+type AppAssociationDeleted = {
+    /**
+     * - Operation status string (e.g. "deleted").
+     */
+    message?: string;
+    /**
+     * - The application_id whose record was deleted.
+     */
+    application_id?: string;
+};
+/** @returns {AppAssociationIosPayload} */
+declare function AppAssociationIosPayload(): AppAssociationIosPayload;
+type AppAssociationIosPayload = {
+    /**
+     * - Universal Links configuration.
+     */
+    applinks?: any;
+    /**
+     * - App Clips configuration.
+     */
+    appclips?: any;
+    /**
+     * - Shared Web Credentials.
+     */
+    webcredentials?: any;
+    /**
+     * - Handoff. Deprecated in iOS 14+.
+     */
+    activitycontinuation?: any;
+};
+/** @returns {AppAssociationAndroidStatement} */
+declare function AppAssociationAndroidStatement(): AppAssociationAndroidStatement;
+type AppAssociationAndroidStatement = {
+    /**
+     * - Permission relations granted by this statement.
+     */
+    relation?: string[];
+    /**
+     * - Subject of the statement (android_app or web).
+     */
+    target?: any;
+};
+/** @returns {AppAssociationWriteBody} */
+declare function AppAssociationWriteBody(): AppAssociationWriteBody;
+type AppAssociationWriteBody = {
+    /**
+     * - Apple App Site
+     * Association JSON. Null to clear.
+     */
+    ios_payload?: AppAssociationIosPayload;
+    /**
+     * - Digital
+     * Asset Links JSON (array of statements). Null to clear.
+     */
+    android_payload?: AppAssociationAndroidStatement[];
+};
+/** @returns {AppAssociationRecord} */
+declare function AppAssociationRecord(): AppAssociationRecord;
+type AppAssociationRecord = {
+    ios_payload?: AppAssociationIosPayload;
+    android_payload?: AppAssociationAndroidStatement[];
+    created_at?: string;
+    updated_at?: string;
+    created_by?: string;
+    modified_by?: string;
+};
 /** @returns {ValidationError} */
 declare function ValidationError(): ValidationError;
 type ValidationError = {

package/sdk/platform/Content/ContentPlatformModel.js

@@ -1,5 +1,43 @@
 const Joi = require("joi");
 
+/**
+ * @typedef AppAssociationDeleted
+ * @property {string} [message] - Operation status string (e.g. "deleted").
+ * @property {string} [application_id] - The application_id whose record was deleted.
+ */
+
+/**
+ * @typedef AppAssociationIosPayload
+ * @property {Object} [applinks] - Universal Links configuration.
+ * @property {Object} [appclips] - App Clips configuration.
+ * @property {Object} [webcredentials] - Shared Web Credentials.
+ * @property {Object} [activitycontinuation] - Handoff. Deprecated in iOS 14+.
+ */
+
+/**
+ * @typedef AppAssociationAndroidStatement
+ * @property {string[]} [relation] - Permission relations granted by this statement.
+ * @property {Object} [target] - Subject of the statement (android_app or web).
+ */
+
+/**
+ * @typedef AppAssociationWriteBody
+ * @property {AppAssociationIosPayload} [ios_payload] - Apple App Site
+ *   Association JSON. Null to clear.
+ * @property {AppAssociationAndroidStatement[]} [android_payload] - Digital
+ *   Asset Links JSON (array of statements). Null to clear.
+ */
+
+/**
+ * @typedef AppAssociationRecord
+ * @property {AppAssociationIosPayload} [ios_payload]
+ * @property {AppAssociationAndroidStatement[]} [android_payload]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {string} [created_by]
+ * @property {string} [modified_by]
+ */
+
 /**
  * @typedef ValidationError
  * @property {string} message - A brief description of the error encountered.
@@ -1830,6 +1868,56 @@ const Joi = require("joi");
  */
 
 class ContentPlatformModel {
+  /** @returns {AppAssociationDeleted} */
+  static AppAssociationDeleted() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AppAssociationIosPayload} */
+  static AppAssociationIosPayload() {
+    return Joi.object({
+      applinks: Joi.object().pattern(/\S/, Joi.any()),
+      appclips: Joi.object().pattern(/\S/, Joi.any()),
+      webcredentials: Joi.object().pattern(/\S/, Joi.any()),
+      activitycontinuation: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
+  /** @returns {AppAssociationAndroidStatement} */
+  static AppAssociationAndroidStatement() {
+    return Joi.object({
+      relation: Joi.array().items(Joi.string().allow("")),
+      target: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
+  /** @returns {AppAssociationWriteBody} */
+  static AppAssociationWriteBody() {
+    return Joi.object({
+      ios_payload: ContentPlatformModel.AppAssociationIosPayload(),
+      android_payload: Joi.array()
+        .items(ContentPlatformModel.AppAssociationAndroidStatement())
+        .allow(null, ""),
+    });
+  }
+
+  /** @returns {AppAssociationRecord} */
+  static AppAssociationRecord() {
+    return Joi.object({
+      ios_payload: ContentPlatformModel.AppAssociationIosPayload(),
+      android_payload: Joi.array()
+        .items(ContentPlatformModel.AppAssociationAndroidStatement())
+        .allow(null, ""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      created_by: Joi.string().allow(""),
+      modified_by: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ValidationError} */
   static ValidationError() {
     return Joi.object({

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

@@ -760,6 +760,34 @@ declare class Order {
      * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/reassignLocation/).
      */
     reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
+    /**
+     * @param {OrderPlatformValidator.RequestCourierPartnerForShipmentParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
+     *   Success response
+     * @name requestCourierPartnerForShipment
+     * @summary: Manually request a courier partner for a shipment.
+     * @description: Use this API to manually assign a courier partner (delivery partner) to a shipment.
+     *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/requestCourierPartnerForShipment/).
+     */
+    requestCourierPartnerForShipment({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.RequestCourierPartnerForShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerResponseSchema>;
+    /**
+     * @param {OrderPlatformValidator.SaveCourierPartnerPreferenceForShipmentParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
+     *   Success response
+     * @name saveCourierPartnerPreferenceForShipment
+     * @summary: Save courier partner preference for a shipment.
+     * @description: Use this API to save the preferred courier partner for a shipment. The preferred courier partner will be triggered automatically when the shipment moves to a state where delivery partner assignment is performed (for example, ready for DP assignment).
+     *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/saveCourierPartnerPreferenceForShipment/).
+     */
+    saveCourierPartnerPreferenceForShipment({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.SaveCourierPartnerPreferenceForShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerResponseSchema>;
     /**
      * @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Order/OrderPlatformClient.js

@@ -645,9 +645,11 @@ class Order {
     const query_params = {};
 
     const xHeaders = {};
-    xHeaders["x-ordering-source"] = xOrderingSource;
-    xHeaders["x-application-id"] = xApplicationId;
-    xHeaders["x-extension-id"] = xExtensionId;
+    if (xOrderingSource !== undefined)
+      xHeaders["x-ordering-source"] = xOrderingSource;
+    if (xApplicationId !== undefined)
+      xHeaders["x-application-id"] = xApplicationId;
+    if (xExtensionId !== undefined) xHeaders["x-extension-id"] = xExtensionId;
 
     const response = await PlatformAPIClient.execute(
       this.config,
@@ -5028,6 +5030,180 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {OrderPlatformValidator.RequestCourierPartnerForShipmentParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
+   *   Success response
+   * @name requestCourierPartnerForShipment
+   * @summary: Manually request a courier partner for a shipment.
+   * @description: Use this API to manually assign a courier partner (delivery partner) to a shipment.
+   *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/requestCourierPartnerForShipment/).
+   */
+  async requestCourierPartnerForShipment(
+    { shipmentId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformValidator.requestCourierPartnerForShipment().validate(
+      {
+        shipmentId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformValidator.requestCourierPartnerForShipment().validate(
+      {
+        shipmentId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > requestCourierPartnerForShipment \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/shipment/${shipmentId}/courier-partner/request`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.CourierPartnerResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Order > requestCourierPartnerForShipment \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {OrderPlatformValidator.SaveCourierPartnerPreferenceForShipmentParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
+   *   Success response
+   * @name saveCourierPartnerPreferenceForShipment
+   * @summary: Save courier partner preference for a shipment.
+   * @description: Use this API to save the preferred courier partner for a shipment. The preferred courier partner will be triggered automatically when the shipment moves to a state where delivery partner assignment is performed (for example, ready for DP assignment).
+   *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/saveCourierPartnerPreferenceForShipment/).
+   */
+  async saveCourierPartnerPreferenceForShipment(
+    { shipmentId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformValidator.saveCourierPartnerPreferenceForShipment().validate(
+      {
+        shipmentId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformValidator.saveCourierPartnerPreferenceForShipment().validate(
+      {
+        shipmentId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > saveCourierPartnerPreferenceForShipment \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/shipment/${shipmentId}/courier-partner/preference`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.CourierPartnerResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Order > saveCourierPartnerPreferenceForShipment \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`