@gofynd/fdk-client-javascript 3.11.0 → 3.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -6
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +71 -12
  5. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +80 -80
  6. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -48
  7. package/sdk/platform/Cart/CartPlatformModel.d.ts +6 -18
  8. package/sdk/platform/Cart/CartPlatformModel.js +2 -36
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +14 -48
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +85 -338
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +207 -763
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +107 -392
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -71
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +14 -60
  15. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +36 -0
  16. package/sdk/platform/Order/OrderPlatformApplicationClient.js +252 -0
  17. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +34 -1
  18. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +42 -0
  19. package/sdk/platform/Order/OrderPlatformClient.d.ts +69 -7
  20. package/sdk/platform/Order/OrderPlatformClient.js +453 -7
  21. package/sdk/platform/Order/OrderPlatformModel.d.ts +1938 -493
  22. package/sdk/platform/Order/OrderPlatformModel.js +1238 -506
  23. package/sdk/platform/Order/OrderPlatformValidator.d.ts +162 -16
  24. package/sdk/platform/Order/OrderPlatformValidator.js +111 -9
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +14 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +85 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -1
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +16 -0
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +861 -178
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +534 -84
  31. package/sdk/public/Webhook/WebhookPublicModel.d.ts +5 -0
  32. package/sdk/public/Webhook/WebhookPublicModel.js +2 -0
@@ -240,7 +240,7 @@ export = OrderPlatformModel;
240
240
  * bag, used to identify and reference a particular product in a list. This
241
241
  * helps in pinpointing the exact item being updated or processed.
242
242
  * @property {string} [identifier] - A unique string that serves as the
243
- * products identifier, such as a SKU, barcode, or another distinct code.
243
+ * product's identifier, such as a SKU, barcode, or another distinct code.
244
244
  * This ensures the product is correctly identified and distinguished from
245
245
  * other items in the system.
246
246
  * @property {number} [quantity] - The quantity of the product or item,
@@ -395,8 +395,8 @@ export = OrderPlatformModel;
395
395
  */
396
396
  /**
397
397
  * @typedef DPConfiguration
398
- * @property {string} [shipping_by] - Shipping_by denotes dp assignment
399
- * strategy- if shipping_by is fynd dp assignment would be handled by OMS
398
+ * @property {string} [shipping_by] - It denotes DP assignment strategy. If it
399
+ * is fynd, DP assignment will be handled by Fynd's OMS.
400
400
  */
401
401
  /**
402
402
  * @typedef PaymentConfig
@@ -413,17 +413,18 @@ export = OrderPlatformModel;
413
413
  */
414
414
  /**
415
415
  * @typedef CreateOrderConfig
416
- * @property {DPConfiguration} dp_configuration
417
- * @property {boolean} [location_reassignment] - Flag denotes if the location
418
- * for the store needs to be reassigned post cancellation. If true,location
419
- * for the store gets auto reassigned post cancellation, if set false location
420
- * reassignment will not be performed as its disabled.
416
+ * @property {DPConfiguration} [dp_configuration]
417
+ * @property {boolean} [location_reassignment] - The flag denotes if the
418
+ * location for the shipment needs to be reassigned after cancellation. If the
419
+ * flag is set to true, location for the shipment gets auto reassigned post
420
+ * cancellation. If set to false, location reassignment will not be performed
421
+ * as it is disabled.
421
422
  * @property {PaymentConfig} [payment]
422
423
  * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
423
- * breaking strategy. If the flag is set true, the shipment is created using
424
- * optimal shipment creation strategy based on the servicability & packaging
425
- * dimensions by OMS .If false, shipment details, including location_id, must
426
- * be passed to FDK for processing.
424
+ * breaking strategy. If the flag is set to true, the shipment is created
425
+ * using an optimal shipment creation strategy based on the serviceability &
426
+ * packaging dimensions by OMS. If the flag is set to false, shipment details
427
+ * and location_id, must be passed to FDK for processing.
427
428
  * @property {LockStateMessage[]} [lock_state_messages] - A list of
428
429
  * state-specific custom lock messages.
429
430
  * @property {string} [integration_type] - Flag denotes integration type which
@@ -663,8 +664,7 @@ export = OrderPlatformModel;
663
664
  */
664
665
  /**
665
666
  * @typedef CreateOrderResponseSchema
666
- * @property {string} fynd_order_id - A string that represents the unique
667
- * identifier assigned to the order.
667
+ * @property {string} fynd_order_id - Unique identifier assigned to the order
668
668
  */
669
669
  /**
670
670
  * @typedef DispatchManifest
@@ -873,8 +873,8 @@ export = OrderPlatformModel;
873
873
  * @property {string} [ordering_channel] - The specific channel through which
874
874
  * your order was placed. This field will be phased out after version 2.4.0.
875
875
  * Please use ordering_source instead to ensure accurate order tracking and processing.
876
- * @property {string} [ordering_source] - To uniquely identify the source
877
- * through which order has been placed (e.g, marketplace, gofynd).
876
+ * @property {string} [ordering_source] - Ordering source, to be used to
877
+ * identify source of order creation.
878
878
  * @property {Object} [meta] - Meta data of the order data contains additional,
879
879
  * potentially dynamic information about the order data.
880
880
  * @property {number} [cod_charges]
@@ -978,7 +978,7 @@ export = OrderPlatformModel;
978
978
  */
979
979
  /**
980
980
  * @typedef Tax
981
- * @property {string} name - The name of the tax, indicating its purpose (e.g.,
981
+ * @property {string} name - The name of the tax indicating its purpose (e.g.,
982
982
  * VAT, sales tax).
983
983
  * @property {number} rate - The tax rate as a decimal, applied to the transaction amount.
984
984
  * @property {Object[]} [breakup] - An array of objects detailing the components
@@ -994,16 +994,20 @@ export = OrderPlatformModel;
994
994
  */
995
995
  /**
996
996
  * @typedef Charge
997
- * @property {string} name - The name of the charge that indicates its purpose.
998
997
  * @property {AmountSchema} amount
999
- * @property {Tax} [tax]
998
+ * @property {string} type - The category or type of the charge.
999
+ * @property {string} name - The name of the charge that indicates its purpose.
1000
1000
  * @property {string} [code] - An optional code associated with the charge for
1001
1001
  * internal tracking.
1002
- * @property {string} type - The category or type of the charge.
1002
+ * @property {Tax} [tax]
1003
1003
  */
1004
1004
  /**
1005
1005
  * @typedef LineItem
1006
- * @property {Charge[]} [charges] - An array of Charge objects related to the line item.
1006
+ * @property {Charge[]} [charges] - An array of Charge objects related to the
1007
+ * line item. This array must include three mandatory charge types:
1008
+ * amount_paid, price_effective and price_marked. Formula to calculate
1009
+ * amount_paid = price_effective + cod_charges + delivery_charges -
1010
+ * coupon_discount - promo_discount
1007
1011
  * @property {Object} [meta] - An object containing metadata relevant to
1008
1012
  * articles or line items.
1009
1013
  * @property {string} [custom_message] - A string for any special instructions
@@ -1055,37 +1059,33 @@ export = OrderPlatformModel;
1055
1059
  */
1056
1060
  /**
1057
1061
  * @typedef Shipment
1058
- * @property {LineItem[]} line_items - An array of LineItem objects that
1059
- * represent the items included in the shipment.
1062
+ * @property {LineItem[]} line_items - An array of objects that represent the
1063
+ * items included in the shipment.
1060
1064
  * @property {string} [external_shipment_id] - External shipment identifier or
1061
1065
  * marketplace's unique shipment identifier.
1062
1066
  * @property {ProcessingDates} [processing_dates]
1063
1067
  * @property {Object} [meta] - Meta data of the shipment contains additional,
1064
1068
  * potentially dynamic information about the shipment.
1065
- * @property {number} [priority] - An integer indicating the priority level of
1066
- * the shipment.
1067
- * @property {number} [location_id] - Location Identifier or Store/Fulfillment
1068
- * Identifier of the shipment- This field is mandatory when
1069
- * optimal_shipment_creation flag is set to false, indicating that shipments
1070
- * must be associated with a specific location. When
1071
- * `optimal_shipment_creation` is true, the optimal location for order
1072
- * creation would be assigned, location_id becomes optional.
1069
+ * @property {number} [priority] - Priority level of the shipment.
1070
+ * @property {number} [location_id] - Location/store/fulfillment identifier of
1071
+ * the shipment. This field is mandatory when optimal_shipment_creation flag
1072
+ * is set to false, indicating that shipments must be associated with a
1073
+ * specific location. When optimal_shipment_creation is true, location_id
1074
+ * becomes optional and the system automatically assigns the optimal location
1075
+ * for order creation.
1073
1076
  * @property {string} [order_type] - Defines the specific journey a shipment
1074
1077
  * will follow based on the application's operational needs and customer
1075
1078
  * preferences. This field categorizes orders into distinct types, each
1076
- * associated with a unique processing flow. For example:
1077
- *
1078
- * - "HomeDelivery": The order undergoes all state transitions typical for a
1079
- * delivery, from processing the shipment to final delivery at the
1080
- * customer's address.
1081
- * - "PickAtStore": The order is prepared for pickup and moved to a state where it
1082
- * is ready to be handed over directly to the customer at the store. This
1083
- * type streamlines the process by bypassing traditional shipping stages
1084
- * and facilitating a quicker transition to the final handover stage.
1085
- * - "Digital": This order type likely refers to orders that involve digital goods
1086
- * or services, such as software, digital subscriptions, e-books, online
1087
- * courses, or any other item that can be delivered electronically.
1088
- *
1079
+ * associated with a unique processing flow. For example, "HomeDelivery": The
1080
+ * order undergoes all state transitions typical for a delivery, from
1081
+ * processing the shipment to final delivery at the customer's address.
1082
+ * "PickAtStore": The order is prepared for pickup and moved to a state where
1083
+ * it is ready to be handed over directly to the customer at the store. This
1084
+ * type streamlines the process by bypassing traditional shipping stages and
1085
+ * facilitating a quicker transition to the final handover stage. "Digital":
1086
+ * This order type likely refers to orders that involve digital goods or
1087
+ * services, such as software, digital subscriptions, e-books, online courses,
1088
+ * or any other item that can be delivered electronically.
1089
1089
  * @property {string[]} [tags]
1090
1090
  * @property {SystemMessages[]} [system_messages]
1091
1091
  * @property {ProcessAfterConfig} [process_after_config]
@@ -1127,55 +1127,46 @@ export = OrderPlatformModel;
1127
1127
  */
1128
1128
  /**
1129
1129
  * @typedef ShippingInfo
1130
- * @property {string} [alternate_mobile_number] - A string for an alternate
1131
- * mobile number to reach the customer, providing an additional contact method.
1132
- * @property {string} [state] - A string representing the name of the state for
1133
- * shipping purposes.
1134
- * @property {string} [customer_code] - A string representing the customer's
1135
- * unique identifier in the seller's system.
1130
+ * @property {string} [alternate_mobile_number] - Alternate mobile number to
1131
+ * reach the customer, providing an additional contact method.
1132
+ * @property {string} [state] - The name of the state for shipping purposes.
1133
+ * @property {string} [customer_code] - Customer's unique identifier in the
1134
+ * seller's system.
1136
1135
  * @property {string} [shipping_type] - Specifies the method or service used for
1137
1136
  * the shipping of the shipment.
1138
- * @property {string} [middle_name] - A string containing the customer's middle name.
1139
- * @property {string} [primary_mobile_number] - A string for the customer's
1140
- * primary mobile number.
1141
- * @property {string} [last_name] - A string containing the customer's last name.
1137
+ * @property {string} [middle_name] - Customer's middle name
1138
+ * @property {string} [primary_mobile_number] - Customer's primary mobile number
1139
+ * @property {string} [last_name] - Customer's last name
1142
1140
  * @property {GeoLocationSchema} [geo_location]
1143
- * @property {string} [gender] - A string representing the customer's gender.
1144
- * @property {string} [house_no] - A string representing the house or apartment
1145
- * number of the customer.
1146
- * @property {string} [first_name] - A string representing the customer's first name.
1147
- * @property {string} [title] - A string representing the customer's title or prefix.
1148
- * @property {string} [landmark] - A string representing a landmark or reference
1149
- * point near the customer's location.
1150
- * @property {string} [country] - A string representing the customer's country.
1151
- * @property {string} [address_type] - A string representing the address type in
1152
- * the seller's system.
1153
- * @property {string} [state_code] - A string representing the state code of the
1154
- * customer's location.
1155
- * @property {string} [city] - A string representing the city of the customer's location.
1156
- * @property {string} [external_customer_code] - A string representing an
1157
- * external customer code in the seller's system.
1158
- * @property {string} [floor_no] - A string representing the floor number of the
1159
- * customer's location.
1160
- * @property {string} [alternate_email] - A string representing an alternate
1161
- * email address for the customer.
1141
+ * @property {string} [gender] - Customer's gender
1142
+ * @property {string} [house_no] - The house or apartment number of the customer.
1143
+ * @property {string} [first_name] - Customer's first name
1144
+ * @property {string} [title] - Customer's title or prefix
1145
+ * @property {string} [landmark] - Landmark or reference point near the
1146
+ * customer's location
1147
+ * @property {string} [country] - Customer's country
1148
+ * @property {string} [address_type] - Address type in the seller's system
1149
+ * @property {string} [state_code] - State code of the customer's location
1150
+ * @property {string} [city] - City of the customer's location
1151
+ * @property {string} [external_customer_code] - External customer code in the
1152
+ * seller's system
1153
+ * @property {string} [floor_no] - Floor number of the customer's location
1154
+ * @property {string} [alternate_email] - Alternate email address for the customer
1162
1155
  * @property {Object[]} [slot] - A list of objects representing available time
1163
1156
  * slot for delivery or pickup.
1164
1157
  * @property {string} [address] - A comma-separated string representing the address.
1165
- * @property {string} [area] - A string representing the area of the customer's location.
1166
- * @property {string} [address1] - A string representing the first line of the address.
1167
- * @property {string} [pincode] - A string representing the pincode of the
1168
- * customer's location.
1169
- * @property {string} [primary_email] - A string representing the primary email
1170
- * address for the customer.
1171
- * @property {string} [address2] - A string representing the second line of the address.
1158
+ * @property {string} [area] - Area of the customer's location
1159
+ * @property {string} [address1] - First line of the address
1160
+ * @property {string} [pincode] - Pincode of the customer's location
1161
+ * @property {string} [primary_email] - Primary email address for the customer
1162
+ * @property {string} [address2] - Second line of the address
1172
1163
  * @property {string} [country_code] - Uniquely identifies the country
1173
1164
  * associated with the shipping address. This code is essential for
1174
1165
  * international shipments, ensuring accurate routing and delivery across
1175
1166
  * global postal and customs services. Examples include 'US' for the United
1176
1167
  * States, 'IN' for India.
1177
1168
  * @property {string} [country_iso_code] - Specifies the country's unique
1178
- * identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
1169
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
1179
1170
  * is crucial for distinguishing countries in international transactions, data
1180
1171
  * processing, and shipping logistics.
1181
1172
  */
@@ -1203,13 +1194,11 @@ export = OrderPlatformModel;
1203
1194
  * @property {string} [floor_no]
1204
1195
  * @property {string} [alternate_email]
1205
1196
  * @property {string} [address]
1206
- * @property {string} [area] - A string representing the area of the customer's location.
1207
- * @property {string} [address1] - A string representing the first line of the address.
1208
- * @property {string} [pincode] - A string representing the pincode of the
1209
- * customer's location.
1210
- * @property {string} [primary_email] - A string representing the primary email
1211
- * address for the customer.
1212
- * @property {string} [address2] - A string representing the second line of the address.
1197
+ * @property {string} [area] - Area of the customer's location
1198
+ * @property {string} [address1] - First line of the address
1199
+ * @property {string} [pincode] - Pincode of the customer's location
1200
+ * @property {string} [primary_email] - Primary email address for the customer
1201
+ * @property {string} [address2] - Second line of the address
1213
1202
  * @property {string} [country_code] - Uniquely identifies the country
1214
1203
  * associated with the billing address details. This code is essential for
1215
1204
  * international shipments, ensuring accurate routing and delivery across
@@ -1222,34 +1211,28 @@ export = OrderPlatformModel;
1222
1211
  /**
1223
1212
  * @typedef UserInfo
1224
1213
  * @property {string} [user_id] - The unique identifier assigned to the user.
1225
- * @property {string} [user_type] - A string representing the type of the user.
1226
- * @property {string} [primary_email] - A string representing the primary email
1227
- * address for the user.
1228
- * @property {string} [gender] - A string specifying the gender of the user.
1229
- * @property {string} first_name - A string which specifies the user's first name.
1230
- * @property {string} [last_name] - A string which specifies the user's last name.
1231
- * @property {string} primary_mobile_number - A string representing the primary
1232
- * mobile number for the user.
1214
+ * @property {string} [user_type] - Type of the user
1215
+ * @property {string} [primary_email] - Primary email address for the user
1216
+ * @property {string} [gender] - Gender of the user
1217
+ * @property {string} first_name - User's first name
1218
+ * @property {string} [last_name] - User's last name
1219
+ * @property {string} primary_mobile_number - Primary mobile number for the user
1233
1220
  */
1234
1221
  /**
1235
1222
  * @typedef TaxInfo
1236
- * @property {string} [b2b_gstin_number] - A string representing the GSTIN
1237
- * (Goods and Services Tax Identification Number) for business-to-business
1238
- * transactions.
1239
- * @property {string} [gstin] - A string that specifies the GSTIN for the seller.
1240
- * @property {string} [pan_no] - A string representing the PAN assigned to
1241
- * individuals or entities for tax purposes in India.
1223
+ * @property {string} [b2b_gstin_number] - Goods and Services Tax Identification
1224
+ * Number (GSTIN) for business-to-business transactions
1225
+ * @property {string} [gstin] - GSTIN of the customer
1226
+ * @property {string} [pan_no] - PAN assigned to individuals or entities for tax
1227
+ * purposes in India
1242
1228
  */
1243
1229
  /**
1244
1230
  * @typedef PaymentMethod
1245
- * @property {string} collect_by - A string indicating the entity responsible
1246
- * for collecting the payment.
1247
- * @property {string} mode - A string that specifies the mode of payment. Refer
1248
- * to [API & references (in Nav bar) → Payment Modes] for a list of valid
1249
- * payment methods.
1250
- * @property {string} refund_by - A string that indicates the entity responsible
1251
- * for processing refunds.
1252
- * @property {string} name - A string representing the name of the payment method.
1231
+ * @property {string} collect_by - Entity responsible for collecting the payment
1232
+ * @property {string} mode - Mode of payment. Refer to [API & references (in Nav
1233
+ * bar) Payment Modes] for a list of valid payment methods.
1234
+ * @property {string} refund_by - Entity responsible for processing refunds
1235
+ * @property {string} name - Name of the payment method
1253
1236
  * @property {number} amount - A number representing the monetary value
1254
1237
  * associated with the payment method.
1255
1238
  * @property {Object} [meta] - An object for any additional metadata related to
@@ -1259,18 +1242,16 @@ export = OrderPlatformModel;
1259
1242
  */
1260
1243
  /**
1261
1244
  * @typedef PaymentInfo
1262
- * @property {string} primary_mode - A string that indicates the primary payment
1263
- * method used for the order.
1264
- * @property {string} [payment_mode] - A string that indicates the payment mode
1265
- * used for the order.
1245
+ * @property {string} primary_mode - Primary payment method used for the order
1246
+ * @property {string} [payment_mode] - Payment mode used for the order
1266
1247
  * @property {PaymentMethod[]} [payment_methods] - A lists all available payment
1267
1248
  * methods used in the transaction.
1268
1249
  */
1269
1250
  /**
1270
1251
  * @typedef CreateOrderAPI
1271
1252
  * @property {Shipment[]} shipments - List of Shipments which includes shipment
1272
- * data like shipment items, shipment promise, Shipment type, shipment order
1273
- * type, shipment dp options etc.
1253
+ * data like shipment items, shipment promise, shipment type, shipment order
1254
+ * type, shipment DP options etc.
1274
1255
  * @property {ShippingInfo} shipping_info
1275
1256
  * @property {ShippingInfo} billing_info
1276
1257
  * @property {Object} [currency_info] - This object can accommodate a range of
@@ -1278,10 +1259,9 @@ export = OrderPlatformModel;
1278
1259
  * comprehensive details about the currency or currencies involved in a transaction.
1279
1260
  * @property {string} [external_order_id] - A unique identifier for the order
1280
1261
  * assigned by an external system.
1281
- * @property {Charge[]} [charges] - An array of charge objects that detail the
1282
- * various fees associated with the order.
1283
- * @property {string} [external_creation_date] - A string that specifies the
1284
- * date and time when the order was created in an external system
1262
+ * @property {Charge[]} [charges] - It details the various fees associated with the order.
1263
+ * @property {string} [external_creation_date] - Date and time when the order
1264
+ * was created in an external system
1285
1265
  * @property {Object} [meta] - Meta data of the order that contains additional,
1286
1266
  * potentially dynamic information about the order.
1287
1267
  * @property {TaxInfo} [tax_info]
@@ -1295,8 +1275,7 @@ export = OrderPlatformModel;
1295
1275
  * specifying whether the order is in a 'pendency' state (awaiting further
1296
1276
  * action) or marked as 'complete'.
1297
1277
  * @property {SystemMessages[]} [system_messages]
1298
- * @property {string} [order_type] - A string that specifies the type of order
1299
- * being placed.
1278
+ * @property {string} [order_type] - Type of order being placed
1300
1279
  * @property {string} [fynd_order_id] - Unique identifier for the order.
1301
1280
  * @property {string} [application_id] - A unique identifier for the application
1302
1281
  * or system that is making the order request.
@@ -2283,7 +2262,7 @@ export = OrderPlatformModel;
2283
2262
  * associated with a unique processing flow. For example:
2284
2263
  *
2285
2264
  * - "HomeDelivery": The order goes through all the steps needed for delivery,
2286
- * from being packed to arriving at the customers address.
2265
+ * from being packed to arriving at the customer's address.
2287
2266
  * - "PickAtStore": The order is prepared for pickup at the store, skipping
2288
2267
  * shipping steps to make it ready faster for the customer to collect in person.
2289
2268
  * - "Digital": This order type likely refers to orders that involve digital goods
@@ -2378,8 +2357,8 @@ export = OrderPlatformModel;
2378
2357
  * @property {string} [ordering_channel] - The specific channel through which
2379
2358
  * your order was placed. This field will be phased out after version 2.4.0.
2380
2359
  * Please use ordering_source instead to ensure accurate order tracking and processing.
2381
- * @property {string} [ordering_source] - To uniquely identify the source
2382
- * through which order has been placed (e.g, marketplace, gofynd).
2360
+ * @property {string} [ordering_source] - Ordering source, to be used to
2361
+ * identify source of order creation.
2383
2362
  * @property {string} entity - The type of entity that the configuration pertains to.
2384
2363
  */
2385
2364
  /**
@@ -2592,9 +2571,421 @@ export = OrderPlatformModel;
2592
2571
  * @property {string} small - URL for the small version of the payment method's logo.
2593
2572
  */
2594
2573
  /**
2595
- * @typedef ValidationError
2596
- * @property {string} message - A brief description of the error encountered.
2597
- * @property {string} field - The field in the request that caused the error.
2574
+ * @typedef FulfillmentOptionSchema
2575
+ * @property {string} [name] - The name of the fulfillment option (e.g.,
2576
+ * 'Standard Shipping', 'Express Delivery').
2577
+ * @property {string} [slug] - A unique identifier for the fulfillment option.
2578
+ * @property {boolean} [is_default] - The category or method of fulfillment
2579
+ * (e.g., 'Pickup', 'Delivery', 'Courier').
2580
+ * @property {string} [type] - Indicates whether this fulfillment option is the
2581
+ * default choice for customers.
2582
+ */
2583
+ /**
2584
+ * @typedef PaymentMethodGatewaySchema
2585
+ * @property {string} name - Payment gateway name e.g., Razorpay, Stripe, etc.
2586
+ * @property {string} [logo]
2587
+ */
2588
+ /**
2589
+ * @typedef SubModeOfPaymentSchema
2590
+ * @property {string} name - Name of the sub-mode of payment. For example, if
2591
+ * the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
2592
+ */
2593
+ /**
2594
+ * @typedef PaymentMethodModeOfPaymentSchema
2595
+ * @property {string} name - Payment mode name e.g., Credit Card, Debit Card,
2596
+ * Net Banking, Wallet, etc.
2597
+ * @property {string} slug - Slug of the payment mode e.g., cc, dc, nb, wl, etc.
2598
+ * @property {SubModeOfPaymentSchema} [sub_mode_of_payment]
2599
+ */
2600
+ /**
2601
+ * @typedef PaymentMethodTransactionPartySchema
2602
+ * @property {string} refund_bearer - Entity responsible for refunding the
2603
+ * amount paid by the customer
2604
+ * @property {string} collection_bearer - Entity responsible for collection of
2605
+ * amount paid by the customer
2606
+ */
2607
+ /**
2608
+ * @typedef LineItemPaymentMethodSchema
2609
+ * @property {PaymentMethodGatewaySchema} [gateway]
2610
+ * @property {PaymentMethodModeOfPaymentSchema} [mode_of_payment]
2611
+ * @property {number} [amount_paid] - Total amount paid by this payment method
2612
+ * @property {string} [payment_identifier] - Transaction id
2613
+ * @property {PaymentMethodTransactionPartySchema} [transaction_party]
2614
+ */
2615
+ /**
2616
+ * @typedef BundleDetailsSchema
2617
+ * @property {boolean} [is_base] - This serves as the base item, with all other
2618
+ * items acting as child elements within the bundle to display the hero
2619
+ * product prominently at the top.
2620
+ * @property {string[]} [images] - An array of image URLs associated with the bundle.
2621
+ * @property {string} [group_id] - Unique group identifier for the bundle
2622
+ * generated by seller to club the articles
2623
+ * @property {string} [name] - Name of the bundle.
2624
+ * @property {string} [item_type] - Type of the bundle item
2625
+ * @property {number} [item_id] - Unique identifier of the item.
2626
+ * @property {string} [item_code] - Item code for the item.
2627
+ * @property {string} [item_name] - Name of the item.
2628
+ * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
2629
+ * @property {number} [bundle_article_quantity] - In orders with multiple
2630
+ * quantities of the same line item, the line item count remains constant, but
2631
+ * multiple bundles can exist. To distinguish between these bundles, the
2632
+ * article quantity must be used.
2633
+ * @property {string} [brand_name] - Identifier for the brand name.
2634
+ * @property {string} [size] - Size associated with the bundle item.
2635
+ */
2636
+ /**
2637
+ * @typedef LineItemMonetaryValuesSchema
2638
+ * @property {number} amount_paid - Amount paid by the customer
2639
+ * @property {number} price_effective - The final effective price after applying
2640
+ * discounts, promotional offers, and adjustments.
2641
+ * @property {number} [discount] - Discount amount apart from promo and coupon discount
2642
+ * @property {number} price_marked - The original marked price of the item
2643
+ * before any discounts or promotions.
2644
+ * @property {number} [coupon_discount] - Coupon discount applied for this article
2645
+ * @property {number} [cod_charges] - Cash on Delivery Charges Applied for this Article.
2646
+ * @property {number} [promo_discount] - Promotion Discount
2647
+ * @property {number} [gift_price] - Gift Price
2648
+ * @property {number} [delivery_charges] - Delivery Charges Applied for this Article.
2649
+ */
2650
+ /**
2651
+ * @typedef DimensionSchema
2652
+ * @property {number} height - Height of the product.
2653
+ * @property {number} length - Length of the product.
2654
+ * @property {number} width - Width of the product
2655
+ * @property {boolean} is_default - Not Modified, meaning these are same as
2656
+ * product uploaded while loading catelogue.
2657
+ * @property {string} unit - Unit of the measurement used.
2658
+ */
2659
+ /**
2660
+ * @typedef GiftDetailsSchema
2661
+ * @property {number} amount - Specifies the value or cost of the gift
2662
+ * associated with the order line item.
2663
+ * @property {string} display_text - A short description or label intended for
2664
+ * display purposes. This can be a message to the customer, such as "Gift wrap
2665
+ * included" or "Gift card value applied."
2666
+ */
2667
+ /**
2668
+ * @typedef CPRiderDetailsSchema
2669
+ * @property {string} name
2670
+ * @property {string} phone
2671
+ */
2672
+ /**
2673
+ * @typedef CPAreaCodeSchema
2674
+ * @property {string} source
2675
+ * @property {string} destination
2676
+ */
2677
+ /**
2678
+ * @typedef CPTatToDeliverTheShipmentSchema
2679
+ * @property {number} min
2680
+ * @property {number} max
2681
+ */
2682
+ /**
2683
+ * @typedef CPOptionsSchema
2684
+ * @property {string} [extension_id] - A string that uniquely identifies the
2685
+ * courier partner extension. Refer <a
2686
+ * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
2687
+ * courier partner account</a> to get the extension id.
2688
+ * @property {string} [scheme_id] - A string that specifies the unique
2689
+ * identifier for the scheme associated with the account. Refer <a
2690
+ * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
2691
+ * courier partner account</a> to get the scheme id.
2692
+ * @property {CPAreaCodeSchema} [area_code]
2693
+ * @property {boolean} [is_self_ship]
2694
+ * @property {number} [max_reattempts_for_delivery_allowed]
2695
+ * @property {string} [cp_sort_key] - A sorting key used for categorizing or
2696
+ * sorting courier partners, often related to their performance, costs, or
2697
+ * some other factor, (example: E-17A-4, E-17A-6, etc.).
2698
+ * @property {string} [name] - The name of the courier partner or the delivery
2699
+ * agent handling the shipment.
2700
+ * @property {CPRiderDetailsSchema} [rider_details]
2701
+ * @property {boolean} [using_own_creds] - Specifies whether the seller's
2702
+ * credentials are being used for the courier partner.
2703
+ * @property {boolean} [qc_supported] - Specifies that Assigned CP support's
2704
+ * quality checks
2705
+ */
2706
+ /**
2707
+ * @typedef CourierPartnerDetailsSchema
2708
+ * @property {string} [cp_sort_key] - A sorting key used for categorizing or
2709
+ * sorting courier partners, often related to their performance, costs, or
2710
+ * some other factor. (example: E-17A-4, E-17A-6, etc.).
2711
+ * @property {CPOptionsSchema[]} [cp_options] - Other Available CP's
2712
+ * @property {string} scheme_id
2713
+ * @property {string} name - The name of the courier partner or the delivery
2714
+ * agent handling the shipment.
2715
+ * @property {string} extension_id
2716
+ * @property {CPRiderDetailsSchema} [rider_details]
2717
+ * @property {boolean} [qc_supported] - Specifies that Assigned CP support's
2718
+ * quality checks
2719
+ * @property {boolean} using_own_creds - Specifies weather the Seller's Creds or
2720
+ * Fynd's Creds are being used.
2721
+ * @property {number} [max_reattempts_for_delivery_allowed] - Reattempts Allowed
2722
+ * (required for NDR)
2723
+ * @property {CPTatToDeliverTheShipmentSchema} [tat_to_deliver_the_shipment]
2724
+ * @property {boolean} [is_self_ship] - Is every logistic action handled by seller.
2725
+ */
2726
+ /**
2727
+ * @typedef TaxDetailsSchema
2728
+ * @property {string} hs_code - The HS code of the product
2729
+ * @property {string} tax_rule_id - Tax identifier.
2730
+ */
2731
+ /**
2732
+ * @typedef PromiseDetailsSchema
2733
+ * @property {number} min_sla - Min TimeStamp (EPOCH) that will be taken to
2734
+ * deliver the product
2735
+ * @property {number} max_sla - Max TimeStamp (EPOCH) that will be taken to
2736
+ * deliver the product.
2737
+ */
2738
+ /**
2739
+ * @typedef CustomerPickupSlotSchema
2740
+ * @property {string} start_time
2741
+ * @property {string} end_time
2742
+ */
2743
+ /**
2744
+ * @typedef DpPickupSlotSchema
2745
+ * @property {string} start_time
2746
+ * @property {string} end_time
2747
+ */
2748
+ /**
2749
+ * @typedef OrderFulfillmentTimelineSchema
2750
+ * @property {DpPickupSlotSchema} [dp_pickup_slot]
2751
+ * @property {string} [dispatch_after_date] - A date indicating when the order
2752
+ * can be dispatched (e.g., the earliest possible dispatch date).
2753
+ * @property {string} [dispatch_by_date] - The latest date the order must be
2754
+ * dispatched to meet delivery expectations.
2755
+ * @property {string} [confirm_by_date] - The deadline by which the seller must
2756
+ * confirm the order.
2757
+ * @property {CustomerPickupSlotSchema} [customer_pickup_slot]
2758
+ * @property {string} [pack_by_date] - The latest time the package should be
2759
+ * packed and ready to dispatch.
2760
+ */
2761
+ /**
2762
+ * @typedef LineItemSchema
2763
+ * @property {string} [seller_identifier] - Identifier of the seller selling the item.
2764
+ * @property {LineItemPaymentMethodSchema[]} payment_methods - Payment methods
2765
+ * used to sell this order.
2766
+ * @property {LineItemMonetaryValuesSchema} monetary_values
2767
+ * @property {GiftDetailsSchema} [gift_details]
2768
+ * @property {string} [special_instructions] - These instructions are added by
2769
+ * the customer at checkout for the seller's reference.
2770
+ * @property {DimensionSchema} [dimension]
2771
+ * @property {number} [quantity] - Quantity of the Line Item
2772
+ * @property {string} [external_line_id] - Unique identifier for the LineItem as
2773
+ * assigned by an external system. You can use this to map external id to
2774
+ * Fynd's generated id
2775
+ * @property {BundleDetailsSchema} [bundle_details]
2776
+ * @property {Object} [meta] - Contains metadata related to the shipment
2777
+ */
2778
+ /**
2779
+ * @typedef CreateOrderShipmentSchema
2780
+ * @property {boolean} [is_mto] - Indicates if the shipment belongs to the
2781
+ * made-to-order category, i.e., the seller will start creating this order
2782
+ * after receiving an order creation request.
2783
+ * @property {LifecycleMessageSchema[]} [shipment_lifecycle_messages] - List of
2784
+ * general-purpose messages shown across different points in the shipment's
2785
+ * journey at Order Details screen.
2786
+ * @property {string[]} [tags] - Tags that can be attached to the shipment for
2787
+ * filtering and categorization.
2788
+ * @property {string} [type] - The shipment type defining the fulfillment method
2789
+ * and processing flow. Each type determines the specific journey a shipment
2790
+ * will follow based on operational needs and customer preferences:
2791
+ * "HomeDelivery": Standard delivery to the customer's address, undergoing all
2792
+ * typical state transitions from processing to final delivery. "PickAtStore":
2793
+ * Order prepared for in-store pickup, bypassing traditional shipping stages
2794
+ * for direct handover to the customer. "Digital": Orders involving digital
2795
+ * goods or services (e.g., software, e-books, subscriptions) delivered electronically.
2796
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
2797
+ * @property {string} [external_shipment_id] - Unique identifier for the
2798
+ * shipment as assigned by an external system. Use this to map the external ID
2799
+ * to Fynd's generated ID.
2800
+ * @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
2801
+ * @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
2802
+ * @property {number} [location_id] - The location ID from which this shipment
2803
+ * is being fulfilled.
2804
+ * @property {string} [external_location_id] - The external location ID from
2805
+ * which this shipment is being fulfilled.
2806
+ * @property {number} [return_location_id] - Overrides the article's default
2807
+ * return location.
2808
+ * @property {CourierPartnerDetailsSchema} [courier_partner_details]
2809
+ * @property {TaxDetailsSchema} [tax_details]
2810
+ * @property {PromiseDetailsSchema} [promise_details]
2811
+ * @property {string} [allow_processing_after] - Defines the UTC time at which
2812
+ * the shipment will automatically move to the placed state.
2813
+ * @property {Object} [meta] - Additional metadata related to the shipment.
2814
+ */
2815
+ /**
2816
+ * @typedef OrderingCurrencySchema
2817
+ * @property {string} currency_code - The <a
2818
+ * href='https://www.iso.org/iso-4217-currency-codes.html'>ISO 4217</a>
2819
+ * currency code, such as 'INR' for Indian Rupee. This field represents the
2820
+ * standardized three-letter code of a currency.
2821
+ * @property {string} currency_symbol - The symbol representing the currency,
2822
+ * such as '₹' for Indian Rupee. This is used for display purposes alongside
2823
+ * currency amounts.
2824
+ */
2825
+ /**
2826
+ * @typedef ConversionRateSchema
2827
+ * @property {number} rate - The exchange rate used to convert monetary values
2828
+ * from the ordering currency to the seller's currency.
2829
+ * @property {number} timestamp_ms - The timestamp (in milliseconds) when the
2830
+ * conversion rate was applied.
2831
+ */
2832
+ /**
2833
+ * @typedef CurrencySchema
2834
+ * @property {OrderingCurrencySchema} ordering_currency
2835
+ * @property {ConversionRateSchema} conversion_rate
2836
+ * @property {string} [currency_code] - The ISO 4217 currency code, such as
2837
+ * 'INR' for Indian Rupee. This field represents the standardized three-letter
2838
+ * code of a currency.
2839
+ * @property {string} [currency_symbol] - The symbol representing the currency,
2840
+ * such as '₹' for Indian Rupee. This is used for display purposes alongside
2841
+ * currency amounts.
2842
+ */
2843
+ /**
2844
+ * @typedef CouponOwnershipSchema
2845
+ * @property {string} payable_category - Indicates who issued the coupon
2846
+ */
2847
+ /**
2848
+ * @typedef CouponSchema
2849
+ * @property {string} code - The coupon code that was applied.
2850
+ * @property {string} id - Unique identifier of the coupon.
2851
+ * @property {CouponOwnershipSchema} ownership
2852
+ * @property {boolean} is_return_allowed - Indicates whether returns are allowed
2853
+ * when this coupon is applied.
2854
+ * @property {boolean} is_cancellation_allowed - Indicates whether cancellations
2855
+ * are allowed when this coupon is applied.
2856
+ */
2857
+ /**
2858
+ * @typedef BillingDetailsSchema
2859
+ * @property {string} [first_name] - First name of the customer
2860
+ * @property {string} [phone_code] - Country phone code ex: +91
2861
+ * @property {string} [country] - Country of the customer
2862
+ * @property {string} [city] - City of the customer
2863
+ * @property {string} [pincode] - Pincode of the customer
2864
+ * @property {string} [last_name] - Last name of the customer
2865
+ * @property {string} [mobile_number] - Primary phone number of the customer
2866
+ * @property {string} [email] - Primary email of the customer
2867
+ * @property {string} [state] - State of the customer
2868
+ * @property {string} [alternate_mobile_number] - Alternate mobile number
2869
+ * @property {string} [address] - Billing address of the customer
2870
+ * @property {string} [middle_name] - Customer's middle name.
2871
+ * @property {string} [title] - Customer's title or prefix.
2872
+ * @property {string} [house_no] - House or apartment number of the customer.
2873
+ * @property {GeoLocationSchema} [geo_location]
2874
+ * @property {string} [gender] - Gender of customer
2875
+ * @property {string} [landmark] - Landmark or reference point near the
2876
+ * customer's location.
2877
+ * @property {string} [address_type] - Address type in the seller's system.
2878
+ * @property {string} [state_code] - State code of the customer's location.
2879
+ * @property {string} [floor_no] - Floor number of the customer's location.
2880
+ * @property {string} [alternate_email] - Alternate Email Address
2881
+ * @property {string} [address1] - First line of the address.
2882
+ * @property {string} [address2] - Second line of the address.
2883
+ * @property {string} [country_iso_code] - Specifies the country's unique
2884
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
2885
+ * is crucial for distinguishing countries in international transactions, data
2886
+ * processing, and shipping logistics.
2887
+ * @property {string} [user_id] - The unique identifier assigned to the
2888
+ * customer. Refer <a
2889
+ * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
2890
+ * to get more details.
2891
+ * @property {string} [area_code] - Area Code
2892
+ * @property {string} [area_code_slug]
2893
+ * @property {string} [country_phone_code]
2894
+ */
2895
+ /**
2896
+ * @typedef CPConfigurationSchema
2897
+ * @property {string} shipping_by - Shipping Handled by FYND or SELLER
2898
+ */
2899
+ /**
2900
+ * @typedef ShippingDetailsSchema
2901
+ * @property {string} [first_name] - First name of the customer
2902
+ * @property {string} [phone_code] - Country phone code ex: +91
2903
+ * @property {string} [country] - Country of the customer
2904
+ * @property {string} [city] - City of the customer
2905
+ * @property {string} [pincode] - Pincode of the customer
2906
+ * @property {string} [last_name] - Last name of the customer
2907
+ * @property {string} [mobile_number] - Primary phone number of the customer
2908
+ * @property {string} [email] - Primary email of the customer
2909
+ * @property {string} [state] - State of the customer
2910
+ * @property {string} [alternate_mobile_number] - Alternate mobile number
2911
+ * @property {string} [address] - Shipping address of the customer
2912
+ * @property {string} [middle_name] - Customer's middle name.
2913
+ * @property {string} [title] - Customer's title or prefix.
2914
+ * @property {string} [house_no] - House or apartment number of the customer.
2915
+ * @property {GeoLocationSchema} [geo_location]
2916
+ * @property {string} [gender] - Gender of customer
2917
+ * @property {string} [landmark] - Landmark or reference point near the
2918
+ * customer's location.
2919
+ * @property {string} [address_type] - A string representing the address type in
2920
+ * the seller's system.
2921
+ * @property {string} [state_code] - State code of the customer's location.
2922
+ * @property {string} [floor_no] - Floor number of the customer's location.
2923
+ * @property {string} [alternate_email] - Alternate Email Address
2924
+ * @property {string} [address1] - First line of the address
2925
+ * @property {string} [address2] - Second line of the address
2926
+ * @property {string} [country_iso_code] - Specifies the country's unique
2927
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
2928
+ * is crucial for distinguishing countries in international transactions, data
2929
+ * processing, and shipping logistics.
2930
+ * @property {string} [user_id] - The unique identifier assigned to the
2931
+ * customer. Refer <a
2932
+ * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
2933
+ * in platform documentation to get more details. details.
2934
+ * @property {string} [area_code] - Area Code
2935
+ * @property {string} [area_code_slug]
2936
+ * @property {string} [country_phone_code]
2937
+ */
2938
+ /**
2939
+ * @typedef UserDetailsSchema
2940
+ * @property {string} [gstin] - The customer's GSTIN (Goods and Services Tax
2941
+ * Identification Number).
2942
+ * @property {string} [pan_no] - The customer's PAN (Permanent Account Number).
2943
+ */
2944
+ /**
2945
+ * @typedef LifecycleMessageSchema
2946
+ * @property {string} message - The message text to display to users at specific
2947
+ * order states (e.g., PLACED, SHIPPED).
2948
+ * @property {string} type - The message type, which determines the color of the
2949
+ * message bar.
2950
+ * @property {string[]} states - List of OMS states at which the message should
2951
+ * be visible.
2952
+ * @property {number} priority - Determines the message display sequence, with
2953
+ * '1' being the highest priority.
2954
+ */
2955
+ /**
2956
+ * @typedef CreateOrderRequestSchema
2957
+ * @property {CreateOrderShipmentSchema[]} [shipments] - List of shipments
2958
+ * included in the order.
2959
+ * @property {string[]} [tags] - Tags that can be used to filter and categorize
2960
+ * orders and shipments.
2961
+ * @property {CurrencySchema} currency_details
2962
+ * @property {string} [external_creation_date] - Timestamp indicating when the
2963
+ * order was created in an external system.
2964
+ * @property {CouponSchema} [coupon_details]
2965
+ * @property {BillingDetailsSchema} billing_details
2966
+ * @property {string} primary_payment_mode - The primary payment method used for
2967
+ * the entire order transaction.
2968
+ * @property {CPConfigurationSchema} [cp_configuration]
2969
+ * @property {number} [ordering_location_id] - The location ID where the order
2970
+ * is placed. Required when the order is placed from one location but
2971
+ * fulfilled by another.
2972
+ * @property {boolean} [allow_location_reassignment] - Allows location
2973
+ * reassignment before order confirmation.
2974
+ * @property {ShippingDetailsSchema} shipping_details
2975
+ * @property {string} [external_order_id] - A unique identifier assigned to the
2976
+ * order by an external system or service.
2977
+ * @property {UserDetailsSchema} [user_details]
2978
+ * @property {LifecycleMessageSchema[]} [order_lifecycle_messages] - List of
2979
+ * order lifecycle messages to be displayed to the seller at Order Details.
2980
+ * @property {string} [channel_application_id] - Identifies the application from
2981
+ * which the order was created. Pass this when it differs from the fulfilling
2982
+ * company's application.
2983
+ * @property {string} [b2b_gstin_number] - The GSTIN (Goods and Services Tax
2984
+ * Identification Number) for business-to-business transactions.
2985
+ * @property {string} [channel_company_id] - The company ID where the order is
2986
+ * placed. Required when the order is placed from one company but fulfilled by another.
2987
+ * @property {boolean} [is_draft] - Indicates whether the order is a draft.
2988
+ * Draft orders will be moved to upcoming state instead of placed status.
2598
2989
  */
2599
2990
  /**
2600
2991
  * @typedef Page
@@ -2607,6 +2998,58 @@ export = OrderPlatformModel;
2607
2998
  * @property {number} [size] - The number of items per page.
2608
2999
  * @property {number} [page_size] - The number of items per page.
2609
3000
  */
3001
+ /**
3002
+ * @typedef OrderingSourceConfig
3003
+ * @property {string} [slug] - Slug of the ordering source.
3004
+ * @property {OrderingSourceFeature[]} [configs]
3005
+ * @property {string} [logo] - Logo of the ordering source.
3006
+ */
3007
+ /**
3008
+ * @typedef OrderingSourceFeature
3009
+ * @property {string} [name] - Name of the ordering source config item.
3010
+ * @property {string} [slug] - Slug of the ordering source config item.
3011
+ * @property {string} [description] - Description of the ordering source config item.
3012
+ * @property {boolean} [enabled] - Whether the config/feature is enabled or not.
3013
+ */
3014
+ /**
3015
+ * @typedef ListOrderingSources
3016
+ * @property {OrderingSourceSummary[]} [items]
3017
+ * @property {Page} [page]
3018
+ */
3019
+ /**
3020
+ * @typedef OrderingSourceSummary
3021
+ * @property {string} [text] - Display Text of the ordering source.
3022
+ * @property {string} [value] - Value of the ordering source.
3023
+ */
3024
+ /**
3025
+ * @typedef CreateAccount
3026
+ * @property {string} channel_account_name - Unique name identifier for the
3027
+ * channel account. This represents the sales channel or marketplace through
3028
+ * which orders are received and processed.
3029
+ */
3030
+ /**
3031
+ * @typedef Account
3032
+ * @property {string} [channel_account_id] - Unique identifier for the channel
3033
+ * account. This is a system-generated identifier used to reference the
3034
+ * account across the platform.
3035
+ * @property {number} [company_id] - Unique identifier of the company on the
3036
+ * platform to which this channel account belongs.
3037
+ * @property {string} [channel_account_name] - Name of the channel account. This
3038
+ * identifies the specific sales channel or marketplace (e.g., SHOPIFY,
3039
+ * MARKETPLACE, etc.) through which the company receives and processes orders.
3040
+ */
3041
+ /**
3042
+ * @typedef AccountsList
3043
+ * @property {Account[]} [data] - List of channel accounts associated with the
3044
+ * company. Each account represents a different sales channel or marketplace
3045
+ * integration.
3046
+ * @property {Page} [page]
3047
+ */
3048
+ /**
3049
+ * @typedef ValidationError
3050
+ * @property {string} message - A brief description of the error encountered.
3051
+ * @property {string} field - The field in the request that caused the error.
3052
+ */
2610
3053
  /**
2611
3054
  * @typedef BagReasonMeta
2612
3055
  * @property {boolean} [show_text_area] - Indicates whether a text area should
@@ -2693,6 +3136,35 @@ export = OrderPlatformModel;
2693
3136
  * @property {string} [country_phone_code] - The country-specific phone code,
2694
3137
  * useful for formatting mobile numbers correctly.
2695
3138
  */
3139
+ /**
3140
+ * @typedef BundleReturnConfig
3141
+ * @property {boolean} [allow_partial_return] - Indicates whether partial
3142
+ * returns are allowed for bundle products.
3143
+ * @property {boolean} [returnable] - Indicates whether the bundle product is returnable.
3144
+ * @property {boolean} [unit] - Time unit for the return window (e.g., "week",
3145
+ * "day", "hour").
3146
+ * @property {boolean} [time] - Duration value for the return window, expressed
3147
+ * in the specified unit.
3148
+ */
3149
+ /**
3150
+ * @typedef BundleDetails
3151
+ * @property {string} [bundle_group_id] - Unique group identifier for the bundle.
3152
+ * @property {string} [name] - Name of the bundle.
3153
+ * @property {string} [slug] - URL-friendly identifier for the bundle.
3154
+ * @property {number} [bundle_count] - Indicates bundle count of the bag.
3155
+ * @property {string} [article_bundle_id] - Unique identifier for the article bundle.
3156
+ * @property {number} [bundle_article_quantity] - Article net_quantity in bundle Product.
3157
+ * @property {boolean} [is_base] - A flag that determines if bag is base bag of bundle.
3158
+ * @property {number} [price_marked] - Maximum Retail Price of the bundle.
3159
+ * @property {number} [price_effective] - Current selling price of the bundle.
3160
+ * @property {number} [item_id] - Unique identifier for the item.
3161
+ * @property {string} [item_type] - Type of the item (physical_bundle, virtual_bundle).
3162
+ * @property {BundleReturnConfig} [return_config]
3163
+ * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
3164
+ * @property {string[]} [images] - An array of image URLs associated with the bundle.
3165
+ * @property {string} [brand_name] - Identifier for the brand name.
3166
+ * @property {string} [size] - Size associated with the bundle item.
3167
+ */
2696
3168
  /**
2697
3169
  * @typedef Address
2698
3170
  * @property {string} [phone] - The phone number at the address, used for
@@ -3475,8 +3947,8 @@ export = OrderPlatformModel;
3475
3947
  * @property {string} [ordering_channnel] - The specific channel through which
3476
3948
  * your order was placed. This field will be phased out after version 2.4.0.
3477
3949
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3478
- * @property {string} [ordering_source] - To uniquely identify the source
3479
- * through which order has been placed (e.g, marketplace, gofynd).
3950
+ * @property {string} [ordering_source] - Ordering source, to be used to
3951
+ * identify source of order creation.
3480
3952
  * @property {string} [shipment_id] - The unique identifier for the shipment itself.
3481
3953
  * @property {string} [customer_note] - Any special notes or instructions
3482
3954
  * provided by the customer related to the shipment.
@@ -3585,8 +4057,8 @@ export = OrderPlatformModel;
3585
4057
  * @property {string} [ordering_channel] - The specific channel through which
3586
4058
  * your order was placed. This field will be phased out after version 2.4.0.
3587
4059
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3588
- * @property {string} [ordering_source] - To uniquely identify the source
3589
- * through which order has been placed (e.g, marketplace, gofynd).
4060
+ * @property {string} [ordering_source] - Ordering source, to be used to
4061
+ * identify source of order creation.
3590
4062
  * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
3591
4063
  * @property {Object} [meta] - Meta data of the order contains additional,
3592
4064
  * potentially dynamic information about the order.
@@ -3892,6 +4364,9 @@ export = OrderPlatformModel;
3892
4364
  * tracking is enabled for the bag.
3893
4365
  * @property {boolean} is_customer_return_allowed - A flag that determines if
3894
4366
  * customer return is allowed for the bag.
4367
+ * @property {boolean} [is_bundle_item] - Flag to indicate whether the bag is
4368
+ * part of a bundle.
4369
+ * @property {BundleDetails} [bundle_details]
3895
4370
  */
3896
4371
  /**
3897
4372
  * @typedef OrderBagArticle
@@ -4343,22 +4818,13 @@ export = OrderPlatformModel;
4343
4818
  * with the payment transaction, such as TR669796C0012CF31BBD. This ID helps
4344
4819
  * track and reference the specific transaction within the merchant's system.
4345
4820
  */
4346
- /**
4347
- * @typedef CurrencySchema
4348
- * @property {string} [currency_code] - The ISO 4217 currency code, such as
4349
- * 'INR' for Indian Rupee. This field represents the standardized three-letter
4350
- * code of a currency.
4351
- * @property {string} [currency_symbol] - The symbol representing the currency,
4352
- * such as '₹' for Indian Rupee. This is used for display purposes alongside
4353
- * currency amounts.
4354
- */
4355
4821
  /**
4356
4822
  * @typedef OrderData
4357
4823
  * @property {string} [ordering_channel] - The specific channel through which
4358
4824
  * your order was placed. This field will be phased out after version 2.4.0.
4359
4825
  * Please use ordering_source instead to ensure accurate order tracking and processing.
4360
- * @property {string} [ordering_source] - To uniquely identify the source
4361
- * through which order has been placed (e.g, marketplace, gofynd).
4826
+ * @property {string} [ordering_source] - Ordering source, to be used to
4827
+ * identify source of order creation.
4362
4828
  * @property {string} order_date - Specifies the exact date and time when the
4363
4829
  * order was placed by the customer, serving as a key timestamp for the
4364
4830
  * initiation of the order processing cycle.
@@ -5028,99 +5494,10 @@ export = OrderPlatformModel;
5028
5494
  * @property {boolean} [status]
5029
5495
  * @property {string} [error]
5030
5496
  */
5031
- /**
5032
- * @typedef {| "storefront"
5033
- * | "store_os_pos"
5034
- * | "kiosk"
5035
- * | "scan_go"
5036
- * | "smart_trolley"
5037
- * | "gofynd"
5038
- * | "uniket"
5039
- * | "marketplace"
5040
- * | "social_commerce"
5041
- * | "ondc"
5042
- * | "nexus"
5043
- * | "nykaa_fashion"
5044
- * | "etsy"
5045
- * | "vuivui"
5046
- * | "zilingo"
5047
- * | "firstcry"
5048
- * | "bukalapak"
5049
- * | "myntra_ppmp"
5050
- * | "lazada"
5051
- * | "tiktok"
5052
- * | "sfcc"
5053
- * | "debenhams"
5054
- * | "prestomall"
5055
- * | "meesho"
5056
- * | "amazon_vdf"
5057
- * | "bigcommerce"
5058
- * | "sendo"
5059
- * | "storehippo"
5060
- * | "cdiscount"
5061
- * | "nykaa"
5062
- * | "trendyol"
5063
- * | "weloveshopping"
5064
- * | "jollee"
5065
- * | "wish"
5066
- * | "tiki"
5067
- * | "central_online"
5068
- * | "q10"
5069
- * | "cred"
5070
- * | "walmart"
5071
- * | "snapdeal"
5072
- * | "flipkart"
5073
- * | "blibli"
5074
- * | "ajio_jit"
5075
- * | "pharmeasy"
5076
- * | "ezmall"
5077
- * | "adobe_commerce"
5078
- * | "kartmax"
5079
- * | "shopee"
5080
- * | "zalora"
5081
- * | "prestashop"
5082
- * | "smytten"
5083
- * | "amazon_sc"
5084
- * | "urbanpiper"
5085
- * | "flipkart_quick"
5086
- * | "woocommerce"
5087
- * | "zivame"
5088
- * | "lelong"
5089
- * | "facebook"
5090
- * | "jiomart"
5091
- * | "gmc"
5092
- * | "robins"
5093
- * | "akulaku"
5094
- * | "noon"
5095
- * | "tatacliq"
5096
- * | "kartrocket"
5097
- * | "inorbit"
5098
- * | "ajio_business"
5099
- * | "swiggy"
5100
- * | "asos"
5101
- * | "tokopedia"
5102
- * | "limeroad"
5103
- * | "myntra_omni"
5104
- * | "spoyl"
5105
- * | "amazon_mlf"
5106
- * | "fulfilled_by_lazada"
5107
- * | "ebay"
5108
- * | "jd"
5109
- * | "amazon_pharmacy"
5110
- * | "ajio_vms"
5111
- * | "daraz"
5112
- * | "oker"
5113
- * | "flipkart_b2b"
5114
- * | "amazon_mlf_ss"
5115
- * | "woovly"
5116
- * | "tata1mg"
5117
- * | "zomato"
5118
- * | "shopify"} OrderingSource
5119
- */
5120
5497
  declare class OrderPlatformModel {
5121
5498
  }
5122
5499
  declare namespace OrderPlatformModel {
5123
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, LoyaltyDiscountDetails, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
5500
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, FulfillmentOptionSchema, PaymentMethodGatewaySchema, SubModeOfPaymentSchema, PaymentMethodModeOfPaymentSchema, PaymentMethodTransactionPartySchema, LineItemPaymentMethodSchema, BundleDetailsSchema, LineItemMonetaryValuesSchema, DimensionSchema, GiftDetailsSchema, CPRiderDetailsSchema, CPAreaCodeSchema, CPTatToDeliverTheShipmentSchema, CPOptionsSchema, CourierPartnerDetailsSchema, TaxDetailsSchema, PromiseDetailsSchema, CustomerPickupSlotSchema, DpPickupSlotSchema, OrderFulfillmentTimelineSchema, LineItemSchema, CreateOrderShipmentSchema, OrderingCurrencySchema, ConversionRateSchema, CurrencySchema, CouponOwnershipSchema, CouponSchema, BillingDetailsSchema, CPConfigurationSchema, ShippingDetailsSchema, UserDetailsSchema, LifecycleMessageSchema, CreateOrderRequestSchema, Page, OrderingSourceConfig, OrderingSourceFeature, ListOrderingSources, OrderingSourceSummary, CreateAccount, Account, AccountsList, ValidationError, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, BundleReturnConfig, BundleDetails, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, LoyaltyDiscountDetails, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema };
5124
5501
  }
5125
5502
  /** @returns {InvalidateShipmentCachePayload} */
5126
5503
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -5645,7 +6022,7 @@ type ProductsDataUpdatesFilters = {
5645
6022
  line_number?: number;
5646
6023
  /**
5647
6024
  * - A unique string that serves as the
5648
- * products identifier, such as a SKU, barcode, or another distinct code.
6025
+ * product's identifier, such as a SKU, barcode, or another distinct code.
5649
6026
  * This ensures the product is correctly identified and distinguished from
5650
6027
  * other items in the system.
5651
6028
  */
@@ -5963,8 +6340,8 @@ type ShipmentsResponseSchema = {
5963
6340
  declare function DPConfiguration(): DPConfiguration;
5964
6341
  type DPConfiguration = {
5965
6342
  /**
5966
- * - Shipping_by denotes dp assignment
5967
- * strategy- if shipping_by is fynd dp assignment would be handled by OMS
6343
+ * - It denotes DP assignment strategy. If it
6344
+ * is fynd, DP assignment will be handled by Fynd's OMS.
5968
6345
  */
5969
6346
  shipping_by?: string;
5970
6347
  };
@@ -5998,21 +6375,22 @@ type LockStateMessage = {
5998
6375
  /** @returns {CreateOrderConfig} */
5999
6376
  declare function CreateOrderConfig(): CreateOrderConfig;
6000
6377
  type CreateOrderConfig = {
6001
- dp_configuration: DPConfiguration;
6378
+ dp_configuration?: DPConfiguration;
6002
6379
  /**
6003
- * - Flag denotes if the location
6004
- * for the store needs to be reassigned post cancellation. If true,location
6005
- * for the store gets auto reassigned post cancellation, if set false location
6006
- * reassignment will not be performed as its disabled.
6380
+ * - The flag denotes if the
6381
+ * location for the shipment needs to be reassigned after cancellation. If the
6382
+ * flag is set to true, location for the shipment gets auto reassigned post
6383
+ * cancellation. If set to false, location reassignment will not be performed
6384
+ * as it is disabled.
6007
6385
  */
6008
6386
  location_reassignment?: boolean;
6009
6387
  payment?: PaymentConfig;
6010
6388
  /**
6011
6389
  * - Denotes the shipment
6012
- * breaking strategy. If the flag is set true, the shipment is created using
6013
- * optimal shipment creation strategy based on the servicability & packaging
6014
- * dimensions by OMS .If false, shipment details, including location_id, must
6015
- * be passed to FDK for processing.
6390
+ * breaking strategy. If the flag is set to true, the shipment is created
6391
+ * using an optimal shipment creation strategy based on the serviceability &
6392
+ * packaging dimensions by OMS. If the flag is set to false, shipment details
6393
+ * and location_id, must be passed to FDK for processing.
6016
6394
  */
6017
6395
  optimal_shipment_creation?: boolean;
6018
6396
  /**
@@ -6359,8 +6737,7 @@ type OrderConfig = {
6359
6737
  declare function CreateOrderResponseSchema(): CreateOrderResponseSchema;
6360
6738
  type CreateOrderResponseSchema = {
6361
6739
  /**
6362
- * - A string that represents the unique
6363
- * identifier assigned to the order.
6740
+ * - Unique identifier assigned to the order
6364
6741
  */
6365
6742
  fynd_order_id: string;
6366
6743
  };
@@ -6834,8 +7211,8 @@ type OrderDetails = {
6834
7211
  */
6835
7212
  ordering_channel?: string;
6836
7213
  /**
6837
- * - To uniquely identify the source
6838
- * through which order has been placed (e.g, marketplace, gofynd).
7214
+ * - Ordering source, to be used to
7215
+ * identify source of order creation.
6839
7216
  */
6840
7217
  ordering_source?: string;
6841
7218
  /**
@@ -7035,7 +7412,7 @@ type UpdatePackagingDimensionsResponseSchema = {
7035
7412
  declare function Tax(): Tax;
7036
7413
  type Tax = {
7037
7414
  /**
7038
- * - The name of the tax, indicating its purpose (e.g.,
7415
+ * - The name of the tax indicating its purpose (e.g.,
7039
7416
  * VAT, sales tax).
7040
7417
  */
7041
7418
  name: string;
@@ -7070,27 +7447,31 @@ type AmountSchema = {
7070
7447
  /** @returns {Charge} */
7071
7448
  declare function Charge(): Charge;
7072
7449
  type Charge = {
7450
+ amount: AmountSchema;
7451
+ /**
7452
+ * - The category or type of the charge.
7453
+ */
7454
+ type: string;
7073
7455
  /**
7074
7456
  * - The name of the charge that indicates its purpose.
7075
7457
  */
7076
7458
  name: string;
7077
- amount: AmountSchema;
7078
- tax?: Tax;
7079
7459
  /**
7080
7460
  * - An optional code associated with the charge for
7081
7461
  * internal tracking.
7082
7462
  */
7083
7463
  code?: string;
7084
- /**
7085
- * - The category or type of the charge.
7086
- */
7087
- type: string;
7464
+ tax?: Tax;
7088
7465
  };
7089
7466
  /** @returns {LineItem} */
7090
7467
  declare function LineItem(): LineItem;
7091
7468
  type LineItem = {
7092
7469
  /**
7093
- * - An array of Charge objects related to the line item.
7470
+ * - An array of Charge objects related to the
7471
+ * line item. This array must include three mandatory charge types:
7472
+ * amount_paid, price_effective and price_marked. Formula to calculate
7473
+ * amount_paid = price_effective + cod_charges + delivery_charges -
7474
+ * coupon_discount - promo_discount
7094
7475
  */
7095
7476
  charges?: Charge[];
7096
7477
  /**
@@ -7207,8 +7588,8 @@ type SystemMessages = {
7207
7588
  declare function Shipment(): Shipment;
7208
7589
  type Shipment = {
7209
7590
  /**
7210
- * - An array of LineItem objects that
7211
- * represent the items included in the shipment.
7591
+ * - An array of objects that represent the
7592
+ * items included in the shipment.
7212
7593
  */
7213
7594
  line_items: LineItem[];
7214
7595
  /**
@@ -7223,35 +7604,32 @@ type Shipment = {
7223
7604
  */
7224
7605
  meta?: any;
7225
7606
  /**
7226
- * - An integer indicating the priority level of
7227
- * the shipment.
7607
+ * - Priority level of the shipment.
7228
7608
  */
7229
7609
  priority?: number;
7230
7610
  /**
7231
- * - Location Identifier or Store/Fulfillment
7232
- * Identifier of the shipment- This field is mandatory when
7233
- * optimal_shipment_creation flag is set to false, indicating that shipments
7234
- * must be associated with a specific location. When
7235
- * `optimal_shipment_creation` is true, the optimal location for order
7236
- * creation would be assigned, location_id becomes optional.
7611
+ * - Location/store/fulfillment identifier of
7612
+ * the shipment. This field is mandatory when optimal_shipment_creation flag
7613
+ * is set to false, indicating that shipments must be associated with a
7614
+ * specific location. When optimal_shipment_creation is true, location_id
7615
+ * becomes optional and the system automatically assigns the optimal location
7616
+ * for order creation.
7237
7617
  */
7238
7618
  location_id?: number;
7239
7619
  /**
7240
7620
  * - Defines the specific journey a shipment
7241
7621
  * will follow based on the application's operational needs and customer
7242
7622
  * preferences. This field categorizes orders into distinct types, each
7243
- * associated with a unique processing flow. For example:
7244
- *
7245
- * - "HomeDelivery": The order undergoes all state transitions typical for a
7246
- * delivery, from processing the shipment to final delivery at the
7247
- * customer's address.
7248
- * - "PickAtStore": The order is prepared for pickup and moved to a state where it
7249
- * is ready to be handed over directly to the customer at the store. This
7250
- * type streamlines the process by bypassing traditional shipping stages
7251
- * and facilitating a quicker transition to the final handover stage.
7252
- * - "Digital": This order type likely refers to orders that involve digital goods
7253
- * or services, such as software, digital subscriptions, e-books, online
7254
- * courses, or any other item that can be delivered electronically.
7623
+ * associated with a unique processing flow. For example, "HomeDelivery": The
7624
+ * order undergoes all state transitions typical for a delivery, from
7625
+ * processing the shipment to final delivery at the customer's address.
7626
+ * "PickAtStore": The order is prepared for pickup and moved to a state where
7627
+ * it is ready to be handed over directly to the customer at the store. This
7628
+ * type streamlines the process by bypassing traditional shipping stages and
7629
+ * facilitating a quicker transition to the final handover stage. "Digital":
7630
+ * This order type likely refers to orders that involve digital goods or
7631
+ * services, such as software, digital subscriptions, e-books, online courses,
7632
+ * or any other item that can be delivered electronically.
7255
7633
  */
7256
7634
  order_type?: string;
7257
7635
  tags?: string[];
@@ -7313,18 +7691,17 @@ type GeoLocationSchema = {
7313
7691
  declare function ShippingInfo(): ShippingInfo;
7314
7692
  type ShippingInfo = {
7315
7693
  /**
7316
- * - A string for an alternate
7317
- * mobile number to reach the customer, providing an additional contact method.
7694
+ * - Alternate mobile number to
7695
+ * reach the customer, providing an additional contact method.
7318
7696
  */
7319
7697
  alternate_mobile_number?: string;
7320
7698
  /**
7321
- * - A string representing the name of the state for
7322
- * shipping purposes.
7699
+ * - The name of the state for shipping purposes.
7323
7700
  */
7324
7701
  state?: string;
7325
7702
  /**
7326
- * - A string representing the customer's
7327
- * unique identifier in the seller's system.
7703
+ * - Customer's unique identifier in the
7704
+ * seller's system.
7328
7705
  */
7329
7706
  customer_code?: string;
7330
7707
  /**
@@ -7333,72 +7710,66 @@ type ShippingInfo = {
7333
7710
  */
7334
7711
  shipping_type?: string;
7335
7712
  /**
7336
- * - A string containing the customer's middle name.
7713
+ * - Customer's middle name
7337
7714
  */
7338
7715
  middle_name?: string;
7339
7716
  /**
7340
- * - A string for the customer's
7341
- * primary mobile number.
7717
+ * - Customer's primary mobile number
7342
7718
  */
7343
7719
  primary_mobile_number?: string;
7344
7720
  /**
7345
- * - A string containing the customer's last name.
7721
+ * - Customer's last name
7346
7722
  */
7347
7723
  last_name?: string;
7348
7724
  geo_location?: GeoLocationSchema;
7349
7725
  /**
7350
- * - A string representing the customer's gender.
7726
+ * - Customer's gender
7351
7727
  */
7352
7728
  gender?: string;
7353
7729
  /**
7354
- * - A string representing the house or apartment
7355
- * number of the customer.
7730
+ * - The house or apartment number of the customer.
7356
7731
  */
7357
7732
  house_no?: string;
7358
7733
  /**
7359
- * - A string representing the customer's first name.
7734
+ * - Customer's first name
7360
7735
  */
7361
7736
  first_name?: string;
7362
7737
  /**
7363
- * - A string representing the customer's title or prefix.
7738
+ * - Customer's title or prefix
7364
7739
  */
7365
7740
  title?: string;
7366
7741
  /**
7367
- * - A string representing a landmark or reference
7368
- * point near the customer's location.
7742
+ * - Landmark or reference point near the
7743
+ * customer's location
7369
7744
  */
7370
7745
  landmark?: string;
7371
7746
  /**
7372
- * - A string representing the customer's country.
7747
+ * - Customer's country
7373
7748
  */
7374
7749
  country?: string;
7375
7750
  /**
7376
- * - A string representing the address type in
7377
- * the seller's system.
7751
+ * - Address type in the seller's system
7378
7752
  */
7379
7753
  address_type?: string;
7380
7754
  /**
7381
- * - A string representing the state code of the
7382
- * customer's location.
7755
+ * - State code of the customer's location
7383
7756
  */
7384
7757
  state_code?: string;
7385
7758
  /**
7386
- * - A string representing the city of the customer's location.
7759
+ * - City of the customer's location
7387
7760
  */
7388
7761
  city?: string;
7389
7762
  /**
7390
- * - A string representing an
7391
- * external customer code in the seller's system.
7763
+ * - External customer code in the
7764
+ * seller's system
7392
7765
  */
7393
7766
  external_customer_code?: string;
7394
7767
  /**
7395
- * - A string representing the floor number of the
7396
- * customer's location.
7768
+ * - Floor number of the customer's location
7397
7769
  */
7398
7770
  floor_no?: string;
7399
7771
  /**
7400
- * - A string representing an alternate
7401
- * email address for the customer.
7772
+ * - Alternate email address for the customer
7402
7773
  */
7403
7774
  alternate_email?: string;
7404
7775
  /**
@@ -7411,25 +7782,23 @@ type ShippingInfo = {
7411
7782
  */
7412
7783
  address?: string;
7413
7784
  /**
7414
- * - A string representing the area of the customer's location.
7785
+ * - Area of the customer's location
7415
7786
  */
7416
7787
  area?: string;
7417
7788
  /**
7418
- * - A string representing the first line of the address.
7789
+ * - First line of the address
7419
7790
  */
7420
7791
  address1?: string;
7421
7792
  /**
7422
- * - A string representing the pincode of the
7423
- * customer's location.
7793
+ * - Pincode of the customer's location
7424
7794
  */
7425
7795
  pincode?: string;
7426
7796
  /**
7427
- * - A string representing the primary email
7428
- * address for the customer.
7797
+ * - Primary email address for the customer
7429
7798
  */
7430
7799
  primary_email?: string;
7431
7800
  /**
7432
- * - A string representing the second line of the address.
7801
+ * - Second line of the address
7433
7802
  */
7434
7803
  address2?: string;
7435
7804
  /**
@@ -7442,7 +7811,7 @@ type ShippingInfo = {
7442
7811
  country_code?: string;
7443
7812
  /**
7444
7813
  * - Specifies the country's unique
7445
- * identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
7814
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
7446
7815
  * is crucial for distinguishing countries in international transactions, data
7447
7816
  * processing, and shipping logistics.
7448
7817
  */
@@ -7483,25 +7852,23 @@ type BillingInfo = {
7483
7852
  alternate_email?: string;
7484
7853
  address?: string;
7485
7854
  /**
7486
- * - A string representing the area of the customer's location.
7855
+ * - Area of the customer's location
7487
7856
  */
7488
7857
  area?: string;
7489
7858
  /**
7490
- * - A string representing the first line of the address.
7859
+ * - First line of the address
7491
7860
  */
7492
7861
  address1?: string;
7493
7862
  /**
7494
- * - A string representing the pincode of the
7495
- * customer's location.
7863
+ * - Pincode of the customer's location
7496
7864
  */
7497
7865
  pincode?: string;
7498
7866
  /**
7499
- * - A string representing the primary email
7500
- * address for the customer.
7867
+ * - Primary email address for the customer
7501
7868
  */
7502
7869
  primary_email?: string;
7503
7870
  /**
7504
- * - A string representing the second line of the address.
7871
+ * - Second line of the address
7505
7872
  */
7506
7873
  address2?: string;
7507
7874
  /**
@@ -7527,29 +7894,27 @@ type UserInfo = {
7527
7894
  */
7528
7895
  user_id?: string;
7529
7896
  /**
7530
- * - A string representing the type of the user.
7897
+ * - Type of the user
7531
7898
  */
7532
7899
  user_type?: string;
7533
7900
  /**
7534
- * - A string representing the primary email
7535
- * address for the user.
7901
+ * - Primary email address for the user
7536
7902
  */
7537
7903
  primary_email?: string;
7538
7904
  /**
7539
- * - A string specifying the gender of the user.
7905
+ * - Gender of the user
7540
7906
  */
7541
7907
  gender?: string;
7542
7908
  /**
7543
- * - A string which specifies the user's first name.
7909
+ * - User's first name
7544
7910
  */
7545
7911
  first_name: string;
7546
7912
  /**
7547
- * - A string which specifies the user's last name.
7913
+ * - User's last name
7548
7914
  */
7549
7915
  last_name?: string;
7550
7916
  /**
7551
- * - A string representing the primary
7552
- * mobile number for the user.
7917
+ * - Primary mobile number for the user
7553
7918
  */
7554
7919
  primary_mobile_number: string;
7555
7920
  };
@@ -7557,18 +7922,17 @@ type UserInfo = {
7557
7922
  declare function TaxInfo(): TaxInfo;
7558
7923
  type TaxInfo = {
7559
7924
  /**
7560
- * - A string representing the GSTIN
7561
- * (Goods and Services Tax Identification Number) for business-to-business
7562
- * transactions.
7925
+ * - Goods and Services Tax Identification
7926
+ * Number (GSTIN) for business-to-business transactions
7563
7927
  */
7564
7928
  b2b_gstin_number?: string;
7565
7929
  /**
7566
- * - A string that specifies the GSTIN for the seller.
7930
+ * - GSTIN of the customer
7567
7931
  */
7568
7932
  gstin?: string;
7569
7933
  /**
7570
- * - A string representing the PAN assigned to
7571
- * individuals or entities for tax purposes in India.
7934
+ * - PAN assigned to individuals or entities for tax
7935
+ * purposes in India
7572
7936
  */
7573
7937
  pan_no?: string;
7574
7938
  };
@@ -7576,23 +7940,20 @@ type TaxInfo = {
7576
7940
  declare function PaymentMethod(): PaymentMethod;
7577
7941
  type PaymentMethod = {
7578
7942
  /**
7579
- * - A string indicating the entity responsible
7580
- * for collecting the payment.
7943
+ * - Entity responsible for collecting the payment
7581
7944
  */
7582
7945
  collect_by: string;
7583
7946
  /**
7584
- * - A string that specifies the mode of payment. Refer
7585
- * to [API & references (in Nav bar) → Payment Modes] for a list of valid
7586
- * payment methods.
7947
+ * - Mode of payment. Refer to [API & references (in Nav
7948
+ * bar) → Payment Modes] for a list of valid payment methods.
7587
7949
  */
7588
7950
  mode: string;
7589
7951
  /**
7590
- * - A string that indicates the entity responsible
7591
- * for processing refunds.
7952
+ * - Entity responsible for processing refunds
7592
7953
  */
7593
7954
  refund_by: string;
7594
7955
  /**
7595
- * - A string representing the name of the payment method.
7956
+ * - Name of the payment method
7596
7957
  */
7597
7958
  name: string;
7598
7959
  /**
@@ -7615,13 +7976,11 @@ type PaymentMethod = {
7615
7976
  declare function PaymentInfo(): PaymentInfo;
7616
7977
  type PaymentInfo = {
7617
7978
  /**
7618
- * - A string that indicates the primary payment
7619
- * method used for the order.
7979
+ * - Primary payment method used for the order
7620
7980
  */
7621
7981
  primary_mode: string;
7622
7982
  /**
7623
- * - A string that indicates the payment mode
7624
- * used for the order.
7983
+ * - Payment mode used for the order
7625
7984
  */
7626
7985
  payment_mode?: string;
7627
7986
  /**
@@ -7635,8 +7994,8 @@ declare function CreateOrderAPI(): CreateOrderAPI;
7635
7994
  type CreateOrderAPI = {
7636
7995
  /**
7637
7996
  * - List of Shipments which includes shipment
7638
- * data like shipment items, shipment promise, Shipment type, shipment order
7639
- * type, shipment dp options etc.
7997
+ * data like shipment items, shipment promise, shipment type, shipment order
7998
+ * type, shipment DP options etc.
7640
7999
  */
7641
8000
  shipments: Shipment[];
7642
8001
  shipping_info: ShippingInfo;
@@ -7653,13 +8012,12 @@ type CreateOrderAPI = {
7653
8012
  */
7654
8013
  external_order_id?: string;
7655
8014
  /**
7656
- * - An array of charge objects that detail the
7657
- * various fees associated with the order.
8015
+ * - It details the various fees associated with the order.
7658
8016
  */
7659
8017
  charges?: Charge[];
7660
8018
  /**
7661
- * - A string that specifies the
7662
- * date and time when the order was created in an external system
8019
+ * - Date and time when the order
8020
+ * was created in an external system
7663
8021
  */
7664
8022
  external_creation_date?: string;
7665
8023
  /**
@@ -7688,8 +8046,7 @@ type CreateOrderAPI = {
7688
8046
  status?: string;
7689
8047
  system_messages?: SystemMessages[];
7690
8048
  /**
7691
- * - A string that specifies the type of order
7692
- * being placed.
8049
+ * - Type of order being placed
7693
8050
  */
7694
8051
  order_type?: string;
7695
8052
  /**
@@ -9649,7 +10006,7 @@ type Filter = {
9649
10006
  * associated with a unique processing flow. For example:
9650
10007
  *
9651
10008
  * - "HomeDelivery": The order goes through all the steps needed for delivery,
9652
- * from being packed to arriving at the customers address.
10009
+ * from being packed to arriving at the customer's address.
9653
10010
  * - "PickAtStore": The order is prepared for pickup at the store, skipping
9654
10011
  * shipping steps to make it ready faster for the customer to collect in person.
9655
10012
  * - "Digital": This order type likely refers to orders that involve digital goods
@@ -9844,8 +10201,8 @@ type TransitionConfigCondition = {
9844
10201
  */
9845
10202
  ordering_channel?: string;
9846
10203
  /**
9847
- * - To uniquely identify the source
9848
- * through which order has been placed (e.g, marketplace, gofynd).
10204
+ * - Ordering source, to be used to
10205
+ * identify source of order creation.
9849
10206
  */
9850
10207
  ordering_source?: string;
9851
10208
  /**
@@ -10289,166 +10646,1183 @@ type PaymentMetaLogoURLSchema = {
10289
10646
  */
10290
10647
  small: string;
10291
10648
  };
10292
- /** @returns {ValidationError} */
10293
- declare function ValidationError(): ValidationError;
10294
- type ValidationError = {
10649
+ /** @returns {FulfillmentOptionSchema} */
10650
+ declare function FulfillmentOptionSchema(): FulfillmentOptionSchema;
10651
+ type FulfillmentOptionSchema = {
10295
10652
  /**
10296
- * - A brief description of the error encountered.
10653
+ * - The name of the fulfillment option (e.g.,
10654
+ * 'Standard Shipping', 'Express Delivery').
10297
10655
  */
10298
- message: string;
10656
+ name?: string;
10299
10657
  /**
10300
- * - The field in the request that caused the error.
10658
+ * - A unique identifier for the fulfillment option.
10301
10659
  */
10302
- field: string;
10303
- };
10304
- /** @returns {Page} */
10305
- declare function Page(): Page;
10306
- type Page = {
10660
+ slug?: string;
10307
10661
  /**
10308
- * - The total number of all items across all pages.
10662
+ * - The category or method of fulfillment
10663
+ * (e.g., 'Pickup', 'Delivery', 'Courier').
10309
10664
  */
10310
- item_total?: number;
10665
+ is_default?: boolean;
10311
10666
  /**
10312
- * - The identifier for the next page.
10667
+ * - Indicates whether this fulfillment option is the
10668
+ * default choice for customers.
10313
10669
  */
10314
- next_id?: string;
10670
+ type?: string;
10671
+ };
10672
+ /** @returns {PaymentMethodGatewaySchema} */
10673
+ declare function PaymentMethodGatewaySchema(): PaymentMethodGatewaySchema;
10674
+ type PaymentMethodGatewaySchema = {
10315
10675
  /**
10316
- * - Indicates whether there is a previous page.
10676
+ * - Payment gateway name e.g., Razorpay, Stripe, etc.
10317
10677
  */
10318
- has_previous?: boolean;
10678
+ name: string;
10679
+ logo?: string;
10680
+ };
10681
+ /** @returns {SubModeOfPaymentSchema} */
10682
+ declare function SubModeOfPaymentSchema(): SubModeOfPaymentSchema;
10683
+ type SubModeOfPaymentSchema = {
10319
10684
  /**
10320
- * - Indicates whether there is a next page.
10685
+ * - Name of the sub-mode of payment. For example, if
10686
+ * the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
10321
10687
  */
10322
- has_next?: boolean;
10688
+ name: string;
10689
+ };
10690
+ /** @returns {PaymentMethodModeOfPaymentSchema} */
10691
+ declare function PaymentMethodModeOfPaymentSchema(): PaymentMethodModeOfPaymentSchema;
10692
+ type PaymentMethodModeOfPaymentSchema = {
10323
10693
  /**
10324
- * - The current page number.
10694
+ * - Payment mode name e.g., Credit Card, Debit Card,
10695
+ * Net Banking, Wallet, etc.
10325
10696
  */
10326
- current?: number;
10697
+ name: string;
10327
10698
  /**
10328
- * - The type of the page, such as 'PageType'.
10699
+ * - Slug of the payment mode e.g., cc, dc, nb, wl, etc.
10329
10700
  */
10330
- type: string;
10701
+ slug: string;
10702
+ sub_mode_of_payment?: SubModeOfPaymentSchema;
10703
+ };
10704
+ /** @returns {PaymentMethodTransactionPartySchema} */
10705
+ declare function PaymentMethodTransactionPartySchema(): PaymentMethodTransactionPartySchema;
10706
+ type PaymentMethodTransactionPartySchema = {
10331
10707
  /**
10332
- * - The number of items per page.
10708
+ * - Entity responsible for refunding the
10709
+ * amount paid by the customer
10333
10710
  */
10334
- size?: number;
10711
+ refund_bearer: string;
10335
10712
  /**
10336
- * - The number of items per page.
10713
+ * - Entity responsible for collection of
10714
+ * amount paid by the customer
10337
10715
  */
10338
- page_size?: number;
10716
+ collection_bearer: string;
10339
10717
  };
10340
- /** @returns {BagReasonMeta} */
10341
- declare function BagReasonMeta(): BagReasonMeta;
10342
- type BagReasonMeta = {
10718
+ /** @returns {LineItemPaymentMethodSchema} */
10719
+ declare function LineItemPaymentMethodSchema(): LineItemPaymentMethodSchema;
10720
+ type LineItemPaymentMethodSchema = {
10721
+ gateway?: PaymentMethodGatewaySchema;
10722
+ mode_of_payment?: PaymentMethodModeOfPaymentSchema;
10343
10723
  /**
10344
- * - Indicates whether a text area should
10345
- * be displayed for additional input related to the bag reason.
10724
+ * - Total amount paid by this payment method
10346
10725
  */
10347
- show_text_area?: boolean;
10348
- };
10349
- /** @returns {QuestionSet} */
10350
- declare function QuestionSet(): QuestionSet;
10351
- type QuestionSet = {
10726
+ amount_paid?: number;
10352
10727
  /**
10353
- * - A unique identifier for the question set.
10728
+ * - Transaction id
10354
10729
  */
10355
- id?: number;
10730
+ payment_identifier?: string;
10731
+ transaction_party?: PaymentMethodTransactionPartySchema;
10732
+ };
10733
+ /** @returns {BundleDetailsSchema} */
10734
+ declare function BundleDetailsSchema(): BundleDetailsSchema;
10735
+ type BundleDetailsSchema = {
10356
10736
  /**
10357
- * - The display name for the question set,
10358
- * used for user-facing purposes.
10737
+ * - This serves as the base item, with all other
10738
+ * items acting as child elements within the bundle to display the hero
10739
+ * product prominently at the top.
10359
10740
  */
10360
- display_name?: string;
10361
- };
10362
- /** @returns {BagReasons} */
10363
- declare function BagReasons(): BagReasons;
10364
- type BagReasons = {
10741
+ is_base?: boolean;
10365
10742
  /**
10366
- * - List of QC (Quality Control) types -- having
10367
- * return reason types indicating the stage at which QC is performed. -
10368
- * "Doorstep QC" refers involves inspecting products for damages at the
10369
- * customer's location before delivery. - "Pre QC" requires customers to
10370
- * upload product photos for a preliminary quality check by the operations
10371
- * team before a return or exchange pickup is arranged, ensuring criteria are
10372
- * met and optimizing logistics.
10743
+ * - An array of image URLs associated with the bundle.
10373
10744
  */
10374
- qc_type?: string[];
10745
+ images?: string[];
10375
10746
  /**
10376
- * - A unique identifier for the bag reason.
10747
+ * - Unique group identifier for the bundle
10748
+ * generated by seller to club the articles
10377
10749
  */
10378
- id?: number;
10750
+ group_id?: string;
10379
10751
  /**
10380
- * - The display name for the bag reason, used
10381
- * for user-facing purposes.
10752
+ * - Name of the bundle.
10382
10753
  */
10383
- display_name?: string;
10384
- meta?: BagReasonMeta;
10754
+ name?: string;
10385
10755
  /**
10386
- * - An array of question sets linked
10387
- * to the bag reason, defining the questions to be answered.
10756
+ * - Type of the bundle item
10388
10757
  */
10389
- question_set?: QuestionSet[];
10758
+ item_type?: string;
10390
10759
  /**
10391
- * - An array of nested bag reasons that can
10392
- * further explain the primary reason.
10760
+ * - Unique identifier of the item.
10393
10761
  */
10394
- reasons?: BagReasons[];
10395
- };
10396
- /** @returns {ShipmentBagReasons} */
10397
- declare function ShipmentBagReasons(): ShipmentBagReasons;
10398
- type ShipmentBagReasons = {
10762
+ item_id?: number;
10399
10763
  /**
10400
- * - List of bag reasons for a shipment with
10401
- * a corresponding shipment status.
10764
+ * - Item code for the item.
10402
10765
  */
10403
- reasons?: BagReasons[];
10766
+ item_code?: string;
10404
10767
  /**
10405
- * - Indicates whether the API call was successful
10406
- * (true) or not (false).
10768
+ * - Name of the item.
10407
10769
  */
10408
- success?: boolean;
10770
+ item_name?: string;
10409
10771
  /**
10410
- * - The unique identifier for the rule that is
10411
- * associated with the given reasons. This ID serves as a reference to the
10412
- * specific rule within the RMA system that governs or influences the reasons listed.
10772
+ * - Identifier for the seller of the bundle.
10413
10773
  */
10414
- rule_id?: number;
10415
- };
10416
- /** @returns {ShipmentStatus} */
10417
- declare function ShipmentStatus(): ShipmentStatus;
10418
- type ShipmentStatus = {
10774
+ seller_identifier?: string;
10419
10775
  /**
10420
- * - The current status of the shipment.
10776
+ * - In orders with multiple
10777
+ * quantities of the same line item, the line item count remains constant, but
10778
+ * multiple bundles can exist. To distinguish between these bundles, the
10779
+ * article quantity must be used.
10421
10780
  */
10422
- current_shipment_status?: string;
10781
+ bundle_article_quantity?: number;
10423
10782
  /**
10424
- * - It contains the additional properties related to
10425
- * shipment status transition like Kafka_emission_status, user_name, etc.
10426
- * Additionally it is dynamic.
10783
+ * - Identifier for the brand name.
10427
10784
  */
10428
- meta?: any;
10785
+ brand_name?: string;
10429
10786
  /**
10430
- * - A unique identifier for the shipment status.
10787
+ * - Size associated with the bundle item.
10431
10788
  */
10432
- id?: number;
10789
+ size?: string;
10790
+ };
10791
+ /** @returns {LineItemMonetaryValuesSchema} */
10792
+ declare function LineItemMonetaryValuesSchema(): LineItemMonetaryValuesSchema;
10793
+ type LineItemMonetaryValuesSchema = {
10433
10794
  /**
10434
- * - A list of bags associated with the
10435
- * shipment, useful for tracking individual items within the shipment.
10795
+ * - Amount paid by the customer
10436
10796
  */
10437
- bag_list?: string[];
10797
+ amount_paid: number;
10438
10798
  /**
10439
- * - A brief title or label for the shipment status,
10440
- * summarizing its current state.
10799
+ * - The final effective price after applying
10800
+ * discounts, promotional offers, and adjustments.
10441
10801
  */
10442
- title: string;
10802
+ price_effective: number;
10443
10803
  /**
10444
- * - A user-friendly name or identifier for
10445
- * the shipment status.
10804
+ * - Discount amount apart from promo and coupon discount
10446
10805
  */
10447
- display_name?: string;
10806
+ discount?: number;
10448
10807
  /**
10449
- * - Timestamp when the shipment was initially
10450
- * created.This timestamp is crucial for tracking the shipment's age,
10451
- * scheduling, and historical analysis.
10808
+ * - The original marked price of the item
10809
+ * before any discounts or promotions.
10810
+ */
10811
+ price_marked: number;
10812
+ /**
10813
+ * - Coupon discount applied for this article
10814
+ */
10815
+ coupon_discount?: number;
10816
+ /**
10817
+ * - Cash on Delivery Charges Applied for this Article.
10818
+ */
10819
+ cod_charges?: number;
10820
+ /**
10821
+ * - Promotion Discount
10822
+ */
10823
+ promo_discount?: number;
10824
+ /**
10825
+ * - Gift Price
10826
+ */
10827
+ gift_price?: number;
10828
+ /**
10829
+ * - Delivery Charges Applied for this Article.
10830
+ */
10831
+ delivery_charges?: number;
10832
+ };
10833
+ /** @returns {DimensionSchema} */
10834
+ declare function DimensionSchema(): DimensionSchema;
10835
+ type DimensionSchema = {
10836
+ /**
10837
+ * - Height of the product.
10838
+ */
10839
+ height: number;
10840
+ /**
10841
+ * - Length of the product.
10842
+ */
10843
+ length: number;
10844
+ /**
10845
+ * - Width of the product
10846
+ */
10847
+ width: number;
10848
+ /**
10849
+ * - Not Modified, meaning these are same as
10850
+ * product uploaded while loading catelogue.
10851
+ */
10852
+ is_default: boolean;
10853
+ /**
10854
+ * - Unit of the measurement used.
10855
+ */
10856
+ unit: string;
10857
+ };
10858
+ /** @returns {GiftDetailsSchema} */
10859
+ declare function GiftDetailsSchema(): GiftDetailsSchema;
10860
+ type GiftDetailsSchema = {
10861
+ /**
10862
+ * - Specifies the value or cost of the gift
10863
+ * associated with the order line item.
10864
+ */
10865
+ amount: number;
10866
+ /**
10867
+ * - A short description or label intended for
10868
+ * display purposes. This can be a message to the customer, such as "Gift wrap
10869
+ * included" or "Gift card value applied."
10870
+ */
10871
+ display_text: string;
10872
+ };
10873
+ /** @returns {CPRiderDetailsSchema} */
10874
+ declare function CPRiderDetailsSchema(): CPRiderDetailsSchema;
10875
+ type CPRiderDetailsSchema = {
10876
+ name: string;
10877
+ phone: string;
10878
+ };
10879
+ /** @returns {CPAreaCodeSchema} */
10880
+ declare function CPAreaCodeSchema(): CPAreaCodeSchema;
10881
+ type CPAreaCodeSchema = {
10882
+ source: string;
10883
+ destination: string;
10884
+ };
10885
+ /** @returns {CPTatToDeliverTheShipmentSchema} */
10886
+ declare function CPTatToDeliverTheShipmentSchema(): CPTatToDeliverTheShipmentSchema;
10887
+ type CPTatToDeliverTheShipmentSchema = {
10888
+ min: number;
10889
+ max: number;
10890
+ };
10891
+ /** @returns {CPOptionsSchema} */
10892
+ declare function CPOptionsSchema(): CPOptionsSchema;
10893
+ type CPOptionsSchema = {
10894
+ /**
10895
+ * - A string that uniquely identifies the
10896
+ * courier partner extension. Refer <a
10897
+ * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
10898
+ * courier partner account</a> to get the extension id.
10899
+ */
10900
+ extension_id?: string;
10901
+ /**
10902
+ * - A string that specifies the unique
10903
+ * identifier for the scheme associated with the account. Refer <a
10904
+ * href='/commerce/sdk/latest/platform/company/serviceability#getCourierPartnerAccount'>Get
10905
+ * courier partner account</a> to get the scheme id.
10906
+ */
10907
+ scheme_id?: string;
10908
+ area_code?: CPAreaCodeSchema;
10909
+ is_self_ship?: boolean;
10910
+ max_reattempts_for_delivery_allowed?: number;
10911
+ /**
10912
+ * - A sorting key used for categorizing or
10913
+ * sorting courier partners, often related to their performance, costs, or
10914
+ * some other factor, (example: E-17A-4, E-17A-6, etc.).
10915
+ */
10916
+ cp_sort_key?: string;
10917
+ /**
10918
+ * - The name of the courier partner or the delivery
10919
+ * agent handling the shipment.
10920
+ */
10921
+ name?: string;
10922
+ rider_details?: CPRiderDetailsSchema;
10923
+ /**
10924
+ * - Specifies whether the seller's
10925
+ * credentials are being used for the courier partner.
10926
+ */
10927
+ using_own_creds?: boolean;
10928
+ /**
10929
+ * - Specifies that Assigned CP support's
10930
+ * quality checks
10931
+ */
10932
+ qc_supported?: boolean;
10933
+ };
10934
+ /** @returns {CourierPartnerDetailsSchema} */
10935
+ declare function CourierPartnerDetailsSchema(): CourierPartnerDetailsSchema;
10936
+ type CourierPartnerDetailsSchema = {
10937
+ /**
10938
+ * - A sorting key used for categorizing or
10939
+ * sorting courier partners, often related to their performance, costs, or
10940
+ * some other factor. (example: E-17A-4, E-17A-6, etc.).
10941
+ */
10942
+ cp_sort_key?: string;
10943
+ /**
10944
+ * - Other Available CP's
10945
+ */
10946
+ cp_options?: CPOptionsSchema[];
10947
+ scheme_id: string;
10948
+ /**
10949
+ * - The name of the courier partner or the delivery
10950
+ * agent handling the shipment.
10951
+ */
10952
+ name: string;
10953
+ extension_id: string;
10954
+ rider_details?: CPRiderDetailsSchema;
10955
+ /**
10956
+ * - Specifies that Assigned CP support's
10957
+ * quality checks
10958
+ */
10959
+ qc_supported?: boolean;
10960
+ /**
10961
+ * - Specifies weather the Seller's Creds or
10962
+ * Fynd's Creds are being used.
10963
+ */
10964
+ using_own_creds: boolean;
10965
+ /**
10966
+ * - Reattempts Allowed
10967
+ * (required for NDR)
10968
+ */
10969
+ max_reattempts_for_delivery_allowed?: number;
10970
+ tat_to_deliver_the_shipment?: CPTatToDeliverTheShipmentSchema;
10971
+ /**
10972
+ * - Is every logistic action handled by seller.
10973
+ */
10974
+ is_self_ship?: boolean;
10975
+ };
10976
+ /** @returns {TaxDetailsSchema} */
10977
+ declare function TaxDetailsSchema(): TaxDetailsSchema;
10978
+ type TaxDetailsSchema = {
10979
+ /**
10980
+ * - The HS code of the product
10981
+ */
10982
+ hs_code: string;
10983
+ /**
10984
+ * - Tax identifier.
10985
+ */
10986
+ tax_rule_id: string;
10987
+ };
10988
+ /** @returns {PromiseDetailsSchema} */
10989
+ declare function PromiseDetailsSchema(): PromiseDetailsSchema;
10990
+ type PromiseDetailsSchema = {
10991
+ /**
10992
+ * - Min TimeStamp (EPOCH) that will be taken to
10993
+ * deliver the product
10994
+ */
10995
+ min_sla: number;
10996
+ /**
10997
+ * - Max TimeStamp (EPOCH) that will be taken to
10998
+ * deliver the product.
10999
+ */
11000
+ max_sla: number;
11001
+ };
11002
+ /** @returns {CustomerPickupSlotSchema} */
11003
+ declare function CustomerPickupSlotSchema(): CustomerPickupSlotSchema;
11004
+ type CustomerPickupSlotSchema = {
11005
+ start_time: string;
11006
+ end_time: string;
11007
+ };
11008
+ /** @returns {DpPickupSlotSchema} */
11009
+ declare function DpPickupSlotSchema(): DpPickupSlotSchema;
11010
+ type DpPickupSlotSchema = {
11011
+ start_time: string;
11012
+ end_time: string;
11013
+ };
11014
+ /** @returns {OrderFulfillmentTimelineSchema} */
11015
+ declare function OrderFulfillmentTimelineSchema(): OrderFulfillmentTimelineSchema;
11016
+ type OrderFulfillmentTimelineSchema = {
11017
+ dp_pickup_slot?: DpPickupSlotSchema;
11018
+ /**
11019
+ * - A date indicating when the order
11020
+ * can be dispatched (e.g., the earliest possible dispatch date).
11021
+ */
11022
+ dispatch_after_date?: string;
11023
+ /**
11024
+ * - The latest date the order must be
11025
+ * dispatched to meet delivery expectations.
11026
+ */
11027
+ dispatch_by_date?: string;
11028
+ /**
11029
+ * - The deadline by which the seller must
11030
+ * confirm the order.
11031
+ */
11032
+ confirm_by_date?: string;
11033
+ customer_pickup_slot?: CustomerPickupSlotSchema;
11034
+ /**
11035
+ * - The latest time the package should be
11036
+ * packed and ready to dispatch.
11037
+ */
11038
+ pack_by_date?: string;
11039
+ };
11040
+ /** @returns {LineItemSchema} */
11041
+ declare function LineItemSchema(): LineItemSchema;
11042
+ type LineItemSchema = {
11043
+ /**
11044
+ * - Identifier of the seller selling the item.
11045
+ */
11046
+ seller_identifier?: string;
11047
+ /**
11048
+ * - Payment methods
11049
+ * used to sell this order.
11050
+ */
11051
+ payment_methods: LineItemPaymentMethodSchema[];
11052
+ monetary_values: LineItemMonetaryValuesSchema;
11053
+ gift_details?: GiftDetailsSchema;
11054
+ /**
11055
+ * - These instructions are added by
11056
+ * the customer at checkout for the seller's reference.
11057
+ */
11058
+ special_instructions?: string;
11059
+ dimension?: DimensionSchema;
11060
+ /**
11061
+ * - Quantity of the Line Item
11062
+ */
11063
+ quantity?: number;
11064
+ /**
11065
+ * - Unique identifier for the LineItem as
11066
+ * assigned by an external system. You can use this to map external id to
11067
+ * Fynd's generated id
11068
+ */
11069
+ external_line_id?: string;
11070
+ bundle_details?: BundleDetailsSchema;
11071
+ /**
11072
+ * - Contains metadata related to the shipment
11073
+ */
11074
+ meta?: any;
11075
+ };
11076
+ /** @returns {CreateOrderShipmentSchema} */
11077
+ declare function CreateOrderShipmentSchema(): CreateOrderShipmentSchema;
11078
+ type CreateOrderShipmentSchema = {
11079
+ /**
11080
+ * - Indicates if the shipment belongs to the
11081
+ * made-to-order category, i.e., the seller will start creating this order
11082
+ * after receiving an order creation request.
11083
+ */
11084
+ is_mto?: boolean;
11085
+ /**
11086
+ * - List of
11087
+ * general-purpose messages shown across different points in the shipment's
11088
+ * journey at Order Details screen.
11089
+ */
11090
+ shipment_lifecycle_messages?: LifecycleMessageSchema[];
11091
+ /**
11092
+ * - Tags that can be attached to the shipment for
11093
+ * filtering and categorization.
11094
+ */
11095
+ tags?: string[];
11096
+ /**
11097
+ * - The shipment type defining the fulfillment method
11098
+ * and processing flow. Each type determines the specific journey a shipment
11099
+ * will follow based on operational needs and customer preferences:
11100
+ * "HomeDelivery": Standard delivery to the customer's address, undergoing all
11101
+ * typical state transitions from processing to final delivery. "PickAtStore":
11102
+ * Order prepared for in-store pickup, bypassing traditional shipping stages
11103
+ * for direct handover to the customer. "Digital": Orders involving digital
11104
+ * goods or services (e.g., software, e-books, subscriptions) delivered electronically.
11105
+ */
11106
+ type?: string;
11107
+ fulfillment_option?: FulfillmentOptionSchema;
11108
+ /**
11109
+ * - Unique identifier for the
11110
+ * shipment as assigned by an external system. Use this to map the external ID
11111
+ * to Fynd's generated ID.
11112
+ */
11113
+ external_shipment_id?: string;
11114
+ /**
11115
+ * - A list of items included in the shipment.
11116
+ */
11117
+ line_items?: LineItemSchema[];
11118
+ order_fulfillment_timeline?: OrderFulfillmentTimelineSchema;
11119
+ /**
11120
+ * - The location ID from which this shipment
11121
+ * is being fulfilled.
11122
+ */
11123
+ location_id?: number;
11124
+ /**
11125
+ * - The external location ID from
11126
+ * which this shipment is being fulfilled.
11127
+ */
11128
+ external_location_id?: string;
11129
+ /**
11130
+ * - Overrides the article's default
11131
+ * return location.
11132
+ */
11133
+ return_location_id?: number;
11134
+ courier_partner_details?: CourierPartnerDetailsSchema;
11135
+ tax_details?: TaxDetailsSchema;
11136
+ promise_details?: PromiseDetailsSchema;
11137
+ /**
11138
+ * - Defines the UTC time at which
11139
+ * the shipment will automatically move to the placed state.
11140
+ */
11141
+ allow_processing_after?: string;
11142
+ /**
11143
+ * - Additional metadata related to the shipment.
11144
+ */
11145
+ meta?: any;
11146
+ };
11147
+ /** @returns {OrderingCurrencySchema} */
11148
+ declare function OrderingCurrencySchema(): OrderingCurrencySchema;
11149
+ type OrderingCurrencySchema = {
11150
+ /**
11151
+ * - The <a
11152
+ * href='https://www.iso.org/iso-4217-currency-codes.html'>ISO 4217</a>
11153
+ * currency code, such as 'INR' for Indian Rupee. This field represents the
11154
+ * standardized three-letter code of a currency.
11155
+ */
11156
+ currency_code: string;
11157
+ /**
11158
+ * - The symbol representing the currency,
11159
+ * such as '₹' for Indian Rupee. This is used for display purposes alongside
11160
+ * currency amounts.
11161
+ */
11162
+ currency_symbol: string;
11163
+ };
11164
+ /** @returns {ConversionRateSchema} */
11165
+ declare function ConversionRateSchema(): ConversionRateSchema;
11166
+ type ConversionRateSchema = {
11167
+ /**
11168
+ * - The exchange rate used to convert monetary values
11169
+ * from the ordering currency to the seller's currency.
11170
+ */
11171
+ rate: number;
11172
+ /**
11173
+ * - The timestamp (in milliseconds) when the
11174
+ * conversion rate was applied.
11175
+ */
11176
+ timestamp_ms: number;
11177
+ };
11178
+ /** @returns {CurrencySchema} */
11179
+ declare function CurrencySchema(): CurrencySchema;
11180
+ type CurrencySchema = {
11181
+ ordering_currency: OrderingCurrencySchema;
11182
+ conversion_rate: ConversionRateSchema;
11183
+ /**
11184
+ * - The ISO 4217 currency code, such as
11185
+ * 'INR' for Indian Rupee. This field represents the standardized three-letter
11186
+ * code of a currency.
11187
+ */
11188
+ currency_code?: string;
11189
+ /**
11190
+ * - The symbol representing the currency,
11191
+ * such as '₹' for Indian Rupee. This is used for display purposes alongside
11192
+ * currency amounts.
11193
+ */
11194
+ currency_symbol?: string;
11195
+ };
11196
+ /** @returns {CouponOwnershipSchema} */
11197
+ declare function CouponOwnershipSchema(): CouponOwnershipSchema;
11198
+ type CouponOwnershipSchema = {
11199
+ /**
11200
+ * - Indicates who issued the coupon
11201
+ */
11202
+ payable_category: string;
11203
+ };
11204
+ /** @returns {CouponSchema} */
11205
+ declare function CouponSchema(): CouponSchema;
11206
+ type CouponSchema = {
11207
+ /**
11208
+ * - The coupon code that was applied.
11209
+ */
11210
+ code: string;
11211
+ /**
11212
+ * - Unique identifier of the coupon.
11213
+ */
11214
+ id: string;
11215
+ ownership: CouponOwnershipSchema;
11216
+ /**
11217
+ * - Indicates whether returns are allowed
11218
+ * when this coupon is applied.
11219
+ */
11220
+ is_return_allowed: boolean;
11221
+ /**
11222
+ * - Indicates whether cancellations
11223
+ * are allowed when this coupon is applied.
11224
+ */
11225
+ is_cancellation_allowed: boolean;
11226
+ };
11227
+ /** @returns {BillingDetailsSchema} */
11228
+ declare function BillingDetailsSchema(): BillingDetailsSchema;
11229
+ type BillingDetailsSchema = {
11230
+ /**
11231
+ * - First name of the customer
11232
+ */
11233
+ first_name?: string;
11234
+ /**
11235
+ * - Country phone code ex: +91
11236
+ */
11237
+ phone_code?: string;
11238
+ /**
11239
+ * - Country of the customer
11240
+ */
11241
+ country?: string;
11242
+ /**
11243
+ * - City of the customer
11244
+ */
11245
+ city?: string;
11246
+ /**
11247
+ * - Pincode of the customer
11248
+ */
11249
+ pincode?: string;
11250
+ /**
11251
+ * - Last name of the customer
11252
+ */
11253
+ last_name?: string;
11254
+ /**
11255
+ * - Primary phone number of the customer
11256
+ */
11257
+ mobile_number?: string;
11258
+ /**
11259
+ * - Primary email of the customer
11260
+ */
11261
+ email?: string;
11262
+ /**
11263
+ * - State of the customer
11264
+ */
11265
+ state?: string;
11266
+ /**
11267
+ * - Alternate mobile number
11268
+ */
11269
+ alternate_mobile_number?: string;
11270
+ /**
11271
+ * - Billing address of the customer
11272
+ */
11273
+ address?: string;
11274
+ /**
11275
+ * - Customer's middle name.
11276
+ */
11277
+ middle_name?: string;
11278
+ /**
11279
+ * - Customer's title or prefix.
11280
+ */
11281
+ title?: string;
11282
+ /**
11283
+ * - House or apartment number of the customer.
11284
+ */
11285
+ house_no?: string;
11286
+ geo_location?: GeoLocationSchema;
11287
+ /**
11288
+ * - Gender of customer
11289
+ */
11290
+ gender?: string;
11291
+ /**
11292
+ * - Landmark or reference point near the
11293
+ * customer's location.
11294
+ */
11295
+ landmark?: string;
11296
+ /**
11297
+ * - Address type in the seller's system.
11298
+ */
11299
+ address_type?: string;
11300
+ /**
11301
+ * - State code of the customer's location.
11302
+ */
11303
+ state_code?: string;
11304
+ /**
11305
+ * - Floor number of the customer's location.
11306
+ */
11307
+ floor_no?: string;
11308
+ /**
11309
+ * - Alternate Email Address
11310
+ */
11311
+ alternate_email?: string;
11312
+ /**
11313
+ * - First line of the address.
11314
+ */
11315
+ address1?: string;
11316
+ /**
11317
+ * - Second line of the address.
11318
+ */
11319
+ address2?: string;
11320
+ /**
11321
+ * - Specifies the country's unique
11322
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
11323
+ * is crucial for distinguishing countries in international transactions, data
11324
+ * processing, and shipping logistics.
11325
+ */
11326
+ country_iso_code?: string;
11327
+ /**
11328
+ * - The unique identifier assigned to the
11329
+ * customer. Refer <a
11330
+ * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
11331
+ * to get more details.
11332
+ */
11333
+ user_id?: string;
11334
+ /**
11335
+ * - Area Code
11336
+ */
11337
+ area_code?: string;
11338
+ area_code_slug?: string;
11339
+ country_phone_code?: string;
11340
+ };
11341
+ /** @returns {CPConfigurationSchema} */
11342
+ declare function CPConfigurationSchema(): CPConfigurationSchema;
11343
+ type CPConfigurationSchema = {
11344
+ /**
11345
+ * - Shipping Handled by FYND or SELLER
11346
+ */
11347
+ shipping_by: string;
11348
+ };
11349
+ /** @returns {ShippingDetailsSchema} */
11350
+ declare function ShippingDetailsSchema(): ShippingDetailsSchema;
11351
+ type ShippingDetailsSchema = {
11352
+ /**
11353
+ * - First name of the customer
11354
+ */
11355
+ first_name?: string;
11356
+ /**
11357
+ * - Country phone code ex: +91
11358
+ */
11359
+ phone_code?: string;
11360
+ /**
11361
+ * - Country of the customer
11362
+ */
11363
+ country?: string;
11364
+ /**
11365
+ * - City of the customer
11366
+ */
11367
+ city?: string;
11368
+ /**
11369
+ * - Pincode of the customer
11370
+ */
11371
+ pincode?: string;
11372
+ /**
11373
+ * - Last name of the customer
11374
+ */
11375
+ last_name?: string;
11376
+ /**
11377
+ * - Primary phone number of the customer
11378
+ */
11379
+ mobile_number?: string;
11380
+ /**
11381
+ * - Primary email of the customer
11382
+ */
11383
+ email?: string;
11384
+ /**
11385
+ * - State of the customer
11386
+ */
11387
+ state?: string;
11388
+ /**
11389
+ * - Alternate mobile number
11390
+ */
11391
+ alternate_mobile_number?: string;
11392
+ /**
11393
+ * - Shipping address of the customer
11394
+ */
11395
+ address?: string;
11396
+ /**
11397
+ * - Customer's middle name.
11398
+ */
11399
+ middle_name?: string;
11400
+ /**
11401
+ * - Customer's title or prefix.
11402
+ */
11403
+ title?: string;
11404
+ /**
11405
+ * - House or apartment number of the customer.
11406
+ */
11407
+ house_no?: string;
11408
+ geo_location?: GeoLocationSchema;
11409
+ /**
11410
+ * - Gender of customer
11411
+ */
11412
+ gender?: string;
11413
+ /**
11414
+ * - Landmark or reference point near the
11415
+ * customer's location.
11416
+ */
11417
+ landmark?: string;
11418
+ /**
11419
+ * - A string representing the address type in
11420
+ * the seller's system.
11421
+ */
11422
+ address_type?: string;
11423
+ /**
11424
+ * - State code of the customer's location.
11425
+ */
11426
+ state_code?: string;
11427
+ /**
11428
+ * - Floor number of the customer's location.
11429
+ */
11430
+ floor_no?: string;
11431
+ /**
11432
+ * - Alternate Email Address
11433
+ */
11434
+ alternate_email?: string;
11435
+ /**
11436
+ * - First line of the address
11437
+ */
11438
+ address1?: string;
11439
+ /**
11440
+ * - Second line of the address
11441
+ */
11442
+ address2?: string;
11443
+ /**
11444
+ * - Specifies the country's unique
11445
+ * identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
11446
+ * is crucial for distinguishing countries in international transactions, data
11447
+ * processing, and shipping logistics.
11448
+ */
11449
+ country_iso_code?: string;
11450
+ /**
11451
+ * - The unique identifier assigned to the
11452
+ * customer. Refer <a
11453
+ * href='/commerce/sdk/latest/platform/application/user#customer'>Customer</a>
11454
+ * in platform documentation to get more details. details.
11455
+ */
11456
+ user_id?: string;
11457
+ /**
11458
+ * - Area Code
11459
+ */
11460
+ area_code?: string;
11461
+ area_code_slug?: string;
11462
+ country_phone_code?: string;
11463
+ };
11464
+ /** @returns {UserDetailsSchema} */
11465
+ declare function UserDetailsSchema(): UserDetailsSchema;
11466
+ type UserDetailsSchema = {
11467
+ /**
11468
+ * - The customer's GSTIN (Goods and Services Tax
11469
+ * Identification Number).
11470
+ */
11471
+ gstin?: string;
11472
+ /**
11473
+ * - The customer's PAN (Permanent Account Number).
11474
+ */
11475
+ pan_no?: string;
11476
+ };
11477
+ /** @returns {LifecycleMessageSchema} */
11478
+ declare function LifecycleMessageSchema(): LifecycleMessageSchema;
11479
+ type LifecycleMessageSchema = {
11480
+ /**
11481
+ * - The message text to display to users at specific
11482
+ * order states (e.g., PLACED, SHIPPED).
11483
+ */
11484
+ message: string;
11485
+ /**
11486
+ * - The message type, which determines the color of the
11487
+ * message bar.
11488
+ */
11489
+ type: string;
11490
+ /**
11491
+ * - List of OMS states at which the message should
11492
+ * be visible.
11493
+ */
11494
+ states: string[];
11495
+ /**
11496
+ * - Determines the message display sequence, with
11497
+ * '1' being the highest priority.
11498
+ */
11499
+ priority: number;
11500
+ };
11501
+ /** @returns {CreateOrderRequestSchema} */
11502
+ declare function CreateOrderRequestSchema(): CreateOrderRequestSchema;
11503
+ type CreateOrderRequestSchema = {
11504
+ /**
11505
+ * - List of shipments
11506
+ * included in the order.
11507
+ */
11508
+ shipments?: CreateOrderShipmentSchema[];
11509
+ /**
11510
+ * - Tags that can be used to filter and categorize
11511
+ * orders and shipments.
11512
+ */
11513
+ tags?: string[];
11514
+ currency_details: CurrencySchema;
11515
+ /**
11516
+ * - Timestamp indicating when the
11517
+ * order was created in an external system.
11518
+ */
11519
+ external_creation_date?: string;
11520
+ coupon_details?: CouponSchema;
11521
+ billing_details: BillingDetailsSchema;
11522
+ /**
11523
+ * - The primary payment method used for
11524
+ * the entire order transaction.
11525
+ */
11526
+ primary_payment_mode: string;
11527
+ cp_configuration?: CPConfigurationSchema;
11528
+ /**
11529
+ * - The location ID where the order
11530
+ * is placed. Required when the order is placed from one location but
11531
+ * fulfilled by another.
11532
+ */
11533
+ ordering_location_id?: number;
11534
+ /**
11535
+ * - Allows location
11536
+ * reassignment before order confirmation.
11537
+ */
11538
+ allow_location_reassignment?: boolean;
11539
+ shipping_details: ShippingDetailsSchema;
11540
+ /**
11541
+ * - A unique identifier assigned to the
11542
+ * order by an external system or service.
11543
+ */
11544
+ external_order_id?: string;
11545
+ user_details?: UserDetailsSchema;
11546
+ /**
11547
+ * - List of
11548
+ * order lifecycle messages to be displayed to the seller at Order Details.
11549
+ */
11550
+ order_lifecycle_messages?: LifecycleMessageSchema[];
11551
+ /**
11552
+ * - Identifies the application from
11553
+ * which the order was created. Pass this when it differs from the fulfilling
11554
+ * company's application.
11555
+ */
11556
+ channel_application_id?: string;
11557
+ /**
11558
+ * - The GSTIN (Goods and Services Tax
11559
+ * Identification Number) for business-to-business transactions.
11560
+ */
11561
+ b2b_gstin_number?: string;
11562
+ /**
11563
+ * - The company ID where the order is
11564
+ * placed. Required when the order is placed from one company but fulfilled by another.
11565
+ */
11566
+ channel_company_id?: string;
11567
+ /**
11568
+ * - Indicates whether the order is a draft.
11569
+ * Draft orders will be moved to upcoming state instead of placed status.
11570
+ */
11571
+ is_draft?: boolean;
11572
+ };
11573
+ /** @returns {Page} */
11574
+ declare function Page(): Page;
11575
+ type Page = {
11576
+ /**
11577
+ * - The total number of all items across all pages.
11578
+ */
11579
+ item_total?: number;
11580
+ /**
11581
+ * - The identifier for the next page.
11582
+ */
11583
+ next_id?: string;
11584
+ /**
11585
+ * - Indicates whether there is a previous page.
11586
+ */
11587
+ has_previous?: boolean;
11588
+ /**
11589
+ * - Indicates whether there is a next page.
11590
+ */
11591
+ has_next?: boolean;
11592
+ /**
11593
+ * - The current page number.
11594
+ */
11595
+ current?: number;
11596
+ /**
11597
+ * - The type of the page, such as 'PageType'.
11598
+ */
11599
+ type: string;
11600
+ /**
11601
+ * - The number of items per page.
11602
+ */
11603
+ size?: number;
11604
+ /**
11605
+ * - The number of items per page.
11606
+ */
11607
+ page_size?: number;
11608
+ };
11609
+ /** @returns {OrderingSourceConfig} */
11610
+ declare function OrderingSourceConfig(): OrderingSourceConfig;
11611
+ type OrderingSourceConfig = {
11612
+ /**
11613
+ * - Slug of the ordering source.
11614
+ */
11615
+ slug?: string;
11616
+ configs?: OrderingSourceFeature[];
11617
+ /**
11618
+ * - Logo of the ordering source.
11619
+ */
11620
+ logo?: string;
11621
+ };
11622
+ /** @returns {OrderingSourceFeature} */
11623
+ declare function OrderingSourceFeature(): OrderingSourceFeature;
11624
+ type OrderingSourceFeature = {
11625
+ /**
11626
+ * - Name of the ordering source config item.
11627
+ */
11628
+ name?: string;
11629
+ /**
11630
+ * - Slug of the ordering source config item.
11631
+ */
11632
+ slug?: string;
11633
+ /**
11634
+ * - Description of the ordering source config item.
11635
+ */
11636
+ description?: string;
11637
+ /**
11638
+ * - Whether the config/feature is enabled or not.
11639
+ */
11640
+ enabled?: boolean;
11641
+ };
11642
+ /** @returns {ListOrderingSources} */
11643
+ declare function ListOrderingSources(): ListOrderingSources;
11644
+ type ListOrderingSources = {
11645
+ items?: OrderingSourceSummary[];
11646
+ page?: Page;
11647
+ };
11648
+ /** @returns {OrderingSourceSummary} */
11649
+ declare function OrderingSourceSummary(): OrderingSourceSummary;
11650
+ type OrderingSourceSummary = {
11651
+ /**
11652
+ * - Display Text of the ordering source.
11653
+ */
11654
+ text?: string;
11655
+ /**
11656
+ * - Value of the ordering source.
11657
+ */
11658
+ value?: string;
11659
+ };
11660
+ /** @returns {CreateAccount} */
11661
+ declare function CreateAccount(): CreateAccount;
11662
+ type CreateAccount = {
11663
+ /**
11664
+ * - Unique name identifier for the
11665
+ * channel account. This represents the sales channel or marketplace through
11666
+ * which orders are received and processed.
11667
+ */
11668
+ channel_account_name: string;
11669
+ };
11670
+ /** @returns {Account} */
11671
+ declare function Account(): Account;
11672
+ type Account = {
11673
+ /**
11674
+ * - Unique identifier for the channel
11675
+ * account. This is a system-generated identifier used to reference the
11676
+ * account across the platform.
11677
+ */
11678
+ channel_account_id?: string;
11679
+ /**
11680
+ * - Unique identifier of the company on the
11681
+ * platform to which this channel account belongs.
11682
+ */
11683
+ company_id?: number;
11684
+ /**
11685
+ * - Name of the channel account. This
11686
+ * identifies the specific sales channel or marketplace (e.g., SHOPIFY,
11687
+ * MARKETPLACE, etc.) through which the company receives and processes orders.
11688
+ */
11689
+ channel_account_name?: string;
11690
+ };
11691
+ /** @returns {AccountsList} */
11692
+ declare function AccountsList(): AccountsList;
11693
+ type AccountsList = {
11694
+ /**
11695
+ * - List of channel accounts associated with the
11696
+ * company. Each account represents a different sales channel or marketplace
11697
+ * integration.
11698
+ */
11699
+ data?: Account[];
11700
+ page?: Page;
11701
+ };
11702
+ /** @returns {ValidationError} */
11703
+ declare function ValidationError(): ValidationError;
11704
+ type ValidationError = {
11705
+ /**
11706
+ * - A brief description of the error encountered.
11707
+ */
11708
+ message: string;
11709
+ /**
11710
+ * - The field in the request that caused the error.
11711
+ */
11712
+ field: string;
11713
+ };
11714
+ /** @returns {BagReasonMeta} */
11715
+ declare function BagReasonMeta(): BagReasonMeta;
11716
+ type BagReasonMeta = {
11717
+ /**
11718
+ * - Indicates whether a text area should
11719
+ * be displayed for additional input related to the bag reason.
11720
+ */
11721
+ show_text_area?: boolean;
11722
+ };
11723
+ /** @returns {QuestionSet} */
11724
+ declare function QuestionSet(): QuestionSet;
11725
+ type QuestionSet = {
11726
+ /**
11727
+ * - A unique identifier for the question set.
11728
+ */
11729
+ id?: number;
11730
+ /**
11731
+ * - The display name for the question set,
11732
+ * used for user-facing purposes.
11733
+ */
11734
+ display_name?: string;
11735
+ };
11736
+ /** @returns {BagReasons} */
11737
+ declare function BagReasons(): BagReasons;
11738
+ type BagReasons = {
11739
+ /**
11740
+ * - List of QC (Quality Control) types -- having
11741
+ * return reason types indicating the stage at which QC is performed. -
11742
+ * "Doorstep QC" refers involves inspecting products for damages at the
11743
+ * customer's location before delivery. - "Pre QC" requires customers to
11744
+ * upload product photos for a preliminary quality check by the operations
11745
+ * team before a return or exchange pickup is arranged, ensuring criteria are
11746
+ * met and optimizing logistics.
11747
+ */
11748
+ qc_type?: string[];
11749
+ /**
11750
+ * - A unique identifier for the bag reason.
11751
+ */
11752
+ id?: number;
11753
+ /**
11754
+ * - The display name for the bag reason, used
11755
+ * for user-facing purposes.
11756
+ */
11757
+ display_name?: string;
11758
+ meta?: BagReasonMeta;
11759
+ /**
11760
+ * - An array of question sets linked
11761
+ * to the bag reason, defining the questions to be answered.
11762
+ */
11763
+ question_set?: QuestionSet[];
11764
+ /**
11765
+ * - An array of nested bag reasons that can
11766
+ * further explain the primary reason.
11767
+ */
11768
+ reasons?: BagReasons[];
11769
+ };
11770
+ /** @returns {ShipmentBagReasons} */
11771
+ declare function ShipmentBagReasons(): ShipmentBagReasons;
11772
+ type ShipmentBagReasons = {
11773
+ /**
11774
+ * - List of bag reasons for a shipment with
11775
+ * a corresponding shipment status.
11776
+ */
11777
+ reasons?: BagReasons[];
11778
+ /**
11779
+ * - Indicates whether the API call was successful
11780
+ * (true) or not (false).
11781
+ */
11782
+ success?: boolean;
11783
+ /**
11784
+ * - The unique identifier for the rule that is
11785
+ * associated with the given reasons. This ID serves as a reference to the
11786
+ * specific rule within the RMA system that governs or influences the reasons listed.
11787
+ */
11788
+ rule_id?: number;
11789
+ };
11790
+ /** @returns {ShipmentStatus} */
11791
+ declare function ShipmentStatus(): ShipmentStatus;
11792
+ type ShipmentStatus = {
11793
+ /**
11794
+ * - The current status of the shipment.
11795
+ */
11796
+ current_shipment_status?: string;
11797
+ /**
11798
+ * - It contains the additional properties related to
11799
+ * shipment status transition like Kafka_emission_status, user_name, etc.
11800
+ * Additionally it is dynamic.
11801
+ */
11802
+ meta?: any;
11803
+ /**
11804
+ * - A unique identifier for the shipment status.
11805
+ */
11806
+ id?: number;
11807
+ /**
11808
+ * - A list of bags associated with the
11809
+ * shipment, useful for tracking individual items within the shipment.
11810
+ */
11811
+ bag_list?: string[];
11812
+ /**
11813
+ * - A brief title or label for the shipment status,
11814
+ * summarizing its current state.
11815
+ */
11816
+ title: string;
11817
+ /**
11818
+ * - A user-friendly name or identifier for
11819
+ * the shipment status.
11820
+ */
11821
+ display_name?: string;
11822
+ /**
11823
+ * - Timestamp when the shipment was initially
11824
+ * created.This timestamp is crucial for tracking the shipment's age,
11825
+ * scheduling, and historical analysis.
10452
11826
  */
10453
11827
  created_at?: string;
10454
11828
  /**
@@ -10537,6 +11911,94 @@ type UserDataInfo = {
10537
11911
  */
10538
11912
  country_phone_code?: string;
10539
11913
  };
11914
+ /** @returns {BundleReturnConfig} */
11915
+ declare function BundleReturnConfig(): BundleReturnConfig;
11916
+ type BundleReturnConfig = {
11917
+ /**
11918
+ * - Indicates whether partial
11919
+ * returns are allowed for bundle products.
11920
+ */
11921
+ allow_partial_return?: boolean;
11922
+ /**
11923
+ * - Indicates whether the bundle product is returnable.
11924
+ */
11925
+ returnable?: boolean;
11926
+ /**
11927
+ * - Time unit for the return window (e.g., "week",
11928
+ * "day", "hour").
11929
+ */
11930
+ unit?: boolean;
11931
+ /**
11932
+ * - Duration value for the return window, expressed
11933
+ * in the specified unit.
11934
+ */
11935
+ time?: boolean;
11936
+ };
11937
+ /** @returns {BundleDetails} */
11938
+ declare function BundleDetails(): BundleDetails;
11939
+ type BundleDetails = {
11940
+ /**
11941
+ * - Unique group identifier for the bundle.
11942
+ */
11943
+ bundle_group_id?: string;
11944
+ /**
11945
+ * - Name of the bundle.
11946
+ */
11947
+ name?: string;
11948
+ /**
11949
+ * - URL-friendly identifier for the bundle.
11950
+ */
11951
+ slug?: string;
11952
+ /**
11953
+ * - Indicates bundle count of the bag.
11954
+ */
11955
+ bundle_count?: number;
11956
+ /**
11957
+ * - Unique identifier for the article bundle.
11958
+ */
11959
+ article_bundle_id?: string;
11960
+ /**
11961
+ * - Article net_quantity in bundle Product.
11962
+ */
11963
+ bundle_article_quantity?: number;
11964
+ /**
11965
+ * - A flag that determines if bag is base bag of bundle.
11966
+ */
11967
+ is_base?: boolean;
11968
+ /**
11969
+ * - Maximum Retail Price of the bundle.
11970
+ */
11971
+ price_marked?: number;
11972
+ /**
11973
+ * - Current selling price of the bundle.
11974
+ */
11975
+ price_effective?: number;
11976
+ /**
11977
+ * - Unique identifier for the item.
11978
+ */
11979
+ item_id?: number;
11980
+ /**
11981
+ * - Type of the item (physical_bundle, virtual_bundle).
11982
+ */
11983
+ item_type?: string;
11984
+ return_config?: BundleReturnConfig;
11985
+ /**
11986
+ * - Identifier for the seller of the bundle.
11987
+ */
11988
+ seller_identifier?: string;
11989
+ /**
11990
+ * - An array of image URLs associated with the bundle.
11991
+ */
11992
+ images?: string[];
11993
+ /**
11994
+ * - Identifier for the brand name.
11995
+ */
11996
+ brand_name?: string;
11997
+ /**
11998
+ * - Size associated with the bundle item.
11999
+ */
12000
+ size?: string;
12001
+ };
10540
12002
  /** @returns {Address} */
10541
12003
  declare function Address(): Address;
10542
12004
  type Address = {
@@ -12264,8 +13726,8 @@ type ShipmentItem = {
12264
13726
  */
12265
13727
  ordering_channnel?: string;
12266
13728
  /**
12267
- * - To uniquely identify the source
12268
- * through which order has been placed (e.g, marketplace, gofynd).
13729
+ * - Ordering source, to be used to
13730
+ * identify source of order creation.
12269
13731
  */
12270
13732
  ordering_source?: string;
12271
13733
  /**
@@ -12502,8 +13964,8 @@ type OrderDetailsData = {
12502
13964
  */
12503
13965
  ordering_channel?: string;
12504
13966
  /**
12505
- * - To uniquely identify the source
12506
- * through which order has been placed (e.g, marketplace, gofynd).
13967
+ * - Ordering source, to be used to
13968
+ * identify source of order creation.
12507
13969
  */
12508
13970
  ordering_source?: string;
12509
13971
  loyalty_discount_details?: LoyaltyDiscountDetails;
@@ -13197,6 +14659,12 @@ type BagConfigs = {
13197
14659
  * customer return is allowed for the bag.
13198
14660
  */
13199
14661
  is_customer_return_allowed: boolean;
14662
+ /**
14663
+ * - Flag to indicate whether the bag is
14664
+ * part of a bundle.
14665
+ */
14666
+ is_bundle_item?: boolean;
14667
+ bundle_details?: BundleDetails;
13200
14668
  };
13201
14669
  /** @returns {OrderBagArticle} */
13202
14670
  declare function OrderBagArticle(): OrderBagArticle;
@@ -14132,22 +15600,6 @@ type PaymentInfoData = {
14132
15600
  */
14133
15601
  merchant_transaction_id?: string;
14134
15602
  };
14135
- /** @returns {CurrencySchema} */
14136
- declare function CurrencySchema(): CurrencySchema;
14137
- type CurrencySchema = {
14138
- /**
14139
- * - The ISO 4217 currency code, such as
14140
- * 'INR' for Indian Rupee. This field represents the standardized three-letter
14141
- * code of a currency.
14142
- */
14143
- currency_code?: string;
14144
- /**
14145
- * - The symbol representing the currency,
14146
- * such as '₹' for Indian Rupee. This is used for display purposes alongside
14147
- * currency amounts.
14148
- */
14149
- currency_symbol?: string;
14150
- };
14151
15603
  /** @returns {OrderData} */
14152
15604
  declare function OrderData(): OrderData;
14153
15605
  type OrderData = {
@@ -14158,8 +15610,8 @@ type OrderData = {
14158
15610
  */
14159
15611
  ordering_channel?: string;
14160
15612
  /**
14161
- * - To uniquely identify the source
14162
- * through which order has been placed (e.g, marketplace, gofynd).
15613
+ * - Ordering source, to be used to
15614
+ * identify source of order creation.
14163
15615
  */
14164
15616
  ordering_source?: string;
14165
15617
  /**
@@ -15252,10 +16704,3 @@ type BulkFailedResponseSchema = {
15252
16704
  status?: boolean;
15253
16705
  error?: string;
15254
16706
  };
15255
- /**
15256
- * Enum: OrderingSource Used By: Order
15257
- *
15258
- * @returns {OrderingSource}
15259
- */
15260
- declare function OrderingSource(): OrderingSource;
15261
- type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";