@gofynd/fdk-client-javascript 3.10.0 → 3.12.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +71 -12
- package/sdk/common/Constant.d.ts +5 -0
- package/sdk/common/Constant.js +5 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +80 -80
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -35
- package/sdk/platform/Cart/CartPlatformModel.js +103 -46
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +14 -48
- package/sdk/platform/Catalog/CatalogPlatformClient.js +85 -338
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +210 -765
- package/sdk/platform/Catalog/CatalogPlatformModel.js +112 -394
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +14 -60
- package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
- package/sdk/platform/Content/ContentPlatformModel.js +5 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +252 -0
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +34 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +42 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +70 -8
- package/sdk/platform/Order/OrderPlatformClient.js +454 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1851 -431
- package/sdk/platform/Order/OrderPlatformModel.js +1171 -448
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +150 -16
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -9
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
|
@@ -395,8 +395,8 @@ export = OrderPlatformModel;
|
|
|
395
395
|
*/
|
|
396
396
|
/**
|
|
397
397
|
* @typedef DPConfiguration
|
|
398
|
-
* @property {string} [shipping_by] -
|
|
399
|
-
*
|
|
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] -
|
|
418
|
-
* for the
|
|
419
|
-
* for the
|
|
420
|
-
* reassignment will not be performed
|
|
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
|
|
424
|
-
* optimal shipment creation strategy based on the
|
|
425
|
-
* dimensions by OMS
|
|
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 -
|
|
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] -
|
|
877
|
-
*
|
|
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
|
|
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 {
|
|
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 {
|
|
1002
|
+
* @property {Tax} [tax]
|
|
1003
1003
|
*/
|
|
1004
1004
|
/**
|
|
1005
1005
|
* @typedef LineItem
|
|
1006
|
-
* @property {Charge[]} [charges] - An array of Charge objects related to the
|
|
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
|
|
1059
|
-
*
|
|
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] -
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
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
|
-
*
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
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] -
|
|
1131
|
-
*
|
|
1132
|
-
* @property {string} [state] -
|
|
1133
|
-
*
|
|
1134
|
-
*
|
|
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] -
|
|
1139
|
-
* @property {string} [primary_mobile_number] -
|
|
1140
|
-
*
|
|
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] -
|
|
1144
|
-
* @property {string} [house_no] -
|
|
1145
|
-
*
|
|
1146
|
-
* @property {string} [
|
|
1147
|
-
* @property {string} [
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1150
|
-
* @property {string} [
|
|
1151
|
-
* @property {string} [
|
|
1152
|
-
*
|
|
1153
|
-
* @property {string} [
|
|
1154
|
-
*
|
|
1155
|
-
* @property {string} [
|
|
1156
|
-
* @property {string} [
|
|
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] -
|
|
1166
|
-
* @property {string} [address1] -
|
|
1167
|
-
* @property {string} [pincode] -
|
|
1168
|
-
*
|
|
1169
|
-
* @property {string} [
|
|
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
|
|
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] -
|
|
1207
|
-
* @property {string} [address1] -
|
|
1208
|
-
* @property {string} [pincode] -
|
|
1209
|
-
*
|
|
1210
|
-
* @property {string} [
|
|
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] -
|
|
1226
|
-
* @property {string} [primary_email] -
|
|
1227
|
-
*
|
|
1228
|
-
* @property {string}
|
|
1229
|
-
* @property {string}
|
|
1230
|
-
* @property {string}
|
|
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] -
|
|
1237
|
-
* (
|
|
1238
|
-
*
|
|
1239
|
-
* @property {string} [
|
|
1240
|
-
*
|
|
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 -
|
|
1246
|
-
*
|
|
1247
|
-
*
|
|
1248
|
-
*
|
|
1249
|
-
*
|
|
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 -
|
|
1263
|
-
*
|
|
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,
|
|
1273
|
-
* type, shipment
|
|
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] -
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
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] -
|
|
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.
|
|
@@ -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] -
|
|
2382
|
-
*
|
|
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,412 @@ export = OrderPlatformModel;
|
|
|
2592
2571
|
* @property {string} small - URL for the small version of the payment method's logo.
|
|
2593
2572
|
*/
|
|
2594
2573
|
/**
|
|
2595
|
-
* @typedef
|
|
2596
|
-
* @property {string}
|
|
2597
|
-
*
|
|
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.
|
|
2586
|
+
* @property {string} [logo]
|
|
2587
|
+
*/
|
|
2588
|
+
/**
|
|
2589
|
+
* @typedef SubModeOfPaymentSchema
|
|
2590
|
+
* @property {string} name - Name of the Sub MOP Used.
|
|
2591
|
+
*/
|
|
2592
|
+
/**
|
|
2593
|
+
* @typedef PaymentMethodModeOfPaymentSchema
|
|
2594
|
+
* @property {string} name - Payment Mode Name.
|
|
2595
|
+
* @property {string} slug - Slug of the Payment Mode.
|
|
2596
|
+
* @property {SubModeOfPaymentSchema} [sub_mode_of_payment]
|
|
2597
|
+
*/
|
|
2598
|
+
/**
|
|
2599
|
+
* @typedef PaymentMethodTransactionPartySchema
|
|
2600
|
+
* @property {string} refund_bearer - Entity responsible for refunds (e.g., SELLER/FYND).
|
|
2601
|
+
* @property {string} collection_bearer - Entity responsible for collection
|
|
2602
|
+
* charges (e.g., SELLER/FYND).
|
|
2603
|
+
*/
|
|
2604
|
+
/**
|
|
2605
|
+
* @typedef LineItemPaymentMethodSchema
|
|
2606
|
+
* @property {PaymentMethodGatewaySchema} [gateway]
|
|
2607
|
+
* @property {PaymentMethodModeOfPaymentSchema} [mode_of_payment]
|
|
2608
|
+
* @property {number} [amount_paid] - Total Amount Paid by this Payment Method.
|
|
2609
|
+
* @property {string} [payment_identifier] - Transaction id
|
|
2610
|
+
* @property {PaymentMethodTransactionPartySchema} [transaction_party]
|
|
2611
|
+
*/
|
|
2612
|
+
/**
|
|
2613
|
+
* @typedef BundleDetailsSchema
|
|
2614
|
+
* @property {boolean} [is_base] - A flag that determines if bag is base bag of bundle.
|
|
2615
|
+
* @property {string[]} [images] - An array of image URLs associated with the bundle.
|
|
2616
|
+
* @property {string} [group_id] - Unique group identifier for the bundle.
|
|
2617
|
+
* @property {string} [name] - Name of the bundle.
|
|
2618
|
+
* @property {string} [item_type] - Type of the item (physical_bundle, virtual_bundle).
|
|
2619
|
+
* @property {number} [item_id] - Unique identifier for the item.
|
|
2620
|
+
* @property {string} [item_code] - Item code for the item.
|
|
2621
|
+
* @property {string} [item_name] - Name of the item.
|
|
2622
|
+
* @property {string} [seller_identifier] - Identifier for the seller of the bundle.
|
|
2623
|
+
* @property {number} [bundle_article_quantity] - Article net_quantity in bundle Product.
|
|
2624
|
+
* @property {string} [brand_name] - Identifier for the brand name.
|
|
2625
|
+
* @property {string} [size] - Size associated with the bundle item.
|
|
2626
|
+
*/
|
|
2627
|
+
/**
|
|
2628
|
+
* @typedef LineItemMonetaryValuesSchema
|
|
2629
|
+
* @property {number} amount_paid - Amount Paid by Customer
|
|
2630
|
+
* @property {number} price_effective - The final effective price after applying
|
|
2631
|
+
* discounts, promotional offers, and adjustments.
|
|
2632
|
+
* @property {number} [discount] - Discount amount apart from promo and coupon discount
|
|
2633
|
+
* @property {number} price_marked - The original marked price of the item
|
|
2634
|
+
* before any discounts or promotions.
|
|
2635
|
+
* @property {number} [coupon_discount] - Coupon Discount Applied for this Line Item
|
|
2636
|
+
* @property {number} [cod_charges] - Cash on Delivery Charges Applied for this Article.
|
|
2637
|
+
* @property {number} [promo_discount] - Promotion Discount
|
|
2638
|
+
* @property {number} [gift_price] - Gift Price
|
|
2639
|
+
* @property {number} [delivery_charges] - Delivery Charges Applied for this Article.
|
|
2640
|
+
*/
|
|
2641
|
+
/**
|
|
2642
|
+
* @typedef DimensionSchema
|
|
2643
|
+
* @property {number} height - Height of the Product.
|
|
2644
|
+
* @property {number} length - Length of the product.
|
|
2645
|
+
* @property {boolean} is_default - Not Modified, meaning these are same as
|
|
2646
|
+
* product uploaded while loading catelogue.
|
|
2647
|
+
* @property {string} unit - Unit of the measurement used.
|
|
2648
|
+
* @property {number} width - Width of the Product.
|
|
2649
|
+
*/
|
|
2650
|
+
/**
|
|
2651
|
+
* @typedef GiftDetailsSchema
|
|
2652
|
+
* @property {number} amount - Specifies the value or cost of the gift
|
|
2653
|
+
* associated with the order line item.
|
|
2654
|
+
* @property {string} display_text - A short description or label intended for
|
|
2655
|
+
* display purposes. This can be a message to the customer, such as "Gift wrap
|
|
2656
|
+
* included" or "Gift card value applied."
|
|
2657
|
+
*/
|
|
2658
|
+
/**
|
|
2659
|
+
* @typedef CPRiderDetailsSchema
|
|
2660
|
+
* @property {string} name
|
|
2661
|
+
* @property {string} phone
|
|
2662
|
+
*/
|
|
2663
|
+
/**
|
|
2664
|
+
* @typedef CPAreaCodeSchema
|
|
2665
|
+
* @property {string} source
|
|
2666
|
+
* @property {string} destination
|
|
2667
|
+
*/
|
|
2668
|
+
/**
|
|
2669
|
+
* @typedef CPTatToDeliverTheShipmentSchema
|
|
2670
|
+
* @property {number} min
|
|
2671
|
+
* @property {number} max
|
|
2672
|
+
*/
|
|
2673
|
+
/**
|
|
2674
|
+
* @typedef CPOptionsSchema
|
|
2675
|
+
* @property {string} [extension_id]
|
|
2676
|
+
* @property {string} [scheme_id]
|
|
2677
|
+
* @property {CPAreaCodeSchema} [area_code]
|
|
2678
|
+
* @property {boolean} [is_self_ship]
|
|
2679
|
+
* @property {number} [max_reattempts_for_delivery_allowed]
|
|
2680
|
+
* @property {string} [cp_sort_key] - A sorting key used for categorizing or
|
|
2681
|
+
* sorting courier partners, often related to their performance, costs, or
|
|
2682
|
+
* some other factor.
|
|
2683
|
+
* @property {string} [name] - The name of the courier partner or the delivery
|
|
2684
|
+
* agent handling the shipment.
|
|
2685
|
+
* @property {CPRiderDetailsSchema} [rider_details]
|
|
2686
|
+
* @property {boolean} [using_own_creds] - Specifies whether the seller's
|
|
2687
|
+
* credentials are being used for the courier partner.
|
|
2688
|
+
* @property {boolean} [qc_supported] - Specifies that Assigned CP support's
|
|
2689
|
+
* quality checks
|
|
2690
|
+
*/
|
|
2691
|
+
/**
|
|
2692
|
+
* @typedef CourierPartnerDetailsSchema
|
|
2693
|
+
* @property {string} [cp_sort_key] - A sorting key used for categorizing or
|
|
2694
|
+
* sorting courier partners, often related to their performance, costs, or
|
|
2695
|
+
* some other factor.
|
|
2696
|
+
* @property {CPOptionsSchema[]} [cp_options] - Other Available CP's
|
|
2697
|
+
* @property {string} scheme_id
|
|
2698
|
+
* @property {string} name - The name of the courier partner or the delivery
|
|
2699
|
+
* agent handling the shipment.
|
|
2700
|
+
* @property {string} extension_id
|
|
2701
|
+
* @property {CPRiderDetailsSchema} [rider_details]
|
|
2702
|
+
* @property {boolean} [qc_supported] - Specifies that Assigned CP support's
|
|
2703
|
+
* quality checks
|
|
2704
|
+
* @property {boolean} using_own_creds - Specifies weather the Seller's Creds or
|
|
2705
|
+
* Fynd's Creds are being used.
|
|
2706
|
+
* @property {number} [max_reattempts_for_delivery_allowed] - Reattempts Allowed
|
|
2707
|
+
* (required for ndr)
|
|
2708
|
+
* @property {CPTatToDeliverTheShipmentSchema} [tat_to_deliver_the_shipment]
|
|
2709
|
+
* @property {boolean} [is_self_ship] - Is every logistic action handled by seller.
|
|
2710
|
+
*/
|
|
2711
|
+
/**
|
|
2712
|
+
* @typedef TaxDetailsSchema
|
|
2713
|
+
* @property {string} hs_code - The HS code of the product
|
|
2714
|
+
* @property {string} tax_rule_id - Tax identifier.
|
|
2715
|
+
*/
|
|
2716
|
+
/**
|
|
2717
|
+
* @typedef PromiseDetailsSchema
|
|
2718
|
+
* @property {number} min_sla - Min TimeStamp (EPOCH) that will be taken to
|
|
2719
|
+
* deliver the product
|
|
2720
|
+
* @property {number} max_sla - Max TimeStamp (EPOCH) that will be taken to
|
|
2721
|
+
* deliver the product.
|
|
2722
|
+
*/
|
|
2723
|
+
/**
|
|
2724
|
+
* @typedef CustomerPickupSlotSchema
|
|
2725
|
+
* @property {string} start_time
|
|
2726
|
+
* @property {string} end_time
|
|
2727
|
+
*/
|
|
2728
|
+
/**
|
|
2729
|
+
* @typedef DpPickupSlotSchema
|
|
2730
|
+
* @property {string} start_time
|
|
2731
|
+
* @property {string} end_time
|
|
2732
|
+
*/
|
|
2733
|
+
/**
|
|
2734
|
+
* @typedef OrderFulfillmentTimelineSchema
|
|
2735
|
+
* @property {DpPickupSlotSchema} [dp_pickup_slot]
|
|
2736
|
+
* @property {string} [dispatch_after_date] - A date indicating when the order
|
|
2737
|
+
* can be dispatched (e.g., the earliest possible dispatch date).
|
|
2738
|
+
* @property {string} [dispatch_by_date] - The latest date the order must be
|
|
2739
|
+
* dispatched to meet delivery expectations.
|
|
2740
|
+
* @property {string} [confirm_by_date] - The deadline by which the merchant
|
|
2741
|
+
* must confirm the order.
|
|
2742
|
+
* @property {CustomerPickupSlotSchema} [customer_pickup_slot]
|
|
2743
|
+
* @property {string} [pack_by_date] - The latest time the package should be
|
|
2744
|
+
* packed and ready to dispatch.
|
|
2745
|
+
*/
|
|
2746
|
+
/**
|
|
2747
|
+
* @typedef LineItemSchema
|
|
2748
|
+
* @property {string} [seller_identifier] - Identifier for the seller providing the item.
|
|
2749
|
+
* @property {LineItemPaymentMethodSchema[]} payment_methods - Payment Methods
|
|
2750
|
+
* Used to fulfil this Order.
|
|
2751
|
+
* @property {LineItemMonetaryValuesSchema} monetary_values
|
|
2752
|
+
* @property {GiftDetailsSchema} [gift_details]
|
|
2753
|
+
* @property {string} [special_instructions] - A string for any special
|
|
2754
|
+
* instructions or messages.
|
|
2755
|
+
* @property {DimensionSchema} [dimension]
|
|
2756
|
+
* @property {number} [quantity] - Quantity of the Line Item
|
|
2757
|
+
* @property {string} [external_line_id] - Unique identifier for the LineItem as
|
|
2758
|
+
* assigned by an external system. You can use this to map external id to
|
|
2759
|
+
* Fynd's generated id
|
|
2760
|
+
* @property {BundleDetailsSchema} [bundle_details]
|
|
2761
|
+
* @property {Object} [meta] - An object containing metadata related to the shipment.
|
|
2762
|
+
*/
|
|
2763
|
+
/**
|
|
2764
|
+
* @typedef CreateOrderShipmentSchema
|
|
2765
|
+
* @property {boolean} [is_mto] - Indicates if the shipment belongs to the
|
|
2766
|
+
* made-to-order category, i.e., the seller will start creating this order
|
|
2767
|
+
* after receiving an order creation request.
|
|
2768
|
+
* @property {LifecycleMessageSchema[]} [shipment_lifecycle_messages] - List of
|
|
2769
|
+
* general-purpose messages shown across different points in the shipment's
|
|
2770
|
+
* journey at Order Details Screen.
|
|
2771
|
+
* @property {string[]} [tags] - Tags that can be attached to the shipment for
|
|
2772
|
+
* filtering and categorization.
|
|
2773
|
+
* @property {string} [type] - The shipment type defining the fulfillment method
|
|
2774
|
+
* and processing flow. Each type determines the specific journey a shipment
|
|
2775
|
+
* will follow based on operational needs and customer preferences:
|
|
2776
|
+
*
|
|
2777
|
+
* - "HomeDelivery": Standard delivery to the customer's address, undergoing all
|
|
2778
|
+
* typical state transitions from processing to final delivery.
|
|
2779
|
+
* - "PickAtStore": Order prepared for in-store pickup, bypassing traditional
|
|
2780
|
+
* shipping stages for direct handover to the customer.
|
|
2781
|
+
* - "Digital": Orders involving digital goods or services (e.g., software,
|
|
2782
|
+
* e-books, subscriptions) delivered electronically.
|
|
2783
|
+
*
|
|
2784
|
+
* @property {FulfillmentOptionSchema} [fulfillment_option]
|
|
2785
|
+
* @property {string} [external_shipment_id] - Unique identifier for the
|
|
2786
|
+
* shipment as assigned by an external system. Use this to map the external ID
|
|
2787
|
+
* to Fynd's generated ID.
|
|
2788
|
+
* @property {LineItemSchema[]} [line_items] - A list of items included in the shipment.
|
|
2789
|
+
* @property {OrderFulfillmentTimelineSchema} [order_fulfillment_timeline]
|
|
2790
|
+
* @property {number} [location_id] - The location ID from which this shipment
|
|
2791
|
+
* is being fulfilled.
|
|
2792
|
+
* @property {string} [external_location_id] - The external location ID from
|
|
2793
|
+
* which this shipment is being fulfilled.
|
|
2794
|
+
* @property {number} [return_location_id] - Overrides the article's default
|
|
2795
|
+
* return location.
|
|
2796
|
+
* @property {CourierPartnerDetailsSchema} [courier_partner_details]
|
|
2797
|
+
* @property {TaxDetailsSchema} [tax_details]
|
|
2798
|
+
* @property {PromiseDetailsSchema} [promise_details]
|
|
2799
|
+
* @property {string} [allow_processing_after] - Defines the UTC time at which
|
|
2800
|
+
* the shipment will automatically move to the placed state.
|
|
2801
|
+
* @property {Object} [meta] - Additional metadata related to the shipment.
|
|
2802
|
+
*/
|
|
2803
|
+
/**
|
|
2804
|
+
* @typedef OrderingCurrencySchema
|
|
2805
|
+
* @property {string} currency_code - The ISO 4217 currency code, such as 'INR'
|
|
2806
|
+
* for Indian Rupee. This field represents the standardized three-letter code
|
|
2807
|
+
* of a currency.
|
|
2808
|
+
* @property {string} currency_symbol - The symbol representing the currency,
|
|
2809
|
+
* such as '₹' for Indian Rupee. This is used for display purposes alongside
|
|
2810
|
+
* currency amounts.
|
|
2811
|
+
*/
|
|
2812
|
+
/**
|
|
2813
|
+
* @typedef ConversionRateSchema
|
|
2814
|
+
* @property {number} rate - The exchange rate used to convert monetary values
|
|
2815
|
+
* from the ordering currency to the seller's currency.
|
|
2816
|
+
* @property {number} timestamp_ms - The timestamp (in milliseconds) when the
|
|
2817
|
+
* conversion rate was applied.
|
|
2818
|
+
*/
|
|
2819
|
+
/**
|
|
2820
|
+
* @typedef CurrencySchema
|
|
2821
|
+
* @property {OrderingCurrencySchema} ordering_currency
|
|
2822
|
+
* @property {ConversionRateSchema} conversion_rate
|
|
2823
|
+
* @property {string} [currency_code] - The ISO 4217 currency code, such as
|
|
2824
|
+
* 'INR' for Indian Rupee. This field represents the standardized three-letter
|
|
2825
|
+
* code of a currency.
|
|
2826
|
+
* @property {string} [currency_symbol] - The symbol representing the currency,
|
|
2827
|
+
* such as '₹' for Indian Rupee. This is used for display purposes alongside
|
|
2828
|
+
* currency amounts.
|
|
2829
|
+
*/
|
|
2830
|
+
/**
|
|
2831
|
+
* @typedef CouponOwnershipSchema
|
|
2832
|
+
* @property {string} payable_category - Indicates who issued the coupon
|
|
2833
|
+
* (MARKETPLACE or SELLER).
|
|
2834
|
+
*/
|
|
2835
|
+
/**
|
|
2836
|
+
* @typedef CouponSchema
|
|
2837
|
+
* @property {string} code - The coupon code that was applied.
|
|
2838
|
+
* @property {string} id - Unique identifier of the coupon.
|
|
2839
|
+
* @property {CouponOwnershipSchema} ownership
|
|
2840
|
+
* @property {boolean} is_return_allowed - Indicates whether returns are allowed
|
|
2841
|
+
* when this coupon is applied.
|
|
2842
|
+
* @property {boolean} is_cancellation_allowed - Indicates whether cancellations
|
|
2843
|
+
* are allowed when this coupon is applied.
|
|
2844
|
+
*/
|
|
2845
|
+
/**
|
|
2846
|
+
* @typedef BillingDetailsSchema
|
|
2847
|
+
* @property {string} [first_name] - First Name of the User
|
|
2848
|
+
* @property {string} [phone_code] - Country phone code ex: +91
|
|
2849
|
+
* @property {string} [country] - Country of the User
|
|
2850
|
+
* @property {string} [city] - City of the User
|
|
2851
|
+
* @property {string} [pincode] - Pincode of the User
|
|
2852
|
+
* @property {string} [last_name] - Last Name of the User
|
|
2853
|
+
* @property {string} [mobile_number] - Primary Phone number of the User
|
|
2854
|
+
* @property {string} [email] - Primary Email of the User
|
|
2855
|
+
* @property {string} [state] - State of the User
|
|
2856
|
+
* @property {string} [alternate_mobile_number] - Alternate Mobile Number
|
|
2857
|
+
* @property {string} [address] - Full Address of the Billing User
|
|
2858
|
+
* @property {string} [middle_name] - A string containing the customer's middle name.
|
|
2859
|
+
* @property {string} [title] - A string representing the customer's title or prefix.
|
|
2860
|
+
* @property {string} [house_no] - A string representing the house or apartment
|
|
2861
|
+
* number of the customer.
|
|
2862
|
+
* @property {GeoLocationSchema} [geo_location]
|
|
2863
|
+
* @property {string} [gender] - Gender of user
|
|
2864
|
+
* @property {string} [landmark] - A string representing a landmark or reference
|
|
2865
|
+
* point near the customer's location.
|
|
2866
|
+
* @property {string} [address_type] - A string representing the address type in
|
|
2867
|
+
* the seller's system.
|
|
2868
|
+
* @property {string} [state_code] - A string representing the state code of the
|
|
2869
|
+
* customer's location.
|
|
2870
|
+
* @property {string} [floor_no] - A string representing the floor number of the
|
|
2871
|
+
* customer's location.
|
|
2872
|
+
* @property {string} [alternate_email] - Alternate Email Address
|
|
2873
|
+
* @property {string} [address1] - A string representing the first line of the address.
|
|
2874
|
+
* @property {string} [address2] - A string representing the second line of the address.
|
|
2875
|
+
* @property {string} [country_iso_code] - Specifies the country's unique
|
|
2876
|
+
* identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
|
|
2877
|
+
* is crucial for distinguishing countries in international transactions, data
|
|
2878
|
+
* processing, and shipping logistics.
|
|
2879
|
+
* @property {string} [user_id] - The unique identifier assigned to the user.
|
|
2880
|
+
* refer /user in platform documentation to get more details.
|
|
2881
|
+
* @property {string} [area_code] - Area Code
|
|
2882
|
+
* @property {string} [area_code_slug]
|
|
2883
|
+
* @property {string} [country_phone_code]
|
|
2884
|
+
*/
|
|
2885
|
+
/**
|
|
2886
|
+
* @typedef CPConfigurationSchema
|
|
2887
|
+
* @property {string} shipping_by - Shipping Handled by FYND or SELLER
|
|
2888
|
+
*/
|
|
2889
|
+
/**
|
|
2890
|
+
* @typedef ShippingDetailsSchema
|
|
2891
|
+
* @property {string} [first_name] - First Name of the User
|
|
2892
|
+
* @property {string} [phone_code] - Country phone code ex: +91
|
|
2893
|
+
* @property {string} [country] - Country of the User
|
|
2894
|
+
* @property {string} [city] - City of the User
|
|
2895
|
+
* @property {string} [pincode] - Pincode of the User
|
|
2896
|
+
* @property {string} [last_name] - Last Name of the User
|
|
2897
|
+
* @property {string} [mobile_number] - Primary Phone number of the User
|
|
2898
|
+
* @property {string} [email] - Primary Email of the User
|
|
2899
|
+
* @property {string} [state] - State of the User
|
|
2900
|
+
* @property {string} [alternate_mobile_number] - Alternate Mobile Number
|
|
2901
|
+
* @property {string} [address] - Full Address of the Billing User
|
|
2902
|
+
* @property {string} [middle_name] - A string containing the customer's middle name.
|
|
2903
|
+
* @property {string} [title] - A string representing the customer's title or prefix.
|
|
2904
|
+
* @property {string} [house_no] - A string representing the house or apartment
|
|
2905
|
+
* number of the customer.
|
|
2906
|
+
* @property {GeoLocationSchema} [geo_location]
|
|
2907
|
+
* @property {string} [gender] - Gender of user
|
|
2908
|
+
* @property {string} [landmark] - A string representing a landmark or reference
|
|
2909
|
+
* point near the customer's location.
|
|
2910
|
+
* @property {string} [address_type] - A string representing the address type in
|
|
2911
|
+
* the seller's system.
|
|
2912
|
+
* @property {string} [state_code] - A string representing the state code of the
|
|
2913
|
+
* customer's location.
|
|
2914
|
+
* @property {string} [floor_no] - A string representing the floor number of the
|
|
2915
|
+
* customer's location.
|
|
2916
|
+
* @property {string} [alternate_email] - Alternate Email Address
|
|
2917
|
+
* @property {string} [address1] - A string representing the first line of the address.
|
|
2918
|
+
* @property {string} [address2] - A string representing the second line of the address.
|
|
2919
|
+
* @property {string} [country_iso_code] - Specifies the country's unique
|
|
2920
|
+
* identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
|
|
2921
|
+
* is crucial for distinguishing countries in international transactions, data
|
|
2922
|
+
* processing, and shipping logistics.
|
|
2923
|
+
* @property {string} [user_id] - The unique identifier assigned to the user.
|
|
2924
|
+
* refer /user in platform documentation to get more details.
|
|
2925
|
+
* @property {string} [area_code] - Area Code
|
|
2926
|
+
* @property {string} [area_code_slug]
|
|
2927
|
+
* @property {string} [country_phone_code]
|
|
2928
|
+
*/
|
|
2929
|
+
/**
|
|
2930
|
+
* @typedef UserDetailsSchema
|
|
2931
|
+
* @property {string} [gstin] - The user's GSTIN (Goods and Services Tax
|
|
2932
|
+
* Identification Number).
|
|
2933
|
+
* @property {string} [pan_no] - The user's PAN (Permanent Account Number).
|
|
2934
|
+
*/
|
|
2935
|
+
/**
|
|
2936
|
+
* @typedef LifecycleMessageSchema
|
|
2937
|
+
* @property {string} message - The message text to display to users at specific
|
|
2938
|
+
* order states (e.g., PLACED, SHIPPED).
|
|
2939
|
+
* @property {string} type - The message type, which determines the color of the
|
|
2940
|
+
* message bar.
|
|
2941
|
+
* @property {string[]} states - List of OMS states at which the message should
|
|
2942
|
+
* be visible.
|
|
2943
|
+
* @property {number} priority - Determines the message display sequence, with 1
|
|
2944
|
+
* being the highest priority.
|
|
2945
|
+
*/
|
|
2946
|
+
/**
|
|
2947
|
+
* @typedef CreateOrderRequestSchema
|
|
2948
|
+
* @property {CreateOrderShipmentSchema[]} [shipments] - List of shipments
|
|
2949
|
+
* included in the order.
|
|
2950
|
+
* @property {string[]} [tags] - Tags that can be used to filter and categorize
|
|
2951
|
+
* orders and shipments.
|
|
2952
|
+
* @property {CurrencySchema} currency_details
|
|
2953
|
+
* @property {string} [external_creation_date] - Timestamp indicating when the
|
|
2954
|
+
* order was created in an external system.
|
|
2955
|
+
* @property {CouponSchema} [coupon_details]
|
|
2956
|
+
* @property {BillingDetailsSchema} billing_details
|
|
2957
|
+
* @property {string} primary_payment_mode - The primary payment method used for
|
|
2958
|
+
* the entire order transaction.
|
|
2959
|
+
* @property {CPConfigurationSchema} [cp_configuration]
|
|
2960
|
+
* @property {number} [ordering_location_id] - The location ID where the order
|
|
2961
|
+
* is placed. Required when the order is placed from one location but
|
|
2962
|
+
* fulfilled by another.
|
|
2963
|
+
* @property {boolean} [allow_location_reassignment] - Allows location
|
|
2964
|
+
* reassignment before order confirmation.
|
|
2965
|
+
* @property {ShippingDetailsSchema} shipping_details
|
|
2966
|
+
* @property {string} [external_order_id] - A unique identifier assigned to the
|
|
2967
|
+
* order by an external system or service.
|
|
2968
|
+
* @property {UserDetailsSchema} [user_details]
|
|
2969
|
+
* @property {LifecycleMessageSchema[]} [order_lifecycle_messages] - List of
|
|
2970
|
+
* order lifecycle messages to be displayed to the user at Order Details.
|
|
2971
|
+
* @property {string} [channel_application_id] - Identifies the application from
|
|
2972
|
+
* which the order was created. Pass this when it differs from the fulfilling
|
|
2973
|
+
* company's application.
|
|
2974
|
+
* @property {string} [b2b_gstin_number] - The GSTIN (Goods and Services Tax
|
|
2975
|
+
* Identification Number) for business-to-business transactions.
|
|
2976
|
+
* @property {string} [channel_company_id] - The company ID where the order is
|
|
2977
|
+
* placed. Required when the order is placed from one company but fulfilled by another.
|
|
2978
|
+
* @property {boolean} [is_draft] - Indicates whether the order is a draft.
|
|
2979
|
+
* Draft orders will be moved to upcoming state instead of placed status.
|
|
2598
2980
|
*/
|
|
2599
2981
|
/**
|
|
2600
2982
|
* @typedef Page
|
|
@@ -2607,6 +2989,58 @@ export = OrderPlatformModel;
|
|
|
2607
2989
|
* @property {number} [size] - The number of items per page.
|
|
2608
2990
|
* @property {number} [page_size] - The number of items per page.
|
|
2609
2991
|
*/
|
|
2992
|
+
/**
|
|
2993
|
+
* @typedef OrderingSourceConfig
|
|
2994
|
+
* @property {string} [slug] - Slug of the ordering source.
|
|
2995
|
+
* @property {OrderingSourceFeature[]} [configs]
|
|
2996
|
+
* @property {string} [logo] - Logo of the ordering source.
|
|
2997
|
+
*/
|
|
2998
|
+
/**
|
|
2999
|
+
* @typedef OrderingSourceFeature
|
|
3000
|
+
* @property {string} [name] - Name of the ordering source config item.
|
|
3001
|
+
* @property {string} [slug] - Slug of the ordering source config item.
|
|
3002
|
+
* @property {string} [description] - Description of the ordering source config item.
|
|
3003
|
+
* @property {boolean} [enabled] - Whether the config/feature is enabled or not.
|
|
3004
|
+
*/
|
|
3005
|
+
/**
|
|
3006
|
+
* @typedef ListOrderingSources
|
|
3007
|
+
* @property {OrderingSourceSummary[]} [items]
|
|
3008
|
+
* @property {Page} [page]
|
|
3009
|
+
*/
|
|
3010
|
+
/**
|
|
3011
|
+
* @typedef OrderingSourceSummary
|
|
3012
|
+
* @property {string} [text] - Display Text of the ordering source.
|
|
3013
|
+
* @property {string} [value] - Value of the ordering source.
|
|
3014
|
+
*/
|
|
3015
|
+
/**
|
|
3016
|
+
* @typedef CreateAccount
|
|
3017
|
+
* @property {string} channel_account_name - Unique name identifier for the
|
|
3018
|
+
* channel account. This represents the sales channel or marketplace through
|
|
3019
|
+
* which orders are received and processed.
|
|
3020
|
+
*/
|
|
3021
|
+
/**
|
|
3022
|
+
* @typedef Account
|
|
3023
|
+
* @property {string} [channel_account_id] - Unique identifier for the channel
|
|
3024
|
+
* account. This is a system-generated identifier used to reference the
|
|
3025
|
+
* account across the platform.
|
|
3026
|
+
* @property {number} [company_id] - Unique identifier of the company on the
|
|
3027
|
+
* platform to which this channel account belongs.
|
|
3028
|
+
* @property {string} [channel_account_name] - Name of the channel account. This
|
|
3029
|
+
* identifies the specific sales channel or marketplace (e.g., SHOPIFY,
|
|
3030
|
+
* MARKETPLACE, etc.) through which the company receives and processes orders.
|
|
3031
|
+
*/
|
|
3032
|
+
/**
|
|
3033
|
+
* @typedef AccountsList
|
|
3034
|
+
* @property {Account[]} [data] - List of channel accounts associated with the
|
|
3035
|
+
* company. Each account represents a different sales channel or marketplace
|
|
3036
|
+
* integration.
|
|
3037
|
+
* @property {Page} [page]
|
|
3038
|
+
*/
|
|
3039
|
+
/**
|
|
3040
|
+
* @typedef ValidationError
|
|
3041
|
+
* @property {string} message - A brief description of the error encountered.
|
|
3042
|
+
* @property {string} field - The field in the request that caused the error.
|
|
3043
|
+
*/
|
|
2610
3044
|
/**
|
|
2611
3045
|
* @typedef BagReasonMeta
|
|
2612
3046
|
* @property {boolean} [show_text_area] - Indicates whether a text area should
|
|
@@ -2693,6 +3127,35 @@ export = OrderPlatformModel;
|
|
|
2693
3127
|
* @property {string} [country_phone_code] - The country-specific phone code,
|
|
2694
3128
|
* useful for formatting mobile numbers correctly.
|
|
2695
3129
|
*/
|
|
3130
|
+
/**
|
|
3131
|
+
* @typedef BundleReturnConfig
|
|
3132
|
+
* @property {boolean} [allow_partial_return] - Indicates whether partial
|
|
3133
|
+
* returns are allowed for bundle products.
|
|
3134
|
+
* @property {boolean} [returnable] - Indicates whether the bundle product is returnable.
|
|
3135
|
+
* @property {boolean} [unit] - Time unit for the return window (e.g., "week",
|
|
3136
|
+
* "day", "hour").
|
|
3137
|
+
* @property {boolean} [time] - Duration value for the return window, expressed
|
|
3138
|
+
* in the specified unit.
|
|
3139
|
+
*/
|
|
3140
|
+
/**
|
|
3141
|
+
* @typedef BundleDetails
|
|
3142
|
+
* @property {string} [bundle_group_id] - Unique group identifier for the bundle.
|
|
3143
|
+
* @property {string} [name] - Name of the bundle.
|
|
3144
|
+
* @property {string} [slug] - URL-friendly identifier for the bundle.
|
|
3145
|
+
* @property {number} [bundle_count] - Indicates bundle count of the bag.
|
|
3146
|
+
* @property {string} [article_bundle_id] - Unique identifier for the article bundle.
|
|
3147
|
+
* @property {number} [bundle_article_quantity] - Article net_quantity in bundle Product.
|
|
3148
|
+
* @property {boolean} [is_base] - A flag that determines if bag is base bag of bundle.
|
|
3149
|
+
* @property {number} [price_marked] - Maximum Retail Price of the bundle.
|
|
3150
|
+
* @property {number} [price_effective] - Current selling price of the bundle.
|
|
3151
|
+
* @property {number} [item_id] - Unique identifier for the item.
|
|
3152
|
+
* @property {string} [item_type] - Type of the item (physical_bundle, virtual_bundle).
|
|
3153
|
+
* @property {BundleReturnConfig} [return_config]
|
|
3154
|
+
* @property {string} [seller_identifier] - Identifier for the seller of the bundle.
|
|
3155
|
+
* @property {string[]} [images] - An array of image URLs associated with the bundle.
|
|
3156
|
+
* @property {string} [brand_name] - Identifier for the brand name.
|
|
3157
|
+
* @property {string} [size] - Size associated with the bundle item.
|
|
3158
|
+
*/
|
|
2696
3159
|
/**
|
|
2697
3160
|
* @typedef Address
|
|
2698
3161
|
* @property {string} [phone] - The phone number at the address, used for
|
|
@@ -3475,8 +3938,8 @@ export = OrderPlatformModel;
|
|
|
3475
3938
|
* @property {string} [ordering_channnel] - The specific channel through which
|
|
3476
3939
|
* your order was placed. This field will be phased out after version 2.4.0.
|
|
3477
3940
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
3478
|
-
* @property {string} [ordering_source] -
|
|
3479
|
-
*
|
|
3941
|
+
* @property {string} [ordering_source] - Ordering source, to be used to
|
|
3942
|
+
* identify source of order creation.
|
|
3480
3943
|
* @property {string} [shipment_id] - The unique identifier for the shipment itself.
|
|
3481
3944
|
* @property {string} [customer_note] - Any special notes or instructions
|
|
3482
3945
|
* provided by the customer related to the shipment.
|
|
@@ -3585,8 +4048,8 @@ export = OrderPlatformModel;
|
|
|
3585
4048
|
* @property {string} [ordering_channel] - The specific channel through which
|
|
3586
4049
|
* your order was placed. This field will be phased out after version 2.4.0.
|
|
3587
4050
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
3588
|
-
* @property {string} [ordering_source] -
|
|
3589
|
-
*
|
|
4051
|
+
* @property {string} [ordering_source] - Ordering source, to be used to
|
|
4052
|
+
* identify source of order creation.
|
|
3590
4053
|
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
3591
4054
|
* @property {Object} [meta] - Meta data of the order contains additional,
|
|
3592
4055
|
* potentially dynamic information about the order.
|
|
@@ -3892,6 +4355,9 @@ export = OrderPlatformModel;
|
|
|
3892
4355
|
* tracking is enabled for the bag.
|
|
3893
4356
|
* @property {boolean} is_customer_return_allowed - A flag that determines if
|
|
3894
4357
|
* customer return is allowed for the bag.
|
|
4358
|
+
* @property {boolean} [is_bundle_item] - Flag to indicate whether the bag is
|
|
4359
|
+
* part of a bundle.
|
|
4360
|
+
* @property {BundleDetails} [bundle_details]
|
|
3895
4361
|
*/
|
|
3896
4362
|
/**
|
|
3897
4363
|
* @typedef OrderBagArticle
|
|
@@ -4343,22 +4809,13 @@ export = OrderPlatformModel;
|
|
|
4343
4809
|
* with the payment transaction, such as TR669796C0012CF31BBD. This ID helps
|
|
4344
4810
|
* track and reference the specific transaction within the merchant's system.
|
|
4345
4811
|
*/
|
|
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
4812
|
/**
|
|
4356
4813
|
* @typedef OrderData
|
|
4357
4814
|
* @property {string} [ordering_channel] - The specific channel through which
|
|
4358
4815
|
* your order was placed. This field will be phased out after version 2.4.0.
|
|
4359
4816
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
4360
|
-
* @property {string} [ordering_source] -
|
|
4361
|
-
*
|
|
4817
|
+
* @property {string} [ordering_source] - Ordering source, to be used to
|
|
4818
|
+
* identify source of order creation.
|
|
4362
4819
|
* @property {string} order_date - Specifies the exact date and time when the
|
|
4363
4820
|
* order was placed by the customer, serving as a key timestamp for the
|
|
4364
4821
|
* initiation of the order processing cycle.
|
|
@@ -5028,99 +5485,10 @@ export = OrderPlatformModel;
|
|
|
5028
5485
|
* @property {boolean} [status]
|
|
5029
5486
|
* @property {string} [error]
|
|
5030
5487
|
*/
|
|
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
5488
|
declare class OrderPlatformModel {
|
|
5121
5489
|
}
|
|
5122
5490
|
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,
|
|
5491
|
+
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
5492
|
}
|
|
5125
5493
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
5126
5494
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -5963,8 +6331,8 @@ type ShipmentsResponseSchema = {
|
|
|
5963
6331
|
declare function DPConfiguration(): DPConfiguration;
|
|
5964
6332
|
type DPConfiguration = {
|
|
5965
6333
|
/**
|
|
5966
|
-
* -
|
|
5967
|
-
*
|
|
6334
|
+
* - It denotes DP assignment strategy. If it
|
|
6335
|
+
* is fynd, DP assignment will be handled by Fynd's OMS.
|
|
5968
6336
|
*/
|
|
5969
6337
|
shipping_by?: string;
|
|
5970
6338
|
};
|
|
@@ -5998,21 +6366,22 @@ type LockStateMessage = {
|
|
|
5998
6366
|
/** @returns {CreateOrderConfig} */
|
|
5999
6367
|
declare function CreateOrderConfig(): CreateOrderConfig;
|
|
6000
6368
|
type CreateOrderConfig = {
|
|
6001
|
-
dp_configuration
|
|
6369
|
+
dp_configuration?: DPConfiguration;
|
|
6002
6370
|
/**
|
|
6003
|
-
* -
|
|
6004
|
-
* for the
|
|
6005
|
-
* for the
|
|
6006
|
-
* reassignment will not be performed
|
|
6371
|
+
* - The flag denotes if the
|
|
6372
|
+
* location for the shipment needs to be reassigned after cancellation. If the
|
|
6373
|
+
* flag is set to true, location for the shipment gets auto reassigned post
|
|
6374
|
+
* cancellation. If set to false, location reassignment will not be performed
|
|
6375
|
+
* as it is disabled.
|
|
6007
6376
|
*/
|
|
6008
6377
|
location_reassignment?: boolean;
|
|
6009
6378
|
payment?: PaymentConfig;
|
|
6010
6379
|
/**
|
|
6011
6380
|
* - Denotes the shipment
|
|
6012
|
-
* breaking strategy. If the flag is set true, the shipment is created
|
|
6013
|
-
* optimal shipment creation strategy based on the
|
|
6014
|
-
* dimensions by OMS
|
|
6015
|
-
* be passed to FDK for processing.
|
|
6381
|
+
* breaking strategy. If the flag is set to true, the shipment is created
|
|
6382
|
+
* using an optimal shipment creation strategy based on the serviceability &
|
|
6383
|
+
* packaging dimensions by OMS. If the flag is set to false, shipment details
|
|
6384
|
+
* and location_id, must be passed to FDK for processing.
|
|
6016
6385
|
*/
|
|
6017
6386
|
optimal_shipment_creation?: boolean;
|
|
6018
6387
|
/**
|
|
@@ -6359,8 +6728,7 @@ type OrderConfig = {
|
|
|
6359
6728
|
declare function CreateOrderResponseSchema(): CreateOrderResponseSchema;
|
|
6360
6729
|
type CreateOrderResponseSchema = {
|
|
6361
6730
|
/**
|
|
6362
|
-
* -
|
|
6363
|
-
* identifier assigned to the order.
|
|
6731
|
+
* - Unique identifier assigned to the order
|
|
6364
6732
|
*/
|
|
6365
6733
|
fynd_order_id: string;
|
|
6366
6734
|
};
|
|
@@ -6834,8 +7202,8 @@ type OrderDetails = {
|
|
|
6834
7202
|
*/
|
|
6835
7203
|
ordering_channel?: string;
|
|
6836
7204
|
/**
|
|
6837
|
-
* -
|
|
6838
|
-
*
|
|
7205
|
+
* - Ordering source, to be used to
|
|
7206
|
+
* identify source of order creation.
|
|
6839
7207
|
*/
|
|
6840
7208
|
ordering_source?: string;
|
|
6841
7209
|
/**
|
|
@@ -7035,7 +7403,7 @@ type UpdatePackagingDimensionsResponseSchema = {
|
|
|
7035
7403
|
declare function Tax(): Tax;
|
|
7036
7404
|
type Tax = {
|
|
7037
7405
|
/**
|
|
7038
|
-
* - The name of the tax
|
|
7406
|
+
* - The name of the tax indicating its purpose (e.g.,
|
|
7039
7407
|
* VAT, sales tax).
|
|
7040
7408
|
*/
|
|
7041
7409
|
name: string;
|
|
@@ -7070,27 +7438,31 @@ type AmountSchema = {
|
|
|
7070
7438
|
/** @returns {Charge} */
|
|
7071
7439
|
declare function Charge(): Charge;
|
|
7072
7440
|
type Charge = {
|
|
7441
|
+
amount: AmountSchema;
|
|
7442
|
+
/**
|
|
7443
|
+
* - The category or type of the charge.
|
|
7444
|
+
*/
|
|
7445
|
+
type: string;
|
|
7073
7446
|
/**
|
|
7074
7447
|
* - The name of the charge that indicates its purpose.
|
|
7075
7448
|
*/
|
|
7076
7449
|
name: string;
|
|
7077
|
-
amount: AmountSchema;
|
|
7078
|
-
tax?: Tax;
|
|
7079
7450
|
/**
|
|
7080
7451
|
* - An optional code associated with the charge for
|
|
7081
7452
|
* internal tracking.
|
|
7082
7453
|
*/
|
|
7083
7454
|
code?: string;
|
|
7084
|
-
|
|
7085
|
-
* - The category or type of the charge.
|
|
7086
|
-
*/
|
|
7087
|
-
type: string;
|
|
7455
|
+
tax?: Tax;
|
|
7088
7456
|
};
|
|
7089
7457
|
/** @returns {LineItem} */
|
|
7090
7458
|
declare function LineItem(): LineItem;
|
|
7091
7459
|
type LineItem = {
|
|
7092
7460
|
/**
|
|
7093
|
-
* - An array of Charge objects related to the
|
|
7461
|
+
* - An array of Charge objects related to the
|
|
7462
|
+
* line item. This array must include three mandatory charge types:
|
|
7463
|
+
* amount_paid, price_effective and price_marked. Formula to calculate
|
|
7464
|
+
* amount_paid = price_effective + cod_charges + delivery_charges -
|
|
7465
|
+
* coupon_discount - promo_discount
|
|
7094
7466
|
*/
|
|
7095
7467
|
charges?: Charge[];
|
|
7096
7468
|
/**
|
|
@@ -7207,8 +7579,8 @@ type SystemMessages = {
|
|
|
7207
7579
|
declare function Shipment(): Shipment;
|
|
7208
7580
|
type Shipment = {
|
|
7209
7581
|
/**
|
|
7210
|
-
* - An array of
|
|
7211
|
-
*
|
|
7582
|
+
* - An array of objects that represent the
|
|
7583
|
+
* items included in the shipment.
|
|
7212
7584
|
*/
|
|
7213
7585
|
line_items: LineItem[];
|
|
7214
7586
|
/**
|
|
@@ -7223,35 +7595,32 @@ type Shipment = {
|
|
|
7223
7595
|
*/
|
|
7224
7596
|
meta?: any;
|
|
7225
7597
|
/**
|
|
7226
|
-
* -
|
|
7227
|
-
* the shipment.
|
|
7598
|
+
* - Priority level of the shipment.
|
|
7228
7599
|
*/
|
|
7229
7600
|
priority?: number;
|
|
7230
7601
|
/**
|
|
7231
|
-
* - Location
|
|
7232
|
-
*
|
|
7233
|
-
*
|
|
7234
|
-
*
|
|
7235
|
-
*
|
|
7236
|
-
*
|
|
7602
|
+
* - Location/store/fulfillment identifier of
|
|
7603
|
+
* the shipment. This field is mandatory when optimal_shipment_creation flag
|
|
7604
|
+
* is set to false, indicating that shipments must be associated with a
|
|
7605
|
+
* specific location. When optimal_shipment_creation is true, location_id
|
|
7606
|
+
* becomes optional and the system automatically assigns the optimal location
|
|
7607
|
+
* for order creation.
|
|
7237
7608
|
*/
|
|
7238
7609
|
location_id?: number;
|
|
7239
7610
|
/**
|
|
7240
7611
|
* - Defines the specific journey a shipment
|
|
7241
7612
|
* will follow based on the application's operational needs and customer
|
|
7242
7613
|
* preferences. This field categorizes orders into distinct types, each
|
|
7243
|
-
* associated with a unique processing flow. For example:
|
|
7244
|
-
*
|
|
7245
|
-
*
|
|
7246
|
-
*
|
|
7247
|
-
* customer
|
|
7248
|
-
*
|
|
7249
|
-
*
|
|
7250
|
-
* type
|
|
7251
|
-
*
|
|
7252
|
-
*
|
|
7253
|
-
* or services, such as software, digital subscriptions, e-books, online
|
|
7254
|
-
* courses, or any other item that can be delivered electronically.
|
|
7614
|
+
* associated with a unique processing flow. For example, "HomeDelivery": The
|
|
7615
|
+
* order undergoes all state transitions typical for a delivery, from
|
|
7616
|
+
* processing the shipment to final delivery at the customer's address.
|
|
7617
|
+
* "PickAtStore": The order is prepared for pickup and moved to a state where
|
|
7618
|
+
* it is ready to be handed over directly to the customer at the store. This
|
|
7619
|
+
* type streamlines the process by bypassing traditional shipping stages and
|
|
7620
|
+
* facilitating a quicker transition to the final handover stage. "Digital":
|
|
7621
|
+
* This order type likely refers to orders that involve digital goods or
|
|
7622
|
+
* services, such as software, digital subscriptions, e-books, online courses,
|
|
7623
|
+
* or any other item that can be delivered electronically.
|
|
7255
7624
|
*/
|
|
7256
7625
|
order_type?: string;
|
|
7257
7626
|
tags?: string[];
|
|
@@ -7313,18 +7682,17 @@ type GeoLocationSchema = {
|
|
|
7313
7682
|
declare function ShippingInfo(): ShippingInfo;
|
|
7314
7683
|
type ShippingInfo = {
|
|
7315
7684
|
/**
|
|
7316
|
-
* -
|
|
7317
|
-
*
|
|
7685
|
+
* - Alternate mobile number to
|
|
7686
|
+
* reach the customer, providing an additional contact method.
|
|
7318
7687
|
*/
|
|
7319
7688
|
alternate_mobile_number?: string;
|
|
7320
7689
|
/**
|
|
7321
|
-
* -
|
|
7322
|
-
* shipping purposes.
|
|
7690
|
+
* - The name of the state for shipping purposes.
|
|
7323
7691
|
*/
|
|
7324
7692
|
state?: string;
|
|
7325
7693
|
/**
|
|
7326
|
-
* -
|
|
7327
|
-
*
|
|
7694
|
+
* - Customer's unique identifier in the
|
|
7695
|
+
* seller's system.
|
|
7328
7696
|
*/
|
|
7329
7697
|
customer_code?: string;
|
|
7330
7698
|
/**
|
|
@@ -7333,72 +7701,66 @@ type ShippingInfo = {
|
|
|
7333
7701
|
*/
|
|
7334
7702
|
shipping_type?: string;
|
|
7335
7703
|
/**
|
|
7336
|
-
* -
|
|
7704
|
+
* - Customer's middle name
|
|
7337
7705
|
*/
|
|
7338
7706
|
middle_name?: string;
|
|
7339
7707
|
/**
|
|
7340
|
-
* -
|
|
7341
|
-
* primary mobile number.
|
|
7708
|
+
* - Customer's primary mobile number
|
|
7342
7709
|
*/
|
|
7343
7710
|
primary_mobile_number?: string;
|
|
7344
7711
|
/**
|
|
7345
|
-
* -
|
|
7712
|
+
* - Customer's last name
|
|
7346
7713
|
*/
|
|
7347
7714
|
last_name?: string;
|
|
7348
7715
|
geo_location?: GeoLocationSchema;
|
|
7349
7716
|
/**
|
|
7350
|
-
* -
|
|
7717
|
+
* - Customer's gender
|
|
7351
7718
|
*/
|
|
7352
7719
|
gender?: string;
|
|
7353
7720
|
/**
|
|
7354
|
-
* -
|
|
7355
|
-
* number of the customer.
|
|
7721
|
+
* - The house or apartment number of the customer.
|
|
7356
7722
|
*/
|
|
7357
7723
|
house_no?: string;
|
|
7358
7724
|
/**
|
|
7359
|
-
* -
|
|
7725
|
+
* - Customer's first name
|
|
7360
7726
|
*/
|
|
7361
7727
|
first_name?: string;
|
|
7362
7728
|
/**
|
|
7363
|
-
* -
|
|
7729
|
+
* - Customer's title or prefix
|
|
7364
7730
|
*/
|
|
7365
7731
|
title?: string;
|
|
7366
7732
|
/**
|
|
7367
|
-
* -
|
|
7368
|
-
*
|
|
7733
|
+
* - Landmark or reference point near the
|
|
7734
|
+
* customer's location
|
|
7369
7735
|
*/
|
|
7370
7736
|
landmark?: string;
|
|
7371
7737
|
/**
|
|
7372
|
-
* -
|
|
7738
|
+
* - Customer's country
|
|
7373
7739
|
*/
|
|
7374
7740
|
country?: string;
|
|
7375
7741
|
/**
|
|
7376
|
-
* -
|
|
7377
|
-
* the seller's system.
|
|
7742
|
+
* - Address type in the seller's system
|
|
7378
7743
|
*/
|
|
7379
7744
|
address_type?: string;
|
|
7380
7745
|
/**
|
|
7381
|
-
* -
|
|
7382
|
-
* customer's location.
|
|
7746
|
+
* - State code of the customer's location
|
|
7383
7747
|
*/
|
|
7384
7748
|
state_code?: string;
|
|
7385
7749
|
/**
|
|
7386
|
-
* -
|
|
7750
|
+
* - City of the customer's location
|
|
7387
7751
|
*/
|
|
7388
7752
|
city?: string;
|
|
7389
7753
|
/**
|
|
7390
|
-
* -
|
|
7391
|
-
*
|
|
7754
|
+
* - External customer code in the
|
|
7755
|
+
* seller's system
|
|
7392
7756
|
*/
|
|
7393
7757
|
external_customer_code?: string;
|
|
7394
7758
|
/**
|
|
7395
|
-
* -
|
|
7396
|
-
* customer's location.
|
|
7759
|
+
* - Floor number of the customer's location
|
|
7397
7760
|
*/
|
|
7398
7761
|
floor_no?: string;
|
|
7399
7762
|
/**
|
|
7400
|
-
* -
|
|
7401
|
-
* email address for the customer.
|
|
7763
|
+
* - Alternate email address for the customer
|
|
7402
7764
|
*/
|
|
7403
7765
|
alternate_email?: string;
|
|
7404
7766
|
/**
|
|
@@ -7411,25 +7773,23 @@ type ShippingInfo = {
|
|
|
7411
7773
|
*/
|
|
7412
7774
|
address?: string;
|
|
7413
7775
|
/**
|
|
7414
|
-
* -
|
|
7776
|
+
* - Area of the customer's location
|
|
7415
7777
|
*/
|
|
7416
7778
|
area?: string;
|
|
7417
7779
|
/**
|
|
7418
|
-
* -
|
|
7780
|
+
* - First line of the address
|
|
7419
7781
|
*/
|
|
7420
7782
|
address1?: string;
|
|
7421
7783
|
/**
|
|
7422
|
-
* -
|
|
7423
|
-
* customer's location.
|
|
7784
|
+
* - Pincode of the customer's location
|
|
7424
7785
|
*/
|
|
7425
7786
|
pincode?: string;
|
|
7426
7787
|
/**
|
|
7427
|
-
* -
|
|
7428
|
-
* address for the customer.
|
|
7788
|
+
* - Primary email address for the customer
|
|
7429
7789
|
*/
|
|
7430
7790
|
primary_email?: string;
|
|
7431
7791
|
/**
|
|
7432
|
-
* -
|
|
7792
|
+
* - Second line of the address
|
|
7433
7793
|
*/
|
|
7434
7794
|
address2?: string;
|
|
7435
7795
|
/**
|
|
@@ -7442,7 +7802,7 @@ type ShippingInfo = {
|
|
|
7442
7802
|
country_code?: string;
|
|
7443
7803
|
/**
|
|
7444
7804
|
* - Specifies the country's unique
|
|
7445
|
-
* identifier
|
|
7805
|
+
* identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code
|
|
7446
7806
|
* is crucial for distinguishing countries in international transactions, data
|
|
7447
7807
|
* processing, and shipping logistics.
|
|
7448
7808
|
*/
|
|
@@ -7483,25 +7843,23 @@ type BillingInfo = {
|
|
|
7483
7843
|
alternate_email?: string;
|
|
7484
7844
|
address?: string;
|
|
7485
7845
|
/**
|
|
7486
|
-
* -
|
|
7846
|
+
* - Area of the customer's location
|
|
7487
7847
|
*/
|
|
7488
7848
|
area?: string;
|
|
7489
7849
|
/**
|
|
7490
|
-
* -
|
|
7850
|
+
* - First line of the address
|
|
7491
7851
|
*/
|
|
7492
7852
|
address1?: string;
|
|
7493
7853
|
/**
|
|
7494
|
-
* -
|
|
7495
|
-
* customer's location.
|
|
7854
|
+
* - Pincode of the customer's location
|
|
7496
7855
|
*/
|
|
7497
7856
|
pincode?: string;
|
|
7498
7857
|
/**
|
|
7499
|
-
* -
|
|
7500
|
-
* address for the customer.
|
|
7858
|
+
* - Primary email address for the customer
|
|
7501
7859
|
*/
|
|
7502
7860
|
primary_email?: string;
|
|
7503
7861
|
/**
|
|
7504
|
-
* -
|
|
7862
|
+
* - Second line of the address
|
|
7505
7863
|
*/
|
|
7506
7864
|
address2?: string;
|
|
7507
7865
|
/**
|
|
@@ -7527,29 +7885,27 @@ type UserInfo = {
|
|
|
7527
7885
|
*/
|
|
7528
7886
|
user_id?: string;
|
|
7529
7887
|
/**
|
|
7530
|
-
* -
|
|
7888
|
+
* - Type of the user
|
|
7531
7889
|
*/
|
|
7532
7890
|
user_type?: string;
|
|
7533
7891
|
/**
|
|
7534
|
-
* -
|
|
7535
|
-
* address for the user.
|
|
7892
|
+
* - Primary email address for the user
|
|
7536
7893
|
*/
|
|
7537
7894
|
primary_email?: string;
|
|
7538
7895
|
/**
|
|
7539
|
-
* -
|
|
7896
|
+
* - Gender of the user
|
|
7540
7897
|
*/
|
|
7541
7898
|
gender?: string;
|
|
7542
7899
|
/**
|
|
7543
|
-
* -
|
|
7900
|
+
* - User's first name
|
|
7544
7901
|
*/
|
|
7545
7902
|
first_name: string;
|
|
7546
7903
|
/**
|
|
7547
|
-
* -
|
|
7904
|
+
* - User's last name
|
|
7548
7905
|
*/
|
|
7549
7906
|
last_name?: string;
|
|
7550
7907
|
/**
|
|
7551
|
-
* -
|
|
7552
|
-
* mobile number for the user.
|
|
7908
|
+
* - Primary mobile number for the user
|
|
7553
7909
|
*/
|
|
7554
7910
|
primary_mobile_number: string;
|
|
7555
7911
|
};
|
|
@@ -7557,18 +7913,17 @@ type UserInfo = {
|
|
|
7557
7913
|
declare function TaxInfo(): TaxInfo;
|
|
7558
7914
|
type TaxInfo = {
|
|
7559
7915
|
/**
|
|
7560
|
-
* -
|
|
7561
|
-
* (
|
|
7562
|
-
* transactions.
|
|
7916
|
+
* - Goods and Services Tax Identification
|
|
7917
|
+
* Number (GSTIN) for business-to-business transactions
|
|
7563
7918
|
*/
|
|
7564
7919
|
b2b_gstin_number?: string;
|
|
7565
7920
|
/**
|
|
7566
|
-
* -
|
|
7921
|
+
* - GSTIN of the customer
|
|
7567
7922
|
*/
|
|
7568
7923
|
gstin?: string;
|
|
7569
7924
|
/**
|
|
7570
|
-
* -
|
|
7571
|
-
*
|
|
7925
|
+
* - PAN assigned to individuals or entities for tax
|
|
7926
|
+
* purposes in India
|
|
7572
7927
|
*/
|
|
7573
7928
|
pan_no?: string;
|
|
7574
7929
|
};
|
|
@@ -7576,23 +7931,20 @@ type TaxInfo = {
|
|
|
7576
7931
|
declare function PaymentMethod(): PaymentMethod;
|
|
7577
7932
|
type PaymentMethod = {
|
|
7578
7933
|
/**
|
|
7579
|
-
* -
|
|
7580
|
-
* for collecting the payment.
|
|
7934
|
+
* - Entity responsible for collecting the payment
|
|
7581
7935
|
*/
|
|
7582
7936
|
collect_by: string;
|
|
7583
7937
|
/**
|
|
7584
|
-
* -
|
|
7585
|
-
*
|
|
7586
|
-
* payment methods.
|
|
7938
|
+
* - Mode of payment. Refer to [API & references (in Nav
|
|
7939
|
+
* bar) → Payment Modes] for a list of valid payment methods.
|
|
7587
7940
|
*/
|
|
7588
7941
|
mode: string;
|
|
7589
7942
|
/**
|
|
7590
|
-
* -
|
|
7591
|
-
* for processing refunds.
|
|
7943
|
+
* - Entity responsible for processing refunds
|
|
7592
7944
|
*/
|
|
7593
7945
|
refund_by: string;
|
|
7594
7946
|
/**
|
|
7595
|
-
* -
|
|
7947
|
+
* - Name of the payment method
|
|
7596
7948
|
*/
|
|
7597
7949
|
name: string;
|
|
7598
7950
|
/**
|
|
@@ -7615,13 +7967,11 @@ type PaymentMethod = {
|
|
|
7615
7967
|
declare function PaymentInfo(): PaymentInfo;
|
|
7616
7968
|
type PaymentInfo = {
|
|
7617
7969
|
/**
|
|
7618
|
-
* -
|
|
7619
|
-
* method used for the order.
|
|
7970
|
+
* - Primary payment method used for the order
|
|
7620
7971
|
*/
|
|
7621
7972
|
primary_mode: string;
|
|
7622
7973
|
/**
|
|
7623
|
-
* -
|
|
7624
|
-
* used for the order.
|
|
7974
|
+
* - Payment mode used for the order
|
|
7625
7975
|
*/
|
|
7626
7976
|
payment_mode?: string;
|
|
7627
7977
|
/**
|
|
@@ -7635,8 +7985,8 @@ declare function CreateOrderAPI(): CreateOrderAPI;
|
|
|
7635
7985
|
type CreateOrderAPI = {
|
|
7636
7986
|
/**
|
|
7637
7987
|
* - List of Shipments which includes shipment
|
|
7638
|
-
* data like shipment items, shipment promise,
|
|
7639
|
-
* type, shipment
|
|
7988
|
+
* data like shipment items, shipment promise, shipment type, shipment order
|
|
7989
|
+
* type, shipment DP options etc.
|
|
7640
7990
|
*/
|
|
7641
7991
|
shipments: Shipment[];
|
|
7642
7992
|
shipping_info: ShippingInfo;
|
|
@@ -7653,13 +8003,12 @@ type CreateOrderAPI = {
|
|
|
7653
8003
|
*/
|
|
7654
8004
|
external_order_id?: string;
|
|
7655
8005
|
/**
|
|
7656
|
-
* -
|
|
7657
|
-
* various fees associated with the order.
|
|
8006
|
+
* - It details the various fees associated with the order.
|
|
7658
8007
|
*/
|
|
7659
8008
|
charges?: Charge[];
|
|
7660
8009
|
/**
|
|
7661
|
-
* -
|
|
7662
|
-
*
|
|
8010
|
+
* - Date and time when the order
|
|
8011
|
+
* was created in an external system
|
|
7663
8012
|
*/
|
|
7664
8013
|
external_creation_date?: string;
|
|
7665
8014
|
/**
|
|
@@ -7688,8 +8037,7 @@ type CreateOrderAPI = {
|
|
|
7688
8037
|
status?: string;
|
|
7689
8038
|
system_messages?: SystemMessages[];
|
|
7690
8039
|
/**
|
|
7691
|
-
* -
|
|
7692
|
-
* being placed.
|
|
8040
|
+
* - Type of order being placed
|
|
7693
8041
|
*/
|
|
7694
8042
|
order_type?: string;
|
|
7695
8043
|
/**
|
|
@@ -9844,8 +10192,8 @@ type TransitionConfigCondition = {
|
|
|
9844
10192
|
*/
|
|
9845
10193
|
ordering_channel?: string;
|
|
9846
10194
|
/**
|
|
9847
|
-
* -
|
|
9848
|
-
*
|
|
10195
|
+
* - Ordering source, to be used to
|
|
10196
|
+
* identify source of order creation.
|
|
9849
10197
|
*/
|
|
9850
10198
|
ordering_source?: string;
|
|
9851
10199
|
/**
|
|
@@ -10289,79 +10637,1080 @@ type PaymentMetaLogoURLSchema = {
|
|
|
10289
10637
|
*/
|
|
10290
10638
|
small: string;
|
|
10291
10639
|
};
|
|
10292
|
-
/** @returns {
|
|
10293
|
-
declare function
|
|
10294
|
-
type
|
|
10640
|
+
/** @returns {FulfillmentOptionSchema} */
|
|
10641
|
+
declare function FulfillmentOptionSchema(): FulfillmentOptionSchema;
|
|
10642
|
+
type FulfillmentOptionSchema = {
|
|
10295
10643
|
/**
|
|
10296
|
-
* -
|
|
10644
|
+
* - The name of the fulfillment option (e.g.,
|
|
10645
|
+
* 'Standard Shipping', 'Express Delivery').
|
|
10297
10646
|
*/
|
|
10298
|
-
|
|
10647
|
+
name?: string;
|
|
10299
10648
|
/**
|
|
10300
|
-
* -
|
|
10649
|
+
* - A unique identifier for the fulfillment option.
|
|
10301
10650
|
*/
|
|
10302
|
-
|
|
10303
|
-
};
|
|
10304
|
-
/** @returns {Page} */
|
|
10305
|
-
declare function Page(): Page;
|
|
10306
|
-
type Page = {
|
|
10651
|
+
slug?: string;
|
|
10307
10652
|
/**
|
|
10308
|
-
* - The
|
|
10653
|
+
* - The category or method of fulfillment
|
|
10654
|
+
* (e.g., 'Pickup', 'Delivery', 'Courier').
|
|
10309
10655
|
*/
|
|
10310
|
-
|
|
10656
|
+
is_default?: boolean;
|
|
10311
10657
|
/**
|
|
10312
|
-
* -
|
|
10658
|
+
* - Indicates whether this fulfillment option is the
|
|
10659
|
+
* default choice for customers.
|
|
10313
10660
|
*/
|
|
10314
|
-
|
|
10661
|
+
type?: string;
|
|
10662
|
+
};
|
|
10663
|
+
/** @returns {PaymentMethodGatewaySchema} */
|
|
10664
|
+
declare function PaymentMethodGatewaySchema(): PaymentMethodGatewaySchema;
|
|
10665
|
+
type PaymentMethodGatewaySchema = {
|
|
10315
10666
|
/**
|
|
10316
|
-
* -
|
|
10667
|
+
* - Payment Gateway Name.
|
|
10317
10668
|
*/
|
|
10318
|
-
|
|
10669
|
+
name: string;
|
|
10670
|
+
logo?: string;
|
|
10671
|
+
};
|
|
10672
|
+
/** @returns {SubModeOfPaymentSchema} */
|
|
10673
|
+
declare function SubModeOfPaymentSchema(): SubModeOfPaymentSchema;
|
|
10674
|
+
type SubModeOfPaymentSchema = {
|
|
10319
10675
|
/**
|
|
10320
|
-
* -
|
|
10676
|
+
* - Name of the Sub MOP Used.
|
|
10321
10677
|
*/
|
|
10322
|
-
|
|
10678
|
+
name: string;
|
|
10679
|
+
};
|
|
10680
|
+
/** @returns {PaymentMethodModeOfPaymentSchema} */
|
|
10681
|
+
declare function PaymentMethodModeOfPaymentSchema(): PaymentMethodModeOfPaymentSchema;
|
|
10682
|
+
type PaymentMethodModeOfPaymentSchema = {
|
|
10323
10683
|
/**
|
|
10324
|
-
* -
|
|
10684
|
+
* - Payment Mode Name.
|
|
10325
10685
|
*/
|
|
10326
|
-
|
|
10686
|
+
name: string;
|
|
10327
10687
|
/**
|
|
10328
|
-
* -
|
|
10688
|
+
* - Slug of the Payment Mode.
|
|
10329
10689
|
*/
|
|
10330
|
-
|
|
10690
|
+
slug: string;
|
|
10691
|
+
sub_mode_of_payment?: SubModeOfPaymentSchema;
|
|
10692
|
+
};
|
|
10693
|
+
/** @returns {PaymentMethodTransactionPartySchema} */
|
|
10694
|
+
declare function PaymentMethodTransactionPartySchema(): PaymentMethodTransactionPartySchema;
|
|
10695
|
+
type PaymentMethodTransactionPartySchema = {
|
|
10331
10696
|
/**
|
|
10332
|
-
* -
|
|
10697
|
+
* - Entity responsible for refunds (e.g., SELLER/FYND).
|
|
10333
10698
|
*/
|
|
10334
|
-
|
|
10699
|
+
refund_bearer: string;
|
|
10335
10700
|
/**
|
|
10336
|
-
* -
|
|
10701
|
+
* - Entity responsible for collection
|
|
10702
|
+
* charges (e.g., SELLER/FYND).
|
|
10337
10703
|
*/
|
|
10338
|
-
|
|
10704
|
+
collection_bearer: string;
|
|
10339
10705
|
};
|
|
10340
|
-
/** @returns {
|
|
10341
|
-
declare function
|
|
10342
|
-
type
|
|
10706
|
+
/** @returns {LineItemPaymentMethodSchema} */
|
|
10707
|
+
declare function LineItemPaymentMethodSchema(): LineItemPaymentMethodSchema;
|
|
10708
|
+
type LineItemPaymentMethodSchema = {
|
|
10709
|
+
gateway?: PaymentMethodGatewaySchema;
|
|
10710
|
+
mode_of_payment?: PaymentMethodModeOfPaymentSchema;
|
|
10343
10711
|
/**
|
|
10344
|
-
* -
|
|
10345
|
-
* be displayed for additional input related to the bag reason.
|
|
10712
|
+
* - Total Amount Paid by this Payment Method.
|
|
10346
10713
|
*/
|
|
10347
|
-
|
|
10348
|
-
};
|
|
10349
|
-
/** @returns {QuestionSet} */
|
|
10350
|
-
declare function QuestionSet(): QuestionSet;
|
|
10351
|
-
type QuestionSet = {
|
|
10714
|
+
amount_paid?: number;
|
|
10352
10715
|
/**
|
|
10353
|
-
* -
|
|
10716
|
+
* - Transaction id
|
|
10354
10717
|
*/
|
|
10355
|
-
|
|
10718
|
+
payment_identifier?: string;
|
|
10719
|
+
transaction_party?: PaymentMethodTransactionPartySchema;
|
|
10720
|
+
};
|
|
10721
|
+
/** @returns {BundleDetailsSchema} */
|
|
10722
|
+
declare function BundleDetailsSchema(): BundleDetailsSchema;
|
|
10723
|
+
type BundleDetailsSchema = {
|
|
10356
10724
|
/**
|
|
10357
|
-
* -
|
|
10358
|
-
* used for user-facing purposes.
|
|
10725
|
+
* - A flag that determines if bag is base bag of bundle.
|
|
10359
10726
|
*/
|
|
10360
|
-
|
|
10361
|
-
|
|
10362
|
-
|
|
10363
|
-
|
|
10364
|
-
|
|
10727
|
+
is_base?: boolean;
|
|
10728
|
+
/**
|
|
10729
|
+
* - An array of image URLs associated with the bundle.
|
|
10730
|
+
*/
|
|
10731
|
+
images?: string[];
|
|
10732
|
+
/**
|
|
10733
|
+
* - Unique group identifier for the bundle.
|
|
10734
|
+
*/
|
|
10735
|
+
group_id?: string;
|
|
10736
|
+
/**
|
|
10737
|
+
* - Name of the bundle.
|
|
10738
|
+
*/
|
|
10739
|
+
name?: string;
|
|
10740
|
+
/**
|
|
10741
|
+
* - Type of the item (physical_bundle, virtual_bundle).
|
|
10742
|
+
*/
|
|
10743
|
+
item_type?: string;
|
|
10744
|
+
/**
|
|
10745
|
+
* - Unique identifier for the item.
|
|
10746
|
+
*/
|
|
10747
|
+
item_id?: number;
|
|
10748
|
+
/**
|
|
10749
|
+
* - Item code for the item.
|
|
10750
|
+
*/
|
|
10751
|
+
item_code?: string;
|
|
10752
|
+
/**
|
|
10753
|
+
* - Name of the item.
|
|
10754
|
+
*/
|
|
10755
|
+
item_name?: string;
|
|
10756
|
+
/**
|
|
10757
|
+
* - Identifier for the seller of the bundle.
|
|
10758
|
+
*/
|
|
10759
|
+
seller_identifier?: string;
|
|
10760
|
+
/**
|
|
10761
|
+
* - Article net_quantity in bundle Product.
|
|
10762
|
+
*/
|
|
10763
|
+
bundle_article_quantity?: number;
|
|
10764
|
+
/**
|
|
10765
|
+
* - Identifier for the brand name.
|
|
10766
|
+
*/
|
|
10767
|
+
brand_name?: string;
|
|
10768
|
+
/**
|
|
10769
|
+
* - Size associated with the bundle item.
|
|
10770
|
+
*/
|
|
10771
|
+
size?: string;
|
|
10772
|
+
};
|
|
10773
|
+
/** @returns {LineItemMonetaryValuesSchema} */
|
|
10774
|
+
declare function LineItemMonetaryValuesSchema(): LineItemMonetaryValuesSchema;
|
|
10775
|
+
type LineItemMonetaryValuesSchema = {
|
|
10776
|
+
/**
|
|
10777
|
+
* - Amount Paid by Customer
|
|
10778
|
+
*/
|
|
10779
|
+
amount_paid: number;
|
|
10780
|
+
/**
|
|
10781
|
+
* - The final effective price after applying
|
|
10782
|
+
* discounts, promotional offers, and adjustments.
|
|
10783
|
+
*/
|
|
10784
|
+
price_effective: number;
|
|
10785
|
+
/**
|
|
10786
|
+
* - Discount amount apart from promo and coupon discount
|
|
10787
|
+
*/
|
|
10788
|
+
discount?: number;
|
|
10789
|
+
/**
|
|
10790
|
+
* - The original marked price of the item
|
|
10791
|
+
* before any discounts or promotions.
|
|
10792
|
+
*/
|
|
10793
|
+
price_marked: number;
|
|
10794
|
+
/**
|
|
10795
|
+
* - Coupon Discount Applied for this Line Item
|
|
10796
|
+
*/
|
|
10797
|
+
coupon_discount?: number;
|
|
10798
|
+
/**
|
|
10799
|
+
* - Cash on Delivery Charges Applied for this Article.
|
|
10800
|
+
*/
|
|
10801
|
+
cod_charges?: number;
|
|
10802
|
+
/**
|
|
10803
|
+
* - Promotion Discount
|
|
10804
|
+
*/
|
|
10805
|
+
promo_discount?: number;
|
|
10806
|
+
/**
|
|
10807
|
+
* - Gift Price
|
|
10808
|
+
*/
|
|
10809
|
+
gift_price?: number;
|
|
10810
|
+
/**
|
|
10811
|
+
* - Delivery Charges Applied for this Article.
|
|
10812
|
+
*/
|
|
10813
|
+
delivery_charges?: number;
|
|
10814
|
+
};
|
|
10815
|
+
/** @returns {DimensionSchema} */
|
|
10816
|
+
declare function DimensionSchema(): DimensionSchema;
|
|
10817
|
+
type DimensionSchema = {
|
|
10818
|
+
/**
|
|
10819
|
+
* - Height of the Product.
|
|
10820
|
+
*/
|
|
10821
|
+
height: number;
|
|
10822
|
+
/**
|
|
10823
|
+
* - Length of the product.
|
|
10824
|
+
*/
|
|
10825
|
+
length: number;
|
|
10826
|
+
/**
|
|
10827
|
+
* - Not Modified, meaning these are same as
|
|
10828
|
+
* product uploaded while loading catelogue.
|
|
10829
|
+
*/
|
|
10830
|
+
is_default: boolean;
|
|
10831
|
+
/**
|
|
10832
|
+
* - Unit of the measurement used.
|
|
10833
|
+
*/
|
|
10834
|
+
unit: string;
|
|
10835
|
+
/**
|
|
10836
|
+
* - Width of the Product.
|
|
10837
|
+
*/
|
|
10838
|
+
width: number;
|
|
10839
|
+
};
|
|
10840
|
+
/** @returns {GiftDetailsSchema} */
|
|
10841
|
+
declare function GiftDetailsSchema(): GiftDetailsSchema;
|
|
10842
|
+
type GiftDetailsSchema = {
|
|
10843
|
+
/**
|
|
10844
|
+
* - Specifies the value or cost of the gift
|
|
10845
|
+
* associated with the order line item.
|
|
10846
|
+
*/
|
|
10847
|
+
amount: number;
|
|
10848
|
+
/**
|
|
10849
|
+
* - A short description or label intended for
|
|
10850
|
+
* display purposes. This can be a message to the customer, such as "Gift wrap
|
|
10851
|
+
* included" or "Gift card value applied."
|
|
10852
|
+
*/
|
|
10853
|
+
display_text: string;
|
|
10854
|
+
};
|
|
10855
|
+
/** @returns {CPRiderDetailsSchema} */
|
|
10856
|
+
declare function CPRiderDetailsSchema(): CPRiderDetailsSchema;
|
|
10857
|
+
type CPRiderDetailsSchema = {
|
|
10858
|
+
name: string;
|
|
10859
|
+
phone: string;
|
|
10860
|
+
};
|
|
10861
|
+
/** @returns {CPAreaCodeSchema} */
|
|
10862
|
+
declare function CPAreaCodeSchema(): CPAreaCodeSchema;
|
|
10863
|
+
type CPAreaCodeSchema = {
|
|
10864
|
+
source: string;
|
|
10865
|
+
destination: string;
|
|
10866
|
+
};
|
|
10867
|
+
/** @returns {CPTatToDeliverTheShipmentSchema} */
|
|
10868
|
+
declare function CPTatToDeliverTheShipmentSchema(): CPTatToDeliverTheShipmentSchema;
|
|
10869
|
+
type CPTatToDeliverTheShipmentSchema = {
|
|
10870
|
+
min: number;
|
|
10871
|
+
max: number;
|
|
10872
|
+
};
|
|
10873
|
+
/** @returns {CPOptionsSchema} */
|
|
10874
|
+
declare function CPOptionsSchema(): CPOptionsSchema;
|
|
10875
|
+
type CPOptionsSchema = {
|
|
10876
|
+
extension_id?: string;
|
|
10877
|
+
scheme_id?: string;
|
|
10878
|
+
area_code?: CPAreaCodeSchema;
|
|
10879
|
+
is_self_ship?: boolean;
|
|
10880
|
+
max_reattempts_for_delivery_allowed?: number;
|
|
10881
|
+
/**
|
|
10882
|
+
* - A sorting key used for categorizing or
|
|
10883
|
+
* sorting courier partners, often related to their performance, costs, or
|
|
10884
|
+
* some other factor.
|
|
10885
|
+
*/
|
|
10886
|
+
cp_sort_key?: string;
|
|
10887
|
+
/**
|
|
10888
|
+
* - The name of the courier partner or the delivery
|
|
10889
|
+
* agent handling the shipment.
|
|
10890
|
+
*/
|
|
10891
|
+
name?: string;
|
|
10892
|
+
rider_details?: CPRiderDetailsSchema;
|
|
10893
|
+
/**
|
|
10894
|
+
* - Specifies whether the seller's
|
|
10895
|
+
* credentials are being used for the courier partner.
|
|
10896
|
+
*/
|
|
10897
|
+
using_own_creds?: boolean;
|
|
10898
|
+
/**
|
|
10899
|
+
* - Specifies that Assigned CP support's
|
|
10900
|
+
* quality checks
|
|
10901
|
+
*/
|
|
10902
|
+
qc_supported?: boolean;
|
|
10903
|
+
};
|
|
10904
|
+
/** @returns {CourierPartnerDetailsSchema} */
|
|
10905
|
+
declare function CourierPartnerDetailsSchema(): CourierPartnerDetailsSchema;
|
|
10906
|
+
type CourierPartnerDetailsSchema = {
|
|
10907
|
+
/**
|
|
10908
|
+
* - A sorting key used for categorizing or
|
|
10909
|
+
* sorting courier partners, often related to their performance, costs, or
|
|
10910
|
+
* some other factor.
|
|
10911
|
+
*/
|
|
10912
|
+
cp_sort_key?: string;
|
|
10913
|
+
/**
|
|
10914
|
+
* - Other Available CP's
|
|
10915
|
+
*/
|
|
10916
|
+
cp_options?: CPOptionsSchema[];
|
|
10917
|
+
scheme_id: string;
|
|
10918
|
+
/**
|
|
10919
|
+
* - The name of the courier partner or the delivery
|
|
10920
|
+
* agent handling the shipment.
|
|
10921
|
+
*/
|
|
10922
|
+
name: string;
|
|
10923
|
+
extension_id: string;
|
|
10924
|
+
rider_details?: CPRiderDetailsSchema;
|
|
10925
|
+
/**
|
|
10926
|
+
* - Specifies that Assigned CP support's
|
|
10927
|
+
* quality checks
|
|
10928
|
+
*/
|
|
10929
|
+
qc_supported?: boolean;
|
|
10930
|
+
/**
|
|
10931
|
+
* - Specifies weather the Seller's Creds or
|
|
10932
|
+
* Fynd's Creds are being used.
|
|
10933
|
+
*/
|
|
10934
|
+
using_own_creds: boolean;
|
|
10935
|
+
/**
|
|
10936
|
+
* - Reattempts Allowed
|
|
10937
|
+
* (required for ndr)
|
|
10938
|
+
*/
|
|
10939
|
+
max_reattempts_for_delivery_allowed?: number;
|
|
10940
|
+
tat_to_deliver_the_shipment?: CPTatToDeliverTheShipmentSchema;
|
|
10941
|
+
/**
|
|
10942
|
+
* - Is every logistic action handled by seller.
|
|
10943
|
+
*/
|
|
10944
|
+
is_self_ship?: boolean;
|
|
10945
|
+
};
|
|
10946
|
+
/** @returns {TaxDetailsSchema} */
|
|
10947
|
+
declare function TaxDetailsSchema(): TaxDetailsSchema;
|
|
10948
|
+
type TaxDetailsSchema = {
|
|
10949
|
+
/**
|
|
10950
|
+
* - The HS code of the product
|
|
10951
|
+
*/
|
|
10952
|
+
hs_code: string;
|
|
10953
|
+
/**
|
|
10954
|
+
* - Tax identifier.
|
|
10955
|
+
*/
|
|
10956
|
+
tax_rule_id: string;
|
|
10957
|
+
};
|
|
10958
|
+
/** @returns {PromiseDetailsSchema} */
|
|
10959
|
+
declare function PromiseDetailsSchema(): PromiseDetailsSchema;
|
|
10960
|
+
type PromiseDetailsSchema = {
|
|
10961
|
+
/**
|
|
10962
|
+
* - Min TimeStamp (EPOCH) that will be taken to
|
|
10963
|
+
* deliver the product
|
|
10964
|
+
*/
|
|
10965
|
+
min_sla: number;
|
|
10966
|
+
/**
|
|
10967
|
+
* - Max TimeStamp (EPOCH) that will be taken to
|
|
10968
|
+
* deliver the product.
|
|
10969
|
+
*/
|
|
10970
|
+
max_sla: number;
|
|
10971
|
+
};
|
|
10972
|
+
/** @returns {CustomerPickupSlotSchema} */
|
|
10973
|
+
declare function CustomerPickupSlotSchema(): CustomerPickupSlotSchema;
|
|
10974
|
+
type CustomerPickupSlotSchema = {
|
|
10975
|
+
start_time: string;
|
|
10976
|
+
end_time: string;
|
|
10977
|
+
};
|
|
10978
|
+
/** @returns {DpPickupSlotSchema} */
|
|
10979
|
+
declare function DpPickupSlotSchema(): DpPickupSlotSchema;
|
|
10980
|
+
type DpPickupSlotSchema = {
|
|
10981
|
+
start_time: string;
|
|
10982
|
+
end_time: string;
|
|
10983
|
+
};
|
|
10984
|
+
/** @returns {OrderFulfillmentTimelineSchema} */
|
|
10985
|
+
declare function OrderFulfillmentTimelineSchema(): OrderFulfillmentTimelineSchema;
|
|
10986
|
+
type OrderFulfillmentTimelineSchema = {
|
|
10987
|
+
dp_pickup_slot?: DpPickupSlotSchema;
|
|
10988
|
+
/**
|
|
10989
|
+
* - A date indicating when the order
|
|
10990
|
+
* can be dispatched (e.g., the earliest possible dispatch date).
|
|
10991
|
+
*/
|
|
10992
|
+
dispatch_after_date?: string;
|
|
10993
|
+
/**
|
|
10994
|
+
* - The latest date the order must be
|
|
10995
|
+
* dispatched to meet delivery expectations.
|
|
10996
|
+
*/
|
|
10997
|
+
dispatch_by_date?: string;
|
|
10998
|
+
/**
|
|
10999
|
+
* - The deadline by which the merchant
|
|
11000
|
+
* must confirm the order.
|
|
11001
|
+
*/
|
|
11002
|
+
confirm_by_date?: string;
|
|
11003
|
+
customer_pickup_slot?: CustomerPickupSlotSchema;
|
|
11004
|
+
/**
|
|
11005
|
+
* - The latest time the package should be
|
|
11006
|
+
* packed and ready to dispatch.
|
|
11007
|
+
*/
|
|
11008
|
+
pack_by_date?: string;
|
|
11009
|
+
};
|
|
11010
|
+
/** @returns {LineItemSchema} */
|
|
11011
|
+
declare function LineItemSchema(): LineItemSchema;
|
|
11012
|
+
type LineItemSchema = {
|
|
11013
|
+
/**
|
|
11014
|
+
* - Identifier for the seller providing the item.
|
|
11015
|
+
*/
|
|
11016
|
+
seller_identifier?: string;
|
|
11017
|
+
/**
|
|
11018
|
+
* - Payment Methods
|
|
11019
|
+
* Used to fulfil this Order.
|
|
11020
|
+
*/
|
|
11021
|
+
payment_methods: LineItemPaymentMethodSchema[];
|
|
11022
|
+
monetary_values: LineItemMonetaryValuesSchema;
|
|
11023
|
+
gift_details?: GiftDetailsSchema;
|
|
11024
|
+
/**
|
|
11025
|
+
* - A string for any special
|
|
11026
|
+
* instructions or messages.
|
|
11027
|
+
*/
|
|
11028
|
+
special_instructions?: string;
|
|
11029
|
+
dimension?: DimensionSchema;
|
|
11030
|
+
/**
|
|
11031
|
+
* - Quantity of the Line Item
|
|
11032
|
+
*/
|
|
11033
|
+
quantity?: number;
|
|
11034
|
+
/**
|
|
11035
|
+
* - Unique identifier for the LineItem as
|
|
11036
|
+
* assigned by an external system. You can use this to map external id to
|
|
11037
|
+
* Fynd's generated id
|
|
11038
|
+
*/
|
|
11039
|
+
external_line_id?: string;
|
|
11040
|
+
bundle_details?: BundleDetailsSchema;
|
|
11041
|
+
/**
|
|
11042
|
+
* - An object containing metadata related to the shipment.
|
|
11043
|
+
*/
|
|
11044
|
+
meta?: any;
|
|
11045
|
+
};
|
|
11046
|
+
/** @returns {CreateOrderShipmentSchema} */
|
|
11047
|
+
declare function CreateOrderShipmentSchema(): CreateOrderShipmentSchema;
|
|
11048
|
+
type CreateOrderShipmentSchema = {
|
|
11049
|
+
/**
|
|
11050
|
+
* - Indicates if the shipment belongs to the
|
|
11051
|
+
* made-to-order category, i.e., the seller will start creating this order
|
|
11052
|
+
* after receiving an order creation request.
|
|
11053
|
+
*/
|
|
11054
|
+
is_mto?: boolean;
|
|
11055
|
+
/**
|
|
11056
|
+
* - List of
|
|
11057
|
+
* general-purpose messages shown across different points in the shipment's
|
|
11058
|
+
* journey at Order Details Screen.
|
|
11059
|
+
*/
|
|
11060
|
+
shipment_lifecycle_messages?: LifecycleMessageSchema[];
|
|
11061
|
+
/**
|
|
11062
|
+
* - Tags that can be attached to the shipment for
|
|
11063
|
+
* filtering and categorization.
|
|
11064
|
+
*/
|
|
11065
|
+
tags?: string[];
|
|
11066
|
+
/**
|
|
11067
|
+
* - The shipment type defining the fulfillment method
|
|
11068
|
+
* and processing flow. Each type determines the specific journey a shipment
|
|
11069
|
+
* will follow based on operational needs and customer preferences:
|
|
11070
|
+
*
|
|
11071
|
+
* - "HomeDelivery": Standard delivery to the customer's address, undergoing all
|
|
11072
|
+
* typical state transitions from processing to final delivery.
|
|
11073
|
+
* - "PickAtStore": Order prepared for in-store pickup, bypassing traditional
|
|
11074
|
+
* shipping stages for direct handover to the customer.
|
|
11075
|
+
* - "Digital": Orders involving digital goods or services (e.g., software,
|
|
11076
|
+
* e-books, subscriptions) delivered electronically.
|
|
11077
|
+
*/
|
|
11078
|
+
type?: string;
|
|
11079
|
+
fulfillment_option?: FulfillmentOptionSchema;
|
|
11080
|
+
/**
|
|
11081
|
+
* - Unique identifier for the
|
|
11082
|
+
* shipment as assigned by an external system. Use this to map the external ID
|
|
11083
|
+
* to Fynd's generated ID.
|
|
11084
|
+
*/
|
|
11085
|
+
external_shipment_id?: string;
|
|
11086
|
+
/**
|
|
11087
|
+
* - A list of items included in the shipment.
|
|
11088
|
+
*/
|
|
11089
|
+
line_items?: LineItemSchema[];
|
|
11090
|
+
order_fulfillment_timeline?: OrderFulfillmentTimelineSchema;
|
|
11091
|
+
/**
|
|
11092
|
+
* - The location ID from which this shipment
|
|
11093
|
+
* is being fulfilled.
|
|
11094
|
+
*/
|
|
11095
|
+
location_id?: number;
|
|
11096
|
+
/**
|
|
11097
|
+
* - The external location ID from
|
|
11098
|
+
* which this shipment is being fulfilled.
|
|
11099
|
+
*/
|
|
11100
|
+
external_location_id?: string;
|
|
11101
|
+
/**
|
|
11102
|
+
* - Overrides the article's default
|
|
11103
|
+
* return location.
|
|
11104
|
+
*/
|
|
11105
|
+
return_location_id?: number;
|
|
11106
|
+
courier_partner_details?: CourierPartnerDetailsSchema;
|
|
11107
|
+
tax_details?: TaxDetailsSchema;
|
|
11108
|
+
promise_details?: PromiseDetailsSchema;
|
|
11109
|
+
/**
|
|
11110
|
+
* - Defines the UTC time at which
|
|
11111
|
+
* the shipment will automatically move to the placed state.
|
|
11112
|
+
*/
|
|
11113
|
+
allow_processing_after?: string;
|
|
11114
|
+
/**
|
|
11115
|
+
* - Additional metadata related to the shipment.
|
|
11116
|
+
*/
|
|
11117
|
+
meta?: any;
|
|
11118
|
+
};
|
|
11119
|
+
/** @returns {OrderingCurrencySchema} */
|
|
11120
|
+
declare function OrderingCurrencySchema(): OrderingCurrencySchema;
|
|
11121
|
+
type OrderingCurrencySchema = {
|
|
11122
|
+
/**
|
|
11123
|
+
* - The ISO 4217 currency code, such as 'INR'
|
|
11124
|
+
* for Indian Rupee. This field represents the standardized three-letter code
|
|
11125
|
+
* of a currency.
|
|
11126
|
+
*/
|
|
11127
|
+
currency_code: string;
|
|
11128
|
+
/**
|
|
11129
|
+
* - The symbol representing the currency,
|
|
11130
|
+
* such as '₹' for Indian Rupee. This is used for display purposes alongside
|
|
11131
|
+
* currency amounts.
|
|
11132
|
+
*/
|
|
11133
|
+
currency_symbol: string;
|
|
11134
|
+
};
|
|
11135
|
+
/** @returns {ConversionRateSchema} */
|
|
11136
|
+
declare function ConversionRateSchema(): ConversionRateSchema;
|
|
11137
|
+
type ConversionRateSchema = {
|
|
11138
|
+
/**
|
|
11139
|
+
* - The exchange rate used to convert monetary values
|
|
11140
|
+
* from the ordering currency to the seller's currency.
|
|
11141
|
+
*/
|
|
11142
|
+
rate: number;
|
|
11143
|
+
/**
|
|
11144
|
+
* - The timestamp (in milliseconds) when the
|
|
11145
|
+
* conversion rate was applied.
|
|
11146
|
+
*/
|
|
11147
|
+
timestamp_ms: number;
|
|
11148
|
+
};
|
|
11149
|
+
/** @returns {CurrencySchema} */
|
|
11150
|
+
declare function CurrencySchema(): CurrencySchema;
|
|
11151
|
+
type CurrencySchema = {
|
|
11152
|
+
ordering_currency: OrderingCurrencySchema;
|
|
11153
|
+
conversion_rate: ConversionRateSchema;
|
|
11154
|
+
/**
|
|
11155
|
+
* - The ISO 4217 currency code, such as
|
|
11156
|
+
* 'INR' for Indian Rupee. This field represents the standardized three-letter
|
|
11157
|
+
* code of a currency.
|
|
11158
|
+
*/
|
|
11159
|
+
currency_code?: string;
|
|
11160
|
+
/**
|
|
11161
|
+
* - The symbol representing the currency,
|
|
11162
|
+
* such as '₹' for Indian Rupee. This is used for display purposes alongside
|
|
11163
|
+
* currency amounts.
|
|
11164
|
+
*/
|
|
11165
|
+
currency_symbol?: string;
|
|
11166
|
+
};
|
|
11167
|
+
/** @returns {CouponOwnershipSchema} */
|
|
11168
|
+
declare function CouponOwnershipSchema(): CouponOwnershipSchema;
|
|
11169
|
+
type CouponOwnershipSchema = {
|
|
11170
|
+
/**
|
|
11171
|
+
* - Indicates who issued the coupon
|
|
11172
|
+
* (MARKETPLACE or SELLER).
|
|
11173
|
+
*/
|
|
11174
|
+
payable_category: string;
|
|
11175
|
+
};
|
|
11176
|
+
/** @returns {CouponSchema} */
|
|
11177
|
+
declare function CouponSchema(): CouponSchema;
|
|
11178
|
+
type CouponSchema = {
|
|
11179
|
+
/**
|
|
11180
|
+
* - The coupon code that was applied.
|
|
11181
|
+
*/
|
|
11182
|
+
code: string;
|
|
11183
|
+
/**
|
|
11184
|
+
* - Unique identifier of the coupon.
|
|
11185
|
+
*/
|
|
11186
|
+
id: string;
|
|
11187
|
+
ownership: CouponOwnershipSchema;
|
|
11188
|
+
/**
|
|
11189
|
+
* - Indicates whether returns are allowed
|
|
11190
|
+
* when this coupon is applied.
|
|
11191
|
+
*/
|
|
11192
|
+
is_return_allowed: boolean;
|
|
11193
|
+
/**
|
|
11194
|
+
* - Indicates whether cancellations
|
|
11195
|
+
* are allowed when this coupon is applied.
|
|
11196
|
+
*/
|
|
11197
|
+
is_cancellation_allowed: boolean;
|
|
11198
|
+
};
|
|
11199
|
+
/** @returns {BillingDetailsSchema} */
|
|
11200
|
+
declare function BillingDetailsSchema(): BillingDetailsSchema;
|
|
11201
|
+
type BillingDetailsSchema = {
|
|
11202
|
+
/**
|
|
11203
|
+
* - First Name of the User
|
|
11204
|
+
*/
|
|
11205
|
+
first_name?: string;
|
|
11206
|
+
/**
|
|
11207
|
+
* - Country phone code ex: +91
|
|
11208
|
+
*/
|
|
11209
|
+
phone_code?: string;
|
|
11210
|
+
/**
|
|
11211
|
+
* - Country of the User
|
|
11212
|
+
*/
|
|
11213
|
+
country?: string;
|
|
11214
|
+
/**
|
|
11215
|
+
* - City of the User
|
|
11216
|
+
*/
|
|
11217
|
+
city?: string;
|
|
11218
|
+
/**
|
|
11219
|
+
* - Pincode of the User
|
|
11220
|
+
*/
|
|
11221
|
+
pincode?: string;
|
|
11222
|
+
/**
|
|
11223
|
+
* - Last Name of the User
|
|
11224
|
+
*/
|
|
11225
|
+
last_name?: string;
|
|
11226
|
+
/**
|
|
11227
|
+
* - Primary Phone number of the User
|
|
11228
|
+
*/
|
|
11229
|
+
mobile_number?: string;
|
|
11230
|
+
/**
|
|
11231
|
+
* - Primary Email of the User
|
|
11232
|
+
*/
|
|
11233
|
+
email?: string;
|
|
11234
|
+
/**
|
|
11235
|
+
* - State of the User
|
|
11236
|
+
*/
|
|
11237
|
+
state?: string;
|
|
11238
|
+
/**
|
|
11239
|
+
* - Alternate Mobile Number
|
|
11240
|
+
*/
|
|
11241
|
+
alternate_mobile_number?: string;
|
|
11242
|
+
/**
|
|
11243
|
+
* - Full Address of the Billing User
|
|
11244
|
+
*/
|
|
11245
|
+
address?: string;
|
|
11246
|
+
/**
|
|
11247
|
+
* - A string containing the customer's middle name.
|
|
11248
|
+
*/
|
|
11249
|
+
middle_name?: string;
|
|
11250
|
+
/**
|
|
11251
|
+
* - A string representing the customer's title or prefix.
|
|
11252
|
+
*/
|
|
11253
|
+
title?: string;
|
|
11254
|
+
/**
|
|
11255
|
+
* - A string representing the house or apartment
|
|
11256
|
+
* number of the customer.
|
|
11257
|
+
*/
|
|
11258
|
+
house_no?: string;
|
|
11259
|
+
geo_location?: GeoLocationSchema;
|
|
11260
|
+
/**
|
|
11261
|
+
* - Gender of user
|
|
11262
|
+
*/
|
|
11263
|
+
gender?: string;
|
|
11264
|
+
/**
|
|
11265
|
+
* - A string representing a landmark or reference
|
|
11266
|
+
* point near the customer's location.
|
|
11267
|
+
*/
|
|
11268
|
+
landmark?: string;
|
|
11269
|
+
/**
|
|
11270
|
+
* - A string representing the address type in
|
|
11271
|
+
* the seller's system.
|
|
11272
|
+
*/
|
|
11273
|
+
address_type?: string;
|
|
11274
|
+
/**
|
|
11275
|
+
* - A string representing the state code of the
|
|
11276
|
+
* customer's location.
|
|
11277
|
+
*/
|
|
11278
|
+
state_code?: string;
|
|
11279
|
+
/**
|
|
11280
|
+
* - A string representing the floor number of the
|
|
11281
|
+
* customer's location.
|
|
11282
|
+
*/
|
|
11283
|
+
floor_no?: string;
|
|
11284
|
+
/**
|
|
11285
|
+
* - Alternate Email Address
|
|
11286
|
+
*/
|
|
11287
|
+
alternate_email?: string;
|
|
11288
|
+
/**
|
|
11289
|
+
* - A string representing the first line of the address.
|
|
11290
|
+
*/
|
|
11291
|
+
address1?: string;
|
|
11292
|
+
/**
|
|
11293
|
+
* - A string representing the second line of the address.
|
|
11294
|
+
*/
|
|
11295
|
+
address2?: string;
|
|
11296
|
+
/**
|
|
11297
|
+
* - Specifies the country's unique
|
|
11298
|
+
* identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
|
|
11299
|
+
* is crucial for distinguishing countries in international transactions, data
|
|
11300
|
+
* processing, and shipping logistics.
|
|
11301
|
+
*/
|
|
11302
|
+
country_iso_code?: string;
|
|
11303
|
+
/**
|
|
11304
|
+
* - The unique identifier assigned to the user.
|
|
11305
|
+
* refer /user in platform documentation to get more details.
|
|
11306
|
+
*/
|
|
11307
|
+
user_id?: string;
|
|
11308
|
+
/**
|
|
11309
|
+
* - Area Code
|
|
11310
|
+
*/
|
|
11311
|
+
area_code?: string;
|
|
11312
|
+
area_code_slug?: string;
|
|
11313
|
+
country_phone_code?: string;
|
|
11314
|
+
};
|
|
11315
|
+
/** @returns {CPConfigurationSchema} */
|
|
11316
|
+
declare function CPConfigurationSchema(): CPConfigurationSchema;
|
|
11317
|
+
type CPConfigurationSchema = {
|
|
11318
|
+
/**
|
|
11319
|
+
* - Shipping Handled by FYND or SELLER
|
|
11320
|
+
*/
|
|
11321
|
+
shipping_by: string;
|
|
11322
|
+
};
|
|
11323
|
+
/** @returns {ShippingDetailsSchema} */
|
|
11324
|
+
declare function ShippingDetailsSchema(): ShippingDetailsSchema;
|
|
11325
|
+
type ShippingDetailsSchema = {
|
|
11326
|
+
/**
|
|
11327
|
+
* - First Name of the User
|
|
11328
|
+
*/
|
|
11329
|
+
first_name?: string;
|
|
11330
|
+
/**
|
|
11331
|
+
* - Country phone code ex: +91
|
|
11332
|
+
*/
|
|
11333
|
+
phone_code?: string;
|
|
11334
|
+
/**
|
|
11335
|
+
* - Country of the User
|
|
11336
|
+
*/
|
|
11337
|
+
country?: string;
|
|
11338
|
+
/**
|
|
11339
|
+
* - City of the User
|
|
11340
|
+
*/
|
|
11341
|
+
city?: string;
|
|
11342
|
+
/**
|
|
11343
|
+
* - Pincode of the User
|
|
11344
|
+
*/
|
|
11345
|
+
pincode?: string;
|
|
11346
|
+
/**
|
|
11347
|
+
* - Last Name of the User
|
|
11348
|
+
*/
|
|
11349
|
+
last_name?: string;
|
|
11350
|
+
/**
|
|
11351
|
+
* - Primary Phone number of the User
|
|
11352
|
+
*/
|
|
11353
|
+
mobile_number?: string;
|
|
11354
|
+
/**
|
|
11355
|
+
* - Primary Email of the User
|
|
11356
|
+
*/
|
|
11357
|
+
email?: string;
|
|
11358
|
+
/**
|
|
11359
|
+
* - State of the User
|
|
11360
|
+
*/
|
|
11361
|
+
state?: string;
|
|
11362
|
+
/**
|
|
11363
|
+
* - Alternate Mobile Number
|
|
11364
|
+
*/
|
|
11365
|
+
alternate_mobile_number?: string;
|
|
11366
|
+
/**
|
|
11367
|
+
* - Full Address of the Billing User
|
|
11368
|
+
*/
|
|
11369
|
+
address?: string;
|
|
11370
|
+
/**
|
|
11371
|
+
* - A string containing the customer's middle name.
|
|
11372
|
+
*/
|
|
11373
|
+
middle_name?: string;
|
|
11374
|
+
/**
|
|
11375
|
+
* - A string representing the customer's title or prefix.
|
|
11376
|
+
*/
|
|
11377
|
+
title?: string;
|
|
11378
|
+
/**
|
|
11379
|
+
* - A string representing the house or apartment
|
|
11380
|
+
* number of the customer.
|
|
11381
|
+
*/
|
|
11382
|
+
house_no?: string;
|
|
11383
|
+
geo_location?: GeoLocationSchema;
|
|
11384
|
+
/**
|
|
11385
|
+
* - Gender of user
|
|
11386
|
+
*/
|
|
11387
|
+
gender?: string;
|
|
11388
|
+
/**
|
|
11389
|
+
* - A string representing a landmark or reference
|
|
11390
|
+
* point near the customer's location.
|
|
11391
|
+
*/
|
|
11392
|
+
landmark?: string;
|
|
11393
|
+
/**
|
|
11394
|
+
* - A string representing the address type in
|
|
11395
|
+
* the seller's system.
|
|
11396
|
+
*/
|
|
11397
|
+
address_type?: string;
|
|
11398
|
+
/**
|
|
11399
|
+
* - A string representing the state code of the
|
|
11400
|
+
* customer's location.
|
|
11401
|
+
*/
|
|
11402
|
+
state_code?: string;
|
|
11403
|
+
/**
|
|
11404
|
+
* - A string representing the floor number of the
|
|
11405
|
+
* customer's location.
|
|
11406
|
+
*/
|
|
11407
|
+
floor_no?: string;
|
|
11408
|
+
/**
|
|
11409
|
+
* - Alternate Email Address
|
|
11410
|
+
*/
|
|
11411
|
+
alternate_email?: string;
|
|
11412
|
+
/**
|
|
11413
|
+
* - A string representing the first line of the address.
|
|
11414
|
+
*/
|
|
11415
|
+
address1?: string;
|
|
11416
|
+
/**
|
|
11417
|
+
* - A string representing the second line of the address.
|
|
11418
|
+
*/
|
|
11419
|
+
address2?: string;
|
|
11420
|
+
/**
|
|
11421
|
+
* - Specifies the country's unique
|
|
11422
|
+
* identifier ollowing the ISO 3166-1 alpha-2 standard. This two-letter code
|
|
11423
|
+
* is crucial for distinguishing countries in international transactions, data
|
|
11424
|
+
* processing, and shipping logistics.
|
|
11425
|
+
*/
|
|
11426
|
+
country_iso_code?: string;
|
|
11427
|
+
/**
|
|
11428
|
+
* - The unique identifier assigned to the user.
|
|
11429
|
+
* refer /user in platform documentation to get more details.
|
|
11430
|
+
*/
|
|
11431
|
+
user_id?: string;
|
|
11432
|
+
/**
|
|
11433
|
+
* - Area Code
|
|
11434
|
+
*/
|
|
11435
|
+
area_code?: string;
|
|
11436
|
+
area_code_slug?: string;
|
|
11437
|
+
country_phone_code?: string;
|
|
11438
|
+
};
|
|
11439
|
+
/** @returns {UserDetailsSchema} */
|
|
11440
|
+
declare function UserDetailsSchema(): UserDetailsSchema;
|
|
11441
|
+
type UserDetailsSchema = {
|
|
11442
|
+
/**
|
|
11443
|
+
* - The user's GSTIN (Goods and Services Tax
|
|
11444
|
+
* Identification Number).
|
|
11445
|
+
*/
|
|
11446
|
+
gstin?: string;
|
|
11447
|
+
/**
|
|
11448
|
+
* - The user's PAN (Permanent Account Number).
|
|
11449
|
+
*/
|
|
11450
|
+
pan_no?: string;
|
|
11451
|
+
};
|
|
11452
|
+
/** @returns {LifecycleMessageSchema} */
|
|
11453
|
+
declare function LifecycleMessageSchema(): LifecycleMessageSchema;
|
|
11454
|
+
type LifecycleMessageSchema = {
|
|
11455
|
+
/**
|
|
11456
|
+
* - The message text to display to users at specific
|
|
11457
|
+
* order states (e.g., PLACED, SHIPPED).
|
|
11458
|
+
*/
|
|
11459
|
+
message: string;
|
|
11460
|
+
/**
|
|
11461
|
+
* - The message type, which determines the color of the
|
|
11462
|
+
* message bar.
|
|
11463
|
+
*/
|
|
11464
|
+
type: string;
|
|
11465
|
+
/**
|
|
11466
|
+
* - List of OMS states at which the message should
|
|
11467
|
+
* be visible.
|
|
11468
|
+
*/
|
|
11469
|
+
states: string[];
|
|
11470
|
+
/**
|
|
11471
|
+
* - Determines the message display sequence, with 1
|
|
11472
|
+
* being the highest priority.
|
|
11473
|
+
*/
|
|
11474
|
+
priority: number;
|
|
11475
|
+
};
|
|
11476
|
+
/** @returns {CreateOrderRequestSchema} */
|
|
11477
|
+
declare function CreateOrderRequestSchema(): CreateOrderRequestSchema;
|
|
11478
|
+
type CreateOrderRequestSchema = {
|
|
11479
|
+
/**
|
|
11480
|
+
* - List of shipments
|
|
11481
|
+
* included in the order.
|
|
11482
|
+
*/
|
|
11483
|
+
shipments?: CreateOrderShipmentSchema[];
|
|
11484
|
+
/**
|
|
11485
|
+
* - Tags that can be used to filter and categorize
|
|
11486
|
+
* orders and shipments.
|
|
11487
|
+
*/
|
|
11488
|
+
tags?: string[];
|
|
11489
|
+
currency_details: CurrencySchema;
|
|
11490
|
+
/**
|
|
11491
|
+
* - Timestamp indicating when the
|
|
11492
|
+
* order was created in an external system.
|
|
11493
|
+
*/
|
|
11494
|
+
external_creation_date?: string;
|
|
11495
|
+
coupon_details?: CouponSchema;
|
|
11496
|
+
billing_details: BillingDetailsSchema;
|
|
11497
|
+
/**
|
|
11498
|
+
* - The primary payment method used for
|
|
11499
|
+
* the entire order transaction.
|
|
11500
|
+
*/
|
|
11501
|
+
primary_payment_mode: string;
|
|
11502
|
+
cp_configuration?: CPConfigurationSchema;
|
|
11503
|
+
/**
|
|
11504
|
+
* - The location ID where the order
|
|
11505
|
+
* is placed. Required when the order is placed from one location but
|
|
11506
|
+
* fulfilled by another.
|
|
11507
|
+
*/
|
|
11508
|
+
ordering_location_id?: number;
|
|
11509
|
+
/**
|
|
11510
|
+
* - Allows location
|
|
11511
|
+
* reassignment before order confirmation.
|
|
11512
|
+
*/
|
|
11513
|
+
allow_location_reassignment?: boolean;
|
|
11514
|
+
shipping_details: ShippingDetailsSchema;
|
|
11515
|
+
/**
|
|
11516
|
+
* - A unique identifier assigned to the
|
|
11517
|
+
* order by an external system or service.
|
|
11518
|
+
*/
|
|
11519
|
+
external_order_id?: string;
|
|
11520
|
+
user_details?: UserDetailsSchema;
|
|
11521
|
+
/**
|
|
11522
|
+
* - List of
|
|
11523
|
+
* order lifecycle messages to be displayed to the user at Order Details.
|
|
11524
|
+
*/
|
|
11525
|
+
order_lifecycle_messages?: LifecycleMessageSchema[];
|
|
11526
|
+
/**
|
|
11527
|
+
* - Identifies the application from
|
|
11528
|
+
* which the order was created. Pass this when it differs from the fulfilling
|
|
11529
|
+
* company's application.
|
|
11530
|
+
*/
|
|
11531
|
+
channel_application_id?: string;
|
|
11532
|
+
/**
|
|
11533
|
+
* - The GSTIN (Goods and Services Tax
|
|
11534
|
+
* Identification Number) for business-to-business transactions.
|
|
11535
|
+
*/
|
|
11536
|
+
b2b_gstin_number?: string;
|
|
11537
|
+
/**
|
|
11538
|
+
* - The company ID where the order is
|
|
11539
|
+
* placed. Required when the order is placed from one company but fulfilled by another.
|
|
11540
|
+
*/
|
|
11541
|
+
channel_company_id?: string;
|
|
11542
|
+
/**
|
|
11543
|
+
* - Indicates whether the order is a draft.
|
|
11544
|
+
* Draft orders will be moved to upcoming state instead of placed status.
|
|
11545
|
+
*/
|
|
11546
|
+
is_draft?: boolean;
|
|
11547
|
+
};
|
|
11548
|
+
/** @returns {Page} */
|
|
11549
|
+
declare function Page(): Page;
|
|
11550
|
+
type Page = {
|
|
11551
|
+
/**
|
|
11552
|
+
* - The total number of all items across all pages.
|
|
11553
|
+
*/
|
|
11554
|
+
item_total?: number;
|
|
11555
|
+
/**
|
|
11556
|
+
* - The identifier for the next page.
|
|
11557
|
+
*/
|
|
11558
|
+
next_id?: string;
|
|
11559
|
+
/**
|
|
11560
|
+
* - Indicates whether there is a previous page.
|
|
11561
|
+
*/
|
|
11562
|
+
has_previous?: boolean;
|
|
11563
|
+
/**
|
|
11564
|
+
* - Indicates whether there is a next page.
|
|
11565
|
+
*/
|
|
11566
|
+
has_next?: boolean;
|
|
11567
|
+
/**
|
|
11568
|
+
* - The current page number.
|
|
11569
|
+
*/
|
|
11570
|
+
current?: number;
|
|
11571
|
+
/**
|
|
11572
|
+
* - The type of the page, such as 'PageType'.
|
|
11573
|
+
*/
|
|
11574
|
+
type: string;
|
|
11575
|
+
/**
|
|
11576
|
+
* - The number of items per page.
|
|
11577
|
+
*/
|
|
11578
|
+
size?: number;
|
|
11579
|
+
/**
|
|
11580
|
+
* - The number of items per page.
|
|
11581
|
+
*/
|
|
11582
|
+
page_size?: number;
|
|
11583
|
+
};
|
|
11584
|
+
/** @returns {OrderingSourceConfig} */
|
|
11585
|
+
declare function OrderingSourceConfig(): OrderingSourceConfig;
|
|
11586
|
+
type OrderingSourceConfig = {
|
|
11587
|
+
/**
|
|
11588
|
+
* - Slug of the ordering source.
|
|
11589
|
+
*/
|
|
11590
|
+
slug?: string;
|
|
11591
|
+
configs?: OrderingSourceFeature[];
|
|
11592
|
+
/**
|
|
11593
|
+
* - Logo of the ordering source.
|
|
11594
|
+
*/
|
|
11595
|
+
logo?: string;
|
|
11596
|
+
};
|
|
11597
|
+
/** @returns {OrderingSourceFeature} */
|
|
11598
|
+
declare function OrderingSourceFeature(): OrderingSourceFeature;
|
|
11599
|
+
type OrderingSourceFeature = {
|
|
11600
|
+
/**
|
|
11601
|
+
* - Name of the ordering source config item.
|
|
11602
|
+
*/
|
|
11603
|
+
name?: string;
|
|
11604
|
+
/**
|
|
11605
|
+
* - Slug of the ordering source config item.
|
|
11606
|
+
*/
|
|
11607
|
+
slug?: string;
|
|
11608
|
+
/**
|
|
11609
|
+
* - Description of the ordering source config item.
|
|
11610
|
+
*/
|
|
11611
|
+
description?: string;
|
|
11612
|
+
/**
|
|
11613
|
+
* - Whether the config/feature is enabled or not.
|
|
11614
|
+
*/
|
|
11615
|
+
enabled?: boolean;
|
|
11616
|
+
};
|
|
11617
|
+
/** @returns {ListOrderingSources} */
|
|
11618
|
+
declare function ListOrderingSources(): ListOrderingSources;
|
|
11619
|
+
type ListOrderingSources = {
|
|
11620
|
+
items?: OrderingSourceSummary[];
|
|
11621
|
+
page?: Page;
|
|
11622
|
+
};
|
|
11623
|
+
/** @returns {OrderingSourceSummary} */
|
|
11624
|
+
declare function OrderingSourceSummary(): OrderingSourceSummary;
|
|
11625
|
+
type OrderingSourceSummary = {
|
|
11626
|
+
/**
|
|
11627
|
+
* - Display Text of the ordering source.
|
|
11628
|
+
*/
|
|
11629
|
+
text?: string;
|
|
11630
|
+
/**
|
|
11631
|
+
* - Value of the ordering source.
|
|
11632
|
+
*/
|
|
11633
|
+
value?: string;
|
|
11634
|
+
};
|
|
11635
|
+
/** @returns {CreateAccount} */
|
|
11636
|
+
declare function CreateAccount(): CreateAccount;
|
|
11637
|
+
type CreateAccount = {
|
|
11638
|
+
/**
|
|
11639
|
+
* - Unique name identifier for the
|
|
11640
|
+
* channel account. This represents the sales channel or marketplace through
|
|
11641
|
+
* which orders are received and processed.
|
|
11642
|
+
*/
|
|
11643
|
+
channel_account_name: string;
|
|
11644
|
+
};
|
|
11645
|
+
/** @returns {Account} */
|
|
11646
|
+
declare function Account(): Account;
|
|
11647
|
+
type Account = {
|
|
11648
|
+
/**
|
|
11649
|
+
* - Unique identifier for the channel
|
|
11650
|
+
* account. This is a system-generated identifier used to reference the
|
|
11651
|
+
* account across the platform.
|
|
11652
|
+
*/
|
|
11653
|
+
channel_account_id?: string;
|
|
11654
|
+
/**
|
|
11655
|
+
* - Unique identifier of the company on the
|
|
11656
|
+
* platform to which this channel account belongs.
|
|
11657
|
+
*/
|
|
11658
|
+
company_id?: number;
|
|
11659
|
+
/**
|
|
11660
|
+
* - Name of the channel account. This
|
|
11661
|
+
* identifies the specific sales channel or marketplace (e.g., SHOPIFY,
|
|
11662
|
+
* MARKETPLACE, etc.) through which the company receives and processes orders.
|
|
11663
|
+
*/
|
|
11664
|
+
channel_account_name?: string;
|
|
11665
|
+
};
|
|
11666
|
+
/** @returns {AccountsList} */
|
|
11667
|
+
declare function AccountsList(): AccountsList;
|
|
11668
|
+
type AccountsList = {
|
|
11669
|
+
/**
|
|
11670
|
+
* - List of channel accounts associated with the
|
|
11671
|
+
* company. Each account represents a different sales channel or marketplace
|
|
11672
|
+
* integration.
|
|
11673
|
+
*/
|
|
11674
|
+
data?: Account[];
|
|
11675
|
+
page?: Page;
|
|
11676
|
+
};
|
|
11677
|
+
/** @returns {ValidationError} */
|
|
11678
|
+
declare function ValidationError(): ValidationError;
|
|
11679
|
+
type ValidationError = {
|
|
11680
|
+
/**
|
|
11681
|
+
* - A brief description of the error encountered.
|
|
11682
|
+
*/
|
|
11683
|
+
message: string;
|
|
11684
|
+
/**
|
|
11685
|
+
* - The field in the request that caused the error.
|
|
11686
|
+
*/
|
|
11687
|
+
field: string;
|
|
11688
|
+
};
|
|
11689
|
+
/** @returns {BagReasonMeta} */
|
|
11690
|
+
declare function BagReasonMeta(): BagReasonMeta;
|
|
11691
|
+
type BagReasonMeta = {
|
|
11692
|
+
/**
|
|
11693
|
+
* - Indicates whether a text area should
|
|
11694
|
+
* be displayed for additional input related to the bag reason.
|
|
11695
|
+
*/
|
|
11696
|
+
show_text_area?: boolean;
|
|
11697
|
+
};
|
|
11698
|
+
/** @returns {QuestionSet} */
|
|
11699
|
+
declare function QuestionSet(): QuestionSet;
|
|
11700
|
+
type QuestionSet = {
|
|
11701
|
+
/**
|
|
11702
|
+
* - A unique identifier for the question set.
|
|
11703
|
+
*/
|
|
11704
|
+
id?: number;
|
|
11705
|
+
/**
|
|
11706
|
+
* - The display name for the question set,
|
|
11707
|
+
* used for user-facing purposes.
|
|
11708
|
+
*/
|
|
11709
|
+
display_name?: string;
|
|
11710
|
+
};
|
|
11711
|
+
/** @returns {BagReasons} */
|
|
11712
|
+
declare function BagReasons(): BagReasons;
|
|
11713
|
+
type BagReasons = {
|
|
10365
11714
|
/**
|
|
10366
11715
|
* - List of QC (Quality Control) types -- having
|
|
10367
11716
|
* return reason types indicating the stage at which QC is performed. -
|
|
@@ -10537,6 +11886,94 @@ type UserDataInfo = {
|
|
|
10537
11886
|
*/
|
|
10538
11887
|
country_phone_code?: string;
|
|
10539
11888
|
};
|
|
11889
|
+
/** @returns {BundleReturnConfig} */
|
|
11890
|
+
declare function BundleReturnConfig(): BundleReturnConfig;
|
|
11891
|
+
type BundleReturnConfig = {
|
|
11892
|
+
/**
|
|
11893
|
+
* - Indicates whether partial
|
|
11894
|
+
* returns are allowed for bundle products.
|
|
11895
|
+
*/
|
|
11896
|
+
allow_partial_return?: boolean;
|
|
11897
|
+
/**
|
|
11898
|
+
* - Indicates whether the bundle product is returnable.
|
|
11899
|
+
*/
|
|
11900
|
+
returnable?: boolean;
|
|
11901
|
+
/**
|
|
11902
|
+
* - Time unit for the return window (e.g., "week",
|
|
11903
|
+
* "day", "hour").
|
|
11904
|
+
*/
|
|
11905
|
+
unit?: boolean;
|
|
11906
|
+
/**
|
|
11907
|
+
* - Duration value for the return window, expressed
|
|
11908
|
+
* in the specified unit.
|
|
11909
|
+
*/
|
|
11910
|
+
time?: boolean;
|
|
11911
|
+
};
|
|
11912
|
+
/** @returns {BundleDetails} */
|
|
11913
|
+
declare function BundleDetails(): BundleDetails;
|
|
11914
|
+
type BundleDetails = {
|
|
11915
|
+
/**
|
|
11916
|
+
* - Unique group identifier for the bundle.
|
|
11917
|
+
*/
|
|
11918
|
+
bundle_group_id?: string;
|
|
11919
|
+
/**
|
|
11920
|
+
* - Name of the bundle.
|
|
11921
|
+
*/
|
|
11922
|
+
name?: string;
|
|
11923
|
+
/**
|
|
11924
|
+
* - URL-friendly identifier for the bundle.
|
|
11925
|
+
*/
|
|
11926
|
+
slug?: string;
|
|
11927
|
+
/**
|
|
11928
|
+
* - Indicates bundle count of the bag.
|
|
11929
|
+
*/
|
|
11930
|
+
bundle_count?: number;
|
|
11931
|
+
/**
|
|
11932
|
+
* - Unique identifier for the article bundle.
|
|
11933
|
+
*/
|
|
11934
|
+
article_bundle_id?: string;
|
|
11935
|
+
/**
|
|
11936
|
+
* - Article net_quantity in bundle Product.
|
|
11937
|
+
*/
|
|
11938
|
+
bundle_article_quantity?: number;
|
|
11939
|
+
/**
|
|
11940
|
+
* - A flag that determines if bag is base bag of bundle.
|
|
11941
|
+
*/
|
|
11942
|
+
is_base?: boolean;
|
|
11943
|
+
/**
|
|
11944
|
+
* - Maximum Retail Price of the bundle.
|
|
11945
|
+
*/
|
|
11946
|
+
price_marked?: number;
|
|
11947
|
+
/**
|
|
11948
|
+
* - Current selling price of the bundle.
|
|
11949
|
+
*/
|
|
11950
|
+
price_effective?: number;
|
|
11951
|
+
/**
|
|
11952
|
+
* - Unique identifier for the item.
|
|
11953
|
+
*/
|
|
11954
|
+
item_id?: number;
|
|
11955
|
+
/**
|
|
11956
|
+
* - Type of the item (physical_bundle, virtual_bundle).
|
|
11957
|
+
*/
|
|
11958
|
+
item_type?: string;
|
|
11959
|
+
return_config?: BundleReturnConfig;
|
|
11960
|
+
/**
|
|
11961
|
+
* - Identifier for the seller of the bundle.
|
|
11962
|
+
*/
|
|
11963
|
+
seller_identifier?: string;
|
|
11964
|
+
/**
|
|
11965
|
+
* - An array of image URLs associated with the bundle.
|
|
11966
|
+
*/
|
|
11967
|
+
images?: string[];
|
|
11968
|
+
/**
|
|
11969
|
+
* - Identifier for the brand name.
|
|
11970
|
+
*/
|
|
11971
|
+
brand_name?: string;
|
|
11972
|
+
/**
|
|
11973
|
+
* - Size associated with the bundle item.
|
|
11974
|
+
*/
|
|
11975
|
+
size?: string;
|
|
11976
|
+
};
|
|
10540
11977
|
/** @returns {Address} */
|
|
10541
11978
|
declare function Address(): Address;
|
|
10542
11979
|
type Address = {
|
|
@@ -12264,8 +13701,8 @@ type ShipmentItem = {
|
|
|
12264
13701
|
*/
|
|
12265
13702
|
ordering_channnel?: string;
|
|
12266
13703
|
/**
|
|
12267
|
-
* -
|
|
12268
|
-
*
|
|
13704
|
+
* - Ordering source, to be used to
|
|
13705
|
+
* identify source of order creation.
|
|
12269
13706
|
*/
|
|
12270
13707
|
ordering_source?: string;
|
|
12271
13708
|
/**
|
|
@@ -12502,8 +13939,8 @@ type OrderDetailsData = {
|
|
|
12502
13939
|
*/
|
|
12503
13940
|
ordering_channel?: string;
|
|
12504
13941
|
/**
|
|
12505
|
-
* -
|
|
12506
|
-
*
|
|
13942
|
+
* - Ordering source, to be used to
|
|
13943
|
+
* identify source of order creation.
|
|
12507
13944
|
*/
|
|
12508
13945
|
ordering_source?: string;
|
|
12509
13946
|
loyalty_discount_details?: LoyaltyDiscountDetails;
|
|
@@ -13197,6 +14634,12 @@ type BagConfigs = {
|
|
|
13197
14634
|
* customer return is allowed for the bag.
|
|
13198
14635
|
*/
|
|
13199
14636
|
is_customer_return_allowed: boolean;
|
|
14637
|
+
/**
|
|
14638
|
+
* - Flag to indicate whether the bag is
|
|
14639
|
+
* part of a bundle.
|
|
14640
|
+
*/
|
|
14641
|
+
is_bundle_item?: boolean;
|
|
14642
|
+
bundle_details?: BundleDetails;
|
|
13200
14643
|
};
|
|
13201
14644
|
/** @returns {OrderBagArticle} */
|
|
13202
14645
|
declare function OrderBagArticle(): OrderBagArticle;
|
|
@@ -14132,22 +15575,6 @@ type PaymentInfoData = {
|
|
|
14132
15575
|
*/
|
|
14133
15576
|
merchant_transaction_id?: string;
|
|
14134
15577
|
};
|
|
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
15578
|
/** @returns {OrderData} */
|
|
14152
15579
|
declare function OrderData(): OrderData;
|
|
14153
15580
|
type OrderData = {
|
|
@@ -14158,8 +15585,8 @@ type OrderData = {
|
|
|
14158
15585
|
*/
|
|
14159
15586
|
ordering_channel?: string;
|
|
14160
15587
|
/**
|
|
14161
|
-
* -
|
|
14162
|
-
*
|
|
15588
|
+
* - Ordering source, to be used to
|
|
15589
|
+
* identify source of order creation.
|
|
14163
15590
|
*/
|
|
14164
15591
|
ordering_source?: string;
|
|
14165
15592
|
/**
|
|
@@ -15252,10 +16679,3 @@ type BulkFailedResponseSchema = {
|
|
|
15252
16679
|
status?: boolean;
|
|
15253
16680
|
error?: string;
|
|
15254
16681
|
};
|
|
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";
|