@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

package/sdk/platform/Order/OrderPlatformModel.js

@@ -1,25 +1,41 @@
 const Joi = require("joi");
 
 /**
- * @typedef InvalidateShipmentCachePayload
- * @property {string[]} [shipment_ids] - Shipment Ids to clear cache
- * @property {string[]} [affiliate_bag_ids] - Affiliate Bag Ids to clear cache
- *   of shipment Ids mapped to it
- * @property {string[]} [bag_ids] - Bag Ids to clear cache of shipment Ids mapped to it
- */
-
-/**
- * @typedef InvalidateShipmentCacheNestedResponseSchema
- * @property {string} [shipment_id]
- * @property {number} [status] - The HTTP status code corresponding to the
- *   overall status of the shipment response.
- * @property {string} [message]
- * @property {string} [error]
- */
-
-/**
- * @typedef InvalidateShipmentCacheResponseSchema
- * @property {InvalidateShipmentCacheNestedResponseSchema[]} [response]
+ * @typedef PackageSchema
+ * @property {string} [id] - Unique identifier of the physical package. If not
+ *   provided, the system will auto-generate a unique ID with format 'PK'
+ *   followed by a 10-digit number.
+ * @property {string} [packaging_id] - Optional reference to a predefined
+ *   packaging configuration or template used for creating physical packages.
+ * @property {string} [name] - A human-readable name or label for the package,
+ *   used for identification and organizational purposes.
+ * @property {string} [size] - The size category of the package (e.g., small,
+ *   medium, large). Used for logistics and carrier selection.
+ * @property {string} [package_type] - The type or category of packaging
+ *   material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
+ * @property {number} [length] - The length dimension of the package in
+ *   centimeters. Used for volumetric weight calculation and carrier requirements.
+ * @property {number} [width] - The width dimension of the package in
+ *   centimeters. Used for volumetric weight calculation and carrier requirements.
+ * @property {number} [height] - The height dimension of the package in
+ *   centimeters. Used for volumetric weight calculation and carrier requirements.
+ * @property {number} [weight] - The actual weight of the package in kilograms,
+ *   including packaging materials and products.
+ * @property {number} [error_rate] - The acceptable error rate or tolerance for
+ *   the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
+ * @property {number} [package_vol_weight] - The volumetric weight of the
+ *   package calculated based on dimensions, used for shipping cost calculation
+ *   when greater than actual weight.
+ * @property {number} [max_weight] - The maximum weight capacity that this
+ *   package can handle, used for validation and logistics planning.
+ * @property {string} [awb] - Air Waybill number assigned by the courier partner
+ *   for tracking this specific package throughout the delivery process.
+ * @property {Object} [pdf_links] - Dictionary containing PDF document links
+ *   related to this package (labels, invoices, etc.). Always returns an object
+ *   - empty object {} if no links are present, populated object if links exist.
+ *   Users can update values by providing new key-value pairs.
+ * @property {PackageProduct[]} [products] - List of products contained within
+ *   this package. Each product specifies its line number, quantity, and identifier.
  */
 
 /**
@@ -354,6 +370,14 @@ const Joi = require("joi");
  * @property {string} message - Message for the transition.
  */
 
+/**
+ * @typedef RefundModeTransitionData
+ * @property {string} [refund_mode] - Refund Mode for status transition data.
+ * @property {string} [display_name] - Refund Mode display name.
+ * @property {string[]} [payment_identifiers] - List of identifiers associated
+ *   with the refund transaction.
+ */
+
 /**
  * @typedef ShipmentsRequestSchema
  * @property {string} identifier - Unique identifier for the shipment.
@@ -363,6 +387,8 @@ const Joi = require("joi");
  * @property {DataUpdates} [data_updates]
  * @property {TransitionComments[]} [transition_comments] - Comments or notes
  *   associated with the transition of shipment status.
+ * @property {RefundModeTransitionData[]} [refund_modes] - Refund Mode for
+ *   status transition.
  */
 
 /**
@@ -394,7 +420,9 @@ const Joi = require("joi");
 
 /**
  * @typedef StatuesRequestSchema
- * @property {string} [status] - The new status to be assigned to the shipment(s).
+ * @property {string} [status] - The new status to be assigned to a shipment.
+ *   Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS
+ *   States</a> for the complete status list.
  * @property {ShipmentsRequestSchema[]} [shipments] - A list of shipments to
  *   which the new status will be applied.
  * @property {string} [exclude_bags_next_state] - Specifies the state to which
@@ -2534,6 +2562,14 @@ const Joi = require("joi");
  *
  *   - `status_update`: Status Update
  *   - `data_update`: Data Update
+ *
+ * @property {string} [fulfillment_option_slug] - Represents the unique slug
+ *   associated with the fulfillment option attached to the shipment. This slug
+ *   helps determine the fulfillment method and operational flow used to deliver
+ *   the shipment. Examples:
+ *
+ *   - "standard-delivery"
+ *   - "hyperlocal-delivery"
  */
 
 /**
@@ -2854,6 +2890,29 @@ const Joi = require("joi");
  * @property {PaymentMethodTransactionPartySchema} [transaction_party]
  */
 
+/**
+ * @typedef PackagesSchema
+ * @property {PackageSchema[]} packages - Array of packages to be created or
+ *   updated for the shipment. At least two packages are required for MPS functionality.
+ */
+
+/**
+ * @typedef PackagesResponseSchema
+ * @property {boolean} success - Indicates whether the API call was successful
+ *   (true) or failed (false).
+ * @property {PackagesSchema} data
+ * @property {string} [message] - A descriptive message providing additional
+ *   information about the API response.
+ */
+
+/**
+ * @typedef PackagesErrorResponseSchema
+ * @property {boolean} success - Indicates whether the API call was successful.
+ *   Will always be false for error responses.
+ * @property {string} error - A detailed error message describing what went
+ *   wrong during the API call.
+ */
+
 /**
  * @typedef BundleDetailsSchema
  * @property {boolean} [is_base] - This serves as the base item, with all other
@@ -3054,6 +3113,8 @@ const Joi = require("joi");
  * @property {string} [external_shipment_id] - Unique identifier for the
  *   shipment as assigned by an external system. Use this to map the external ID
  *   to Fynd's generated ID.
+ * @property {string} [invoice_id] - Indicates whether the order was created in
+ *   offline mode. Used to enable offline-specific processing and sync behavior.
  * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
  * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
  * @property {number} [location_id] - The location ID from which this shipment
@@ -3254,6 +3315,8 @@ const Joi = require("joi");
  *   placed. Required when the order is placed from one company but fulfilled by another.
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
  *   Draft orders will be moved to upcoming state instead of placed status.
+ * @property {boolean} [is_offline_order] - Indicates whether the order is an
+ *   offline order placed through a physical store or offline channel.
  * @property {Object} [meta] - Metadata related to the order may include
  *   additional, dynamic information that provides further context about the
  *   order. This information can also be viewed on the Order or Shipment Details page.
@@ -3325,6 +3388,15 @@ const Joi = require("joi");
  * @property {Page} [page]
  */
 
+/**
+ * @typedef PackageProduct
+ * @property {number} line_number - The line number of the product within the
+ *   shipment, used for tracking and identification purposes.
+ * @property {number} quantity - The quantity of the product included in this package.
+ * @property {string} identifier - The unique identifier or SKU (Stock Keeping
+ *   Unit) of the product. This is used to match products across packages and bags.
+ */
+
 /**
  * @typedef ValidationError
  * @property {string} message - A brief description of the error encountered.
@@ -3401,6 +3473,15 @@ const Joi = require("joi");
  *   providing a clear indication of its current processing stage.
  */
 
+/**
+ * @typedef OrderingSourceDetails
+ * @property {string} [type] - Type of the ordering source.
+ * @property {string} [slug] - Slug identifier of the ordering source.
+ * @property {string} [display_name] - Display name of the ordering source.
+ * @property {boolean} [is_active] - Indicates whether the ordering source is active.
+ * @property {string} [logo] - Logo URL of the ordering source.
+ */
+
 /**
  * @typedef UserDataInfo
  * @property {number} [id] - The unique identifier associated with the user.
@@ -3579,6 +3660,8 @@ const Joi = require("joi");
  *   used in the transaction.
  * @property {number} [amount_to_be_collected] - Total amount to be collected in
  *   scenarios involving multiple payment methods.
+ * @property {number} [cost_price] - The base cost incurred by the seller to
+ *   acquire or produce the product before margin or discount.
  * @property {number} [loyalty_discount] - Amount reduced from the payable price
  *   when the customer applies loyalty program points while placing the order.
  */
@@ -3669,6 +3752,8 @@ const Joi = require("joi");
  *   purchased by the customer, usable for future transactions.
  * @property {number} [amount_to_be_collected] - Amount to be collected from the
  *   customer when multiple payment methods are utilized for a single order.
+ * @property {number} [cost_price] - The base cost incurred by the seller to
+ *   acquire or produce the product before margin or discount.
  * @property {number} [loyalty_discount] - Amount reduced from the payable price
  *   when the customer applies loyalty program points while placing the order.
  */
@@ -3711,6 +3796,16 @@ const Joi = require("joi");
  *   services before tax is applied.
  */
 
+/**
+ * @typedef SellerQcDetails
+ * @property {number} [line_number] - Represents the line number in an order or
+ *   transaction associated with the bag.
+ * @property {number} [bad_quantity] - Represents the total number of items in a
+ *   bag that have failed quality control and are marked as bad QC.
+ * @property {number} [good_quantity] - Represents the total number of items in
+ *   a bag that have passed quality control and are marked as good QC.
+ */
+
 /**
  * @typedef FinancialBreakup
  * @property {number} refund_credit - The amount of refund credits applicable
@@ -4213,6 +4308,7 @@ const Joi = require("joi");
  *   placed by the customer. This timestamp is crucial for tracking the order'
  * @property {string} [order_created_ts] - The timestamp indicating when the
  *   order was created in UTC format.
+ * @property {OrderingSourceDetails} [ordering_source_details]
  * @property {ShipmentStatus} [shipment_status]
  * @property {UserDataInfo} [user]
  * @property {string} [estimated_sla_time] - The estimated Service Level
@@ -4892,6 +4988,7 @@ const Joi = require("joi");
  * @property {BagStatusHistory[]} [bag_status]
  * @property {Object} [parent_promo_bags] - An object containing details of
  *   parent promotional bags.
+ * @property {SellerQcDetails} [seller_qc_details]
  * @property {FinancialBreakup} [financial_breakup]
  * @property {BagConfigs} [bag_configs]
  * @property {string} [seller_identifier]
@@ -5146,6 +5243,8 @@ const Joi = require("joi");
  * @property {Object} [logistics_meta] - An object storing detailed
  *   logistics-related information, including courier partner details and other
  *   relevant metadata.
+ * @property {PackageSchema[]} [packages] - Array of packages to be created or
+ *   updated for the shipment. At least two packages are required for MPS functionality.
  */
 
 /**
@@ -5193,6 +5292,7 @@ const Joi = require("joi");
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - Ordering source, to be used to
  *   identify source of order creation.
+ * @property {OrderingSourceDetails} [ordering_source_details]
  * @property {string} order_date - Specifies the exact date and time when the
  *   order was placed by the customer, serving as a key timestamp for the
  *   initiation of the order processing cycle.
@@ -5286,6 +5386,9 @@ const Joi = require("joi");
  * @property {string} [order_created_time] - The Date and time when the order was created.
  * @property {string} [order_created_ts] - The timestamp indicating when the
  *   order was created.
+ * @property {string} [ordering_source] - Ordering source, to be used to
+ *   identify source of order creation.
+ * @property {OrderingSourceDetails} [ordering_source_details]
  * @property {string} [payment_mode] - The payment mode used for the order.
  * @property {PlatformShipment[]} [shipments] - An array of shipment items
  *   returned as part of the order.
@@ -5912,31 +6015,24 @@ const Joi = require("joi");
  */
 
 class OrderPlatformModel {
-  /** @returns {InvalidateShipmentCachePayload} */
-  static InvalidateShipmentCachePayload() {
-    return Joi.object({
-      shipment_ids: Joi.array().items(Joi.string().allow("")),
-      affiliate_bag_ids: Joi.array().items(Joi.string().allow("")),
-      bag_ids: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {InvalidateShipmentCacheNestedResponseSchema} */
-  static InvalidateShipmentCacheNestedResponseSchema() {
-    return Joi.object({
-      shipment_id: Joi.string().allow(""),
-      status: Joi.number(),
-      message: Joi.string().allow(""),
-      error: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvalidateShipmentCacheResponseSchema} */
-  static InvalidateShipmentCacheResponseSchema() {
+  /** @returns {PackageSchema} */
+  static PackageSchema() {
     return Joi.object({
-      response: Joi.array().items(
-        OrderPlatformModel.InvalidateShipmentCacheNestedResponseSchema()
-      ),
+      id: Joi.string().allow(""),
+      packaging_id: Joi.string().allow("").allow(null),
+      name: Joi.string().allow("").allow(null),
+      size: Joi.string().allow("").allow(null),
+      package_type: Joi.string().allow("").allow(null),
+      length: Joi.number().allow(null),
+      width: Joi.number().allow(null),
+      height: Joi.number().allow(null),
+      weight: Joi.number().allow(null),
+      error_rate: Joi.number().allow(null),
+      package_vol_weight: Joi.number().allow(null),
+      max_weight: Joi.number().allow(null),
+      awb: Joi.string().allow("").allow(null),
+      pdf_links: Joi.object().pattern(/\S/, Joi.string().allow("")),
+      products: Joi.array().items(OrderPlatformModel.PackageProduct()),
     });
   }
 
@@ -6255,6 +6351,15 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {RefundModeTransitionData} */
+  static RefundModeTransitionData() {
+    return Joi.object({
+      refund_mode: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      payment_identifiers: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
   /** @returns {ShipmentsRequestSchema} */
   static ShipmentsRequestSchema() {
     return Joi.object({
@@ -6265,6 +6370,9 @@ class OrderPlatformModel {
       transition_comments: Joi.array().items(
         OrderPlatformModel.TransitionComments()
       ),
+      refund_modes: Joi.array().items(
+        OrderPlatformModel.RefundModeTransitionData()
+      ),
     });
   }
 
@@ -8282,6 +8390,7 @@ class OrderPlatformModel {
       customer_country_code: Joi.string().allow(""),
       is_test_order: Joi.boolean(),
       task_trigger_condition: Joi.array().items(Joi.string().allow("")),
+      fulfillment_option_slug: Joi.string().allow(""),
     });
   }
 
@@ -8578,6 +8687,32 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {PackagesSchema} */
+  static PackagesSchema() {
+    return Joi.object({
+      packages: Joi.array()
+        .items(OrderPlatformModel.PackageSchema())
+        .required(),
+    });
+  }
+
+  /** @returns {PackagesResponseSchema} */
+  static PackagesResponseSchema() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+      data: OrderPlatformModel.PackagesSchema().required(),
+      message: Joi.string().allow("").allow(null),
+    });
+  }
+
+  /** @returns {PackagesErrorResponseSchema} */
+  static PackagesErrorResponseSchema() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+      error: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {BundleDetailsSchema} */
   static BundleDetailsSchema() {
     return Joi.object({
@@ -8760,6 +8895,7 @@ class OrderPlatformModel {
       type: Joi.string().allow(""),
       fulfillment_option: OrderPlatformModel.FulfillmentOptionSchema(),
       external_shipment_id: Joi.string().allow(""),
+      invoice_id: Joi.string().allow(""),
       line_items: Joi.array().items(OrderPlatformModel.LineItemSchema()),
       order_fulfillment_timeline: OrderPlatformModel.OrderFulfillmentTimelineSchema(),
       location_id: Joi.number(),
@@ -8935,6 +9071,7 @@ class OrderPlatformModel {
       b2b_gstin_number: Joi.string().allow(""),
       channel_company_id: Joi.string().allow(""),
       is_draft: Joi.boolean(),
+      is_offline_order: Joi.boolean(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
@@ -9012,6 +9149,15 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {PackageProduct} */
+  static PackageProduct() {
+    return Joi.object({
+      line_number: Joi.number().required(),
+      quantity: Joi.number().required(),
+      identifier: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {ValidationError} */
   static ValidationError() {
     return Joi.object({
@@ -9074,6 +9220,17 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {OrderingSourceDetails} */
+  static OrderingSourceDetails() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      is_active: Joi.boolean(),
+      logo: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserDataInfo} */
   static UserDataInfo() {
     return Joi.object({
@@ -9198,6 +9355,7 @@ class OrderPlatformModel {
       fynd_credits: Joi.number().allow(null),
       gift_price: Joi.number().allow(null),
       amount_to_be_collected: Joi.number().allow(null),
+      cost_price: Joi.number().allow(null),
       loyalty_discount: Joi.number(),
     });
   }
@@ -9270,6 +9428,7 @@ class OrderPlatformModel {
       fynd_credits: Joi.number().allow(null),
       gift_price: Joi.number().allow(null),
       amount_to_be_collected: Joi.number().allow(null),
+      cost_price: Joi.number().allow(null),
       loyalty_discount: Joi.number(),
     });
   }
@@ -9295,6 +9454,15 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {SellerQcDetails} */
+  static SellerQcDetails() {
+    return Joi.object({
+      line_number: Joi.number(),
+      bad_quantity: Joi.number(),
+      good_quantity: Joi.number(),
+    }).allow(null);
+  }
+
   /** @returns {FinancialBreakup} */
   static FinancialBreakup() {
     return Joi.object({
@@ -9645,6 +9813,7 @@ class OrderPlatformModel {
     return Joi.object({
       order_date: Joi.string().allow("").allow(null),
       order_created_ts: Joi.string().allow("").allow(null),
+      ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
       shipment_status: OrderPlatformModel.ShipmentStatus(),
       user: OrderPlatformModel.UserDataInfo(),
       estimated_sla_time: Joi.string().allow("").allow(null),
@@ -10152,6 +10321,7 @@ class OrderPlatformModel {
       gst_details: OrderPlatformModel.GSTDetailsData(),
       bag_status: Joi.array().items(OrderPlatformModel.BagStatusHistory()),
       parent_promo_bags: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
+      seller_qc_details: OrderPlatformModel.SellerQcDetails(),
       financial_breakup: OrderPlatformModel.FinancialBreakup(),
       bag_configs: OrderPlatformModel.BagConfigs(),
       seller_identifier: Joi.string().allow("").allow(null),
@@ -10324,6 +10494,7 @@ class OrderPlatformModel {
       is_lapa_enabled: Joi.boolean(),
       forward_end_shipment_id: Joi.string().allow("").allow(null),
       logistics_meta: Joi.object().pattern(/\S/, Joi.any()),
+      packages: Joi.array().items(OrderPlatformModel.PackageSchema()),
     });
   }
 
@@ -10364,6 +10535,7 @@ class OrderPlatformModel {
     return Joi.object({
       ordering_channel: Joi.string().allow(""),
       ordering_source: Joi.string().allow(""),
+      ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
       order_date: Joi.string().allow("").required(),
       created_ts: Joi.string().allow(""),
       tax_details: OrderPlatformModel.TaxDetails(),
@@ -10448,6 +10620,8 @@ class OrderPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       order_created_time: Joi.string().allow("").allow(null),
       order_created_ts: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
       payment_mode: Joi.string().allow("").allow(null),
       shipments: Joi.array().items(OrderPlatformModel.PlatformShipment()),
       order_id: Joi.string().allow("").allow(null),

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

@@ -50,18 +50,9 @@ export = OrderPlatformValidator;
  * @property {OrderPlatformModel.CreateOrderRequestSchema} body
  */
 /**
- * @typedef CreateOrderDeprecatedParam
- * @property {string} xOrderingSource - To uniquely identify the source through
- *   which order has been placed.
- * @property {string} [xApplicationId] - The Application ID is a unique
- *   identifier assigned to a storefront that typically follows a 24-character
- *   hexadecimal string. Either `x-application-id` or `x-extension-id` header is
- *   mandatory. At least one of them must be provided.
- * @property {string} [xExtensionId] - The Extension ID is a unique identifier
- *   assigned to an extension that typically follows a 24-character hexadecimal
- *   string. Either `x-application-id` or `x-extension-id` header is mandatory.
- *   At least one of them must be provided.
- * @property {OrderPlatformModel.CreateOrderAPI} body
+ * @typedef CreateShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier of the shipment.
+ * @property {OrderPlatformModel.PackagesSchema} body
  */
 /**
  * @typedef DispatchManifestsParam
@@ -328,6 +319,11 @@ export = OrderPlatformValidator;
  * @property {string} [shipmentId] - Identifier for the shipment
  * @property {number} [bagId] - Identifier for a bag or product.
  */
+/**
+ * @typedef GetShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier for the shipment whose
+ *   packages are being retrieved.
+ */
 /**
  * @typedef GetShipmentReasonsParam
  * @property {string} shipmentId - ID of the shipment. An order may contain
@@ -437,10 +433,6 @@ export = OrderPlatformValidator;
  * @property {string} view - Name of view
  * @property {string} [groupEntity] - Name of group entity
  */
-/**
- * @typedef InvalidateShipmentCacheParam
- * @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
- */
 /**
  * @typedef JobDetailsParam
  * @property {string} batchId - A unique identifier for the batch associated
@@ -502,6 +494,12 @@ export = OrderPlatformValidator;
  * @typedef UpdateShipmentLockParam
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
  */
+/**
+ * @typedef UpdateShipmentPackagesParam
+ * @property {string} shipmentId - Unique identifier for the shipment whose
+ *   packages will be updated.
+ * @property {OrderPlatformModel.PackagesSchema} body
+ */
 /**
  * @typedef UpdateShipmentStatusParam
  * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
@@ -535,8 +533,8 @@ declare class OrderPlatformValidator {
     static createChannelConfig(): CreateChannelConfigParam;
     /** @returns {CreateOrderParam} */
     static createOrder(): CreateOrderParam;
-    /** @returns {CreateOrderDeprecatedParam} */
-    static createOrderDeprecated(): CreateOrderDeprecatedParam;
+    /** @returns {CreateShipmentPackagesParam} */
+    static createShipmentPackages(): CreateShipmentPackagesParam;
     /** @returns {DispatchManifestsParam} */
     static dispatchManifests(): DispatchManifestsParam;
     /** @returns {DownloadBulkActionTemplateParam} */
@@ -597,6 +595,8 @@ declare class OrderPlatformValidator {
     static getShipmentById(): GetShipmentByIdParam;
     /** @returns {GetShipmentHistoryParam} */
     static getShipmentHistory(): GetShipmentHistoryParam;
+    /** @returns {GetShipmentPackagesParam} */
+    static getShipmentPackages(): GetShipmentPackagesParam;
     /** @returns {GetShipmentReasonsParam} */
     static getShipmentReasons(): GetShipmentReasonsParam;
     /** @returns {GetShipmentsParam} */
@@ -609,8 +609,6 @@ declare class OrderPlatformValidator {
     static getTemplate(): GetTemplateParam;
     /** @returns {GetfiltersParam} */
     static getfilters(): GetfiltersParam;
-    /** @returns {InvalidateShipmentCacheParam} */
-    static invalidateShipmentCache(): InvalidateShipmentCacheParam;
     /** @returns {JobDetailsParam} */
     static jobDetails(): JobDetailsParam;
     /** @returns {ListAccountsParam} */
@@ -637,6 +635,8 @@ declare class OrderPlatformValidator {
     static updatePaymentInfo(): UpdatePaymentInfoParam;
     /** @returns {UpdateShipmentLockParam} */
     static updateShipmentLock(): UpdateShipmentLockParam;
+    /** @returns {UpdateShipmentPackagesParam} */
+    static updateShipmentPackages(): UpdateShipmentPackagesParam;
     /** @returns {UpdateShipmentStatusParam} */
     static updateShipmentStatus(): UpdateShipmentStatusParam;
     /** @returns {UpdateShipmentTrackingParam} */
@@ -647,7 +647,7 @@ declare class OrderPlatformValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam, CreateOrderDeprecatedParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAccountByIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, ListAccountsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAccountParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
+    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam, CreateShipmentPackagesParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAccountByIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentPackagesParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, JobDetailsParam, ListAccountsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAccountParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentPackagesParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
 type AddStateManagerConfigParam = {
     body: OrderPlatformModel.TransitionConfigPayload;
@@ -721,27 +721,12 @@ type CreateOrderParam = {
     xExtensionId?: string;
     body: OrderPlatformModel.CreateOrderRequestSchema;
 };
-type CreateOrderDeprecatedParam = {
+type CreateShipmentPackagesParam = {
     /**
-     * - To uniquely identify the source through
-     * which order has been placed.
+     * - Unique identifier of the shipment.
      */
-    xOrderingSource: string;
-    /**
-     * - The Application ID is a unique
-     * identifier assigned to a storefront that typically follows a 24-character
-     * hexadecimal string. Either `x-application-id` or `x-extension-id` header is
-     * mandatory. At least one of them must be provided.
-     */
-    xApplicationId?: string;
-    /**
-     * - The Extension ID is a unique identifier
-     * assigned to an extension that typically follows a 24-character hexadecimal
-     * string. Either `x-application-id` or `x-extension-id` header is mandatory.
-     * At least one of them must be provided.
-     */
-    xExtensionId?: string;
-    body: OrderPlatformModel.CreateOrderAPI;
+    shipmentId: string;
+    body: OrderPlatformModel.PackagesSchema;
 };
 type DispatchManifestsParam = {
     body: OrderPlatformModel.DispatchManifest;
@@ -1305,6 +1290,13 @@ type GetShipmentHistoryParam = {
      */
     bagId?: number;
 };
+type GetShipmentPackagesParam = {
+    /**
+     * - Unique identifier for the shipment whose
+     * packages are being retrieved.
+     */
+    shipmentId: string;
+};
 type GetShipmentReasonsParam = {
     /**
      * - ID of the shipment. An order may contain
@@ -1552,9 +1544,6 @@ type GetfiltersParam = {
      */
     groupEntity?: string;
 };
-type InvalidateShipmentCacheParam = {
-    body: OrderPlatformModel.InvalidateShipmentCachePayload;
-};
 type JobDetailsParam = {
     /**
      * - A unique identifier for the batch associated
@@ -1630,6 +1619,14 @@ type UpdatePaymentInfoParam = {
 type UpdateShipmentLockParam = {
     body: OrderPlatformModel.UpdateShipmentLockPayload;
 };
+type UpdateShipmentPackagesParam = {
+    /**
+     * - Unique identifier for the shipment whose
+     * packages will be updated.
+     */
+    shipmentId: string;
+    body: OrderPlatformModel.PackagesSchema;
+};
 type UpdateShipmentStatusParam = {
     body: OrderPlatformModel.UpdateShipmentStatusRequestSchema;
 };