@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1

package/sdk/application/Order/OrderApplicationModel.d.ts

@@ -32,12 +32,7 @@ export = OrderApplicationModel;
  * @property {string} [name] - The official name of the entity.
  * @property {string} [display] - The name of the entity as it should be displayed.
  * @property {string} [currency_code] - The international currency code
- *   representing the currency used for the value. This specifies the currency
- *   code for all amounts. The currency_code field will hold a string value
- *   representing the code for the currency in which all monetary amounts are
- *   denominated. This code typically follows the ISO 4217 standard, which uses
- *   three-letter alphabetic codes to define different currencies around the
- *   world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+ *   representing the currency used for the value.
  */
 /**
  * @typedef ShipmentPayment
@@ -77,42 +72,8 @@ export = OrderApplicationModel;
  * @property {string} [code] - A code associated with the store.
  * @property {string} [name] - The name of the store.
  * @property {string} [company_name] - The name of the company associated with the store.
- * @property {number} [company_id] - Schema for fulfilling store.
- */
-/**
- * @typedef ChargeDistributionSchema
- * @property {string} type - This field defines the distribution type, e.g
- *   values('multi', 'single') multi: distribute the changes across all entity
- *   single: distribute the changes across to any one single entity
- * @property {string} logic - This field defines the distribution logic e.g
- *   values('apportion', 'equally') apportion: distribute charge amount based of
- *   weighted average amount of all the entity (like article with [10, 20] will
- *   get charge of 9 as [3, 6]) equally: distribute charge amount 'equally' to
- *   all the entity
- */
-/**
- * @typedef ChargeDistributionLogic
- * @property {ChargeDistributionSchema} distribution
- * @property {string} distribution_level - This field defines the distribution
- *   level, e.g distribution level is (order, shipment, article)
- */
-/**
- * @typedef ChargeAmountCurrency
- * @property {number} value - Charge currency value or amount
- * @property {string} currency - Charge currency code
- */
-/**
- * @typedef ChargeAmount
- * @property {ChargeAmountCurrency} base_currency
- * @property {ChargeAmountCurrency} ordering_currency
- */
-/**
- * @typedef PriceAdjustmentCharge
- * @property {string} [code] - Code defined for charge
- * @property {string} name - Display name for charge (charge is unique by the name)
- * @property {string} [type] - Type defined for charge
- * @property {ChargeAmount} amount
- * @property {ChargeDistributionLogic} distribution_logic
+ * @property {number} [company_id] - The identifier of the company associated
+ *   with the store.
  */
 /**
  * @typedef ShipmentStatus
@@ -121,10 +82,7 @@ export = OrderApplicationModel;
  * @property {string} [title] - The title or display name representing the
  *   shipment status.
  * @property {string} [hex_code] - The hexadecimal color code associated with
- *   the shipment status. Each state of a shipment (like "processing",
- *   "cancelled", "delivered", etc.) is associated with a unique color,
- *   represented by a hex code. This color coding makes it visually intuitive
- *   for users to understand the status of their shipment at a glance.
+ *   the shipment status.
  */
 /**
  * @typedef Invoice
@@ -197,12 +155,7 @@ export = OrderApplicationModel;
  * @property {number} [promotion_effective_discount] - The effective discount
  *   from promotions.
  * @property {number} [refund_amount] - The amount refunded to the customer.
- * @property {string} [currency_code] - This specifies the currency code for all
- *   amounts. The currency_code field will hold a string value representing the
- *   code for the currency in which all monetary amounts are denominated. This
- *   code typically follows the ISO 4217 standard, which uses three-letter
- *   alphabetic codes to define different currencies around the world. For
- *   example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+ * @property {string} [currency_code] - The code of the currency used.
  * @property {number} [fynd_credits] - The amount of Fynd credits used.
  * @property {number} [amount_to_be_collected] - The total amount that needs to
  *   be collected from the customer.
@@ -215,15 +168,18 @@ export = OrderApplicationModel;
 /**
  * @typedef Item
  * @property {string[]} [image] - An array of URLs pointing to images of the item.
- * @property {string[]} [l1_categories] - An array of level 1 categories the item belongs.
+ * @property {string[]} [l1_categories] - An array of level 1 categories to
+ *   which the item belongs.
+ * @property {string[]} [l2_category] - An array of level 2 categories to which
+ *   the item belongs.
+ * @property {number} [l2_category_id] - ID representing the level 2 category
+ *   classification of the item
  * @property {ItemBrand} [brand]
  * @property {string} [seller_identifier] - The identifier for the seller .
  * @property {string} [code] - The code or SKU of the item.
  * @property {number} [id] - The unique identifier of the item.
  * @property {string} [name] - The name of the item.
- * @property {string} [l3_category_name] - This key specifies the name of the
- *   third-level category under which the product is listed, offering a more
- *   detailed classification within the e-commerce platform's hierarchy.
+ * @property {string} [l3_category_name] - The level 3 category name.
  * @property {string} [slug_key] - A unique key or identifier for the item slug.
  * @property {string[]} [l2_categories] - An array of level 2 categories the
  *   item belongs to.
@@ -247,34 +203,14 @@ export = OrderApplicationModel;
  *   qualify for the promotion.
  * @property {string} [promo_id] - The unique identifier for the promotion.
  * @property {number} [amount] - The discount amount provided by the promotion.
- * @property {string} [promotion_type] - Specifies the type of discount or deal
- *   applied to the current promotion, defining how the promotion modifies the
- *   price or adds value to the purchase. Each type represents a different
- *   promotional strategy - percentage- Discount by a percentage of the original
- *   price. - amount- Discount by a specific amount off the original price. -
- *   fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get
- *   One or at a discount. - contract_price- Special pricing based on a contract
- *   or agreement. - shipping_price- Discount or deal related to the shipping
- *   cost. - ladder_price- Price changes based on quantity purchased. -
- *   bundle_price_percentage- Discount on a bundle purchase by a percentage. -
- *   bundle_price_amount- Discount on a bundle purchase by a specific amount. -
- *   bundle_amount_percentage- A percentage of the purchase amount is applied as
- *   a discount when buying in a bundle. - custom- A custom promotion not
- *   covered by other types. - free_gift_items- Free gift items are included
- *   with the purchase. - free_non_sellable_items- Free items that are not for
- *   sale are included with the purchase.
+ * @property {string} [promotion_type] - The type of promotion.
  * @property {AppliedFreeArticles[]} [applied_free_articles] - An array
  *   containing details of free articles applied under the promotion.
  */
 /**
  * @typedef Identifiers
  * @property {string} [ean] - The European Article Number (EAN) of the item.
- * @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item
- *   - uniquely identifies each distinct product. SKUs are used to track
- *   inventory levels, facilitate accurate stocktaking, and streamline order
- *   fulfillment processes. This code is essential for inventory management,
- *   allowing for the differentiation between products based on attributes such
- *   as price, color, and size.
+ * @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item.
  */
 /**
  * @typedef FinancialBreakup
@@ -285,12 +221,8 @@ export = OrderApplicationModel;
  *   other charges.
  * @property {number} [price_marked] - The original marked price of the item.
  * @property {number} [coupon_effective_discount] - The effective discount from coupons.
- * @property {string} [hsn_code] - The HSN Code (Harmonized System of
- *   Nomenclature Code) is an internationally standardized system for
- *   classifying goods. It is used in trade and commerce to identify products
- *   and services uniformly across different countries and industries. The
- *   system was developed by the World Customs Organization (WCO) and is widely
- *   used in customs processes and tax systems.
+ * @property {string} [hsn_code] - The HSN (Harmonized System of Nomenclature)
+ *   code of the item.
  * @property {number} [discount] - The discount applied to the item.
  * @property {number} [gst_tax_percentage] - The GST tax percentage applied .
  * @property {number} [cod_charges] - The cash on delivery charges, if applicable.
@@ -322,13 +254,8 @@ export = OrderApplicationModel;
  * @property {string} [updated_at] - The date and time when the status was last updated.
  * @property {string} [name] - The name or label indicating the current state or status.
  * @property {string} [status] - The current status of the bag.
- * @property {string} [journey_type] - It is a type being used to represent the
- *   journey of shipment through the performed status transition. Forward
- *   Journey: The forward journey encompasses all the stages of shipping,
- *   including order placement, packing, dispatch, in-transit updates, and
- *   delivery. Return Journey: Contrary to the forward journey, the return
- *   journey involves the process of sending items back from the customer to the
- *   original sender or a designated return facility.
+ * @property {string} [journey_type] - The type of journey for the shipment,
+ *   indicating the direction of the shipment.
  */
 /**
  * @typedef Bags
@@ -350,19 +277,11 @@ export = OrderApplicationModel;
  *   financial details of the item.
  * @property {Object} [parent_promo_bags] - An object containing details of
  *   parent promotional bags.
- * @property {Object} [meta] - It contains the additional properties related to
- *   shipment status transition like Kafka_emission_status, user_name, etc.
- *   Additionally it is dynamic.
- * @property {string} [currency_code] - This specifies the currency code for all
- *   amounts. The currency_code field will hold a string value representing the
- *   code for the currency in which all monetary amounts are denominated. This
- *   code typically follows the ISO 4217 standard, which uses three-letter
- *   alphabetic codes to define different currencies around the world. For
- *   example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+ * @property {Object} [meta] - An object containing metadata for the item.
+ * @property {string} [currency_code] - The code of the currency used.
  * @property {string} [seller_identifier] - The identifier for the seller.
  * @property {CurrentStatus} [current_status]
  * @property {Article} [article]
- * @property {PriceAdjustmentCharge[]} [charges]
  */
 /**
  * @typedef FulfillingCompany
@@ -384,7 +303,7 @@ export = OrderApplicationModel;
  * @property {string} [area] - The area or locality.
  * @property {string} [city] - The city of the address.
  * @property {string} [address] - The full address.
- * @property {string} [address_type] - The type of the address (e.g., home, office).
+ * @property {string} [address_type] - The type of address.
  * @property {number} [longitude] - The longitude coordinate.
  * @property {string} [country_iso_code] - The ISO code for the country.
  * @property {string} [state] - The state of the address.
@@ -394,20 +313,7 @@ export = OrderApplicationModel;
  *   typically used for printing or displaying in user interfaces.
  * @property {string} [name] - The name of the person associated with the address.
  * @property {string} [contact_person] - The name of the contact person.
- * @property {string} [address_category] - Category or classification of the
- *   address. The address_category field that includes "store", "delivery", and
- *   "billing" serves to classify addresses based on various business processes
- *
- *   - 'store': Identifies addresses associated with physical retail locations or
- *       warehouses which is essential for inventory management, order
- *       fulfillment, and facilitating in-store pickups or returns.
- *   - 'delivery': Identifies addresses where orders are shipped to customers which
- *       ensures successful delivery, enhancing customer satisfaction, and
- *       optimizing logistics operations.
- *   - 'billing': Identifies addresses used for billing and financial transactions
- *       which are essential for payment processing, invoice generation, and
- *       maintaining financial accuracy.
- *
+ * @property {string} [address_category] - The category of the address.
  * @property {string} [email] - The email address.
  * @property {string} [country_phone_code] - The country phone code.
  * @property {string} [version] - The version of the address format.
@@ -420,25 +326,8 @@ export = OrderApplicationModel;
  * @property {ShipmentPaymentInfo[]} [payment_info] - Array of objects
  *   containing payment methods used for placing an order. Each object will
  *   provide information about corresponding payment method with relevant details.
- * @property {string} [order_type] - Defines the specific journey a shipment
- *   will follow based on the application's operational needs and customer
- *   preferences. This field categorizes orders into distinct types, each
- *   associated with a unique processing flow. For example:
- *
- *   - "HomeDelivery": The order undergoes all state transitions typical for a
- *       delivery, from processing the shipment to final delivery at the
- *       customer's address.
- *   - "PickAtStore": The order is prepared for pickup and moved to a state where it
- *       is ready to be handed over directly to the customer at the store. This
- *       type streamlines the process by bypassing traditional shipping stages
- *       and facilitating a quicker transition to the final handover stage.
- *
- * @property {string} [gstin_code] - A GST Number (Goods and Services Tax
- *   Identification Number, often abbreviated as GSTIN) is a unique identifier
- *   assigned to a business or individual registered under the Goods and
- *   Services Tax (GST) system in countries like India. The GST number is
- *   essential for businesses to comply with tax regulations and for the
- *   government to track tax payments and returns.
+ * @property {string} [order_type] - The type of order.
+ * @property {string} [gstin_code] - The GSTIN code for the shipment.
  * @property {boolean} [show_download_invoice] - Indicates if the download
  *   invoice option should be shown.
  * @property {boolean} [can_cancel] - Indicates if the shipment can be canceled.
@@ -485,8 +374,7 @@ export = OrderApplicationModel;
  * @property {Object} [return_meta] - An object containing metadata about the
  *   return process.
  * @property {string} [delivery_date] - The expected delivery date.
- * @property {OrderRequestSchema} [order]
- * @property {PriceAdjustmentCharge[]} [charges]
+ * @property {OrderRequest} [order]
  */
 /**
  * @typedef BagsForReorderArticleAssignment
@@ -506,12 +394,7 @@ export = OrderApplicationModel;
  * @typedef OrderSchema
  * @property {number} [total_shipments_in_order] - The total number of shipments
  *   in the order.
- * @property {string} [gstin_code] - A GST Number (Goods and Services Tax
- *   Identification Number, often abbreviated as GSTIN) is a unique identifier
- *   assigned to a business or individual registered under the Goods and
- *   Services Tax (GST) system in countries like India. The GST number is
- *   essential for businesses to comply with tax regulations and for the
- *   government to track tax payments and returns.
+ * @property {string} [gstin_code] - The GSTIN code for the shipment.
  * @property {UserInfo} [user_info]
  * @property {BreakupValues[]} [breakup_values] - An array containing the
  *   breakup of various charges and discounts.
@@ -520,8 +403,7 @@ export = OrderApplicationModel;
  * @property {string} [order_id] - The unique identifier for the order.
  * @property {Shipments[]} [shipments] - An array containing details of
  *   individual shipments within the order.
- * @property {BagsForReorder[]} [bags_for_reorder] - Order details.
- * @property {PriceAdjustmentCharge[]} [charges] - An array containing details
+ * @property {BagsForReorder[]} [bags_for_reorder] - An array containing details
  *   of bags available for reorder.
  * @property {Object} [meta] - An object containing additional metadata for the order.
  */
@@ -581,7 +463,7 @@ export = OrderApplicationModel;
  * @property {Track[]} [results] - A array containing tracking details.
  */
 /**
- * @typedef CustomerDetailsResponseSchema
+ * @typedef CustomerDetailsResponse
  * @property {string} [phone] - Customer's phone number.
  * @property {string} [shipment_id] - Unique identifier of the shipment.
  * @property {string} [name] - Customer's name.
@@ -589,7 +471,7 @@ export = OrderApplicationModel;
  * @property {string} [country] - Country of the customer.
  */
 /**
- * @typedef SendOtpToCustomerResponseSchema
+ * @typedef SendOtpToCustomerResponse
  * @property {string} [request_id] - Unique identifier for the request.
  * @property {string} [message] - Message indicating the result of the request.
  * @property {boolean} [success] - Indicates whether the request was successful.
@@ -601,7 +483,7 @@ export = OrderApplicationModel;
  * @property {string} [request_id] - Unique identifier for the request.
  */
 /**
- * @typedef VerifyOtpResponseSchema
+ * @typedef VerifyOtpResponse
  * @property {boolean} [success] - Indicates whether the request was successful.
  */
 /**
@@ -616,20 +498,7 @@ export = OrderApplicationModel;
  */
 /**
  * @typedef BagReasons
- * @property {string[]} [qc_type] - List of QC (Quality Control) types -- having
- *   return reason types indicating the stage at which QC is performed. -
- *   "Doorstep QC" refers to the quality control checks that occur at the
- *   customer's doorstep. This could be part of a delivery process where the
- *   product is inspected for any damages, defects, or discrepancies in the
- *   presence of the customer before the final handover. - "Pre QC" represents a
- *   proactive quality control approach where the customer plays an active role
- *   in the QC process before the product is collected for return or exchange.
- *   In this procedure, customers are required to upload photos of the product
- *   for a preliminary quality check by the operations team. Approval from this
- *   team is necessary before a delivery partner is dispatched to pick up the
- *   product. This innovative method ensures that the product meets return or
- *   exchange criteria, streamlining the process for both the customer and the
- *   operations team, and minimizing unnecessary logistics movements.
+ * @property {string[]} [qc_type] - A list of quality check types.
  * @property {number} [id] - The unique identifier.
  * @property {string} [display_name] - The text displayed.
  * @property {BagReasonMeta} [meta]
@@ -640,9 +509,6 @@ export = OrderApplicationModel;
  * @typedef ShipmentBagReasons
  * @property {BagReasons[]} [reasons] - A list of shipment's bag reasons.
  * @property {boolean} [success] - Indicates if the operation was successful.
- * @property {number} [rule_id] - The unique identifier for the rule that is
- *   associated with the given reasons. This ID serves as a reference to the
- *   specific rule within the RMA system that governs or influences the reasons listed.
  */
 /**
  * @typedef ShipmentReason
@@ -698,16 +564,8 @@ export = OrderApplicationModel;
  */
 /**
  * @typedef ProductsDataUpdatesFilters
- * @property {number} [line_number] - Represents the specific line item within a
- *   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.
- *   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,
- *   specified as an integer. This indicates how many units of the product are
- *   being referenced or processed, such as the number of items in a bag or shipment.
+ * @property {number} [line_number] - The specific line item of bag.
+ * @property {string} [identifier] - The quantity of the product.
  */
 /**
  * @typedef ProductsDataUpdates
@@ -726,7 +584,7 @@ export = OrderApplicationModel;
  * @property {EntitiesDataUpdates[]} [entities] - Data updates for shipments.
  */
 /**
- * @typedef ShipmentsRequestSchema
+ * @typedef ShipmentsRequest
  * @property {ReasonsData} [reasons]
  * @property {Products[]} [products] - Specific bag to be updated.
  * @property {DataUpdates} [data_updates]
@@ -734,21 +592,20 @@ export = OrderApplicationModel;
  *   the shipment_id.
  */
 /**
- * @typedef StatuesRequestSchema
- * @property {ShipmentsRequestSchema[]} [shipments] - A list containing
- *   information about shipments.
+ * @typedef StatuesRequest
+ * @property {ShipmentsRequest[]} [shipments] - A list containing information
+ *   about shipments.
  * @property {string} [exclude_bags_next_state] - State to be change for
  *   Remaining Bag/Products.
  * @property {string} [status] - The status to which the entity is to be transitioned.
  */
 /**
- * @typedef OrderRequestSchema
+ * @typedef OrderRequest
  * @property {Object} [meta] - Metadata for the order.
  */
 /**
- * @typedef UpdateShipmentStatusRequestSchema
- * @property {StatuesRequestSchema[]} [statuses] - An array containing different
- *   status details.
+ * @typedef UpdateShipmentStatusRequest
+ * @property {StatuesRequest[]} [statuses] - An array containing different status details.
  * @property {boolean} [task] - Indicates whether the task is active or required.
  * @property {boolean} [lock_after_transition] - Indicates whether the status
  *   should be locked after the transition.
@@ -758,16 +615,16 @@ export = OrderApplicationModel;
  *   should be unlocked before the transition.
  */
 /**
- * @typedef StatusesBodyResponseSchema
+ * @typedef StatusesBodyResponse
  * @property {Object[]} [shipments] - List of shipments.
  */
 /**
- * @typedef ShipmentApplicationStatusResponseSchema
- * @property {StatusesBodyResponseSchema[]} [statuses] - An array containing
- *   different status options of shipments.
+ * @typedef ShipmentApplicationStatusResponse
+ * @property {StatusesBodyResponse[]} [statuses] - An array containing different
+ *   status options of shipments.
  */
 /**
- * @typedef ErrorResponseSchema
+ * @typedef ErrorResponse
  * @property {string} [code] - The HTTP status code of the response.
  * @property {string} [message] - A message providing details about the response.
  * @property {number} [status] - An additional code providing more context about
@@ -778,7 +635,7 @@ export = OrderApplicationModel;
 declare class OrderApplicationModel {
 }
 declare namespace OrderApplicationModel {
-    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentPaymentInfo, ShipmentUserInfo, FulfillingStore, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, Address, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponseSchema, SendOtpToCustomerResponseSchema, VerifyOtp, VerifyOtpResponseSchema, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequestSchema, StatuesRequestSchema, OrderRequestSchema, UpdateShipmentStatusRequestSchema, StatusesBodyResponseSchema, ShipmentApplicationStatusResponseSchema, ErrorResponseSchema };
+    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentPaymentInfo, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, Address, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
 }
 /** @returns {OrderPage} */
 declare function OrderPage(): OrderPage;
@@ -862,12 +719,7 @@ type BreakupValues = {
     display?: string;
     /**
      * - The international currency code
-     * representing the currency used for the value. This specifies the currency
-     * code for all amounts. The currency_code field will hold a string value
-     * representing the code for the currency in which all monetary amounts are
-     * denominated. This code typically follows the ISO 4217 standard, which uses
-     * three-letter alphabetic codes to define different currencies around the
-     * world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+     * representing the currency used for the value.
      */
     currency_code?: string;
 };
@@ -983,74 +835,11 @@ type FulfillingStore = {
      */
     company_name?: string;
     /**
-     * - Schema for fulfilling store.
+     * - The identifier of the company associated
+     * with the store.
      */
     company_id?: number;
 };
-/** @returns {ChargeDistributionSchema} */
-declare function ChargeDistributionSchema(): ChargeDistributionSchema;
-type ChargeDistributionSchema = {
-    /**
-     * - This field defines the distribution type, e.g
-     * values('multi', 'single') multi: distribute the changes across all entity
-     * single: distribute the changes across to any one single entity
-     */
-    type: string;
-    /**
-     * - This field defines the distribution logic e.g
-     * values('apportion', 'equally') apportion: distribute charge amount based of
-     * weighted average amount of all the entity (like article with [10, 20] will
-     * get charge of 9 as [3, 6]) equally: distribute charge amount 'equally' to
-     * all the entity
-     */
-    logic: string;
-};
-/** @returns {ChargeDistributionLogic} */
-declare function ChargeDistributionLogic(): ChargeDistributionLogic;
-type ChargeDistributionLogic = {
-    distribution: ChargeDistributionSchema;
-    /**
-     * - This field defines the distribution
-     * level, e.g distribution level is (order, shipment, article)
-     */
-    distribution_level: string;
-};
-/** @returns {ChargeAmountCurrency} */
-declare function ChargeAmountCurrency(): ChargeAmountCurrency;
-type ChargeAmountCurrency = {
-    /**
-     * - Charge currency value or amount
-     */
-    value: number;
-    /**
-     * - Charge currency code
-     */
-    currency: string;
-};
-/** @returns {ChargeAmount} */
-declare function ChargeAmount(): ChargeAmount;
-type ChargeAmount = {
-    base_currency: ChargeAmountCurrency;
-    ordering_currency: ChargeAmountCurrency;
-};
-/** @returns {PriceAdjustmentCharge} */
-declare function PriceAdjustmentCharge(): PriceAdjustmentCharge;
-type PriceAdjustmentCharge = {
-    /**
-     * - Code defined for charge
-     */
-    code?: string;
-    /**
-     * - Display name for charge (charge is unique by the name)
-     */
-    name: string;
-    /**
-     * - Type defined for charge
-     */
-    type?: string;
-    amount: ChargeAmount;
-    distribution_logic: ChargeDistributionLogic;
-};
 /** @returns {ShipmentStatus} */
 declare function ShipmentStatus(): ShipmentStatus;
 type ShipmentStatus = {
@@ -1066,10 +855,7 @@ type ShipmentStatus = {
     title?: string;
     /**
      * - The hexadecimal color code associated with
-     * the shipment status. Each state of a shipment (like "processing",
-     * "cancelled", "delivered", etc.) is associated with a unique color,
-     * represented by a hex code. This color coding makes it visually intuitive
-     * for users to understand the status of their shipment at a glance.
+     * the shipment status.
      */
     hex_code?: string;
 };
@@ -1272,12 +1058,7 @@ type Prices = {
      */
     refund_amount?: number;
     /**
-     * - This specifies the currency code for all
-     * amounts. The currency_code field will hold a string value representing the
-     * code for the currency in which all monetary amounts are denominated. This
-     * code typically follows the ISO 4217 standard, which uses three-letter
-     * alphabetic codes to define different currencies around the world. For
-     * example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+     * - The code of the currency used.
      */
     currency_code?: string;
     /**
@@ -1310,9 +1091,20 @@ type Item = {
      */
     image?: string[];
     /**
-     * - An array of level 1 categories the item belongs.
+     * - An array of level 1 categories to
+     * which the item belongs.
      */
     l1_categories?: string[];
+    /**
+     * - An array of level 2 categories to which
+     * the item belongs.
+     */
+    l2_category?: string[];
+    /**
+     * - ID representing the level 2 category
+     * classification of the item
+     */
+    l2_category_id?: number;
     brand?: ItemBrand;
     /**
      * - The identifier for the seller .
@@ -1331,9 +1123,7 @@ type Item = {
      */
     name?: string;
     /**
-     * - This key specifies the name of the
-     * third-level category under which the product is listed, offering a more
-     * detailed classification within the e-commerce platform's hierarchy.
+     * - The level 3 category name.
      */
     l3_category_name?: string;
     /**
@@ -1401,22 +1191,7 @@ type AppliedPromos = {
      */
     amount?: number;
     /**
-     * - Specifies the type of discount or deal
-     * applied to the current promotion, defining how the promotion modifies the
-     * price or adds value to the purchase. Each type represents a different
-     * promotional strategy - percentage- Discount by a percentage of the original
-     * price. - amount- Discount by a specific amount off the original price. -
-     * fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get
-     * One or at a discount. - contract_price- Special pricing based on a contract
-     * or agreement. - shipping_price- Discount or deal related to the shipping
-     * cost. - ladder_price- Price changes based on quantity purchased. -
-     * bundle_price_percentage- Discount on a bundle purchase by a percentage. -
-     * bundle_price_amount- Discount on a bundle purchase by a specific amount. -
-     * bundle_amount_percentage- A percentage of the purchase amount is applied as
-     * a discount when buying in a bundle. - custom- A custom promotion not
-     * covered by other types. - free_gift_items- Free gift items are included
-     * with the purchase. - free_non_sellable_items- Free items that are not for
-     * sale are included with the purchase.
+     * - The type of promotion.
      */
     promotion_type?: string;
     /**
@@ -1433,12 +1208,7 @@ type Identifiers = {
      */
     ean?: string;
     /**
-     * - The Stock Keeping Unit (SKU) code of the item
-     * - uniquely identifies each distinct product. SKUs are used to track
-     * inventory levels, facilitate accurate stocktaking, and streamline order
-     * fulfillment processes. This code is essential for inventory management,
-     * allowing for the differentiation between products based on attributes such
-     * as price, color, and size.
+     * - The Stock Keeping Unit (SKU) code of the item.
      */
     sku_code?: string;
 };
@@ -1471,12 +1241,8 @@ type FinancialBreakup = {
      */
     coupon_effective_discount?: number;
     /**
-     * - The HSN Code (Harmonized System of
-     * Nomenclature Code) is an internationally standardized system for
-     * classifying goods. It is used in trade and commerce to identify products
-     * and services uniformly across different countries and industries. The
-     * system was developed by the World Customs Organization (WCO) and is widely
-     * used in customs processes and tax systems.
+     * - The HSN (Harmonized System of Nomenclature)
+     * code of the item.
      */
     hsn_code?: string;
     /**
@@ -1581,13 +1347,8 @@ type CurrentStatus = {
      */
     status?: string;
     /**
-     * - It is a type being used to represent the
-     * journey of shipment through the performed status transition. Forward
-     * Journey: The forward journey encompasses all the stages of shipping,
-     * including order placement, packing, dispatch, in-transit updates, and
-     * delivery. Return Journey: Contrary to the forward journey, the return
-     * journey involves the process of sending items back from the customer to the
-     * original sender or a designated return facility.
+     * - The type of journey for the shipment,
+     * indicating the direction of the shipment.
      */
     journey_type?: string;
 };
@@ -1646,18 +1407,11 @@ type Bags = {
      */
     parent_promo_bags?: any;
     /**
-     * - It contains the additional properties related to
-     * shipment status transition like Kafka_emission_status, user_name, etc.
-     * Additionally it is dynamic.
+     * - An object containing metadata for the item.
      */
     meta?: any;
     /**
-     * - This specifies the currency code for all
-     * amounts. The currency_code field will hold a string value representing the
-     * code for the currency in which all monetary amounts are denominated. This
-     * code typically follows the ISO 4217 standard, which uses three-letter
-     * alphabetic codes to define different currencies around the world. For
-     * example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
+     * - The code of the currency used.
      */
     currency_code?: string;
     /**
@@ -1666,7 +1420,6 @@ type Bags = {
     seller_identifier?: string;
     current_status?: CurrentStatus;
     article?: Article;
-    charges?: PriceAdjustmentCharge[];
 };
 /** @returns {FulfillingCompany} */
 declare function FulfillingCompany(): FulfillingCompany;
@@ -1725,7 +1478,7 @@ type Address = {
      */
     address?: string;
     /**
-     * - The type of the address (e.g., home, office).
+     * - The type of address.
      */
     address_type?: string;
     /**
@@ -1762,19 +1515,7 @@ type Address = {
      */
     contact_person?: string;
     /**
-     * - Category or classification of the
-     * address. The address_category field that includes "store", "delivery", and
-     * "billing" serves to classify addresses based on various business processes
-     *
-     * - 'store': Identifies addresses associated with physical retail locations or
-     * warehouses which is essential for inventory management, order
-     * fulfillment, and facilitating in-store pickups or returns.
-     * - 'delivery': Identifies addresses where orders are shipped to customers which
-     * ensures successful delivery, enhancing customer satisfaction, and
-     * optimizing logistics operations.
-     * - 'billing': Identifies addresses used for billing and financial transactions
-     * which are essential for payment processing, invoice generation, and
-     * maintaining financial accuracy.
+     * - The category of the address.
      */
     address_category?: string;
     /**
@@ -1809,27 +1550,11 @@ type Shipments = {
      */
     payment_info?: ShipmentPaymentInfo[];
     /**
-     * - Defines the specific journey a shipment
-     * will follow based on the application's operational needs and customer
-     * preferences. This field categorizes orders into distinct types, each
-     * associated with a unique processing flow. For example:
-     *
-     * - "HomeDelivery": The order undergoes all state transitions typical for a
-     * delivery, from processing the shipment to final delivery at the
-     * customer's address.
-     * - "PickAtStore": The order is prepared for pickup and moved to a state where it
-     * is ready to be handed over directly to the customer at the store. This
-     * type streamlines the process by bypassing traditional shipping stages
-     * and facilitating a quicker transition to the final handover stage.
+     * - The type of order.
      */
     order_type?: string;
     /**
-     * - A GST Number (Goods and Services Tax
-     * Identification Number, often abbreviated as GSTIN) is a unique identifier
-     * assigned to a business or individual registered under the Goods and
-     * Services Tax (GST) system in countries like India. The GST number is
-     * essential for businesses to comply with tax regulations and for the
-     * government to track tax payments and returns.
+     * - The GSTIN code for the shipment.
      */
     gstin_code?: string;
     /**
@@ -1956,8 +1681,7 @@ type Shipments = {
      * - The expected delivery date.
      */
     delivery_date?: string;
-    order?: OrderRequestSchema;
-    charges?: PriceAdjustmentCharge[];
+    order?: OrderRequest;
 };
 /** @returns {BagsForReorderArticleAssignment} */
 declare function BagsForReorderArticleAssignment(): BagsForReorderArticleAssignment;
@@ -2005,12 +1729,7 @@ type OrderSchema = {
      */
     total_shipments_in_order?: number;
     /**
-     * - A GST Number (Goods and Services Tax
-     * Identification Number, often abbreviated as GSTIN) is a unique identifier
-     * assigned to a business or individual registered under the Goods and
-     * Services Tax (GST) system in countries like India. The GST number is
-     * essential for businesses to comply with tax regulations and for the
-     * government to track tax payments and returns.
+     * - The GSTIN code for the shipment.
      */
     gstin_code?: string;
     user_info?: UserInfo;
@@ -2036,15 +1755,11 @@ type OrderSchema = {
      * individual shipments within the order.
      */
     shipments?: Shipments[];
-    /**
-     * - Order details.
-     */
-    bags_for_reorder?: BagsForReorder[];
     /**
      * - An array containing details
      * of bags available for reorder.
      */
-    charges?: PriceAdjustmentCharge[];
+    bags_for_reorder?: BagsForReorder[];
     /**
      * - An object containing additional metadata for the order.
      */
@@ -2174,9 +1889,9 @@ type ShipmentTrack = {
      */
     results?: Track[];
 };
-/** @returns {CustomerDetailsResponseSchema} */
-declare function CustomerDetailsResponseSchema(): CustomerDetailsResponseSchema;
-type CustomerDetailsResponseSchema = {
+/** @returns {CustomerDetailsResponse} */
+declare function CustomerDetailsResponse(): CustomerDetailsResponse;
+type CustomerDetailsResponse = {
     /**
      * - Customer's phone number.
      */
@@ -2198,9 +1913,9 @@ type CustomerDetailsResponseSchema = {
      */
     country?: string;
 };
-/** @returns {SendOtpToCustomerResponseSchema} */
-declare function SendOtpToCustomerResponseSchema(): SendOtpToCustomerResponseSchema;
-type SendOtpToCustomerResponseSchema = {
+/** @returns {SendOtpToCustomerResponse} */
+declare function SendOtpToCustomerResponse(): SendOtpToCustomerResponse;
+type SendOtpToCustomerResponse = {
     /**
      * - Unique identifier for the request.
      */
@@ -2230,9 +1945,9 @@ type VerifyOtp = {
      */
     request_id?: string;
 };
-/** @returns {VerifyOtpResponseSchema} */
-declare function VerifyOtpResponseSchema(): VerifyOtpResponseSchema;
-type VerifyOtpResponseSchema = {
+/** @returns {VerifyOtpResponse} */
+declare function VerifyOtpResponse(): VerifyOtpResponse;
+type VerifyOtpResponse = {
     /**
      * - Indicates whether the request was successful.
      */
@@ -2263,20 +1978,7 @@ type QuestionSet = {
 declare function BagReasons(): BagReasons;
 type BagReasons = {
     /**
-     * - List of QC (Quality Control) types -- having
-     * return reason types indicating the stage at which QC is performed. -
-     * "Doorstep QC" refers to the quality control checks that occur at the
-     * customer's doorstep. This could be part of a delivery process where the
-     * product is inspected for any damages, defects, or discrepancies in the
-     * presence of the customer before the final handover. - "Pre QC" represents a
-     * proactive quality control approach where the customer plays an active role
-     * in the QC process before the product is collected for return or exchange.
-     * In this procedure, customers are required to upload photos of the product
-     * for a preliminary quality check by the operations team. Approval from this
-     * team is necessary before a delivery partner is dispatched to pick up the
-     * product. This innovative method ensures that the product meets return or
-     * exchange criteria, streamlining the process for both the customer and the
-     * operations team, and minimizing unnecessary logistics movements.
+     * - A list of quality check types.
      */
     qc_type?: string[];
     /**
@@ -2308,12 +2010,6 @@ type ShipmentBagReasons = {
      * - Indicates if the operation was successful.
      */
     success?: boolean;
-    /**
-     * - The unique identifier for the rule that is
-     * associated with the given reasons. This ID serves as a reference to the
-     * specific rule within the RMA system that governs or influences the reasons listed.
-     */
-    rule_id?: number;
 };
 /** @returns {ShipmentReason} */
 declare function ShipmentReason(): ShipmentReason;
@@ -2443,24 +2139,13 @@ type Products = {
 declare function ProductsDataUpdatesFilters(): ProductsDataUpdatesFilters;
 type ProductsDataUpdatesFilters = {
     /**
-     * - Represents the specific line item within a
-     * bag, used to identify and reference a particular product in a list. This
-     * helps in pinpointing the exact item being updated or processed.
+     * - The specific line item of bag.
      */
     line_number?: number;
     /**
-     * - A unique string that serves as the
-     * 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.
+     * - The quantity of the product.
      */
     identifier?: string;
-    /**
-     * - The quantity of the product or item,
-     * specified as an integer. This indicates how many units of the product are
-     * being referenced or processed, such as the number of items in a bag or shipment.
-     */
-    quantity?: number;
 };
 /** @returns {ProductsDataUpdates} */
 declare function ProductsDataUpdates(): ProductsDataUpdates;
@@ -2499,9 +2184,9 @@ type DataUpdates = {
      */
     entities?: EntitiesDataUpdates[];
 };
-/** @returns {ShipmentsRequestSchema} */
-declare function ShipmentsRequestSchema(): ShipmentsRequestSchema;
-type ShipmentsRequestSchema = {
+/** @returns {ShipmentsRequest} */
+declare function ShipmentsRequest(): ShipmentsRequest;
+type ShipmentsRequest = {
     reasons?: ReasonsData;
     /**
      * - Specific bag to be updated.
@@ -2514,14 +2199,14 @@ type ShipmentsRequestSchema = {
      */
     identifier: string;
 };
-/** @returns {StatuesRequestSchema} */
-declare function StatuesRequestSchema(): StatuesRequestSchema;
-type StatuesRequestSchema = {
+/** @returns {StatuesRequest} */
+declare function StatuesRequest(): StatuesRequest;
+type StatuesRequest = {
     /**
-     * - A list containing
-     * information about shipments.
+     * - A list containing information
+     * about shipments.
      */
-    shipments?: ShipmentsRequestSchema[];
+    shipments?: ShipmentsRequest[];
     /**
      * - State to be change for
      * Remaining Bag/Products.
@@ -2532,22 +2217,21 @@ type StatuesRequestSchema = {
      */
     status?: string;
 };
-/** @returns {OrderRequestSchema} */
-declare function OrderRequestSchema(): OrderRequestSchema;
-type OrderRequestSchema = {
+/** @returns {OrderRequest} */
+declare function OrderRequest(): OrderRequest;
+type OrderRequest = {
     /**
      * - Metadata for the order.
      */
     meta?: any;
 };
-/** @returns {UpdateShipmentStatusRequestSchema} */
-declare function UpdateShipmentStatusRequestSchema(): UpdateShipmentStatusRequestSchema;
-type UpdateShipmentStatusRequestSchema = {
+/** @returns {UpdateShipmentStatusRequest} */
+declare function UpdateShipmentStatusRequest(): UpdateShipmentStatusRequest;
+type UpdateShipmentStatusRequest = {
     /**
-     * - An array containing different
-     * status details.
+     * - An array containing different status details.
      */
-    statuses?: StatuesRequestSchema[];
+    statuses?: StatuesRequest[];
     /**
      * - Indicates whether the task is active or required.
      */
@@ -2568,26 +2252,26 @@ type UpdateShipmentStatusRequestSchema = {
      */
     unlock_before_transition?: boolean;
 };
-/** @returns {StatusesBodyResponseSchema} */
-declare function StatusesBodyResponseSchema(): StatusesBodyResponseSchema;
-type StatusesBodyResponseSchema = {
+/** @returns {StatusesBodyResponse} */
+declare function StatusesBodyResponse(): StatusesBodyResponse;
+type StatusesBodyResponse = {
     /**
      * - List of shipments.
      */
     shipments?: any[];
 };
-/** @returns {ShipmentApplicationStatusResponseSchema} */
-declare function ShipmentApplicationStatusResponseSchema(): ShipmentApplicationStatusResponseSchema;
-type ShipmentApplicationStatusResponseSchema = {
+/** @returns {ShipmentApplicationStatusResponse} */
+declare function ShipmentApplicationStatusResponse(): ShipmentApplicationStatusResponse;
+type ShipmentApplicationStatusResponse = {
     /**
-     * - An array containing
-     * different status options of shipments.
+     * - An array containing different
+     * status options of shipments.
      */
-    statuses?: StatusesBodyResponseSchema[];
+    statuses?: StatusesBodyResponse[];
 };
-/** @returns {ErrorResponseSchema} */
-declare function ErrorResponseSchema(): ErrorResponseSchema;
-type ErrorResponseSchema = {
+/** @returns {ErrorResponse} */
+declare function ErrorResponse(): ErrorResponse;
+type ErrorResponse = {
     /**
      * - The HTTP status code of the response.
      */