@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

package/sdk/platform/Order/OrderPlatformClient.js

@@ -996,6 +996,105 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
+   * @name failedOrderLogs
+   * @summary: List failed order logs
+   * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
+   */
+  async failedOrderLogs(
+    {
+      applicationId,
+      pageNo,
+      pageSize,
+      searchType,
+      searchValue,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = OrderPlatformValidator.failedOrderLogs().validate(
+      {
+        applicationId,
+        pageNo,
+        pageSize,
+        searchType,
+        searchValue,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformValidator.failedOrderLogs().validate(
+      {
+        applicationId,
+        pageNo,
+        pageSize,
+        searchType,
+        searchValue,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["application_id"] = applicationId;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["search_type"] = searchType;
+    query_params["search_value"] = searchValue;
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.FailedOrderLogs().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 > failedOrderLogs \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2982,6 +3081,129 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.lane] - Lane refers to a section where orders are
+   *   assigned, indicating its grouping.
+   * @param {string} [arg.searchType] - Search_type refers to the field that
+   *   will be used as the target for the search operation.
+   * @param {string} [arg.bagStatus] - Bag_status refers to status of the
+   *   entity. Filters orders based on the status.
+   * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
+   *   estimated SLA time.
+   * @param {string} [arg.paymentMethods] - Comma separated values of payment
+   *   methods that were used to place order.
+   * @param {string} [arg.tags] - Tags refers to additional descriptive labels
+   *   associated with the order
+   * @param {string} [arg.searchValue] - Search_value is matched against the
+   *   field specified by the search_type
+   * @param {string} [arg.fromDate] - Date time in UTC timezone as per ISO format.
+   * @param {string} [arg.toDate] - Date time in UTC timezone as per ISO format.
+   * @param {string} [arg.startDate] - Date time in UTC timezone as per ISO format.
+   * @param {string} [arg.endDate] - Date time in UTC timezone as per ISO format.
+   * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
+   * @param {string} [arg.stores] - A comma-separated list of store IDs used
+   *   to filter results to only those related to specific stores.
+   * @param {string} [arg.salesChannels] - A comma-separated list of sales
+   *   channel IDs to filter results based on the sales channels involved.
+   * @param {number} [arg.pageSize] - Determines the number of results
+   *   returned per page.
+   * @param {boolean} [arg.isPrioritySort] -
+   * @param {string} [arg.customMeta] -
+   * @param {boolean} [arg.myOrders] -
+   * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
+   *   non-cross company order
+   * @param {string} [arg.customerId] - The unique identifier for the customer
+   *   associated with the query, useful for filtering results to a specific customer.
+   * @param {string} [arg.orderType] -
+   * @param {boolean} [arg.allowInactive] - Flag indicating whether inactive
+   *   shipments are allowed
+   * @param {string} [arg.groupEntity] - Defines the grouping criterion for
+   *   retrieving shipments or orders. It specifies whether the results should
+   *   be organized based on shipment groups or order groups. For example,
+   *   using 'shipments' groups results by shipment, while an invalid value
+   *   like 'abcd' may not be recognized, leading to errors or default behavior.
+   * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
+   *   listing orders. This is useful when fetching data for a specific date
+   *   range while performing searches.
+   * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
+   *   Listing Orders, This is use when we want to get list of shipments or
+   *   orders by cross store or cross company or fulfilling Store (by
+   *   default), this is also depends on the login user accessType and store access
+   * @returns {Paginator<OrderPlatformModel.OrderListingResponseSchema>}
+   * @summary: List orders
+   * @description: Get a list of orders based on the filters provided.
+   */
+  getOrdersPaginator({
+    lane,
+    searchType,
+    bagStatus,
+    timeToDispatch,
+    paymentMethods,
+    tags,
+    searchValue,
+    fromDate,
+    toDate,
+    startDate,
+    endDate,
+    dpIds,
+    stores,
+    salesChannels,
+    pageSize,
+    isPrioritySort,
+    customMeta,
+    myOrders,
+    showCrossCompanyData,
+    customerId,
+    orderType,
+    allowInactive,
+    groupEntity,
+    enforceDateFilter,
+    fulfillmentType,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getOrders({
+        lane: lane,
+        searchType: searchType,
+        bagStatus: bagStatus,
+        timeToDispatch: timeToDispatch,
+        paymentMethods: paymentMethods,
+        tags: tags,
+        searchValue: searchValue,
+        fromDate: fromDate,
+        toDate: toDate,
+        startDate: startDate,
+        endDate: endDate,
+        dpIds: dpIds,
+        stores: stores,
+        salesChannels: salesChannels,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        isPrioritySort: isPrioritySort,
+        customMeta: customMeta,
+        myOrders: myOrders,
+        showCrossCompanyData: showCrossCompanyData,
+        customerId: customerId,
+        orderType: orderType,
+        allowInactive: allowInactive,
+        groupEntity: groupEntity,
+        enforceDateFilter: enforceDateFilter,
+        fulfillmentType: fulfillmentType,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -3549,6 +3771,181 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.lane] - Name of lane for which data is to be fetched
+   * @param {string} [arg.bagStatus] - Comma separated values of bag statuses.
+   * @param {string} [arg.statusAssigned] - Used to filter shipments based on
+   *   status present in shipment_status_history. For more information on
+   *   these statuses, refer to the Fynd Partners documentation.
+   * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
+   *   bag_status and override lane.
+   * @param {number} [arg.timeToDispatch] - Indicates the time to dispatch.
+   * @param {string} [arg.searchType] - Specifies the key used to determine
+   *   the type of search being performed.
+   * @param {string} [arg.searchValue] - The value corresponding to the search
+   *   type, such as a specific shipment ID or order ID.
+   * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
+   * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
+   * @param {string} [arg.startDate] - The UTC start date in ISO format
+   *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+   * @param {string} [arg.endDate] - The UTC end date in ISO format
+   *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+   * @param {string} [arg.statusAssignedStartDate] - Specifies the starting
+   *   UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the
+   *   lower boundary for filtering shipments based on the `created_at`
+   *   timestamp of statuses in the shipment's status history. It allows
+   *   filtering statuses that were created within a specific time range.
+   * @param {string} [arg.statusAssignedEndDate] - Specifies the ending UTC
+   *   date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper
+   *   boundary for filtering shipments based on the `created_at` timestamp of
+   *   statuses in the shipment's status history.
+   * @param {string} [arg.dpIds] - A comma-separated list of delivery partner
+   *   IDs to filter results by specific delivery partners.
+   * @param {string} [arg.stores] - A comma-separated list of store IDs used
+   *   to filter results to only those related to specific stores.
+   * @param {string} [arg.salesChannels] - A comma-separated list of sales
+   *   channel IDs to filter results based on the sales channels involved.
+   * @param {number} [arg.pageSize] - Determines the number of results
+   *   returned per page.
+   * @param {boolean} [arg.fetchActiveShipment] - A boolean flag that
+   *   indicates whether to include only active shipments in the results.
+   * @param {boolean} [arg.allowInactive] - A flag indicating whether to allow
+   *   the inclusion of inactive shipments in the results.
+   * @param {boolean} [arg.excludeLockedShipments] - A flag to specify whether
+   *   to exclude shipments that are locked from the results.
+   * @param {string} [arg.paymentMethods] - A comma-separated list of payment methods.
+   * @param {string} [arg.channelShipmentId] - The shipment ID used in the
+   *   application, which can be used to reference specific shipments.
+   * @param {string} [arg.channelOrderId] - The order ID used in the application.
+   * @param {string} [arg.customMeta] - Custom metadata associated with the
+   *   query, allowing for additional filtering or information to be passed.
+   * @param {string} [arg.orderingChannel] - The channel through which the
+   *   order was placed.
+   * @param {string} [arg.companyAffiliateTag] - A tag used to identify the
+   *   company's affiliation for filtering or reporting purposes.
+   * @param {boolean} [arg.myOrders] - A boolean flag indicating whether the
+   *   query should return only the user's orders.
+   * @param {string} [arg.platformUserId] - The unique identifier of the user
+   *   on the platform, useful for filtering orders related to a specific user.
+   * @param {string} [arg.sortType] - Determines the sorting order of the
+   *   results based on specific criteria.
+   * @param {boolean} [arg.showCrossCompanyData] - A flag indicating whether
+   *   to include data from both cross-company and non-cross-company orders in
+   *   the results.
+   * @param {string} [arg.tags] - A comma-separated list of tags associated
+   *   with the orders to filter results based on specific characteristics.
+   * @param {string} [arg.customerId] - The unique identifier for the customer
+   *   associated with the query, useful for filtering results to a specific customer.
+   * @param {string} [arg.orderType] - The type of order being queried.
+   * @param {string} [arg.groupEntity] - Defines the grouping criterion for
+   *   retrieving shipments or orders. It specifies whether the results should
+   *   be organized based on shipment groups or order groups. For example,
+   *   using 'shipments' groups results by shipment, while an invalid value
+   *   like 'abcd' may not be recognized, leading to errors or default behavior.
+   * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
+   *   listing shipments. This is useful when fetching data for a specific
+   *   date range while performing searches.
+   * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
+   *   Listing Orders, This is use when we want to get list of shipments or
+   *   orders by cross store or cross company or fulfilling Store (by
+   *   default), this is also depends on the login user accessType and store access
+   * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
+   * @summary: List shipments
+   * @description: Get a list of shipments based on the filters provided
+   */
+  getShipmentsPaginator({
+    lane,
+    bagStatus,
+    statusAssigned,
+    statusOverrideLane,
+    timeToDispatch,
+    searchType,
+    searchValue,
+    fromDate,
+    toDate,
+    startDate,
+    endDate,
+    statusAssignedStartDate,
+    statusAssignedEndDate,
+    dpIds,
+    stores,
+    salesChannels,
+    pageSize,
+    fetchActiveShipment,
+    allowInactive,
+    excludeLockedShipments,
+    paymentMethods,
+    channelShipmentId,
+    channelOrderId,
+    customMeta,
+    orderingChannel,
+    companyAffiliateTag,
+    myOrders,
+    platformUserId,
+    sortType,
+    showCrossCompanyData,
+    tags,
+    customerId,
+    orderType,
+    groupEntity,
+    enforceDateFilter,
+    fulfillmentType,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getShipments({
+        lane: lane,
+        bagStatus: bagStatus,
+        statusAssigned: statusAssigned,
+        statusOverrideLane: statusOverrideLane,
+        timeToDispatch: timeToDispatch,
+        searchType: searchType,
+        searchValue: searchValue,
+        fromDate: fromDate,
+        toDate: toDate,
+        startDate: startDate,
+        endDate: endDate,
+        statusAssignedStartDate: statusAssignedStartDate,
+        statusAssignedEndDate: statusAssignedEndDate,
+        dpIds: dpIds,
+        stores: stores,
+        salesChannels: salesChannels,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        fetchActiveShipment: fetchActiveShipment,
+        allowInactive: allowInactive,
+        excludeLockedShipments: excludeLockedShipments,
+        paymentMethods: paymentMethods,
+        channelShipmentId: channelShipmentId,
+        channelOrderId: channelOrderId,
+        customMeta: customMeta,
+        orderingChannel: orderingChannel,
+        companyAffiliateTag: companyAffiliateTag,
+        myOrders: myOrders,
+        platformUserId: platformUserId,
+        sortType: sortType,
+        showCrossCompanyData: showCrossCompanyData,
+        tags: tags,
+        customerId: customerId,
+        orderType: orderType,
+        groupEntity: groupEntity,
+        enforceDateFilter: enforceDateFilter,
+        fulfillmentType: fulfillmentType,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -276,6 +276,11 @@ export = OrderPlatformModel;
  *   the properties of any relevant entities.
  * @property {OrderDataUpdates[]} [order]
  */
+/**
+ * @typedef TransitionComments
+ * @property {string} title - Title for the transition message.
+ * @property {string} message - Message for the transition.
+ */
 /**
  * @typedef ShipmentsRequestSchema
  * @property {string} identifier - Unique identifier for the shipment.
@@ -283,6 +288,8 @@ export = OrderPlatformModel;
  * @property {Products[]} [products] - A list of products or bags that need to
  *   be updated as part of the shipment status change.
  * @property {DataUpdates} [data_updates]
+ * @property {TransitionComments[]} [transition_comments] - Comments or notes
+ *   associated with the transition of shipment status.
  */
 /**
  * @typedef UpdatedAddressSchema
@@ -655,8 +662,8 @@ export = OrderPlatformModel;
  * @property {string} [text] - A reason for the activity or change.
  * @property {string} [category] - Category of the reason for the status change.
  * @property {string} [state] - Current state related to the reason.
- * @property {string} [dislay_name] - Display name of the reason for better user
- *   understanding.
+ * @property {string} [display_name] - Display name of the reason for better
+ *   user understanding.
  * @property {number} [code] - Unique code identifying the reason.
  * @property {number} [quantity] - Quantity related to the reason, if applicable.
  */
@@ -2406,9 +2413,9 @@ export = OrderPlatformModel;
  *   met and optimizing logistics.
  * @property {QuestionSet[]} question_set - An array of question sets linked to
  *   the reason, defining the questions to be answered.
- * @property {Object} meta - Meta object of the reason. This contains any
+ * @property {Object} [meta] - Meta object of the reason. This contains any
  *   additional metadata that might be relevant to the reason.
- * @property {boolean} is_active - Indicates whether the reason is currently
+ * @property {boolean} [is_active] - Indicates whether the reason is currently
  *   active. Active reasons are those that are currently in use within the system.
  */
 /**
@@ -2551,6 +2558,7 @@ export = OrderPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef BagReasonMeta
@@ -2702,6 +2710,7 @@ export = OrderPlatformModel;
  * @property {string} [uid] - A unique identifier for the user associated with
  *   the address.
  * @property {string} [user_id] - The unique identifier of the user in the system.
+ * @property {string} [code] - A unique identifier associated with store.
  */
 /**
  * @typedef ShipmentListingChannel
@@ -3570,6 +3579,8 @@ export = OrderPlatformModel;
  *   at the ordering store.
  * @property {string} [state] - The state or region where the ordering store is situated.
  * @property {string} [city] - The city in which the ordering store is located.
+ * @property {string} [name] - The name of the ordering store.
+ * @property {string} [store_email] - The email address of the ordering store.
  */
 /**
  * @typedef DPDetailsData
@@ -3802,6 +3813,8 @@ export = OrderPlatformModel;
  * @property {string} [size] - The size of the article, which may be relevant
  *   for clothing.
  * @property {string[]} [tags] - An array of tags associated with the article.
+ * @property {Object} [_custom_json] - A custom JSON object containing
+ *   additional details or configurations specific to the article.
  */
 /**
  * @typedef OrderBrandName
@@ -4017,6 +4030,7 @@ export = OrderPlatformModel;
  *   with a fulfilling store.
  * @property {string} state - The state or region where the fulfilling store is located.
  * @property {string} city - The city in which the fulfilling store is situated.
+ * @property {string} [store_email] - The email address of the fulfilling store.
  */
 /**
  * @typedef ShipmentPayments
@@ -4914,7 +4928,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, DataUpdates, 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, 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, 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 };
+    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, 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, 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, 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 };
 }
 /** @returns {InvalidateShipmentCachePayload} */
 declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -5508,6 +5522,18 @@ type DataUpdates = {
     entities?: EntitiesDataUpdates[];
     order?: OrderDataUpdates[];
 };
+/** @returns {TransitionComments} */
+declare function TransitionComments(): TransitionComments;
+type TransitionComments = {
+    /**
+     * - Title for the transition message.
+     */
+    title: string;
+    /**
+     * - Message for the transition.
+     */
+    message: string;
+};
 /** @returns {ShipmentsRequestSchema} */
 declare function ShipmentsRequestSchema(): ShipmentsRequestSchema;
 type ShipmentsRequestSchema = {
@@ -5522,6 +5548,11 @@ type ShipmentsRequestSchema = {
      */
     products?: Products[];
     data_updates?: DataUpdates;
+    /**
+     * - Comments or notes
+     * associated with the transition of shipment status.
+     */
+    transition_comments?: TransitionComments[];
 };
 /** @returns {UpdatedAddressSchema} */
 declare function UpdatedAddressSchema(): UpdatedAddressSchema;
@@ -6145,10 +6176,10 @@ type HistoryReason = {
      */
     state?: string;
     /**
-     * - Display name of the reason for better user
-     * understanding.
+     * - Display name of the reason for better
+     * user understanding.
      */
-    dislay_name?: string;
+    display_name?: string;
     /**
      * - Unique code identifying the reason.
      */
@@ -9699,12 +9730,12 @@ type Reason = {
      * - Meta object of the reason. This contains any
      * additional metadata that might be relevant to the reason.
      */
-    meta: any;
+    meta?: any;
     /**
      * - Indicates whether the reason is currently
      * active. Active reasons are those that are currently in use within the system.
      */
-    is_active: boolean;
+    is_active?: boolean;
 };
 /** @returns {Conditions} */
 declare function Conditions(): Conditions;
@@ -10022,6 +10053,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {BagReasonMeta} */
 declare function BagReasonMeta(): BagReasonMeta;
@@ -10380,6 +10415,10 @@ type Address = {
      * - The unique identifier of the user in the system.
      */
     user_id?: string;
+    /**
+     * - A unique identifier associated with store.
+     */
+    code?: string;
 };
 /** @returns {ShipmentListingChannel} */
 declare function ShipmentListingChannel(): ShipmentListingChannel;
@@ -12272,6 +12311,14 @@ type OrderingStoreDetails = {
      * - The city in which the ordering store is located.
      */
     city?: string;
+    /**
+     * - The name of the ordering store.
+     */
+    name?: string;
+    /**
+     * - The email address of the ordering store.
+     */
+    store_email?: string;
 };
 /** @returns {DPDetailsData} */
 declare function DPDetailsData(): DPDetailsData;
@@ -12808,6 +12855,11 @@ type OrderBagArticle = {
      * - An array of tags associated with the article.
      */
     tags?: string[];
+    /**
+     * - A custom JSON object containing
+     * additional details or configurations specific to the article.
+     */
+    _custom_json?: any;
 };
 /** @returns {OrderBrandName} */
 declare function OrderBrandName(): OrderBrandName;
@@ -13246,6 +13298,10 @@ type FulfillingStore = {
      * - The city in which the fulfilling store is situated.
      */
     city: string;
+    /**
+     * - The email address of the fulfilling store.
+     */
+    store_email?: string;
 };
 /** @returns {ShipmentPayments} */
 declare function ShipmentPayments(): ShipmentPayments;