@gofynd/fdk-client-javascript 3.12.0 → 3.14.0

package/sdk/platform/Order/OrderPlatformModel.js

@@ -266,7 +266,7 @@ const Joi = require("joi");
  *   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,
@@ -2473,7 +2473,7 @@ const Joi = require("joi");
  *   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
@@ -2819,63 +2819,72 @@ const Joi = require("joi");
 
 /**
  * @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
@@ -2884,12 +2893,12 @@ const Joi = require("joi");
 
 /**
  * @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.
  */
 
 /**
@@ -2921,14 +2930,20 @@ const Joi = require("joi");
 
 /**
  * @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]
@@ -2942,7 +2957,7 @@ const Joi = require("joi");
  * @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
@@ -2954,7 +2969,7 @@ const Joi = require("joi");
  * @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.
  */
@@ -2992,8 +3007,8 @@ const Joi = require("joi");
  *   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.
@@ -3001,20 +3016,20 @@ const Joi = require("joi");
 
 /**
  * @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
  */
 
 /**
@@ -3024,20 +3039,17 @@ const Joi = require("joi");
  *   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
@@ -3060,9 +3072,10 @@ const Joi = require("joi");
 
 /**
  * @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.
@@ -3091,7 +3104,6 @@ const Joi = require("joi");
 /**
  * @typedef CouponOwnershipSchema
  * @property {string} payable_category - Indicates who issued the coupon
- *   (MARKETPLACE or SELLER).
  */
 
 /**
@@ -3107,40 +3119,38 @@ const Joi = require("joi");
 
 /**
  * @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]
@@ -3153,40 +3163,39 @@ const Joi = require("joi");
 
 /**
  * @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]
@@ -3194,9 +3203,9 @@ const Joi = require("joi");
 
 /**
  * @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).
  */
 
 /**
@@ -3207,8 +3216,8 @@ const Joi = require("joi");
  *   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.
  */
 
 /**
@@ -3235,7 +3244,7 @@ const Joi = require("joi");
  *   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.
@@ -3245,6 +3254,9 @@ const Joi = require("joi");
  *   placed. Required when the order is placed from one company but fulfilled by another.
  * @property {boolean} [is_draft] - Indicates whether the order is a draft.
  *   Draft orders will be moved to upcoming state instead of placed status.
+ * @property {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.
  */
 
 /**
@@ -8604,9 +8616,9 @@ class OrderPlatformModel {
     return Joi.object({
       height: Joi.number().required(),
       length: Joi.number().required(),
+      width: Joi.number().required(),
       is_default: Joi.boolean().required(),
       unit: Joi.string().allow("").required(),
-      width: Joi.number().required(),
     });
   }
 
@@ -8923,6 +8935,7 @@ class OrderPlatformModel {
       b2b_gstin_number: Joi.string().allow(""),
       channel_company_id: Joi.string().allow(""),
       is_draft: Joi.boolean(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 

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

@@ -39,8 +39,14 @@ export = OrderPlatformValidator;
  * @typedef CreateOrderParam
  * @property {string} xOrderingSource - To uniquely identify the source through
  *   which order has been placed.
- * @property {string} [xApplicationId] - Application id
- * @property {string} [xExtensionId] - Extension id
+ * @property {string} [xApplicationId] - The Application ID is a unique
+ *   identifier assigned to a storefront that typically follows a 24-character
+ *   hexadecimal string. Either `x-application-id` or `x-extension-id` header is
+ *   mandatory. At least one of them must be provided.
+ * @property {string} [xExtensionId] - The Extension ID is a unique identifier
+ *   assigned to an extension that typically follows a 24-character hexadecimal
+ *   string. Either `x-application-id` or `x-extension-id` header is mandatory.
+ *   At least one of them must be provided.
  * @property {OrderPlatformModel.CreateOrderRequestSchema} body
  */
 /**
@@ -700,11 +706,17 @@ type CreateOrderParam = {
      */
     xOrderingSource: string;
     /**
-     * - Application id
+     * - The Application ID is a unique
+     * identifier assigned to a storefront that typically follows a 24-character
+     * hexadecimal string. Either `x-application-id` or `x-extension-id` header is
+     * mandatory. At least one of them must be provided.
      */
     xApplicationId?: string;
     /**
-     * - Extension id
+     * - The Extension ID is a unique identifier
+     * assigned to an extension that typically follows a 24-character hexadecimal
+     * string. Either `x-application-id` or `x-extension-id` header is mandatory.
+     * At least one of them must be provided.
      */
     xExtensionId?: string;
     body: OrderPlatformModel.CreateOrderRequestSchema;

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -49,8 +49,14 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef CreateOrderParam
  * @property {string} xOrderingSource - To uniquely identify the source through
  *   which order has been placed.
- * @property {string} [xApplicationId] - Application id
- * @property {string} [xExtensionId] - Extension id
+ * @property {string} [xApplicationId] - The Application ID is a unique
+ *   identifier assigned to a storefront that typically follows a 24-character
+ *   hexadecimal string. Either `x-application-id` or `x-extension-id` header is
+ *   mandatory. At least one of them must be provided.
+ * @property {string} [xExtensionId] - The Extension ID is a unique identifier
+ *   assigned to an extension that typically follows a 24-character hexadecimal
+ *   string. Either `x-application-id` or `x-extension-id` header is mandatory.
+ *   At least one of them must be provided.
  * @property {OrderPlatformModel.CreateOrderRequestSchema} body
  */
 

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts

@@ -82,6 +82,20 @@ declare class Serviceability {
      * @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoAreaExportJob/).
      */
     createGeoAreaExportJob({ geoareaId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateGeoAreaExportJobParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GeoAreaBulkCreationResult>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.CreateShipmentsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.PlatformShipmentsResponseSchema>}
+     *   - Success response
+     *
+     * @name createShipments
+     * @summary: Create and return shipments
+     * @description: Create and return shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createShipments/).
+     */
+    createShipments({ body, xOrderingSource, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateShipmentsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PlatformShipmentsResponseSchema>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -508,6 +508,91 @@ class Serviceability {
     return response;
   }
 
+  /**
+   * @param {ServiceabilityPlatformApplicationValidator.CreateShipmentsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ServiceabilityPlatformModel.PlatformShipmentsResponseSchema>}
+   *   - Success response
+   *
+   * @name createShipments
+   * @summary: Create and return shipments
+   * @description: Create and return shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createShipments/).
+   */
+  async createShipments(
+    { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ServiceabilityPlatformApplicationValidator.createShipments().validate(
+      {
+        body,
+        xOrderingSource,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ServiceabilityPlatformApplicationValidator.createShipments().validate(
+      {
+        body,
+        xOrderingSource,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Serviceability > createShipments \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipments`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ServiceabilityPlatformModel.PlatformShipmentsResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Serviceability > createShipments \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ServiceabilityPlatformApplicationValidator.CreateStoreRulesParam} arg
    *   - Arg object