@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1
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/Cart/CartApplicationClient.d.ts +14 -14
- package/sdk/application/Cart/CartApplicationClient.js +14 -14
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationClient.js +53 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
- package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
- package/sdk/platform/Cart/CartPlatformModel.js +203 -31
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
- package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
- package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
- package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
- package/sdk/platform/Content/ContentPlatformModel.js +43 -13
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
- package/sdk/platform/Order/OrderPlatformClient.js +21 -21
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
- package/sdk/platform/Order/OrderPlatformModel.js +665 -70
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -23,10 +23,11 @@ const Joi = require("joi");
|
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
* @typedef ErrorResponse
|
|
26
|
-
* @property {number} [status]
|
|
27
|
-
* @property {boolean} [success]
|
|
28
|
-
*
|
|
29
|
-
* @property {string}
|
|
26
|
+
* @property {number} [status] - The HTTP status code corresponding to the error.
|
|
27
|
+
* @property {boolean} [success] - Indicates whether the operation was
|
|
28
|
+
* successful. Always false in the case of an error.
|
|
29
|
+
* @property {string} message - A message describing the error that occurred.
|
|
30
|
+
* @property {string} [error_trace] - Error trace of the error that occurred.
|
|
30
31
|
* @property {string} [error]
|
|
31
32
|
*/
|
|
32
33
|
|
|
@@ -339,9 +340,9 @@ const Joi = require("joi");
|
|
|
339
340
|
* product’s identifier, such as a SKU, barcode, or another distinct code.
|
|
340
341
|
* This ensures the product is correctly identified and distinguished from
|
|
341
342
|
* other items in the system.
|
|
342
|
-
* @property {number} [quantity] - The quantity of the product or item
|
|
343
|
-
*
|
|
344
|
-
*
|
|
343
|
+
* @property {number} [quantity] - The quantity of the product or item. This
|
|
344
|
+
* indicates how many units of the product are being referenced or processed,
|
|
345
|
+
* such as the number of items in a bag or shipment.
|
|
345
346
|
*/
|
|
346
347
|
|
|
347
348
|
/**
|
|
@@ -661,6 +662,36 @@ const Joi = require("joi");
|
|
|
661
662
|
* @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
|
|
662
663
|
*/
|
|
663
664
|
|
|
665
|
+
/**
|
|
666
|
+
* @typedef DPConfiguration
|
|
667
|
+
* @property {string} [shipping_by] - Shipping_by denotes dp assignment
|
|
668
|
+
* strategy- if shipping_by is fynd dp assignment would be handled by OMS
|
|
669
|
+
*/
|
|
670
|
+
|
|
671
|
+
/**
|
|
672
|
+
* @typedef PaymentConfig
|
|
673
|
+
* @property {string} [mode_of_payment] - Specifies the mode through which the
|
|
674
|
+
* payment was collected, serving as an identifier for the payment's origin.
|
|
675
|
+
* @property {string} [source] - The source field identifies the channel through
|
|
676
|
+
* which the order was placed, such as MARKETPLACE, ECOMM.
|
|
677
|
+
*/
|
|
678
|
+
|
|
679
|
+
/**
|
|
680
|
+
* @typedef CreateOrderConfig
|
|
681
|
+
* @property {DPConfiguration} [dp_configuration]
|
|
682
|
+
* @property {string} [integration_type] - Flag denotes integration type which
|
|
683
|
+
* is used to retrieve specific configurations and application details
|
|
684
|
+
* relevant to channel fulfillment.
|
|
685
|
+
* @property {boolean} [location_reassignment] - Flag denotes if the location
|
|
686
|
+
* for the store needs to be reassigned post cancellation.
|
|
687
|
+
* @property {PaymentConfig} [payment]
|
|
688
|
+
* @property {boolean} [optimal_shipment_creation] - Denotes the shipment
|
|
689
|
+
* breaking strategy. If the flag is set true, the shipment is created using
|
|
690
|
+
* optimal shipment creation strategy based on the servicability & packaging
|
|
691
|
+
* dimensions by OMS .If false, shipment details, including location_id, must
|
|
692
|
+
* be passed to FDK for processing.
|
|
693
|
+
*/
|
|
694
|
+
|
|
664
695
|
/**
|
|
665
696
|
* @typedef CreateOrderPayload
|
|
666
697
|
* @property {string} affiliate_id
|
|
@@ -897,6 +928,14 @@ const Joi = require("joi");
|
|
|
897
928
|
* @property {OrderDetails} order_details
|
|
898
929
|
* @property {string[]} [errors]
|
|
899
930
|
* @property {ShipmentDetail[]} [shipment_details]
|
|
931
|
+
* @property {string} [text] - A label or description of the delivery status,
|
|
932
|
+
* such as 'Expected Delivery Date'.
|
|
933
|
+
* @property {string} [value] - The detailed delivery status or time
|
|
934
|
+
* information, such as 'Arriving on 24 Nov 2022 15:54:00'.
|
|
935
|
+
* @property {string} [color_code] - Hex code for the color representing the
|
|
936
|
+
* delivery status.
|
|
937
|
+
* @property {string} [expected_delivery_date] - The ISO 8601 formatted date and
|
|
938
|
+
* time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
|
|
900
939
|
*/
|
|
901
940
|
|
|
902
941
|
/**
|
|
@@ -958,15 +997,78 @@ const Joi = require("joi");
|
|
|
958
997
|
* @property {string} type - The category or type of the charge.
|
|
959
998
|
*/
|
|
960
999
|
|
|
1000
|
+
/**
|
|
1001
|
+
* @typedef CurrencyValueSchema
|
|
1002
|
+
* @property {number} value - The numerical value of the charge.
|
|
1003
|
+
* @property {string} currency - The currency code (e.g., USD, INR).
|
|
1004
|
+
*/
|
|
1005
|
+
|
|
1006
|
+
/**
|
|
1007
|
+
* @typedef AmountSchema
|
|
1008
|
+
* @property {CurrencyValueSchema} ordering_currency
|
|
1009
|
+
* @property {CurrencyValueSchema} base_currency
|
|
1010
|
+
*/
|
|
1011
|
+
|
|
1012
|
+
/**
|
|
1013
|
+
* @typedef DynamicChargeTaxSchema
|
|
1014
|
+
* @property {string} reporting_hsn_code - HSN (Harmonized System of
|
|
1015
|
+
* Nomenclature) code for reporting purposes.
|
|
1016
|
+
*/
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* @typedef RuleConditionsSchema
|
|
1020
|
+
* @property {string} article_tag - The tag for the article.
|
|
1021
|
+
* @property {string[]} department - List of applicable departments.
|
|
1022
|
+
*/
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* @typedef RuleSchema
|
|
1026
|
+
* @property {RuleConditionsSchema} conditions
|
|
1027
|
+
*/
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* @typedef DistributionSchema
|
|
1031
|
+
* @property {string} type - Type of distribution (single or multi).
|
|
1032
|
+
* @property {string} logic - Logic for distribution (apportion, equally).
|
|
1033
|
+
* @property {RuleSchema} [rule]
|
|
1034
|
+
*/
|
|
1035
|
+
|
|
1036
|
+
/**
|
|
1037
|
+
* @typedef DistributionLogicSchema
|
|
1038
|
+
* @property {string} distribution_level - The level at which the charge is
|
|
1039
|
+
* distributed (order, article, shipment).
|
|
1040
|
+
* @property {DistributionSchema} distribution
|
|
1041
|
+
*/
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* @typedef DynamicChargeSchema
|
|
1045
|
+
* @property {string} name - The name of the charge.
|
|
1046
|
+
* @property {string} type - The category or type of the charge.
|
|
1047
|
+
* @property {string} [code] - An optional code associated with the charge for
|
|
1048
|
+
* internal tracking.
|
|
1049
|
+
* @property {AmountSchema} amount
|
|
1050
|
+
* @property {DynamicChargeTaxSchema} [taxes]
|
|
1051
|
+
* @property {Object} [meta] - Meta data of the custom charge.
|
|
1052
|
+
* @property {DistributionLogicSchema} [distribution_logic]
|
|
1053
|
+
*/
|
|
1054
|
+
|
|
961
1055
|
/**
|
|
962
1056
|
* @typedef LineItem
|
|
963
|
-
* @property {Charge[]} charges
|
|
1057
|
+
* @property {Charge[]} charges - These are the mandatory charges required
|
|
1058
|
+
* during order creation and are integral to the order processing flow. They
|
|
1059
|
+
* include fields like amount_paid, discount, and price_marked. The schema for
|
|
1060
|
+
* these charges is predefined and remains consistent, ensuring seamless
|
|
1061
|
+
* forward mapping in the code.
|
|
964
1062
|
* @property {Object} [meta] - Meta data of the articles or line items.
|
|
965
1063
|
* @property {string} [custom_message] - Meta data of the articles or line items.
|
|
966
1064
|
* @property {number} [quantity] - Quantity of the articles or line items.
|
|
967
1065
|
* @property {string} seller_identifier - Seller identifier of the articles or line items.
|
|
968
1066
|
* @property {string} [external_line_id] - External unique identifier of the
|
|
969
1067
|
* articles or line items.
|
|
1068
|
+
* @property {DynamicChargeSchema[]} [dynamic_charges] - (Optional) These are
|
|
1069
|
+
* additional charges specified by the client based on specific use cases.
|
|
1070
|
+
* They allow for flexibility in adding new fields such as installation_fee,
|
|
1071
|
+
* service_charge, or other dynamic costs.
|
|
970
1072
|
*/
|
|
971
1073
|
|
|
972
1074
|
/**
|
|
@@ -988,8 +1090,12 @@ const Joi = require("joi");
|
|
|
988
1090
|
* @property {ProcessingDates} [processing_dates]
|
|
989
1091
|
* @property {Object} [meta] - Meta data of the shipment.
|
|
990
1092
|
* @property {number} [priority] - Integer value indicating high and low priority.
|
|
991
|
-
* @property {number} location_id - Location Identifier or Store/Fulfillment
|
|
992
|
-
* Identifier of the shipment
|
|
1093
|
+
* @property {number} [location_id] - Location Identifier or Store/Fulfillment
|
|
1094
|
+
* Identifier of the shipment- This field is mandatory when
|
|
1095
|
+
* optimal_shipment_creation flag is set to false, indicating that shipments
|
|
1096
|
+
* must be associated with a specific location. When
|
|
1097
|
+
* `optimal_shipment_creation` is true, the optimal location for order
|
|
1098
|
+
* creation would be assigned, location_id becomes optional.
|
|
993
1099
|
* @property {string} [order_type] - The order type of shipment HomeDelivery -
|
|
994
1100
|
* If the customer wants the order home-delivered PickAtStore - If the
|
|
995
1101
|
* customer wants the handover of an order at the store itself.
|
|
@@ -1022,17 +1128,6 @@ const Joi = require("joi");
|
|
|
1022
1128
|
* @property {ShipmentGstDetails} [gst]
|
|
1023
1129
|
*/
|
|
1024
1130
|
|
|
1025
|
-
/**
|
|
1026
|
-
* @typedef ShipmentRequestData
|
|
1027
|
-
* @property {LineItem[]} line_items
|
|
1028
|
-
* @property {ProcessingDates} [processing_dates]
|
|
1029
|
-
* @property {Object} [meta] - Meta data of the shipment.
|
|
1030
|
-
* @property {number} [priority] - Integer value indicating high and low priority.
|
|
1031
|
-
* @property {string} [order_type] - The order type of shipment HomeDelivery -
|
|
1032
|
-
* If the customer wants the order home-delivered PickAtStore - If the
|
|
1033
|
-
* customer wants the handover of an order at the store itself.
|
|
1034
|
-
*/
|
|
1035
|
-
|
|
1036
1131
|
/**
|
|
1037
1132
|
* @typedef ShippingInfo
|
|
1038
1133
|
* @property {string} [alternate_mobile_number]
|
|
@@ -1175,36 +1270,32 @@ const Joi = require("joi");
|
|
|
1175
1270
|
* @property {string} [logo]
|
|
1176
1271
|
*/
|
|
1177
1272
|
|
|
1178
|
-
/**
|
|
1179
|
-
* @typedef Config
|
|
1180
|
-
* @property {string[]} [lock_states]
|
|
1181
|
-
* @property {ConfigPayment} payment
|
|
1182
|
-
* @property {ConfigDpConfiguration} [dp_configuration]
|
|
1183
|
-
* @property {boolean} [location_reassignment]
|
|
1184
|
-
* @property {ConfigApplication} [application]
|
|
1185
|
-
* @property {string} [ordering_channel_logo]
|
|
1186
|
-
* @property {string} [integration_type]
|
|
1187
|
-
*/
|
|
1188
|
-
|
|
1189
1273
|
/**
|
|
1190
1274
|
* @typedef CreateOrderAPI
|
|
1191
1275
|
* @property {Shipment[]} shipments
|
|
1192
|
-
* @property {ShipmentRequestData} [shipment_request_data]
|
|
1193
1276
|
* @property {Object} shipping_info
|
|
1194
1277
|
* @property {Object} billing_info
|
|
1195
1278
|
* @property {CurrencyInfo} [currency_info]
|
|
1196
1279
|
* @property {string} [external_order_id]
|
|
1197
1280
|
* @property {string} [external_shipment_id]
|
|
1198
1281
|
* @property {string} [order_type]
|
|
1199
|
-
* @property {Charge[]} [charges]
|
|
1282
|
+
* @property {Charge[]} [charges] - These are the mandatory charges required
|
|
1283
|
+
* during order creation and are integral to the order processing flow. They
|
|
1284
|
+
* include fields like amount_paid, discount, and price_marked, etc.. The
|
|
1285
|
+
* schema for these charges is predefined and remains consistent, ensuring
|
|
1286
|
+
* seamless forward mapping in the code.
|
|
1200
1287
|
* @property {string} [external_creation_date]
|
|
1201
1288
|
* @property {Object} [meta]
|
|
1202
1289
|
* @property {TaxInfo} [tax_info]
|
|
1203
|
-
* @property {
|
|
1290
|
+
* @property {CreateOrderConfig} [config]
|
|
1204
1291
|
* @property {PaymentInfo} payment_info
|
|
1205
1292
|
* @property {UserInfo} [user_info]
|
|
1206
1293
|
* @property {boolean} [unlock_before_transition]
|
|
1207
1294
|
* @property {boolean} [lock_after_transition]
|
|
1295
|
+
* @property {DynamicChargeSchema[]} [dynamic_charges] - (Optional) These are
|
|
1296
|
+
* additional charges specified by the client based on specific use cases.
|
|
1297
|
+
* They allow for flexibility in adding new fields such as installation_fee,
|
|
1298
|
+
* service_charge, or other dynamic costs.
|
|
1208
1299
|
*/
|
|
1209
1300
|
|
|
1210
1301
|
/**
|
|
@@ -1681,19 +1772,19 @@ const Joi = require("joi");
|
|
|
1681
1772
|
* @typedef DateRange
|
|
1682
1773
|
* @property {string} [from_date]
|
|
1683
1774
|
* @property {string} [to_date]
|
|
1775
|
+
* @property {string} [end_date]
|
|
1776
|
+
* @property {string} [start_date]
|
|
1684
1777
|
*/
|
|
1685
1778
|
|
|
1686
1779
|
/**
|
|
1687
1780
|
* @typedef Filters
|
|
1688
1781
|
* @property {DateRange} [date_range]
|
|
1689
|
-
* @property {string} [logo]
|
|
1690
|
-
* @property {string} [from_date]
|
|
1691
1782
|
* @property {number} [stores]
|
|
1692
|
-
* @property {string} [to_date]
|
|
1693
1783
|
* @property {string} [dp_name]
|
|
1694
|
-
* @property {
|
|
1784
|
+
* @property {string} [dp_ids]
|
|
1695
1785
|
* @property {string} [lane]
|
|
1696
1786
|
* @property {string} [selected_shipments]
|
|
1787
|
+
* @property {string} [deselected_shipments]
|
|
1697
1788
|
* @property {string} [store_name]
|
|
1698
1789
|
* @property {string} [type]
|
|
1699
1790
|
*/
|
|
@@ -2222,6 +2313,254 @@ const Joi = require("joi");
|
|
|
2222
2313
|
* @property {number} [page_size]
|
|
2223
2314
|
*/
|
|
2224
2315
|
|
|
2316
|
+
/**
|
|
2317
|
+
* @typedef ConfigData
|
|
2318
|
+
* @property {boolean} [acknowledged] - Indicates whether the update operation
|
|
2319
|
+
* was acknowledged by the database.
|
|
2320
|
+
* @property {boolean} [is_upserted] - Indicates whether the update operation
|
|
2321
|
+
* resulted in an upsert (an update or insert).
|
|
2322
|
+
* @property {boolean} [is_inserted] - Indicates whether the update operation
|
|
2323
|
+
* resulted in a new document being inserted.
|
|
2324
|
+
*/
|
|
2325
|
+
|
|
2326
|
+
/**
|
|
2327
|
+
* @typedef ConfigUpdatedResponse
|
|
2328
|
+
* @property {ConfigData[]} data - The result of the config update operation,
|
|
2329
|
+
* including whether it was acknowledged, upserted, or inserted.
|
|
2330
|
+
* @property {boolean} success - Indicates whether the config update operation
|
|
2331
|
+
* was successful.
|
|
2332
|
+
*/
|
|
2333
|
+
|
|
2334
|
+
/**
|
|
2335
|
+
* @typedef FlagData
|
|
2336
|
+
* @property {Object} [value]
|
|
2337
|
+
* @property {Object} [filter]
|
|
2338
|
+
*/
|
|
2339
|
+
|
|
2340
|
+
/**
|
|
2341
|
+
* @typedef Flags
|
|
2342
|
+
* @property {FlagData[]} [allow_partial_transition] - Indicates whether a
|
|
2343
|
+
* partial transition of bags to the next state is permissible, allowing some
|
|
2344
|
+
* bags to progress while others remain in the current state.
|
|
2345
|
+
* @property {FlagData[]} [can_break_entity] - Specifies whether bags within a
|
|
2346
|
+
* shipment, set,cdf or entity can be broken individually or as a group. If
|
|
2347
|
+
* set to false, all bags within the entity must remain together and
|
|
2348
|
+
* transition together to the same state.
|
|
2349
|
+
* @property {FlagData[]} [allowed_bag_updates] - Specifies which fields are
|
|
2350
|
+
* permitted to be updated at the bag level. Allowed fields are:
|
|
2351
|
+
*
|
|
2352
|
+
* - Meta
|
|
2353
|
+
* - Pdf_links
|
|
2354
|
+
* - Affiliate_meta
|
|
2355
|
+
* - Delivery_awb_number
|
|
2356
|
+
* - Store_invoice_id
|
|
2357
|
+
* - Store_id
|
|
2358
|
+
* - Return_store_id
|
|
2359
|
+
* - Eway_bill_id
|
|
2360
|
+
*
|
|
2361
|
+
* @property {FlagData[]} [allowed_bag_status_updates] - Specifies which fields
|
|
2362
|
+
* are permitted to be updated at the bag status level. Allowed fields are:
|
|
2363
|
+
*
|
|
2364
|
+
* - Json
|
|
2365
|
+
*
|
|
2366
|
+
* @property {FlagData[]} [allowed_entity_updates] - Specifies which fields are
|
|
2367
|
+
* permitted to be updated at shipment level. Allowed fields are:
|
|
2368
|
+
*
|
|
2369
|
+
* - Meta
|
|
2370
|
+
* - Pdf_links
|
|
2371
|
+
* - Affiliate_meta
|
|
2372
|
+
* - Delivery_awb_number
|
|
2373
|
+
* - Store_invoice_id
|
|
2374
|
+
* - Store_id
|
|
2375
|
+
* - Return_store_id
|
|
2376
|
+
* - Eway_bill_id
|
|
2377
|
+
* - Logistics_meta
|
|
2378
|
+
*
|
|
2379
|
+
* @property {FlagData[]} [allowed_entity_status_updates] - Specifies which
|
|
2380
|
+
* fields are permitted to be updated at the Entity status level. Allowed fields are:
|
|
2381
|
+
*
|
|
2382
|
+
* - Json
|
|
2383
|
+
*
|
|
2384
|
+
* @property {FlagData[]} [status_update_type] - Describes the type of journey
|
|
2385
|
+
* associated with the particular status of the shipment. Possible values are:
|
|
2386
|
+
*
|
|
2387
|
+
* - Positive
|
|
2388
|
+
* - Negative
|
|
2389
|
+
*
|
|
2390
|
+
* @property {FlagData[]} [is_bag_status_reason_allowed] - Indicates whether a
|
|
2391
|
+
* reason at the product level should be allowed for a particular status.
|
|
2392
|
+
* @property {FlagData[]} [is_entity_status_reason_allowed] - Indicates whether
|
|
2393
|
+
* a reason at the shipment level should be allowed for a particular status.
|
|
2394
|
+
* @property {FlagData[]} [transition_strategy] - This flag is used to define
|
|
2395
|
+
* the shipment breaking strategy. Possible values are:
|
|
2396
|
+
*
|
|
2397
|
+
* - Break_shipment_based_on_location_reassignment
|
|
2398
|
+
* - Break_shipment_based_on_groups
|
|
2399
|
+
* - Break_shipment_based_on_stormbreaker
|
|
2400
|
+
*/
|
|
2401
|
+
|
|
2402
|
+
/**
|
|
2403
|
+
* @typedef Filter
|
|
2404
|
+
* @property {string} [order_type] - Indicates the type or category of the order.
|
|
2405
|
+
*
|
|
2406
|
+
* - PickAtStore: Pick from store
|
|
2407
|
+
* - HomeDelivery: Home delivery
|
|
2408
|
+
* - Digital: Digital
|
|
2409
|
+
*
|
|
2410
|
+
* @property {boolean} [is_partial_transition] - Specifies whether a partial
|
|
2411
|
+
* transition of the order is allowed, allowing some components to progress
|
|
2412
|
+
* while others remain in the current state.
|
|
2413
|
+
* @property {boolean} [auto_trigger_dp_assignment_acf] - Indicates whether the
|
|
2414
|
+
* assignment of a designated person is automatically triggered in the context of ACF.
|
|
2415
|
+
* @property {string} [lock_status] - Indicates the current locking status of
|
|
2416
|
+
* the shipment.
|
|
2417
|
+
*
|
|
2418
|
+
* - `complete`: Complete shipment lock
|
|
2419
|
+
* - `operational`: Operational shipment lock
|
|
2420
|
+
* - `None`: No lock on shipment
|
|
2421
|
+
*
|
|
2422
|
+
* @property {boolean} [lock_after_transition] - Specifies whether locking is
|
|
2423
|
+
* required after transitioning to the next status. lock_after_transition :
|
|
2424
|
+
* true - Lock Transition enabled lock_after_transition : false - Lock
|
|
2425
|
+
* Transition set false
|
|
2426
|
+
* @property {boolean} [resume_tasks_after_unlock] - Indicates whether tasks
|
|
2427
|
+
* should resume automatically after unlocking, such as DP assignment task and
|
|
2428
|
+
* invoicing task.
|
|
2429
|
+
* @property {boolean} [is_invoice_id_present] - Indicates whether an invoice ID
|
|
2430
|
+
* is present for the order.
|
|
2431
|
+
* @property {boolean} [is_credit_note_generated] - Indicates whether a credit
|
|
2432
|
+
* note has been generated for the order.
|
|
2433
|
+
* @property {boolean} [fulfill_virtual_invoice] - Specifies whether an
|
|
2434
|
+
* automated virtual invoice ID is associated with the order.
|
|
2435
|
+
* @property {string} [next_status] - Indicates the next status to which the
|
|
2436
|
+
* order will transition.
|
|
2437
|
+
* @property {boolean} [is_hook_enabled] - Indicates whether a task is enabled
|
|
2438
|
+
* for the order.
|
|
2439
|
+
* @property {boolean} [pos_credit_note_check] - Specifies whether a credit note
|
|
2440
|
+
* check is performed in a point of sale (POS) scenario.
|
|
2441
|
+
* @property {string} [order_platform] - Specifies the platform on which the
|
|
2442
|
+
* order was placed.
|
|
2443
|
+
*
|
|
2444
|
+
* - `platform-pos`: POS
|
|
2445
|
+
* - `platform-site`: WEB
|
|
2446
|
+
* - `openapi`: OPENAPI
|
|
2447
|
+
* - `marketplace`: MARKETPLACE
|
|
2448
|
+
*
|
|
2449
|
+
* @property {string} [refund_type] - Indicates the type of refund associated
|
|
2450
|
+
* with the order.
|
|
2451
|
+
*
|
|
2452
|
+
* - `credit_note`: CREDIT_NOTE
|
|
2453
|
+
* - `source`: SOURCE
|
|
2454
|
+
* - `bank_transfer`: BANK
|
|
2455
|
+
* - `manual_refund`: MANUAL_REFUND
|
|
2456
|
+
*
|
|
2457
|
+
* @property {boolean} [is_non_pos_platform] - Specifies whether the platform is
|
|
2458
|
+
* non-point of sale (POS) in nature.
|
|
2459
|
+
* @property {boolean} [is_self_ship] - Indicates whether the order is
|
|
2460
|
+
* self-shipped by the seller.
|
|
2461
|
+
* @property {string} [seller_country_code] - Specifies the country code of the seller.
|
|
2462
|
+
*
|
|
2463
|
+
* - `seller_country_code`: US
|
|
2464
|
+
* - `seller_country_code`: UK
|
|
2465
|
+
* - `seller_country_code`: IN
|
|
2466
|
+
*
|
|
2467
|
+
* @property {string} [customer_country_code] - Specifies the country code of the seller.
|
|
2468
|
+
*
|
|
2469
|
+
* - `customer_country_code`: US
|
|
2470
|
+
* - `customer_country_code`: UK
|
|
2471
|
+
* - `customer_country_code`: IN
|
|
2472
|
+
*
|
|
2473
|
+
* @property {boolean} [is_test_order] - Indicates whether the order is a test
|
|
2474
|
+
* order used for testing purposes - `is_test_order` : True - indicates test order
|
|
2475
|
+
* @property {string[]} [task_trigger_condition] - Specifies trigger conditions:
|
|
2476
|
+
*
|
|
2477
|
+
* - `status_update`: Status Update
|
|
2478
|
+
* - `data_update`: Data Update
|
|
2479
|
+
*/
|
|
2480
|
+
|
|
2481
|
+
/**
|
|
2482
|
+
* @typedef PostHook
|
|
2483
|
+
* @property {string} task - Name of the hook that has to be added
|
|
2484
|
+
* @property {Object} [kwargs] - Additional parameters for the hook
|
|
2485
|
+
* @property {Filter} [filters] - Filters for scope selection.
|
|
2486
|
+
*/
|
|
2487
|
+
|
|
2488
|
+
/**
|
|
2489
|
+
* @typedef PreHook
|
|
2490
|
+
* @property {string} task - Name of the hook that has to be added
|
|
2491
|
+
* @property {Object} [kwargs] - Additional parameters for the hook
|
|
2492
|
+
* @property {Filter} [filters] - Filter
|
|
2493
|
+
*/
|
|
2494
|
+
|
|
2495
|
+
/**
|
|
2496
|
+
* @typedef Config
|
|
2497
|
+
* @property {string} [from_state] - Source state from which state transition
|
|
2498
|
+
* will take place
|
|
2499
|
+
* @property {string} [to_state] - Target state to which state transition will take place
|
|
2500
|
+
* @property {PreHook[]} [pre_hooks] - Tasks to be run before state transition
|
|
2501
|
+
* @property {PostHook[]} [post_hooks] - Tasks to be run after state transition
|
|
2502
|
+
* @property {Flags} [flags] - Various flags related to the transition. These
|
|
2503
|
+
* include options and settings that influence the behavior of the state
|
|
2504
|
+
* transition, such as whether partial transitions are allowed or whether the
|
|
2505
|
+
* transition can break the entity.
|
|
2506
|
+
*/
|
|
2507
|
+
|
|
2508
|
+
/**
|
|
2509
|
+
* @typedef TransitionConfigCondition
|
|
2510
|
+
* @property {string} app_id - The unique identifier of the application to which
|
|
2511
|
+
* the configuration applies.
|
|
2512
|
+
* @property {string} ordering_channel - The channel through which the order was
|
|
2513
|
+
* placed, such as ECOMM or another specified channel.
|
|
2514
|
+
* @property {string} entity - The type of entity that the configuration pertains to.
|
|
2515
|
+
*/
|
|
2516
|
+
|
|
2517
|
+
/**
|
|
2518
|
+
* @typedef TransitionConfigData
|
|
2519
|
+
* @property {TransitionConfigCondition} [conditions] - Conditions that must be
|
|
2520
|
+
* met for the ESM config to be applied.
|
|
2521
|
+
* @property {Config[]} [configs] - The configuration settings for the entity
|
|
2522
|
+
* transition. This includes pre_hooks, post_hooks, and flags for each
|
|
2523
|
+
* transition state.
|
|
2524
|
+
*/
|
|
2525
|
+
|
|
2526
|
+
/**
|
|
2527
|
+
* @typedef TransitionConfigPayload
|
|
2528
|
+
* @property {TransitionConfigData} [data]
|
|
2529
|
+
*/
|
|
2530
|
+
|
|
2531
|
+
/**
|
|
2532
|
+
* @typedef ProcessManifestRequest
|
|
2533
|
+
* @property {string} [action] - Expected Actions: [save, process,
|
|
2534
|
+
* pdf_generated,invalidate,pdf_failed,complete]
|
|
2535
|
+
* @property {Filters} [filters]
|
|
2536
|
+
* @property {string} [unique_id] - Unique Id.
|
|
2537
|
+
*/
|
|
2538
|
+
|
|
2539
|
+
/**
|
|
2540
|
+
* @typedef ManifestResponse
|
|
2541
|
+
* @property {ManifestItems} [items]
|
|
2542
|
+
*/
|
|
2543
|
+
|
|
2544
|
+
/**
|
|
2545
|
+
* @typedef ManifestItems
|
|
2546
|
+
* @property {Filters} [filters]
|
|
2547
|
+
* @property {string} [manifest_id] - Id of the manifest.
|
|
2548
|
+
* @property {string} [unique_id] - Unique Id.
|
|
2549
|
+
* @property {number} [company_id] - Id of the company.
|
|
2550
|
+
* @property {string} [dp_id] - Shipment with the specific courier partner Id.
|
|
2551
|
+
* @property {string} [courier_partner_slug] - Courier partner slug
|
|
2552
|
+
* @property {string} [action] - Expected Actions: [Save, Process, Pdf
|
|
2553
|
+
* Generated, Invalidate, Pdf Failed, Complete]
|
|
2554
|
+
* @property {string} [created_by] - Created date of the manifest.
|
|
2555
|
+
* @property {string} [user_id] - Id of user.
|
|
2556
|
+
*/
|
|
2557
|
+
|
|
2558
|
+
/**
|
|
2559
|
+
* @typedef ManifestErrorResponse
|
|
2560
|
+
* @property {boolean} [success] - Success State.
|
|
2561
|
+
* @property {string} [error] - Error String.
|
|
2562
|
+
*/
|
|
2563
|
+
|
|
2225
2564
|
/**
|
|
2226
2565
|
* @typedef Page
|
|
2227
2566
|
* @property {number} [item_total] - The total number of items on the page.
|
|
@@ -2924,6 +3263,7 @@ const Joi = require("joi");
|
|
|
2924
3263
|
* @property {string} [contact_person] - Name of the contact person
|
|
2925
3264
|
* @property {string} [state] - State where the store is located.
|
|
2926
3265
|
* @property {string} [city] - City where the store is located.
|
|
3266
|
+
* @property {string} [store_email] - Email address of store
|
|
2927
3267
|
*/
|
|
2928
3268
|
|
|
2929
3269
|
/**
|
|
@@ -3276,6 +3616,7 @@ const Joi = require("joi");
|
|
|
3276
3616
|
* @property {string} contact_person
|
|
3277
3617
|
* @property {string} state
|
|
3278
3618
|
* @property {string} city
|
|
3619
|
+
* @property {string} [store_email] - Email of the recipient associated with the store
|
|
3279
3620
|
*/
|
|
3280
3621
|
|
|
3281
3622
|
/**
|
|
@@ -3321,6 +3662,7 @@ const Joi = require("joi");
|
|
|
3321
3662
|
* transaction, this is essential for referencing individual payments.
|
|
3322
3663
|
* @property {string} [display_name] - The name of the payment method as it
|
|
3323
3664
|
* should be displayed to the user.
|
|
3665
|
+
* @property {Object} [transaction_data] - All necessary data for transaction received
|
|
3324
3666
|
*/
|
|
3325
3667
|
|
|
3326
3668
|
/**
|
|
@@ -3333,6 +3675,7 @@ const Joi = require("joi");
|
|
|
3333
3675
|
* @property {string} [shipment_status] - Status of the shipment indicating its
|
|
3334
3676
|
* current stage
|
|
3335
3677
|
* @property {GSTDetailsData} [gst_details]
|
|
3678
|
+
* @property {OrderStatusData} [order_status]
|
|
3336
3679
|
* @property {Object} [delivery_slot] - Delivery slot details
|
|
3337
3680
|
* @property {OrderDetailsData} [order]
|
|
3338
3681
|
* @property {UserDataInfo} [user]
|
|
@@ -4890,6 +5233,32 @@ class OrderPlatformModel {
|
|
|
4890
5233
|
});
|
|
4891
5234
|
}
|
|
4892
5235
|
|
|
5236
|
+
/** @returns {DPConfiguration} */
|
|
5237
|
+
static DPConfiguration() {
|
|
5238
|
+
return Joi.object({
|
|
5239
|
+
shipping_by: Joi.string().allow(""),
|
|
5240
|
+
});
|
|
5241
|
+
}
|
|
5242
|
+
|
|
5243
|
+
/** @returns {PaymentConfig} */
|
|
5244
|
+
static PaymentConfig() {
|
|
5245
|
+
return Joi.object({
|
|
5246
|
+
mode_of_payment: Joi.string().allow(""),
|
|
5247
|
+
source: Joi.string().allow(""),
|
|
5248
|
+
});
|
|
5249
|
+
}
|
|
5250
|
+
|
|
5251
|
+
/** @returns {CreateOrderConfig} */
|
|
5252
|
+
static CreateOrderConfig() {
|
|
5253
|
+
return Joi.object({
|
|
5254
|
+
dp_configuration: OrderPlatformModel.DPConfiguration(),
|
|
5255
|
+
integration_type: Joi.string().allow(""),
|
|
5256
|
+
location_reassignment: Joi.boolean(),
|
|
5257
|
+
payment: OrderPlatformModel.PaymentConfig(),
|
|
5258
|
+
optimal_shipment_creation: Joi.boolean(),
|
|
5259
|
+
});
|
|
5260
|
+
}
|
|
5261
|
+
|
|
4893
5262
|
/** @returns {CreateOrderPayload} */
|
|
4894
5263
|
static CreateOrderPayload() {
|
|
4895
5264
|
return Joi.object({
|
|
@@ -5152,6 +5521,10 @@ class OrderPlatformModel {
|
|
|
5152
5521
|
order_details: OrderPlatformModel.OrderDetails().required(),
|
|
5153
5522
|
errors: Joi.array().items(Joi.string().allow("")),
|
|
5154
5523
|
shipment_details: Joi.array().items(OrderPlatformModel.ShipmentDetail()),
|
|
5524
|
+
text: Joi.string().allow(""),
|
|
5525
|
+
value: Joi.string().allow(""),
|
|
5526
|
+
color_code: Joi.string().allow(""),
|
|
5527
|
+
expected_delivery_date: Joi.string().allow(""),
|
|
5155
5528
|
});
|
|
5156
5529
|
}
|
|
5157
5530
|
|
|
@@ -5228,6 +5601,74 @@ class OrderPlatformModel {
|
|
|
5228
5601
|
});
|
|
5229
5602
|
}
|
|
5230
5603
|
|
|
5604
|
+
/** @returns {CurrencyValueSchema} */
|
|
5605
|
+
static CurrencyValueSchema() {
|
|
5606
|
+
return Joi.object({
|
|
5607
|
+
value: Joi.number().required(),
|
|
5608
|
+
currency: Joi.string().allow("").required(),
|
|
5609
|
+
});
|
|
5610
|
+
}
|
|
5611
|
+
|
|
5612
|
+
/** @returns {AmountSchema} */
|
|
5613
|
+
static AmountSchema() {
|
|
5614
|
+
return Joi.object({
|
|
5615
|
+
ordering_currency: OrderPlatformModel.CurrencyValueSchema().required(),
|
|
5616
|
+
base_currency: OrderPlatformModel.CurrencyValueSchema().required(),
|
|
5617
|
+
});
|
|
5618
|
+
}
|
|
5619
|
+
|
|
5620
|
+
/** @returns {DynamicChargeTaxSchema} */
|
|
5621
|
+
static DynamicChargeTaxSchema() {
|
|
5622
|
+
return Joi.object({
|
|
5623
|
+
reporting_hsn_code: Joi.string().allow("").required(),
|
|
5624
|
+
});
|
|
5625
|
+
}
|
|
5626
|
+
|
|
5627
|
+
/** @returns {RuleConditionsSchema} */
|
|
5628
|
+
static RuleConditionsSchema() {
|
|
5629
|
+
return Joi.object({
|
|
5630
|
+
article_tag: Joi.string().allow("").required(),
|
|
5631
|
+
department: Joi.array().items(Joi.string().allow("")).required(),
|
|
5632
|
+
});
|
|
5633
|
+
}
|
|
5634
|
+
|
|
5635
|
+
/** @returns {RuleSchema} */
|
|
5636
|
+
static RuleSchema() {
|
|
5637
|
+
return Joi.object({
|
|
5638
|
+
conditions: OrderPlatformModel.RuleConditionsSchema().required(),
|
|
5639
|
+
});
|
|
5640
|
+
}
|
|
5641
|
+
|
|
5642
|
+
/** @returns {DistributionSchema} */
|
|
5643
|
+
static DistributionSchema() {
|
|
5644
|
+
return Joi.object({
|
|
5645
|
+
type: Joi.string().allow("").required(),
|
|
5646
|
+
logic: Joi.string().allow("").required(),
|
|
5647
|
+
rule: OrderPlatformModel.RuleSchema(),
|
|
5648
|
+
});
|
|
5649
|
+
}
|
|
5650
|
+
|
|
5651
|
+
/** @returns {DistributionLogicSchema} */
|
|
5652
|
+
static DistributionLogicSchema() {
|
|
5653
|
+
return Joi.object({
|
|
5654
|
+
distribution_level: Joi.string().allow("").required(),
|
|
5655
|
+
distribution: OrderPlatformModel.DistributionSchema().required(),
|
|
5656
|
+
});
|
|
5657
|
+
}
|
|
5658
|
+
|
|
5659
|
+
/** @returns {DynamicChargeSchema} */
|
|
5660
|
+
static DynamicChargeSchema() {
|
|
5661
|
+
return Joi.object({
|
|
5662
|
+
name: Joi.string().allow("").required(),
|
|
5663
|
+
type: Joi.string().allow("").required(),
|
|
5664
|
+
code: Joi.string().allow(""),
|
|
5665
|
+
amount: OrderPlatformModel.AmountSchema().required(),
|
|
5666
|
+
taxes: OrderPlatformModel.DynamicChargeTaxSchema(),
|
|
5667
|
+
meta: Joi.any(),
|
|
5668
|
+
distribution_logic: OrderPlatformModel.DistributionLogicSchema(),
|
|
5669
|
+
});
|
|
5670
|
+
}
|
|
5671
|
+
|
|
5231
5672
|
/** @returns {LineItem} */
|
|
5232
5673
|
static LineItem() {
|
|
5233
5674
|
return Joi.object({
|
|
@@ -5237,6 +5678,9 @@ class OrderPlatformModel {
|
|
|
5237
5678
|
quantity: Joi.number(),
|
|
5238
5679
|
seller_identifier: Joi.string().allow("").required(),
|
|
5239
5680
|
external_line_id: Joi.string().allow(""),
|
|
5681
|
+
dynamic_charges: Joi.array().items(
|
|
5682
|
+
OrderPlatformModel.DynamicChargeSchema()
|
|
5683
|
+
),
|
|
5240
5684
|
});
|
|
5241
5685
|
}
|
|
5242
5686
|
|
|
@@ -5261,7 +5705,7 @@ class OrderPlatformModel {
|
|
|
5261
5705
|
processing_dates: OrderPlatformModel.ProcessingDates(),
|
|
5262
5706
|
meta: Joi.any().allow(null),
|
|
5263
5707
|
priority: Joi.number(),
|
|
5264
|
-
location_id: Joi.number()
|
|
5708
|
+
location_id: Joi.number(),
|
|
5265
5709
|
order_type: Joi.string().allow(""),
|
|
5266
5710
|
parent_type: Joi.string().allow("").allow(null),
|
|
5267
5711
|
store_invoice_id: Joi.string().allow("").allow(null),
|
|
@@ -5293,17 +5737,6 @@ class OrderPlatformModel {
|
|
|
5293
5737
|
});
|
|
5294
5738
|
}
|
|
5295
5739
|
|
|
5296
|
-
/** @returns {ShipmentRequestData} */
|
|
5297
|
-
static ShipmentRequestData() {
|
|
5298
|
-
return Joi.object({
|
|
5299
|
-
line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
|
|
5300
|
-
processing_dates: OrderPlatformModel.ProcessingDates(),
|
|
5301
|
-
meta: Joi.any(),
|
|
5302
|
-
priority: Joi.number(),
|
|
5303
|
-
order_type: Joi.string().allow(""),
|
|
5304
|
-
});
|
|
5305
|
-
}
|
|
5306
|
-
|
|
5307
5740
|
/** @returns {ShippingInfo} */
|
|
5308
5741
|
static ShippingInfo() {
|
|
5309
5742
|
return Joi.object({
|
|
@@ -5470,24 +5903,10 @@ class OrderPlatformModel {
|
|
|
5470
5903
|
});
|
|
5471
5904
|
}
|
|
5472
5905
|
|
|
5473
|
-
/** @returns {Config} */
|
|
5474
|
-
static Config() {
|
|
5475
|
-
return Joi.object({
|
|
5476
|
-
lock_states: Joi.array().items(Joi.string().allow("")),
|
|
5477
|
-
payment: OrderPlatformModel.ConfigPayment().required(),
|
|
5478
|
-
dp_configuration: OrderPlatformModel.ConfigDpConfiguration(),
|
|
5479
|
-
location_reassignment: Joi.boolean(),
|
|
5480
|
-
application: OrderPlatformModel.ConfigApplication(),
|
|
5481
|
-
ordering_channel_logo: Joi.string().allow(""),
|
|
5482
|
-
integration_type: Joi.string().allow(""),
|
|
5483
|
-
});
|
|
5484
|
-
}
|
|
5485
|
-
|
|
5486
5906
|
/** @returns {CreateOrderAPI} */
|
|
5487
5907
|
static CreateOrderAPI() {
|
|
5488
5908
|
return Joi.object({
|
|
5489
5909
|
shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
|
|
5490
|
-
shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
|
|
5491
5910
|
shipping_info: Joi.any().required(),
|
|
5492
5911
|
billing_info: Joi.any().required(),
|
|
5493
5912
|
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
@@ -5498,11 +5917,14 @@ class OrderPlatformModel {
|
|
|
5498
5917
|
external_creation_date: Joi.string().allow(""),
|
|
5499
5918
|
meta: Joi.any(),
|
|
5500
5919
|
tax_info: OrderPlatformModel.TaxInfo(),
|
|
5501
|
-
config: OrderPlatformModel.
|
|
5920
|
+
config: OrderPlatformModel.CreateOrderConfig(),
|
|
5502
5921
|
payment_info: OrderPlatformModel.PaymentInfo().required(),
|
|
5503
5922
|
user_info: OrderPlatformModel.UserInfo(),
|
|
5504
5923
|
unlock_before_transition: Joi.boolean(),
|
|
5505
5924
|
lock_after_transition: Joi.boolean(),
|
|
5925
|
+
dynamic_charges: Joi.array().items(
|
|
5926
|
+
OrderPlatformModel.DynamicChargeSchema()
|
|
5927
|
+
),
|
|
5506
5928
|
});
|
|
5507
5929
|
}
|
|
5508
5930
|
|
|
@@ -6088,6 +6510,8 @@ class OrderPlatformModel {
|
|
|
6088
6510
|
return Joi.object({
|
|
6089
6511
|
from_date: Joi.string().allow(""),
|
|
6090
6512
|
to_date: Joi.string().allow(""),
|
|
6513
|
+
end_date: Joi.string().allow(""),
|
|
6514
|
+
start_date: Joi.string().allow(""),
|
|
6091
6515
|
});
|
|
6092
6516
|
}
|
|
6093
6517
|
|
|
@@ -6095,14 +6519,12 @@ class OrderPlatformModel {
|
|
|
6095
6519
|
static Filters() {
|
|
6096
6520
|
return Joi.object({
|
|
6097
6521
|
date_range: OrderPlatformModel.DateRange(),
|
|
6098
|
-
logo: Joi.string().allow(""),
|
|
6099
|
-
from_date: Joi.string().allow(""),
|
|
6100
6522
|
stores: Joi.number(),
|
|
6101
|
-
to_date: Joi.string().allow(""),
|
|
6102
6523
|
dp_name: Joi.string().allow(""),
|
|
6103
|
-
dp_ids: Joi.
|
|
6524
|
+
dp_ids: Joi.string().allow(""),
|
|
6104
6525
|
lane: Joi.string().allow(""),
|
|
6105
6526
|
selected_shipments: Joi.string().allow(""),
|
|
6527
|
+
deselected_shipments: Joi.string().allow(""),
|
|
6106
6528
|
store_name: Joi.string().allow(""),
|
|
6107
6529
|
type: Joi.string().allow(""),
|
|
6108
6530
|
}).allow(null);
|
|
@@ -6774,6 +7196,175 @@ class OrderPlatformModel {
|
|
|
6774
7196
|
});
|
|
6775
7197
|
}
|
|
6776
7198
|
|
|
7199
|
+
/** @returns {ConfigData} */
|
|
7200
|
+
static ConfigData() {
|
|
7201
|
+
return Joi.object({
|
|
7202
|
+
acknowledged: Joi.boolean(),
|
|
7203
|
+
is_upserted: Joi.boolean(),
|
|
7204
|
+
is_inserted: Joi.boolean(),
|
|
7205
|
+
});
|
|
7206
|
+
}
|
|
7207
|
+
|
|
7208
|
+
/** @returns {ConfigUpdatedResponse} */
|
|
7209
|
+
static ConfigUpdatedResponse() {
|
|
7210
|
+
return Joi.object({
|
|
7211
|
+
data: Joi.array().items(OrderPlatformModel.ConfigData()).required(),
|
|
7212
|
+
success: Joi.boolean().required(),
|
|
7213
|
+
});
|
|
7214
|
+
}
|
|
7215
|
+
|
|
7216
|
+
/** @returns {FlagData} */
|
|
7217
|
+
static FlagData() {
|
|
7218
|
+
return Joi.object({
|
|
7219
|
+
value: Joi.any(),
|
|
7220
|
+
filter: Joi.any(),
|
|
7221
|
+
});
|
|
7222
|
+
}
|
|
7223
|
+
|
|
7224
|
+
/** @returns {Flags} */
|
|
7225
|
+
static Flags() {
|
|
7226
|
+
return Joi.object({
|
|
7227
|
+
allow_partial_transition: Joi.array().items(
|
|
7228
|
+
OrderPlatformModel.FlagData()
|
|
7229
|
+
),
|
|
7230
|
+
can_break_entity: Joi.array().items(OrderPlatformModel.FlagData()),
|
|
7231
|
+
allowed_bag_updates: Joi.array().items(OrderPlatformModel.FlagData()),
|
|
7232
|
+
allowed_bag_status_updates: Joi.array().items(
|
|
7233
|
+
OrderPlatformModel.FlagData()
|
|
7234
|
+
),
|
|
7235
|
+
allowed_entity_updates: Joi.array().items(OrderPlatformModel.FlagData()),
|
|
7236
|
+
allowed_entity_status_updates: Joi.array().items(
|
|
7237
|
+
OrderPlatformModel.FlagData()
|
|
7238
|
+
),
|
|
7239
|
+
status_update_type: Joi.array().items(OrderPlatformModel.FlagData()),
|
|
7240
|
+
is_bag_status_reason_allowed: Joi.array().items(
|
|
7241
|
+
OrderPlatformModel.FlagData()
|
|
7242
|
+
),
|
|
7243
|
+
is_entity_status_reason_allowed: Joi.array().items(
|
|
7244
|
+
OrderPlatformModel.FlagData()
|
|
7245
|
+
),
|
|
7246
|
+
transition_strategy: Joi.array().items(OrderPlatformModel.FlagData()),
|
|
7247
|
+
});
|
|
7248
|
+
}
|
|
7249
|
+
|
|
7250
|
+
/** @returns {Filter} */
|
|
7251
|
+
static Filter() {
|
|
7252
|
+
return Joi.object({
|
|
7253
|
+
order_type: Joi.string().allow(""),
|
|
7254
|
+
is_partial_transition: Joi.boolean(),
|
|
7255
|
+
auto_trigger_dp_assignment_acf: Joi.boolean(),
|
|
7256
|
+
lock_status: Joi.string().allow(""),
|
|
7257
|
+
lock_after_transition: Joi.boolean(),
|
|
7258
|
+
resume_tasks_after_unlock: Joi.boolean(),
|
|
7259
|
+
is_invoice_id_present: Joi.boolean(),
|
|
7260
|
+
is_credit_note_generated: Joi.boolean(),
|
|
7261
|
+
fulfill_virtual_invoice: Joi.boolean(),
|
|
7262
|
+
next_status: Joi.string().allow(""),
|
|
7263
|
+
is_hook_enabled: Joi.boolean(),
|
|
7264
|
+
pos_credit_note_check: Joi.boolean(),
|
|
7265
|
+
order_platform: Joi.string().allow(""),
|
|
7266
|
+
refund_type: Joi.string().allow(""),
|
|
7267
|
+
is_non_pos_platform: Joi.boolean(),
|
|
7268
|
+
is_self_ship: Joi.boolean(),
|
|
7269
|
+
seller_country_code: Joi.string().allow(""),
|
|
7270
|
+
customer_country_code: Joi.string().allow(""),
|
|
7271
|
+
is_test_order: Joi.boolean(),
|
|
7272
|
+
task_trigger_condition: Joi.array().items(Joi.string().allow("")),
|
|
7273
|
+
});
|
|
7274
|
+
}
|
|
7275
|
+
|
|
7276
|
+
/** @returns {PostHook} */
|
|
7277
|
+
static PostHook() {
|
|
7278
|
+
return Joi.object({
|
|
7279
|
+
task: Joi.string().allow("").required(),
|
|
7280
|
+
kwargs: Joi.object().pattern(/\S/, Joi.any()),
|
|
7281
|
+
filters: OrderPlatformModel.Filter(),
|
|
7282
|
+
});
|
|
7283
|
+
}
|
|
7284
|
+
|
|
7285
|
+
/** @returns {PreHook} */
|
|
7286
|
+
static PreHook() {
|
|
7287
|
+
return Joi.object({
|
|
7288
|
+
task: Joi.string().allow("").required(),
|
|
7289
|
+
kwargs: Joi.object().pattern(/\S/, Joi.any()),
|
|
7290
|
+
filters: OrderPlatformModel.Filter(),
|
|
7291
|
+
});
|
|
7292
|
+
}
|
|
7293
|
+
|
|
7294
|
+
/** @returns {Config} */
|
|
7295
|
+
static Config() {
|
|
7296
|
+
return Joi.object({
|
|
7297
|
+
from_state: Joi.string().allow(""),
|
|
7298
|
+
to_state: Joi.string().allow(""),
|
|
7299
|
+
pre_hooks: Joi.array().items(OrderPlatformModel.PreHook()),
|
|
7300
|
+
post_hooks: Joi.array().items(OrderPlatformModel.PostHook()),
|
|
7301
|
+
flags: OrderPlatformModel.Flags(),
|
|
7302
|
+
});
|
|
7303
|
+
}
|
|
7304
|
+
|
|
7305
|
+
/** @returns {TransitionConfigCondition} */
|
|
7306
|
+
static TransitionConfigCondition() {
|
|
7307
|
+
return Joi.object({
|
|
7308
|
+
app_id: Joi.string().allow("").required(),
|
|
7309
|
+
ordering_channel: Joi.string().allow("").required(),
|
|
7310
|
+
entity: Joi.string().allow("").required(),
|
|
7311
|
+
});
|
|
7312
|
+
}
|
|
7313
|
+
|
|
7314
|
+
/** @returns {TransitionConfigData} */
|
|
7315
|
+
static TransitionConfigData() {
|
|
7316
|
+
return Joi.object({
|
|
7317
|
+
conditions: OrderPlatformModel.TransitionConfigCondition(),
|
|
7318
|
+
configs: Joi.array().items(OrderPlatformModel.Config()),
|
|
7319
|
+
});
|
|
7320
|
+
}
|
|
7321
|
+
|
|
7322
|
+
/** @returns {TransitionConfigPayload} */
|
|
7323
|
+
static TransitionConfigPayload() {
|
|
7324
|
+
return Joi.object({
|
|
7325
|
+
data: OrderPlatformModel.TransitionConfigData(),
|
|
7326
|
+
});
|
|
7327
|
+
}
|
|
7328
|
+
|
|
7329
|
+
/** @returns {ProcessManifestRequest} */
|
|
7330
|
+
static ProcessManifestRequest() {
|
|
7331
|
+
return Joi.object({
|
|
7332
|
+
action: Joi.string().allow(""),
|
|
7333
|
+
filters: OrderPlatformModel.Filters(),
|
|
7334
|
+
unique_id: Joi.string().allow(""),
|
|
7335
|
+
});
|
|
7336
|
+
}
|
|
7337
|
+
|
|
7338
|
+
/** @returns {ManifestResponse} */
|
|
7339
|
+
static ManifestResponse() {
|
|
7340
|
+
return Joi.object({
|
|
7341
|
+
items: OrderPlatformModel.ManifestItems(),
|
|
7342
|
+
});
|
|
7343
|
+
}
|
|
7344
|
+
|
|
7345
|
+
/** @returns {ManifestItems} */
|
|
7346
|
+
static ManifestItems() {
|
|
7347
|
+
return Joi.object({
|
|
7348
|
+
filters: OrderPlatformModel.Filters(),
|
|
7349
|
+
manifest_id: Joi.string().allow(""),
|
|
7350
|
+
unique_id: Joi.string().allow(""),
|
|
7351
|
+
company_id: Joi.number(),
|
|
7352
|
+
dp_id: Joi.string().allow("").allow(null),
|
|
7353
|
+
courier_partner_slug: Joi.string().allow(""),
|
|
7354
|
+
action: Joi.string().allow(""),
|
|
7355
|
+
created_by: Joi.string().allow(""),
|
|
7356
|
+
user_id: Joi.string().allow(""),
|
|
7357
|
+
});
|
|
7358
|
+
}
|
|
7359
|
+
|
|
7360
|
+
/** @returns {ManifestErrorResponse} */
|
|
7361
|
+
static ManifestErrorResponse() {
|
|
7362
|
+
return Joi.object({
|
|
7363
|
+
success: Joi.boolean(),
|
|
7364
|
+
error: Joi.string().allow(""),
|
|
7365
|
+
});
|
|
7366
|
+
}
|
|
7367
|
+
|
|
6777
7368
|
/** @returns {Page} */
|
|
6778
7369
|
static Page() {
|
|
6779
7370
|
return Joi.object({
|
|
@@ -7479,6 +8070,7 @@ class OrderPlatformModel {
|
|
|
7479
8070
|
contact_person: Joi.string().allow("").allow(null),
|
|
7480
8071
|
state: Joi.string().allow("").allow(null),
|
|
7481
8072
|
city: Joi.string().allow("").allow(null),
|
|
8073
|
+
store_email: Joi.string().allow("").allow(null),
|
|
7482
8074
|
});
|
|
7483
8075
|
}
|
|
7484
8076
|
|
|
@@ -7852,6 +8444,7 @@ class OrderPlatformModel {
|
|
|
7852
8444
|
contact_person: Joi.string().allow("").required(),
|
|
7853
8445
|
state: Joi.string().allow("").required(),
|
|
7854
8446
|
city: Joi.string().allow("").required(),
|
|
8447
|
+
store_email: Joi.string().allow("").allow(null),
|
|
7855
8448
|
});
|
|
7856
8449
|
}
|
|
7857
8450
|
|
|
@@ -7900,6 +8493,7 @@ class OrderPlatformModel {
|
|
|
7900
8493
|
amount: Joi.number(),
|
|
7901
8494
|
unique_identifier: Joi.string().allow(""),
|
|
7902
8495
|
display_name: Joi.string().allow(""),
|
|
8496
|
+
transaction_data: Joi.any(),
|
|
7903
8497
|
});
|
|
7904
8498
|
}
|
|
7905
8499
|
|
|
@@ -7912,6 +8506,7 @@ class OrderPlatformModel {
|
|
|
7912
8506
|
invoice: OrderPlatformModel.InvoiceInfo(),
|
|
7913
8507
|
shipment_status: Joi.string().allow("").allow(null),
|
|
7914
8508
|
gst_details: OrderPlatformModel.GSTDetailsData(),
|
|
8509
|
+
order_status: OrderPlatformModel.OrderStatusData(),
|
|
7915
8510
|
delivery_slot: Joi.any().allow(null),
|
|
7916
8511
|
order: OrderPlatformModel.OrderDetailsData(),
|
|
7917
8512
|
user: OrderPlatformModel.UserDataInfo(),
|