@gofynd/fdk-client-javascript 3.16.2 → 3.17.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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationClient.js +53 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
- package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
- package/sdk/application/Order/OrderApplicationClient.js +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +4 -4
- package/sdk/application/Payment/PaymentApplicationClient.js +3 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -0
- package/sdk/application/User/UserApplicationClient.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +3 -3
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -4
- package/sdk/platform/Cart/CartPlatformModel.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6 -131
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -141
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -10
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -12
- package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
- package/sdk/platform/Common/CommonPlatformModel.js +14 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +18 -459
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +28 -41
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +12 -52
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +54 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +47 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1 -7
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +0 -14
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -6
- package/sdk/platform/Content/ContentPlatformModel.d.ts +0 -2
- package/sdk/platform/Content/ContentPlatformModel.js +0 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +26 -18
- package/sdk/platform/Order/OrderPlatformClient.js +175 -107
- package/sdk/platform/Order/OrderPlatformModel.d.ts +339 -43
- package/sdk/platform/Order/OrderPlatformModel.js +209 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
- package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformModel.js +14 -10
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +42 -5
- package/sdk/platform/User/UserPlatformModel.js +25 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
- package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
|
@@ -1,25 +1,41 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {string
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* @property {string
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
* @
|
|
13
|
-
*
|
|
14
|
-
* @property {
|
|
15
|
-
*
|
|
16
|
-
* @property {
|
|
17
|
-
*
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
*
|
|
22
|
-
* @property {
|
|
4
|
+
* @typedef PackageSchema
|
|
5
|
+
* @property {string} [id] - Unique identifier of the physical package. If not
|
|
6
|
+
* provided, the system will auto-generate a unique ID with format 'PK'
|
|
7
|
+
* followed by a 10-digit number.
|
|
8
|
+
* @property {string} [packaging_id] - Optional reference to a predefined
|
|
9
|
+
* packaging configuration or template used for creating physical packages.
|
|
10
|
+
* @property {string} [name] - A human-readable name or label for the package,
|
|
11
|
+
* used for identification and organizational purposes.
|
|
12
|
+
* @property {string} [size] - The size category of the package (e.g., small,
|
|
13
|
+
* medium, large). Used for logistics and carrier selection.
|
|
14
|
+
* @property {string} [package_type] - The type or category of packaging
|
|
15
|
+
* material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
|
|
16
|
+
* @property {number} [length] - The length dimension of the package in
|
|
17
|
+
* centimeters. Used for volumetric weight calculation and carrier requirements.
|
|
18
|
+
* @property {number} [width] - The width dimension of the package in
|
|
19
|
+
* centimeters. Used for volumetric weight calculation and carrier requirements.
|
|
20
|
+
* @property {number} [height] - The height dimension of the package in
|
|
21
|
+
* centimeters. Used for volumetric weight calculation and carrier requirements.
|
|
22
|
+
* @property {number} [weight] - The actual weight of the package in kilograms,
|
|
23
|
+
* including packaging materials and products.
|
|
24
|
+
* @property {number} [error_rate] - The acceptable error rate or tolerance for
|
|
25
|
+
* the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
|
|
26
|
+
* @property {number} [package_vol_weight] - The volumetric weight of the
|
|
27
|
+
* package calculated based on dimensions, used for shipping cost calculation
|
|
28
|
+
* when greater than actual weight.
|
|
29
|
+
* @property {number} [max_weight] - The maximum weight capacity that this
|
|
30
|
+
* package can handle, used for validation and logistics planning.
|
|
31
|
+
* @property {string} [awb] - Air Waybill number assigned by the courier partner
|
|
32
|
+
* for tracking this specific package throughout the delivery process.
|
|
33
|
+
* @property {Object} [pdf_links] - Dictionary containing PDF document links
|
|
34
|
+
* related to this package (labels, invoices, etc.). Always returns an object
|
|
35
|
+
* - empty object {} if no links are present, populated object if links exist.
|
|
36
|
+
* Users can update values by providing new key-value pairs.
|
|
37
|
+
* @property {PackageProduct[]} [products] - List of products contained within
|
|
38
|
+
* this package. Each product specifies its line number, quantity, and identifier.
|
|
23
39
|
*/
|
|
24
40
|
|
|
25
41
|
/**
|
|
@@ -354,6 +370,14 @@ const Joi = require("joi");
|
|
|
354
370
|
* @property {string} message - Message for the transition.
|
|
355
371
|
*/
|
|
356
372
|
|
|
373
|
+
/**
|
|
374
|
+
* @typedef RefundModeTransitionData
|
|
375
|
+
* @property {string} [refund_mode] - Refund Mode for status transition data.
|
|
376
|
+
* @property {string} [display_name] - Refund Mode display name.
|
|
377
|
+
* @property {string[]} [payment_identifiers] - List of identifiers associated
|
|
378
|
+
* with the refund transaction.
|
|
379
|
+
*/
|
|
380
|
+
|
|
357
381
|
/**
|
|
358
382
|
* @typedef ShipmentsRequestSchema
|
|
359
383
|
* @property {string} identifier - Unique identifier for the shipment.
|
|
@@ -363,6 +387,8 @@ const Joi = require("joi");
|
|
|
363
387
|
* @property {DataUpdates} [data_updates]
|
|
364
388
|
* @property {TransitionComments[]} [transition_comments] - Comments or notes
|
|
365
389
|
* associated with the transition of shipment status.
|
|
390
|
+
* @property {RefundModeTransitionData[]} [refund_modes] - Refund Mode for
|
|
391
|
+
* status transition.
|
|
366
392
|
*/
|
|
367
393
|
|
|
368
394
|
/**
|
|
@@ -2534,6 +2560,14 @@ const Joi = require("joi");
|
|
|
2534
2560
|
*
|
|
2535
2561
|
* - `status_update`: Status Update
|
|
2536
2562
|
* - `data_update`: Data Update
|
|
2563
|
+
*
|
|
2564
|
+
* @property {string} [fulfillment_option_slug] - Represents the unique slug
|
|
2565
|
+
* associated with the fulfillment option attached to the shipment. This slug
|
|
2566
|
+
* helps determine the fulfillment method and operational flow used to deliver
|
|
2567
|
+
* the shipment. Examples:
|
|
2568
|
+
*
|
|
2569
|
+
* - "standard-delivery"
|
|
2570
|
+
* - "hyperlocal-delivery"
|
|
2537
2571
|
*/
|
|
2538
2572
|
|
|
2539
2573
|
/**
|
|
@@ -2854,6 +2888,29 @@ const Joi = require("joi");
|
|
|
2854
2888
|
* @property {PaymentMethodTransactionPartySchema} [transaction_party]
|
|
2855
2889
|
*/
|
|
2856
2890
|
|
|
2891
|
+
/**
|
|
2892
|
+
* @typedef PackagesSchema
|
|
2893
|
+
* @property {PackageSchema[]} packages - Array of packages to be created or
|
|
2894
|
+
* updated for the shipment. At least two packages are required for MPS functionality.
|
|
2895
|
+
*/
|
|
2896
|
+
|
|
2897
|
+
/**
|
|
2898
|
+
* @typedef PackagesResponseSchema
|
|
2899
|
+
* @property {boolean} success - Indicates whether the API call was successful
|
|
2900
|
+
* (true) or failed (false).
|
|
2901
|
+
* @property {PackagesSchema} data
|
|
2902
|
+
* @property {string} [message] - A descriptive message providing additional
|
|
2903
|
+
* information about the API response.
|
|
2904
|
+
*/
|
|
2905
|
+
|
|
2906
|
+
/**
|
|
2907
|
+
* @typedef PackagesErrorResponseSchema
|
|
2908
|
+
* @property {boolean} success - Indicates whether the API call was successful.
|
|
2909
|
+
* Will always be false for error responses.
|
|
2910
|
+
* @property {string} error - A detailed error message describing what went
|
|
2911
|
+
* wrong during the API call.
|
|
2912
|
+
*/
|
|
2913
|
+
|
|
2857
2914
|
/**
|
|
2858
2915
|
* @typedef BundleDetailsSchema
|
|
2859
2916
|
* @property {boolean} [is_base] - This serves as the base item, with all other
|
|
@@ -3325,6 +3382,15 @@ const Joi = require("joi");
|
|
|
3325
3382
|
* @property {Page} [page]
|
|
3326
3383
|
*/
|
|
3327
3384
|
|
|
3385
|
+
/**
|
|
3386
|
+
* @typedef PackageProduct
|
|
3387
|
+
* @property {number} line_number - The line number of the product within the
|
|
3388
|
+
* shipment, used for tracking and identification purposes.
|
|
3389
|
+
* @property {number} quantity - The quantity of the product included in this package.
|
|
3390
|
+
* @property {string} identifier - The unique identifier or SKU (Stock Keeping
|
|
3391
|
+
* Unit) of the product. This is used to match products across packages and bags.
|
|
3392
|
+
*/
|
|
3393
|
+
|
|
3328
3394
|
/**
|
|
3329
3395
|
* @typedef ValidationError
|
|
3330
3396
|
* @property {string} message - A brief description of the error encountered.
|
|
@@ -3401,6 +3467,15 @@ const Joi = require("joi");
|
|
|
3401
3467
|
* providing a clear indication of its current processing stage.
|
|
3402
3468
|
*/
|
|
3403
3469
|
|
|
3470
|
+
/**
|
|
3471
|
+
* @typedef OrderingSourceDetails
|
|
3472
|
+
* @property {string} [type] - Type of the ordering source.
|
|
3473
|
+
* @property {string} [slug] - Slug identifier of the ordering source.
|
|
3474
|
+
* @property {string} [display_name] - Display name of the ordering source.
|
|
3475
|
+
* @property {boolean} [is_active] - Indicates whether the ordering source is active.
|
|
3476
|
+
* @property {string} [logo] - Logo URL of the ordering source.
|
|
3477
|
+
*/
|
|
3478
|
+
|
|
3404
3479
|
/**
|
|
3405
3480
|
* @typedef UserDataInfo
|
|
3406
3481
|
* @property {number} [id] - The unique identifier associated with the user.
|
|
@@ -3579,6 +3654,8 @@ const Joi = require("joi");
|
|
|
3579
3654
|
* used in the transaction.
|
|
3580
3655
|
* @property {number} [amount_to_be_collected] - Total amount to be collected in
|
|
3581
3656
|
* scenarios involving multiple payment methods.
|
|
3657
|
+
* @property {number} [cost_price] - The base cost incurred by the seller to
|
|
3658
|
+
* acquire or produce the product before margin or discount.
|
|
3582
3659
|
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
3583
3660
|
* when the customer applies loyalty program points while placing the order.
|
|
3584
3661
|
*/
|
|
@@ -3669,6 +3746,8 @@ const Joi = require("joi");
|
|
|
3669
3746
|
* purchased by the customer, usable for future transactions.
|
|
3670
3747
|
* @property {number} [amount_to_be_collected] - Amount to be collected from the
|
|
3671
3748
|
* customer when multiple payment methods are utilized for a single order.
|
|
3749
|
+
* @property {number} [cost_price] - The base cost incurred by the seller to
|
|
3750
|
+
* acquire or produce the product before margin or discount.
|
|
3672
3751
|
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
3673
3752
|
* when the customer applies loyalty program points while placing the order.
|
|
3674
3753
|
*/
|
|
@@ -3711,6 +3790,16 @@ const Joi = require("joi");
|
|
|
3711
3790
|
* services before tax is applied.
|
|
3712
3791
|
*/
|
|
3713
3792
|
|
|
3793
|
+
/**
|
|
3794
|
+
* @typedef SellerQcDetails
|
|
3795
|
+
* @property {number} [line_number] - Represents the line number in an order or
|
|
3796
|
+
* transaction associated with the bag.
|
|
3797
|
+
* @property {number} [bad_quantity] - Represents the total number of items in a
|
|
3798
|
+
* bag that have failed quality control and are marked as bad QC.
|
|
3799
|
+
* @property {number} [good_quantity] - Represents the total number of items in
|
|
3800
|
+
* a bag that have passed quality control and are marked as good QC.
|
|
3801
|
+
*/
|
|
3802
|
+
|
|
3714
3803
|
/**
|
|
3715
3804
|
* @typedef FinancialBreakup
|
|
3716
3805
|
* @property {number} refund_credit - The amount of refund credits applicable
|
|
@@ -4213,6 +4302,7 @@ const Joi = require("joi");
|
|
|
4213
4302
|
* placed by the customer. This timestamp is crucial for tracking the order'
|
|
4214
4303
|
* @property {string} [order_created_ts] - The timestamp indicating when the
|
|
4215
4304
|
* order was created in UTC format.
|
|
4305
|
+
* @property {OrderingSourceDetails} [ordering_source_details]
|
|
4216
4306
|
* @property {ShipmentStatus} [shipment_status]
|
|
4217
4307
|
* @property {UserDataInfo} [user]
|
|
4218
4308
|
* @property {string} [estimated_sla_time] - The estimated Service Level
|
|
@@ -4892,6 +4982,7 @@ const Joi = require("joi");
|
|
|
4892
4982
|
* @property {BagStatusHistory[]} [bag_status]
|
|
4893
4983
|
* @property {Object} [parent_promo_bags] - An object containing details of
|
|
4894
4984
|
* parent promotional bags.
|
|
4985
|
+
* @property {SellerQcDetails} [seller_qc_details]
|
|
4895
4986
|
* @property {FinancialBreakup} [financial_breakup]
|
|
4896
4987
|
* @property {BagConfigs} [bag_configs]
|
|
4897
4988
|
* @property {string} [seller_identifier]
|
|
@@ -5146,6 +5237,8 @@ const Joi = require("joi");
|
|
|
5146
5237
|
* @property {Object} [logistics_meta] - An object storing detailed
|
|
5147
5238
|
* logistics-related information, including courier partner details and other
|
|
5148
5239
|
* relevant metadata.
|
|
5240
|
+
* @property {PackageSchema[]} [packages] - Array of packages to be created or
|
|
5241
|
+
* updated for the shipment. At least two packages are required for MPS functionality.
|
|
5149
5242
|
*/
|
|
5150
5243
|
|
|
5151
5244
|
/**
|
|
@@ -5193,6 +5286,7 @@ const Joi = require("joi");
|
|
|
5193
5286
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
5194
5287
|
* @property {string} [ordering_source] - Ordering source, to be used to
|
|
5195
5288
|
* identify source of order creation.
|
|
5289
|
+
* @property {OrderingSourceDetails} [ordering_source_details]
|
|
5196
5290
|
* @property {string} order_date - Specifies the exact date and time when the
|
|
5197
5291
|
* order was placed by the customer, serving as a key timestamp for the
|
|
5198
5292
|
* initiation of the order processing cycle.
|
|
@@ -5286,6 +5380,9 @@ const Joi = require("joi");
|
|
|
5286
5380
|
* @property {string} [order_created_time] - The Date and time when the order was created.
|
|
5287
5381
|
* @property {string} [order_created_ts] - The timestamp indicating when the
|
|
5288
5382
|
* order was created.
|
|
5383
|
+
* @property {string} [ordering_source] - Ordering source, to be used to
|
|
5384
|
+
* identify source of order creation.
|
|
5385
|
+
* @property {OrderingSourceDetails} [ordering_source_details]
|
|
5289
5386
|
* @property {string} [payment_mode] - The payment mode used for the order.
|
|
5290
5387
|
* @property {PlatformShipment[]} [shipments] - An array of shipment items
|
|
5291
5388
|
* returned as part of the order.
|
|
@@ -5912,31 +6009,24 @@ const Joi = require("joi");
|
|
|
5912
6009
|
*/
|
|
5913
6010
|
|
|
5914
6011
|
class OrderPlatformModel {
|
|
5915
|
-
/** @returns {
|
|
5916
|
-
static
|
|
5917
|
-
return Joi.object({
|
|
5918
|
-
shipment_ids: Joi.array().items(Joi.string().allow("")),
|
|
5919
|
-
affiliate_bag_ids: Joi.array().items(Joi.string().allow("")),
|
|
5920
|
-
bag_ids: Joi.array().items(Joi.string().allow("")),
|
|
5921
|
-
});
|
|
5922
|
-
}
|
|
5923
|
-
|
|
5924
|
-
/** @returns {InvalidateShipmentCacheNestedResponseSchema} */
|
|
5925
|
-
static InvalidateShipmentCacheNestedResponseSchema() {
|
|
5926
|
-
return Joi.object({
|
|
5927
|
-
shipment_id: Joi.string().allow(""),
|
|
5928
|
-
status: Joi.number(),
|
|
5929
|
-
message: Joi.string().allow(""),
|
|
5930
|
-
error: Joi.string().allow(""),
|
|
5931
|
-
});
|
|
5932
|
-
}
|
|
5933
|
-
|
|
5934
|
-
/** @returns {InvalidateShipmentCacheResponseSchema} */
|
|
5935
|
-
static InvalidateShipmentCacheResponseSchema() {
|
|
6012
|
+
/** @returns {PackageSchema} */
|
|
6013
|
+
static PackageSchema() {
|
|
5936
6014
|
return Joi.object({
|
|
5937
|
-
|
|
5938
|
-
|
|
5939
|
-
),
|
|
6015
|
+
id: Joi.string().allow(""),
|
|
6016
|
+
packaging_id: Joi.string().allow("").allow(null),
|
|
6017
|
+
name: Joi.string().allow("").allow(null),
|
|
6018
|
+
size: Joi.string().allow("").allow(null),
|
|
6019
|
+
package_type: Joi.string().allow("").allow(null),
|
|
6020
|
+
length: Joi.number().allow(null),
|
|
6021
|
+
width: Joi.number().allow(null),
|
|
6022
|
+
height: Joi.number().allow(null),
|
|
6023
|
+
weight: Joi.number().allow(null),
|
|
6024
|
+
error_rate: Joi.number().allow(null),
|
|
6025
|
+
package_vol_weight: Joi.number().allow(null),
|
|
6026
|
+
max_weight: Joi.number().allow(null),
|
|
6027
|
+
awb: Joi.string().allow("").allow(null),
|
|
6028
|
+
pdf_links: Joi.object().pattern(/\S/, Joi.string().allow("")),
|
|
6029
|
+
products: Joi.array().items(OrderPlatformModel.PackageProduct()),
|
|
5940
6030
|
});
|
|
5941
6031
|
}
|
|
5942
6032
|
|
|
@@ -6255,6 +6345,15 @@ class OrderPlatformModel {
|
|
|
6255
6345
|
});
|
|
6256
6346
|
}
|
|
6257
6347
|
|
|
6348
|
+
/** @returns {RefundModeTransitionData} */
|
|
6349
|
+
static RefundModeTransitionData() {
|
|
6350
|
+
return Joi.object({
|
|
6351
|
+
refund_mode: Joi.string().allow(""),
|
|
6352
|
+
display_name: Joi.string().allow(""),
|
|
6353
|
+
payment_identifiers: Joi.array().items(Joi.string().allow("")),
|
|
6354
|
+
});
|
|
6355
|
+
}
|
|
6356
|
+
|
|
6258
6357
|
/** @returns {ShipmentsRequestSchema} */
|
|
6259
6358
|
static ShipmentsRequestSchema() {
|
|
6260
6359
|
return Joi.object({
|
|
@@ -6265,6 +6364,9 @@ class OrderPlatformModel {
|
|
|
6265
6364
|
transition_comments: Joi.array().items(
|
|
6266
6365
|
OrderPlatformModel.TransitionComments()
|
|
6267
6366
|
),
|
|
6367
|
+
refund_modes: Joi.array().items(
|
|
6368
|
+
OrderPlatformModel.RefundModeTransitionData()
|
|
6369
|
+
),
|
|
6268
6370
|
});
|
|
6269
6371
|
}
|
|
6270
6372
|
|
|
@@ -8282,6 +8384,7 @@ class OrderPlatformModel {
|
|
|
8282
8384
|
customer_country_code: Joi.string().allow(""),
|
|
8283
8385
|
is_test_order: Joi.boolean(),
|
|
8284
8386
|
task_trigger_condition: Joi.array().items(Joi.string().allow("")),
|
|
8387
|
+
fulfillment_option_slug: Joi.string().allow(""),
|
|
8285
8388
|
});
|
|
8286
8389
|
}
|
|
8287
8390
|
|
|
@@ -8578,6 +8681,32 @@ class OrderPlatformModel {
|
|
|
8578
8681
|
});
|
|
8579
8682
|
}
|
|
8580
8683
|
|
|
8684
|
+
/** @returns {PackagesSchema} */
|
|
8685
|
+
static PackagesSchema() {
|
|
8686
|
+
return Joi.object({
|
|
8687
|
+
packages: Joi.array()
|
|
8688
|
+
.items(OrderPlatformModel.PackageSchema())
|
|
8689
|
+
.required(),
|
|
8690
|
+
});
|
|
8691
|
+
}
|
|
8692
|
+
|
|
8693
|
+
/** @returns {PackagesResponseSchema} */
|
|
8694
|
+
static PackagesResponseSchema() {
|
|
8695
|
+
return Joi.object({
|
|
8696
|
+
success: Joi.boolean().required(),
|
|
8697
|
+
data: OrderPlatformModel.PackagesSchema().required(),
|
|
8698
|
+
message: Joi.string().allow("").allow(null),
|
|
8699
|
+
});
|
|
8700
|
+
}
|
|
8701
|
+
|
|
8702
|
+
/** @returns {PackagesErrorResponseSchema} */
|
|
8703
|
+
static PackagesErrorResponseSchema() {
|
|
8704
|
+
return Joi.object({
|
|
8705
|
+
success: Joi.boolean().required(),
|
|
8706
|
+
error: Joi.string().allow("").required(),
|
|
8707
|
+
});
|
|
8708
|
+
}
|
|
8709
|
+
|
|
8581
8710
|
/** @returns {BundleDetailsSchema} */
|
|
8582
8711
|
static BundleDetailsSchema() {
|
|
8583
8712
|
return Joi.object({
|
|
@@ -9012,6 +9141,15 @@ class OrderPlatformModel {
|
|
|
9012
9141
|
});
|
|
9013
9142
|
}
|
|
9014
9143
|
|
|
9144
|
+
/** @returns {PackageProduct} */
|
|
9145
|
+
static PackageProduct() {
|
|
9146
|
+
return Joi.object({
|
|
9147
|
+
line_number: Joi.number().required(),
|
|
9148
|
+
quantity: Joi.number().required(),
|
|
9149
|
+
identifier: Joi.string().allow("").required(),
|
|
9150
|
+
});
|
|
9151
|
+
}
|
|
9152
|
+
|
|
9015
9153
|
/** @returns {ValidationError} */
|
|
9016
9154
|
static ValidationError() {
|
|
9017
9155
|
return Joi.object({
|
|
@@ -9074,6 +9212,17 @@ class OrderPlatformModel {
|
|
|
9074
9212
|
});
|
|
9075
9213
|
}
|
|
9076
9214
|
|
|
9215
|
+
/** @returns {OrderingSourceDetails} */
|
|
9216
|
+
static OrderingSourceDetails() {
|
|
9217
|
+
return Joi.object({
|
|
9218
|
+
type: Joi.string().allow(""),
|
|
9219
|
+
slug: Joi.string().allow(""),
|
|
9220
|
+
display_name: Joi.string().allow(""),
|
|
9221
|
+
is_active: Joi.boolean(),
|
|
9222
|
+
logo: Joi.string().allow(""),
|
|
9223
|
+
});
|
|
9224
|
+
}
|
|
9225
|
+
|
|
9077
9226
|
/** @returns {UserDataInfo} */
|
|
9078
9227
|
static UserDataInfo() {
|
|
9079
9228
|
return Joi.object({
|
|
@@ -9198,6 +9347,7 @@ class OrderPlatformModel {
|
|
|
9198
9347
|
fynd_credits: Joi.number().allow(null),
|
|
9199
9348
|
gift_price: Joi.number().allow(null),
|
|
9200
9349
|
amount_to_be_collected: Joi.number().allow(null),
|
|
9350
|
+
cost_price: Joi.number().allow(null),
|
|
9201
9351
|
loyalty_discount: Joi.number(),
|
|
9202
9352
|
});
|
|
9203
9353
|
}
|
|
@@ -9270,6 +9420,7 @@ class OrderPlatformModel {
|
|
|
9270
9420
|
fynd_credits: Joi.number().allow(null),
|
|
9271
9421
|
gift_price: Joi.number().allow(null),
|
|
9272
9422
|
amount_to_be_collected: Joi.number().allow(null),
|
|
9423
|
+
cost_price: Joi.number().allow(null),
|
|
9273
9424
|
loyalty_discount: Joi.number(),
|
|
9274
9425
|
});
|
|
9275
9426
|
}
|
|
@@ -9295,6 +9446,15 @@ class OrderPlatformModel {
|
|
|
9295
9446
|
});
|
|
9296
9447
|
}
|
|
9297
9448
|
|
|
9449
|
+
/** @returns {SellerQcDetails} */
|
|
9450
|
+
static SellerQcDetails() {
|
|
9451
|
+
return Joi.object({
|
|
9452
|
+
line_number: Joi.number(),
|
|
9453
|
+
bad_quantity: Joi.number(),
|
|
9454
|
+
good_quantity: Joi.number(),
|
|
9455
|
+
}).allow(null);
|
|
9456
|
+
}
|
|
9457
|
+
|
|
9298
9458
|
/** @returns {FinancialBreakup} */
|
|
9299
9459
|
static FinancialBreakup() {
|
|
9300
9460
|
return Joi.object({
|
|
@@ -9645,6 +9805,7 @@ class OrderPlatformModel {
|
|
|
9645
9805
|
return Joi.object({
|
|
9646
9806
|
order_date: Joi.string().allow("").allow(null),
|
|
9647
9807
|
order_created_ts: Joi.string().allow("").allow(null),
|
|
9808
|
+
ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
|
|
9648
9809
|
shipment_status: OrderPlatformModel.ShipmentStatus(),
|
|
9649
9810
|
user: OrderPlatformModel.UserDataInfo(),
|
|
9650
9811
|
estimated_sla_time: Joi.string().allow("").allow(null),
|
|
@@ -10152,6 +10313,7 @@ class OrderPlatformModel {
|
|
|
10152
10313
|
gst_details: OrderPlatformModel.GSTDetailsData(),
|
|
10153
10314
|
bag_status: Joi.array().items(OrderPlatformModel.BagStatusHistory()),
|
|
10154
10315
|
parent_promo_bags: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
10316
|
+
seller_qc_details: OrderPlatformModel.SellerQcDetails(),
|
|
10155
10317
|
financial_breakup: OrderPlatformModel.FinancialBreakup(),
|
|
10156
10318
|
bag_configs: OrderPlatformModel.BagConfigs(),
|
|
10157
10319
|
seller_identifier: Joi.string().allow("").allow(null),
|
|
@@ -10324,6 +10486,7 @@ class OrderPlatformModel {
|
|
|
10324
10486
|
is_lapa_enabled: Joi.boolean(),
|
|
10325
10487
|
forward_end_shipment_id: Joi.string().allow("").allow(null),
|
|
10326
10488
|
logistics_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
10489
|
+
packages: Joi.array().items(OrderPlatformModel.PackageSchema()),
|
|
10327
10490
|
});
|
|
10328
10491
|
}
|
|
10329
10492
|
|
|
@@ -10364,6 +10527,7 @@ class OrderPlatformModel {
|
|
|
10364
10527
|
return Joi.object({
|
|
10365
10528
|
ordering_channel: Joi.string().allow(""),
|
|
10366
10529
|
ordering_source: Joi.string().allow(""),
|
|
10530
|
+
ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
|
|
10367
10531
|
order_date: Joi.string().allow("").required(),
|
|
10368
10532
|
created_ts: Joi.string().allow(""),
|
|
10369
10533
|
tax_details: OrderPlatformModel.TaxDetails(),
|
|
@@ -10448,6 +10612,8 @@ class OrderPlatformModel {
|
|
|
10448
10612
|
meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
10449
10613
|
order_created_time: Joi.string().allow("").allow(null),
|
|
10450
10614
|
order_created_ts: Joi.string().allow("").allow(null),
|
|
10615
|
+
ordering_source: Joi.string().allow("").allow(null),
|
|
10616
|
+
ordering_source_details: OrderPlatformModel.OrderingSourceDetails(),
|
|
10451
10617
|
payment_mode: Joi.string().allow("").allow(null),
|
|
10452
10618
|
shipments: Joi.array().items(OrderPlatformModel.PlatformShipment()),
|
|
10453
10619
|
order_id: Joi.string().allow("").allow(null),
|
|
@@ -50,18 +50,9 @@ export = OrderPlatformValidator;
|
|
|
50
50
|
* @property {OrderPlatformModel.CreateOrderRequestSchema} body
|
|
51
51
|
*/
|
|
52
52
|
/**
|
|
53
|
-
* @typedef
|
|
54
|
-
* @property {string}
|
|
55
|
-
*
|
|
56
|
-
* @property {string} [xApplicationId] - The Application ID is a unique
|
|
57
|
-
* identifier assigned to a storefront that typically follows a 24-character
|
|
58
|
-
* hexadecimal string. Either `x-application-id` or `x-extension-id` header is
|
|
59
|
-
* mandatory. At least one of them must be provided.
|
|
60
|
-
* @property {string} [xExtensionId] - The Extension ID is a unique identifier
|
|
61
|
-
* assigned to an extension that typically follows a 24-character hexadecimal
|
|
62
|
-
* string. Either `x-application-id` or `x-extension-id` header is mandatory.
|
|
63
|
-
* At least one of them must be provided.
|
|
64
|
-
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
53
|
+
* @typedef CreateShipmentPackagesParam
|
|
54
|
+
* @property {string} shipmentId - Unique identifier of the shipment.
|
|
55
|
+
* @property {OrderPlatformModel.PackagesSchema} body
|
|
65
56
|
*/
|
|
66
57
|
/**
|
|
67
58
|
* @typedef DispatchManifestsParam
|
|
@@ -328,6 +319,11 @@ export = OrderPlatformValidator;
|
|
|
328
319
|
* @property {string} [shipmentId] - Identifier for the shipment
|
|
329
320
|
* @property {number} [bagId] - Identifier for a bag or product.
|
|
330
321
|
*/
|
|
322
|
+
/**
|
|
323
|
+
* @typedef GetShipmentPackagesParam
|
|
324
|
+
* @property {string} shipmentId - Unique identifier for the shipment whose
|
|
325
|
+
* packages are being retrieved.
|
|
326
|
+
*/
|
|
331
327
|
/**
|
|
332
328
|
* @typedef GetShipmentReasonsParam
|
|
333
329
|
* @property {string} shipmentId - ID of the shipment. An order may contain
|
|
@@ -437,10 +433,6 @@ export = OrderPlatformValidator;
|
|
|
437
433
|
* @property {string} view - Name of view
|
|
438
434
|
* @property {string} [groupEntity] - Name of group entity
|
|
439
435
|
*/
|
|
440
|
-
/**
|
|
441
|
-
* @typedef InvalidateShipmentCacheParam
|
|
442
|
-
* @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
|
|
443
|
-
*/
|
|
444
436
|
/**
|
|
445
437
|
* @typedef JobDetailsParam
|
|
446
438
|
* @property {string} batchId - A unique identifier for the batch associated
|
|
@@ -502,6 +494,12 @@ export = OrderPlatformValidator;
|
|
|
502
494
|
* @typedef UpdateShipmentLockParam
|
|
503
495
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
504
496
|
*/
|
|
497
|
+
/**
|
|
498
|
+
* @typedef UpdateShipmentPackagesParam
|
|
499
|
+
* @property {string} shipmentId - Unique identifier for the shipment whose
|
|
500
|
+
* packages will be updated.
|
|
501
|
+
* @property {OrderPlatformModel.PackagesSchema} body
|
|
502
|
+
*/
|
|
505
503
|
/**
|
|
506
504
|
* @typedef UpdateShipmentStatusParam
|
|
507
505
|
* @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
|
|
@@ -535,8 +533,8 @@ declare class OrderPlatformValidator {
|
|
|
535
533
|
static createChannelConfig(): CreateChannelConfigParam;
|
|
536
534
|
/** @returns {CreateOrderParam} */
|
|
537
535
|
static createOrder(): CreateOrderParam;
|
|
538
|
-
/** @returns {
|
|
539
|
-
static
|
|
536
|
+
/** @returns {CreateShipmentPackagesParam} */
|
|
537
|
+
static createShipmentPackages(): CreateShipmentPackagesParam;
|
|
540
538
|
/** @returns {DispatchManifestsParam} */
|
|
541
539
|
static dispatchManifests(): DispatchManifestsParam;
|
|
542
540
|
/** @returns {DownloadBulkActionTemplateParam} */
|
|
@@ -597,6 +595,8 @@ declare class OrderPlatformValidator {
|
|
|
597
595
|
static getShipmentById(): GetShipmentByIdParam;
|
|
598
596
|
/** @returns {GetShipmentHistoryParam} */
|
|
599
597
|
static getShipmentHistory(): GetShipmentHistoryParam;
|
|
598
|
+
/** @returns {GetShipmentPackagesParam} */
|
|
599
|
+
static getShipmentPackages(): GetShipmentPackagesParam;
|
|
600
600
|
/** @returns {GetShipmentReasonsParam} */
|
|
601
601
|
static getShipmentReasons(): GetShipmentReasonsParam;
|
|
602
602
|
/** @returns {GetShipmentsParam} */
|
|
@@ -609,8 +609,6 @@ declare class OrderPlatformValidator {
|
|
|
609
609
|
static getTemplate(): GetTemplateParam;
|
|
610
610
|
/** @returns {GetfiltersParam} */
|
|
611
611
|
static getfilters(): GetfiltersParam;
|
|
612
|
-
/** @returns {InvalidateShipmentCacheParam} */
|
|
613
|
-
static invalidateShipmentCache(): InvalidateShipmentCacheParam;
|
|
614
612
|
/** @returns {JobDetailsParam} */
|
|
615
613
|
static jobDetails(): JobDetailsParam;
|
|
616
614
|
/** @returns {ListAccountsParam} */
|
|
@@ -637,6 +635,8 @@ declare class OrderPlatformValidator {
|
|
|
637
635
|
static updatePaymentInfo(): UpdatePaymentInfoParam;
|
|
638
636
|
/** @returns {UpdateShipmentLockParam} */
|
|
639
637
|
static updateShipmentLock(): UpdateShipmentLockParam;
|
|
638
|
+
/** @returns {UpdateShipmentPackagesParam} */
|
|
639
|
+
static updateShipmentPackages(): UpdateShipmentPackagesParam;
|
|
640
640
|
/** @returns {UpdateShipmentStatusParam} */
|
|
641
641
|
static updateShipmentStatus(): UpdateShipmentStatusParam;
|
|
642
642
|
/** @returns {UpdateShipmentTrackingParam} */
|
|
@@ -647,7 +647,7 @@ declare class OrderPlatformValidator {
|
|
|
647
647
|
static verifyMobileOTP(): VerifyMobileOTPParam;
|
|
648
648
|
}
|
|
649
649
|
declare namespace OrderPlatformValidator {
|
|
650
|
-
export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam,
|
|
650
|
+
export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam, CreateShipmentPackagesParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAccountByIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentPackagesParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, JobDetailsParam, ListAccountsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAccountParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentPackagesParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
651
651
|
}
|
|
652
652
|
type AddStateManagerConfigParam = {
|
|
653
653
|
body: OrderPlatformModel.TransitionConfigPayload;
|
|
@@ -721,27 +721,12 @@ type CreateOrderParam = {
|
|
|
721
721
|
xExtensionId?: string;
|
|
722
722
|
body: OrderPlatformModel.CreateOrderRequestSchema;
|
|
723
723
|
};
|
|
724
|
-
type
|
|
724
|
+
type CreateShipmentPackagesParam = {
|
|
725
725
|
/**
|
|
726
|
-
* -
|
|
727
|
-
* which order has been placed.
|
|
726
|
+
* - Unique identifier of the shipment.
|
|
728
727
|
*/
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
* - The Application ID is a unique
|
|
732
|
-
* identifier assigned to a storefront that typically follows a 24-character
|
|
733
|
-
* hexadecimal string. Either `x-application-id` or `x-extension-id` header is
|
|
734
|
-
* mandatory. At least one of them must be provided.
|
|
735
|
-
*/
|
|
736
|
-
xApplicationId?: string;
|
|
737
|
-
/**
|
|
738
|
-
* - The Extension ID is a unique identifier
|
|
739
|
-
* assigned to an extension that typically follows a 24-character hexadecimal
|
|
740
|
-
* string. Either `x-application-id` or `x-extension-id` header is mandatory.
|
|
741
|
-
* At least one of them must be provided.
|
|
742
|
-
*/
|
|
743
|
-
xExtensionId?: string;
|
|
744
|
-
body: OrderPlatformModel.CreateOrderAPI;
|
|
728
|
+
shipmentId: string;
|
|
729
|
+
body: OrderPlatformModel.PackagesSchema;
|
|
745
730
|
};
|
|
746
731
|
type DispatchManifestsParam = {
|
|
747
732
|
body: OrderPlatformModel.DispatchManifest;
|
|
@@ -1305,6 +1290,13 @@ type GetShipmentHistoryParam = {
|
|
|
1305
1290
|
*/
|
|
1306
1291
|
bagId?: number;
|
|
1307
1292
|
};
|
|
1293
|
+
type GetShipmentPackagesParam = {
|
|
1294
|
+
/**
|
|
1295
|
+
* - Unique identifier for the shipment whose
|
|
1296
|
+
* packages are being retrieved.
|
|
1297
|
+
*/
|
|
1298
|
+
shipmentId: string;
|
|
1299
|
+
};
|
|
1308
1300
|
type GetShipmentReasonsParam = {
|
|
1309
1301
|
/**
|
|
1310
1302
|
* - ID of the shipment. An order may contain
|
|
@@ -1552,9 +1544,6 @@ type GetfiltersParam = {
|
|
|
1552
1544
|
*/
|
|
1553
1545
|
groupEntity?: string;
|
|
1554
1546
|
};
|
|
1555
|
-
type InvalidateShipmentCacheParam = {
|
|
1556
|
-
body: OrderPlatformModel.InvalidateShipmentCachePayload;
|
|
1557
|
-
};
|
|
1558
1547
|
type JobDetailsParam = {
|
|
1559
1548
|
/**
|
|
1560
1549
|
* - A unique identifier for the batch associated
|
|
@@ -1630,6 +1619,14 @@ type UpdatePaymentInfoParam = {
|
|
|
1630
1619
|
type UpdateShipmentLockParam = {
|
|
1631
1620
|
body: OrderPlatformModel.UpdateShipmentLockPayload;
|
|
1632
1621
|
};
|
|
1622
|
+
type UpdateShipmentPackagesParam = {
|
|
1623
|
+
/**
|
|
1624
|
+
* - Unique identifier for the shipment whose
|
|
1625
|
+
* packages will be updated.
|
|
1626
|
+
*/
|
|
1627
|
+
shipmentId: string;
|
|
1628
|
+
body: OrderPlatformModel.PackagesSchema;
|
|
1629
|
+
};
|
|
1633
1630
|
type UpdateShipmentStatusParam = {
|
|
1634
1631
|
body: OrderPlatformModel.UpdateShipmentStatusRequestSchema;
|
|
1635
1632
|
};
|