@gofynd/fdk-client-javascript 3.12.0 → 3.14.0

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

@@ -240,7 +240,7 @@ export = OrderPlatformModel;
  *   bag, used to identify and reference a particular product in a list. This
  *   helps in pinpointing the exact item being updated or processed.
  * @property {string} [identifier] - A unique string that serves as the
- *   product’s identifier, such as a SKU, barcode, or another distinct code.
+ *   product's identifier, such as a SKU, barcode, or another distinct code.
  *   This ensures the product is correctly identified and distinguished from
  *   other items in the system.
  * @property {number} [quantity] - The quantity of the product or item,
@@ -2262,7 +2262,7 @@ export = OrderPlatformModel;
  *   associated with a unique processing flow. For example:
  *
  *   - "HomeDelivery": The order goes through all the steps needed for delivery,
- *       from being packed to arriving at the customer’s address.
+ *       from being packed to arriving at the customer's address.
  *   - "PickAtStore": The order is prepared for pickup at the store, skipping
  *       shipping steps to make it ready faster for the customer to collect in person.
  *   - "Digital": This order type likely refers to orders that involve digital goods
@@ -2582,57 +2582,66 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef PaymentMethodGatewaySchema
- * @property {string} name - Payment Gateway Name.
+ * @property {string} name - Payment gateway name e.g., Razorpay, Stripe, etc.
  * @property {string} [logo]
  */
 /**
  * @typedef SubModeOfPaymentSchema
- * @property {string} name - Name of the Sub MOP Used.
+ * @property {string} name - Name of the sub-mode of payment. For example, if
+ *   the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
  */
 /**
  * @typedef PaymentMethodModeOfPaymentSchema
- * @property {string} name - Payment Mode Name.
- * @property {string} slug - Slug of the Payment Mode.
+ * @property {string} name - Payment mode name e.g., Credit Card, Debit Card,
+ *   Net Banking, Wallet, etc.
+ * @property {string} slug - Slug of the payment mode e.g., cc, dc, nb, wl, etc.
  * @property {SubModeOfPaymentSchema} [sub_mode_of_payment]
  */
 /**
  * @typedef PaymentMethodTransactionPartySchema
- * @property {string} refund_bearer - Entity responsible for refunds (e.g., SELLER/FYND).
- * @property {string} collection_bearer - Entity responsible for collection
- *   charges (e.g., SELLER/FYND).
+ * @property {string} refund_bearer - Entity responsible for refunding the
+ *   amount paid by the customer
+ * @property {string} collection_bearer - Entity responsible for collection of
+ *   amount paid by the customer
  */
 /**
  * @typedef LineItemPaymentMethodSchema
  * @property {PaymentMethodGatewaySchema} [gateway]
  * @property {PaymentMethodModeOfPaymentSchema} [mode_of_payment]
- * @property {number} [amount_paid] - Total Amount Paid by this Payment Method.
+ * @property {number} [amount_paid] - Total amount paid by this payment method
  * @property {string} [payment_identifier] - Transaction id
  * @property {PaymentMethodTransactionPartySchema} [transaction_party]
  */
 /**
  * @typedef BundleDetailsSchema
- * @property {boolean} [is_base] - A flag that determines if bag is base bag of bundle.
+ * @property {boolean} [is_base] - This serves as the base item, with all other
+ *   items acting as child elements within the bundle to display the hero
+ *   product prominently at the top.
  * @property {string[]} [images] - An array of image URLs associated with the bundle.
- * @property {string} [group_id] - Unique group identifier for the bundle.
+ * @property {string} [group_id] - Unique group identifier for the bundle
+ *   generated by seller to club the articles
  * @property {string} [name] - Name of the bundle.
- * @property {string} [item_type] - Type of the item (physical_bundle, virtual_bundle).
- * @property {number} [item_id] - Unique identifier for the item.
+ * @property {string} [item_type] - Type of the bundle item
+ * @property {number} [item_id] - Unique identifier of the item.
  * @property {string} [item_code] - Item code for the item.
  * @property {string} [item_name] - Name of the item.
  * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
- * @property {number} [bundle_article_quantity] - Article net_quantity in bundle Product.
+ * @property {number} [bundle_article_quantity] - In orders with multiple
+ *   quantities of the same line item, the line item count remains constant, but
+ *   multiple bundles can exist. To distinguish between these bundles, the
+ *   article quantity must be used.
  * @property {string} [brand_name] - Identifier for the brand name.
  * @property {string} [size] - Size associated with the bundle item.
  */
 /**
  * @typedef LineItemMonetaryValuesSchema
- * @property {number} amount_paid - Amount Paid by Customer
+ * @property {number} amount_paid - Amount paid by the customer
  * @property {number} price_effective - The final effective price after applying
  *   discounts, promotional offers, and adjustments.
  * @property {number} [discount] - Discount amount apart from promo and coupon discount
  * @property {number} price_marked - The original marked price of the item
  *   before any discounts or promotions.
- * @property {number} [coupon_discount] - Coupon Discount Applied for this Line Item
+ * @property {number} [coupon_discount] - Coupon discount applied for this article
  * @property {number} [cod_charges] - Cash on Delivery Charges Applied for this Article.
  * @property {number} [promo_discount] - Promotion Discount
  * @property {number} [gift_price] - Gift Price
@@ -2640,12 +2649,12 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef DimensionSchema
- * @property {number} height - Height of the Product.
+ * @property {number} height - Height of the product.
  * @property {number} length - Length of the product.
+ * @property {number} width - Width of the product
  * @property {boolean} is_default - Not Modified, meaning these are same as
  *   product uploaded while loading catelogue.
  * @property {string} unit - Unit of the measurement used.
- * @property {number} width - Width of the Product.
  */
 /**
  * @typedef GiftDetailsSchema
@@ -2672,14 +2681,20 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef CPOptionsSchema
- * @property {string} [extension_id]
- * @property {string} [scheme_id]
+ * @property {string} [extension_id] - A string that uniquely identifies the
+ *   courier partner extension. Refer <a
+ *   href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
+ *   courier partner account</a> to get the extension id.
+ * @property {string} [scheme_id] - A string that specifies the unique
+ *   identifier for the scheme associated with the account. Refer <a
+ *   href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
+ *   courier partner account</a> to get the scheme id.
  * @property {CPAreaCodeSchema} [area_code]
  * @property {boolean} [is_self_ship]
  * @property {number} [max_reattempts_for_delivery_allowed]
  * @property {string} [cp_sort_key] - A sorting key used for categorizing or
  *   sorting courier partners, often related to their performance, costs, or
- *   some other factor.
+ *   some other factor, (example: E-17A-4, E-17A-6, etc.).
  * @property {string} [name] - The name of the courier partner or the delivery
  *   agent handling the shipment.
  * @property {CPRiderDetailsSchema} [rider_details]
@@ -2692,7 +2707,7 @@ export = OrderPlatformModel;
  * @typedef CourierPartnerDetailsSchema
  * @property {string} [cp_sort_key] - A sorting key used for categorizing or
  *   sorting courier partners, often related to their performance, costs, or
- *   some other factor.
+ *   some other factor. (example: E-17A-4, E-17A-6, etc.).
  * @property {CPOptionsSchema[]} [cp_options] - Other Available CP's
  * @property {string} scheme_id
  * @property {string} name - The name of the courier partner or the delivery
@@ -2704,7 +2719,7 @@ export = OrderPlatformModel;
  * @property {boolean} using_own_creds - Specifies weather the Seller's Creds or
  *   Fynd's Creds are being used.
  * @property {number} [max_reattempts_for_delivery_allowed] - Reattempts Allowed
- *   (required for ndr)
+ *   (required for NDR)
  * @property {CPTatToDeliverTheShipmentSchema} [tat_to_deliver_the_shipment]
  * @property {boolean} [is_self_ship] - Is every logistic action handled by seller.
  */
@@ -2737,28 +2752,28 @@ export = OrderPlatformModel;
  *   can be dispatched (e.g., the earliest possible dispatch date).
  * @property {string} [dispatch_by_date] - The latest date the order must be
  *   dispatched to meet delivery expectations.
- * @property {string} [confirm_by_date] - The deadline by which the merchant
- *   must confirm the order.
+ * @property {string} [confirm_by_date] - The deadline by which the seller must
+ *   confirm the order.
  * @property {CustomerPickupSlotSchema} [customer_pickup_slot]
  * @property {string} [pack_by_date] - The latest time the package should be
  *   packed and ready to dispatch.
  */
 /**
  * @typedef LineItemSchema
- * @property {string} [seller_identifier] - Identifier for the seller providing the item.
- * @property {LineItemPaymentMethodSchema[]} payment_methods - Payment Methods
- *   Used to fulfil this Order.
+ * @property {string} [seller_identifier] - Identifier of the seller selling the item.
+ * @property {LineItemPaymentMethodSchema[]} payment_methods - Payment methods
+ *   used to sell this order.
  * @property {LineItemMonetaryValuesSchema} monetary_values
  * @property {GiftDetailsSchema} [gift_details]
- * @property {string} [special_instructions] - A string for any special
- *   instructions or messages.
+ * @property {string} [special_instructions] - These instructions are added by
+ *   the customer at checkout for the seller's reference.
  * @property {DimensionSchema} [dimension]
  * @property {number} [quantity] - Quantity of the Line Item
  * @property {string} [external_line_id] - Unique identifier for the LineItem as
  *   assigned by an external system. You can use this to map external id to
  *   Fynd's generated id
  * @property {BundleDetailsSchema} [bundle_details]
- * @property {Object} [meta] - An object containing metadata related to the shipment.
+ * @property {Object} [meta] - Contains metadata related to the shipment
  */
 /**
  * @typedef CreateOrderShipmentSchema
@@ -2767,20 +2782,17 @@ export = OrderPlatformModel;
  *   after receiving an order creation request.
  * @property {LifecycleMessageSchema[]} [shipment_lifecycle_messages] - List of
  *   general-purpose messages shown across different points in the shipment's
- *   journey at Order Details Screen.
+ *   journey at Order Details screen.
  * @property {string[]} [tags] - Tags that can be attached to the shipment for
  *   filtering and categorization.
  * @property {string} [type] - The shipment type defining the fulfillment method
  *   and processing flow. Each type determines the specific journey a shipment
  *   will follow based on operational needs and customer preferences:
- *
- *   - "HomeDelivery": Standard delivery to the customer's address, undergoing all
- *       typical state transitions from processing to final delivery.
- *   - "PickAtStore": Order prepared for in-store pickup, bypassing traditional
- *       shipping stages for direct handover to the customer.
- *   - "Digital": Orders involving digital goods or services (e.g., software,
- *       e-books, subscriptions) delivered electronically.
- *
+ *   "HomeDelivery": Standard delivery to the customer's address, undergoing all
+ *   typical state transitions from processing to final delivery. "PickAtStore":
+ *   Order prepared for in-store pickup, bypassing traditional shipping stages
+ *   for direct handover to the customer. "Digital": Orders involving digital
+ *   goods or services (e.g., software, e-books, subscriptions) delivered electronically.
  * @property {FulfillmentOptionSchema} [fulfillment_option]
  * @property {string} [external_shipment_id] - Unique identifier for the
  *   shipment as assigned by an external system. Use this to map the external ID
@@ -2802,9 +2814,10 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef OrderingCurrencySchema
- * @property {string} currency_code - The ISO 4217 currency code, such as 'INR'
- *   for Indian Rupee. This field represents the standardized three-letter code
- *   of a currency.
+ * @property {string} currency_code - The <a
+ *   href='https://www.iso.org/iso-4217-currency-codes.html'>ISO 4217</a>
+ *   currency code, such as 'INR' for Indian Rupee. This field represents the
+ *   standardized three-letter code of a currency.
  * @property {string} currency_symbol - The symbol representing the currency,
  *   such as '₹' for Indian Rupee. This is used for display purposes alongside
  *   currency amounts.
@@ -2830,7 +2843,6 @@ export = OrderPlatformModel;
 /**
  * @typedef CouponOwnershipSchema
  * @property {string} payable_category - Indicates who issued the coupon
- *   (MARKETPLACE or SELLER).
  */
 /**
  * @typedef CouponSchema
@@ -2844,40 +2856,38 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef BillingDetailsSchema
- * @property {string} [first_name] - First Name of the User
+ * @property {string} [first_name] - First name of the customer
  * @property {string} [phone_code] - Country phone code ex: +91
- * @property {string} [country] - Country of the User
- * @property {string} [city] - City of the User
- * @property {string} [pincode] - Pincode of the User
- * @property {string} [last_name] - Last Name of the User
- * @property {string} [mobile_number] - Primary Phone number of the User
- * @property {string} [email] - Primary Email of the User
- * @property {string} [state] - State of the User
- * @property {string} [alternate_mobile_number] - Alternate Mobile Number
- * @property {string} [address] - Full Address of the Billing User
- * @property {string} [middle_name] - A string containing the customer's middle name.
- * @property {string} [title] - A string representing the customer's title or prefix.
- * @property {string} [house_no] - A string representing the house or apartment
- *   number of the customer.
+ * @property {string} [country] - Country of the customer
+ * @property {string} [city] - City of the customer
+ * @property {string} [pincode] - Pincode of the customer
+ * @property {string} [last_name] - Last name of the customer
+ * @property {string} [mobile_number] - Primary phone number of the customer
+ * @property {string} [email] - Primary email of the customer
+ * @property {string} [state] - State of the customer
+ * @property {string} [alternate_mobile_number] - Alternate mobile number
+ * @property {string} [address] - Billing address of the customer
+ * @property {string} [middle_name] - Customer's middle name.
+ * @property {string} [title] - Customer's title or prefix.
+ * @property {string} [house_no] - House or apartment number of the customer.
  * @property {GeoLocationSchema} [geo_location]
- * @property {string} [gender] - Gender of user
- * @property {string} [landmark] - A string representing a landmark or reference
- *   point near the customer's location.
- * @property {string} [address_type] - A string representing the address type in
- *   the seller's system.
- * @property {string} [state_code] - A string representing the state code of the
- *   customer's location.
- * @property {string} [floor_no] - A string representing the floor number of the
+ * @property {string} [gender] - Gender of customer
+ * @property {string} [landmark] - Landmark or reference point near the
  *   customer's location.
+ * @property {string} [address_type] - Address type in the seller's system.
+ * @property {string} [state_code] - State code of the customer's location.
+ * @property {string} [floor_no] - Floor number of the customer's location.
  * @property {string} [alternate_email] - Alternate Email Address
- * @property {string} [address1] - A string representing the first line of the address.
- * @property {string} [address2] - A string representing the second line of the address.
+ * @property {string} [address1] - First line of the address.
+ * @property {string} [address2] - Second line of the address.
  * @property {string} [country_iso_code] - Specifies the country's unique
- *   identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
+ *   identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
  *   is crucial for distinguishing countries in international transactions, data
  *   processing, and shipping logistics.
- * @property {string} [user_id] - The unique identifier assigned to the user.
- *   refer /user in platform documentation to get more details.
+ * @property {string} [user_id] - The unique identifier assigned to the
+ *   customer. Refer <a
+ *   href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
+ *   to get more details.
  * @property {string} [area_code] - Area Code
  * @property {string} [area_code_slug]
  * @property {string} [country_phone_code]
@@ -2888,49 +2898,48 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef ShippingDetailsSchema
- * @property {string} [first_name] - First Name of the User
+ * @property {string} [first_name] - First name of the customer
  * @property {string} [phone_code] - Country phone code ex: +91
- * @property {string} [country] - Country of the User
- * @property {string} [city] - City of the User
- * @property {string} [pincode] - Pincode of the User
- * @property {string} [last_name] - Last Name of the User
- * @property {string} [mobile_number] - Primary Phone number of the User
- * @property {string} [email] - Primary Email of the User
- * @property {string} [state] - State of the User
- * @property {string} [alternate_mobile_number] - Alternate Mobile Number
- * @property {string} [address] - Full Address of the Billing User
- * @property {string} [middle_name] - A string containing the customer's middle name.
- * @property {string} [title] - A string representing the customer's title or prefix.
- * @property {string} [house_no] - A string representing the house or apartment
- *   number of the customer.
+ * @property {string} [country] - Country of the customer
+ * @property {string} [city] - City of the customer
+ * @property {string} [pincode] - Pincode of the customer
+ * @property {string} [last_name] - Last name of the customer
+ * @property {string} [mobile_number] - Primary phone number of the customer
+ * @property {string} [email] - Primary email of the customer
+ * @property {string} [state] - State of the customer
+ * @property {string} [alternate_mobile_number] - Alternate mobile number
+ * @property {string} [address] - Shipping address of the customer
+ * @property {string} [middle_name] - Customer's middle name.
+ * @property {string} [title] - Customer's title or prefix.
+ * @property {string} [house_no] - House or apartment number of the customer.
  * @property {GeoLocationSchema} [geo_location]
- * @property {string} [gender] - Gender of user
- * @property {string} [landmark] - A string representing a landmark or reference
- *   point near the customer's location.
+ * @property {string} [gender] - Gender of customer
+ * @property {string} [landmark] - Landmark or reference point near the
+ *   customer's location.
  * @property {string} [address_type] - A string representing the address type in
  *   the seller's system.
- * @property {string} [state_code] - A string representing the state code of the
- *   customer's location.
- * @property {string} [floor_no] - A string representing the floor number of the
- *   customer's location.
+ * @property {string} [state_code] - State code of the customer's location.
+ * @property {string} [floor_no] - Floor number of the customer's location.
  * @property {string} [alternate_email] - Alternate Email Address
- * @property {string} [address1] - A string representing the first line of the address.
- * @property {string} [address2] - A string representing the second line of the address.
+ * @property {string} [address1] - First line of the address
+ * @property {string} [address2] - Second line of the address
  * @property {string} [country_iso_code] - Specifies the country's unique
- *   identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
+ *   identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
  *   is crucial for distinguishing countries in international transactions, data
  *   processing, and shipping logistics.
- * @property {string} [user_id] - The unique identifier assigned to the user.
- *   refer /user in platform documentation to get more details.
+ * @property {string} [user_id] - The unique identifier assigned to the
+ *   customer. Refer <a
+ *   href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
+ *   in platform documentation to get more details. details.
  * @property {string} [area_code] - Area Code
  * @property {string} [area_code_slug]
  * @property {string} [country_phone_code]
  */
 /**
  * @typedef UserDetailsSchema
- * @property {string} [gstin] - The user's GSTIN (Goods and Services Tax
+ * @property {string} [gstin] - The customer's GSTIN (Goods and Services Tax
  *   Identification Number).
- * @property {string} [pan_no] - The user's PAN (Permanent Account Number).
+ * @property {string} [pan_no] - The customer's PAN (Permanent Account Number).
  */
 /**
  * @typedef LifecycleMessageSchema
@@ -2940,8 +2949,8 @@ export = OrderPlatformModel;
  *   message bar.
  * @property {string[]} states - List of OMS states at which the message should
  *   be visible.
- * @property {number} priority - Determines the message display sequence, with 1
- *   being the highest priority.
+ * @property {number} priority - Determines the message display sequence, with
+ *   '1' being the highest priority.
  */
 /**
  * @typedef CreateOrderRequestSchema
@@ -2967,7 +2976,7 @@ export = OrderPlatformModel;
  *   order by an external system or service.
  * @property {UserDetailsSchema} [user_details]
  * @property {LifecycleMessageSchema[]} [order_lifecycle_messages] - List of
- *   order lifecycle messages to be displayed to the user at Order Details.
+ *   order lifecycle messages to be displayed to the seller at Order Details.
  * @property {string} [channel_application_id] - Identifies the application from
  *   which the order was created. Pass this when it differs from the fulfilling
  *   company's application.
@@ -2977,6 +2986,9 @@ export = OrderPlatformModel;
  *   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 {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.
  */
 /**
  * @typedef Page
@@ -6013,7 +6025,7 @@ type ProductsDataUpdatesFilters = {
     line_number?: number;
     /**
      * - A unique string that serves as the
-     * product’s identifier, such as a SKU, barcode, or another distinct code.
+     * product's identifier, such as a SKU, barcode, or another distinct code.
      * This ensures the product is correctly identified and distinguished from
      * other items in the system.
      */
@@ -9997,7 +10009,7 @@ type Filter = {
      * associated with a unique processing flow. For example:
      *
      * - "HomeDelivery": The order goes through all the steps needed for delivery,
-     * from being packed to arriving at the customer’s address.
+     * from being packed to arriving at the customer's address.
      * - "PickAtStore": The order is prepared for pickup at the store, skipping
      * shipping steps to make it ready faster for the customer to collect in person.
      * - "Digital": This order type likely refers to orders that involve digital goods
@@ -10664,7 +10676,7 @@ type FulfillmentOptionSchema = {
 declare function PaymentMethodGatewaySchema(): PaymentMethodGatewaySchema;
 type PaymentMethodGatewaySchema = {
     /**
-     * - Payment Gateway Name.
+     * - Payment gateway name e.g., Razorpay, Stripe, etc.
      */
     name: string;
     logo?: string;
@@ -10673,7 +10685,8 @@ type PaymentMethodGatewaySchema = {
 declare function SubModeOfPaymentSchema(): SubModeOfPaymentSchema;
 type SubModeOfPaymentSchema = {
     /**
-     * - Name of the Sub MOP Used.
+     * - Name of the sub-mode of payment. For example, if
+     * the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
      */
     name: string;
 };
@@ -10681,11 +10694,12 @@ type SubModeOfPaymentSchema = {
 declare function PaymentMethodModeOfPaymentSchema(): PaymentMethodModeOfPaymentSchema;
 type PaymentMethodModeOfPaymentSchema = {
     /**
-     * - Payment Mode Name.
+     * - Payment mode name e.g., Credit Card, Debit Card,
+     * Net Banking, Wallet, etc.
      */
     name: string;
     /**
-     * - Slug of the Payment Mode.
+     * - Slug of the payment mode e.g., cc, dc, nb, wl, etc.
      */
     slug: string;
     sub_mode_of_payment?: SubModeOfPaymentSchema;
@@ -10694,12 +10708,13 @@ type PaymentMethodModeOfPaymentSchema = {
 declare function PaymentMethodTransactionPartySchema(): PaymentMethodTransactionPartySchema;
 type PaymentMethodTransactionPartySchema = {
     /**
-     * - Entity responsible for refunds (e.g., SELLER/FYND).
+     * - Entity responsible for refunding the
+     * amount paid by the customer
      */
     refund_bearer: string;
     /**
-     * - Entity responsible for collection
-     * charges (e.g., SELLER/FYND).
+     * - Entity responsible for collection of
+     * amount paid by the customer
      */
     collection_bearer: string;
 };
@@ -10709,7 +10724,7 @@ type LineItemPaymentMethodSchema = {
     gateway?: PaymentMethodGatewaySchema;
     mode_of_payment?: PaymentMethodModeOfPaymentSchema;
     /**
-     * - Total Amount Paid by this Payment Method.
+     * - Total amount paid by this payment method
      */
     amount_paid?: number;
     /**
@@ -10722,7 +10737,9 @@ type LineItemPaymentMethodSchema = {
 declare function BundleDetailsSchema(): BundleDetailsSchema;
 type BundleDetailsSchema = {
     /**
-     * - A flag that determines if bag is base bag of bundle.
+     * - This serves as the base item, with all other
+     * items acting as child elements within the bundle to display the hero
+     * product prominently at the top.
      */
     is_base?: boolean;
     /**
@@ -10730,7 +10747,8 @@ type BundleDetailsSchema = {
      */
     images?: string[];
     /**
-     * - Unique group identifier for the bundle.
+     * - Unique group identifier for the bundle
+     * generated by seller to club the articles
      */
     group_id?: string;
     /**
@@ -10738,11 +10756,11 @@ type BundleDetailsSchema = {
      */
     name?: string;
     /**
-     * - Type of the item (physical_bundle, virtual_bundle).
+     * - Type of the bundle item
      */
     item_type?: string;
     /**
-     * - Unique identifier for the item.
+     * - Unique identifier of the item.
      */
     item_id?: number;
     /**
@@ -10758,7 +10776,10 @@ type BundleDetailsSchema = {
      */
     seller_identifier?: string;
     /**
-     * - Article net_quantity in bundle Product.
+     * - In orders with multiple
+     * quantities of the same line item, the line item count remains constant, but
+     * multiple bundles can exist. To distinguish between these bundles, the
+     * article quantity must be used.
      */
     bundle_article_quantity?: number;
     /**
@@ -10774,7 +10795,7 @@ type BundleDetailsSchema = {
 declare function LineItemMonetaryValuesSchema(): LineItemMonetaryValuesSchema;
 type LineItemMonetaryValuesSchema = {
     /**
-     * - Amount Paid by Customer
+     * - Amount paid by the customer
      */
     amount_paid: number;
     /**
@@ -10792,7 +10813,7 @@ type LineItemMonetaryValuesSchema = {
      */
     price_marked: number;
     /**
-     * - Coupon Discount Applied for this Line Item
+     * - Coupon discount applied for this article
      */
     coupon_discount?: number;
     /**
@@ -10816,13 +10837,17 @@ type LineItemMonetaryValuesSchema = {
 declare function DimensionSchema(): DimensionSchema;
 type DimensionSchema = {
     /**
-     * - Height of the Product.
+     * - Height of the product.
      */
     height: number;
     /**
      * - Length of the product.
      */
     length: number;
+    /**
+     * - Width of the product
+     */
+    width: number;
     /**
      * - Not Modified, meaning these are same as
      * product uploaded while loading catelogue.
@@ -10832,10 +10857,6 @@ type DimensionSchema = {
      * - Unit of the measurement used.
      */
     unit: string;
-    /**
-     * - Width of the Product.
-     */
-    width: number;
 };
 /** @returns {GiftDetailsSchema} */
 declare function GiftDetailsSchema(): GiftDetailsSchema;
@@ -10873,7 +10894,19 @@ type CPTatToDeliverTheShipmentSchema = {
 /** @returns {CPOptionsSchema} */
 declare function CPOptionsSchema(): CPOptionsSchema;
 type CPOptionsSchema = {
+    /**
+     * - A string that uniquely identifies the
+     * courier partner extension. Refer <a
+     * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
+     * courier partner account</a> to get the extension id.
+     */
     extension_id?: string;
+    /**
+     * - A string that specifies the unique
+     * identifier for the scheme associated with the account. Refer <a
+     * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
+     * courier partner account</a> to get the scheme id.
+     */
     scheme_id?: string;
     area_code?: CPAreaCodeSchema;
     is_self_ship?: boolean;
@@ -10881,7 +10914,7 @@ type CPOptionsSchema = {
     /**
      * - A sorting key used for categorizing or
      * sorting courier partners, often related to their performance, costs, or
-     * some other factor.
+     * some other factor, (example: E-17A-4, E-17A-6, etc.).
      */
     cp_sort_key?: string;
     /**
@@ -10907,7 +10940,7 @@ type CourierPartnerDetailsSchema = {
     /**
      * - A sorting key used for categorizing or
      * sorting courier partners, often related to their performance, costs, or
-     * some other factor.
+     * some other factor. (example: E-17A-4, E-17A-6, etc.).
      */
     cp_sort_key?: string;
     /**
@@ -10934,7 +10967,7 @@ type CourierPartnerDetailsSchema = {
     using_own_creds: boolean;
     /**
      * - Reattempts Allowed
-     * (required for ndr)
+     * (required for NDR)
      */
     max_reattempts_for_delivery_allowed?: number;
     tat_to_deliver_the_shipment?: CPTatToDeliverTheShipmentSchema;
@@ -10996,8 +11029,8 @@ type OrderFulfillmentTimelineSchema = {
      */
     dispatch_by_date?: string;
     /**
-     * - The deadline by which the merchant
-     * must confirm the order.
+     * - The deadline by which the seller must
+     * confirm the order.
      */
     confirm_by_date?: string;
     customer_pickup_slot?: CustomerPickupSlotSchema;
@@ -11011,19 +11044,19 @@ type OrderFulfillmentTimelineSchema = {
 declare function LineItemSchema(): LineItemSchema;
 type LineItemSchema = {
     /**
-     * - Identifier for the seller providing the item.
+     * - Identifier of the seller selling the item.
      */
     seller_identifier?: string;
     /**
-     * - Payment Methods
-     * Used to fulfil this Order.
+     * - Payment methods
+     * used to sell this order.
      */
     payment_methods: LineItemPaymentMethodSchema[];
     monetary_values: LineItemMonetaryValuesSchema;
     gift_details?: GiftDetailsSchema;
     /**
-     * - A string for any special
-     * instructions or messages.
+     * - These instructions are added by
+     * the customer at checkout for the seller's reference.
      */
     special_instructions?: string;
     dimension?: DimensionSchema;
@@ -11039,7 +11072,7 @@ type LineItemSchema = {
     external_line_id?: string;
     bundle_details?: BundleDetailsSchema;
     /**
-     * - An object containing metadata related to the shipment.
+     * - Contains metadata related to the shipment
      */
     meta?: any;
 };
@@ -11055,7 +11088,7 @@ type CreateOrderShipmentSchema = {
     /**
      * - List of
      * general-purpose messages shown across different points in the shipment's
-     * journey at Order Details Screen.
+     * journey at Order Details screen.
      */
     shipment_lifecycle_messages?: LifecycleMessageSchema[];
     /**
@@ -11067,13 +11100,11 @@ type CreateOrderShipmentSchema = {
      * - The shipment type defining the fulfillment method
      * and processing flow. Each type determines the specific journey a shipment
      * will follow based on operational needs and customer preferences:
-     *
-     * - "HomeDelivery": Standard delivery to the customer's address, undergoing all
-     * typical state transitions from processing to final delivery.
-     * - "PickAtStore": Order prepared for in-store pickup, bypassing traditional
-     * shipping stages for direct handover to the customer.
-     * - "Digital": Orders involving digital goods or services (e.g., software,
-     * e-books, subscriptions) delivered electronically.
+     * "HomeDelivery": Standard delivery to the customer's address, undergoing all
+     * typical state transitions from processing to final delivery. "PickAtStore":
+     * Order prepared for in-store pickup, bypassing traditional shipping stages
+     * for direct handover to the customer. "Digital": Orders involving digital
+     * goods or services (e.g., software, e-books, subscriptions) delivered electronically.
      */
     type?: string;
     fulfillment_option?: FulfillmentOptionSchema;
@@ -11120,9 +11151,10 @@ type CreateOrderShipmentSchema = {
 declare function OrderingCurrencySchema(): OrderingCurrencySchema;
 type OrderingCurrencySchema = {
     /**
-     * - The ISO 4217 currency code, such as 'INR'
-     * for Indian Rupee. This field represents the standardized three-letter code
-     * of a currency.
+     * - The <a
+     * href='https://www.iso.org/iso-4217-currency-codes.html'>ISO 4217</a>
+     * currency code, such as 'INR' for Indian Rupee. This field represents the
+     * standardized three-letter code of a currency.
      */
     currency_code: string;
     /**
@@ -11169,7 +11201,6 @@ declare function CouponOwnershipSchema(): CouponOwnershipSchema;
 type CouponOwnershipSchema = {
     /**
      * - Indicates who issued the coupon
-     * (MARKETPLACE or SELLER).
      */
     payable_category: string;
 };
@@ -11200,7 +11231,7 @@ type CouponSchema = {
 declare function BillingDetailsSchema(): BillingDetailsSchema;
 type BillingDetailsSchema = {
     /**
-     * - First Name of the User
+     * - First name of the customer
      */
     first_name?: string;
     /**
@@ -11208,77 +11239,73 @@ type BillingDetailsSchema = {
      */
     phone_code?: string;
     /**
-     * - Country of the User
+     * - Country of the customer
      */
     country?: string;
     /**
-     * - City of the User
+     * - City of the customer
      */
     city?: string;
     /**
-     * - Pincode of the User
+     * - Pincode of the customer
      */
     pincode?: string;
     /**
-     * - Last Name of the User
+     * - Last name of the customer
      */
     last_name?: string;
     /**
-     * - Primary Phone number of the User
+     * - Primary phone number of the customer
      */
     mobile_number?: string;
     /**
-     * - Primary Email of the User
+     * - Primary email of the customer
      */
     email?: string;
     /**
-     * - State of the User
+     * - State of the customer
      */
     state?: string;
     /**
-     * - Alternate Mobile Number
+     * - Alternate mobile number
      */
     alternate_mobile_number?: string;
     /**
-     * - Full Address of the Billing User
+     * - Billing address of the customer
      */
     address?: string;
     /**
-     * - A string containing the customer's middle name.
+     * - Customer's middle name.
      */
     middle_name?: string;
     /**
-     * - A string representing the customer's title or prefix.
+     * - Customer's title or prefix.
      */
     title?: string;
     /**
-     * - A string representing the house or apartment
-     * number of the customer.
+     * - House or apartment number of the customer.
      */
     house_no?: string;
     geo_location?: GeoLocationSchema;
     /**
-     * - Gender of user
+     * - Gender of customer
      */
     gender?: string;
     /**
-     * - A string representing a landmark or reference
-     * point near the customer's location.
+     * - Landmark or reference point near the
+     * customer's location.
      */
     landmark?: string;
     /**
-     * - A string representing the address type in
-     * the seller's system.
+     * - Address type in the seller's system.
      */
     address_type?: string;
     /**
-     * - A string representing the state code of the
-     * customer's location.
+     * - State code of the customer's location.
      */
     state_code?: string;
     /**
-     * - A string representing the floor number of the
-     * customer's location.
+     * - Floor number of the customer's location.
      */
     floor_no?: string;
     /**
@@ -11286,23 +11313,25 @@ type BillingDetailsSchema = {
      */
     alternate_email?: string;
     /**
-     * - A string representing the first line of the address.
+     * - First line of the address.
      */
     address1?: string;
     /**
-     * - A string representing the second line of the address.
+     * - Second line of the address.
      */
     address2?: string;
     /**
      * - Specifies the country's unique
-     * identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
+     * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
      * is crucial for distinguishing countries in international transactions, data
      * processing, and shipping logistics.
      */
     country_iso_code?: string;
     /**
-     * - The unique identifier assigned to the user.
-     * refer /user in platform documentation to get more details.
+     * - The unique identifier assigned to the
+     * customer. Refer <a
+     * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
+     * to get more details.
      */
     user_id?: string;
     /**
@@ -11324,7 +11353,7 @@ type CPConfigurationSchema = {
 declare function ShippingDetailsSchema(): ShippingDetailsSchema;
 type ShippingDetailsSchema = {
     /**
-     * - First Name of the User
+     * - First name of the customer
      */
     first_name?: string;
     /**
@@ -11332,62 +11361,61 @@ type ShippingDetailsSchema = {
      */
     phone_code?: string;
     /**
-     * - Country of the User
+     * - Country of the customer
      */
     country?: string;
     /**
-     * - City of the User
+     * - City of the customer
      */
     city?: string;
     /**
-     * - Pincode of the User
+     * - Pincode of the customer
      */
     pincode?: string;
     /**
-     * - Last Name of the User
+     * - Last name of the customer
      */
     last_name?: string;
     /**
-     * - Primary Phone number of the User
+     * - Primary phone number of the customer
      */
     mobile_number?: string;
     /**
-     * - Primary Email of the User
+     * - Primary email of the customer
      */
     email?: string;
     /**
-     * - State of the User
+     * - State of the customer
      */
     state?: string;
     /**
-     * - Alternate Mobile Number
+     * - Alternate mobile number
      */
     alternate_mobile_number?: string;
     /**
-     * - Full Address of the Billing User
+     * - Shipping address of the customer
      */
     address?: string;
     /**
-     * - A string containing the customer's middle name.
+     * - Customer's middle name.
      */
     middle_name?: string;
     /**
-     * - A string representing the customer's title or prefix.
+     * - Customer's title or prefix.
      */
     title?: string;
     /**
-     * - A string representing the house or apartment
-     * number of the customer.
+     * - House or apartment number of the customer.
      */
     house_no?: string;
     geo_location?: GeoLocationSchema;
     /**
-     * - Gender of user
+     * - Gender of customer
      */
     gender?: string;
     /**
-     * - A string representing a landmark or reference
-     * point near the customer's location.
+     * - Landmark or reference point near the
+     * customer's location.
      */
     landmark?: string;
     /**
@@ -11396,13 +11424,11 @@ type ShippingDetailsSchema = {
      */
     address_type?: string;
     /**
-     * - A string representing the state code of the
-     * customer's location.
+     * - State code of the customer's location.
      */
     state_code?: string;
     /**
-     * - A string representing the floor number of the
-     * customer's location.
+     * - Floor number of the customer's location.
      */
     floor_no?: string;
     /**
@@ -11410,23 +11436,25 @@ type ShippingDetailsSchema = {
      */
     alternate_email?: string;
     /**
-     * - A string representing the first line of the address.
+     * - First line of the address
      */
     address1?: string;
     /**
-     * - A string representing the second line of the address.
+     * - Second line of the address
      */
     address2?: string;
     /**
      * - Specifies the country's unique
-     * identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
+     * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
      * is crucial for distinguishing countries in international transactions, data
      * processing, and shipping logistics.
      */
     country_iso_code?: string;
     /**
-     * - The unique identifier assigned to the user.
-     * refer /user in platform documentation to get more details.
+     * - The unique identifier assigned to the
+     * customer. Refer <a
+     * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
+     * in platform documentation to get more details. details.
      */
     user_id?: string;
     /**
@@ -11440,12 +11468,12 @@ type ShippingDetailsSchema = {
 declare function UserDetailsSchema(): UserDetailsSchema;
 type UserDetailsSchema = {
     /**
-     * - The user's GSTIN (Goods and Services Tax
+     * - The customer's GSTIN (Goods and Services Tax
      * Identification Number).
      */
     gstin?: string;
     /**
-     * - The user's PAN (Permanent Account Number).
+     * - The customer's PAN (Permanent Account Number).
      */
     pan_no?: string;
 };
@@ -11468,8 +11496,8 @@ type LifecycleMessageSchema = {
      */
     states: string[];
     /**
-     * - Determines the message display sequence, with 1
-     * being the highest priority.
+     * - Determines the message display sequence, with
+     * '1' being the highest priority.
      */
     priority: number;
 };
@@ -11520,7 +11548,7 @@ type CreateOrderRequestSchema = {
     user_details?: UserDetailsSchema;
     /**
      * - List of
-     * order lifecycle messages to be displayed to the user at Order Details.
+     * order lifecycle messages to be displayed to the seller at Order Details.
      */
     order_lifecycle_messages?: LifecycleMessageSchema[];
     /**
@@ -11544,6 +11572,12 @@ type CreateOrderRequestSchema = {
      * Draft orders will be moved to upcoming state instead of placed status.
      */
     is_draft?: boolean;
+    /**
+     * - 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.
+     */
+    meta?: any;
 };
 /** @returns {Page} */
 declare function Page(): Page;