@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -3,142 +3,144 @@ declare class Order {
|
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
|
-
* @param {OrderPlatformValidator.
|
|
6
|
+
* @param {OrderPlatformValidator.AddStateManagerConfigParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<OrderPlatformModel.
|
|
9
|
+
* @returns {Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>} -
|
|
10
10
|
* Success response
|
|
11
|
-
* @name
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
11
|
+
* @name addStateManagerConfig
|
|
12
|
+
* @summary: Allows esm config updation
|
|
13
|
+
* @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
|
|
14
14
|
*/
|
|
15
|
-
|
|
15
|
+
addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>;
|
|
16
16
|
/**
|
|
17
17
|
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
18
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<OrderPlatformModel.
|
|
20
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponseSchema>} -
|
|
21
|
+
* Success response
|
|
21
22
|
* @name attachOrderUser
|
|
22
|
-
* @summary: Attach order user
|
|
23
|
-
* @description: Attach order
|
|
23
|
+
* @summary: Attach order to a user
|
|
24
|
+
* @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
24
25
|
*/
|
|
25
|
-
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
26
|
+
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponseSchema>;
|
|
26
27
|
/**
|
|
27
28
|
* @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
|
|
28
29
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
30
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
|
-
* @returns {Promise<OrderPlatformModel.
|
|
31
|
+
* @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
|
|
31
32
|
* @name bulkListing
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description:
|
|
34
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
|
|
33
|
+
* @summary: Lists bulk operations
|
|
34
|
+
* @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
|
|
35
35
|
*/
|
|
36
|
-
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
36
|
+
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponseSchema>;
|
|
37
37
|
/**
|
|
38
38
|
* @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
|
|
39
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
40
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
41
|
-
* @returns {Promise<OrderPlatformModel.
|
|
42
|
-
* Success response
|
|
41
|
+
* @returns {Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>}
|
|
42
|
+
* - Success response
|
|
43
|
+
*
|
|
43
44
|
* @name bulkStateTransistion
|
|
44
|
-
* @summary:
|
|
45
|
-
* @description: Performs
|
|
45
|
+
* @summary: Upload bulk state transitions file
|
|
46
|
+
* @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
|
|
46
47
|
*/
|
|
47
|
-
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
48
|
+
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>;
|
|
48
49
|
/**
|
|
49
50
|
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
50
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
52
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
53
|
* @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
|
|
53
54
|
* @name checkOrderStatus
|
|
54
|
-
* @summary:
|
|
55
|
-
* @description:
|
|
55
|
+
* @summary: Debug order
|
|
56
|
+
* @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
56
57
|
*/
|
|
57
58
|
checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
58
59
|
/**
|
|
59
|
-
* @param {OrderPlatformValidator.
|
|
60
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
60
61
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
62
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
|
-
* @returns {Promise<OrderPlatformModel.
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* @
|
|
63
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
|
|
64
|
+
* - Success response
|
|
65
|
+
*
|
|
66
|
+
* @name createChannelConfig
|
|
67
|
+
* @summary: Create channel configuration
|
|
68
|
+
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
66
69
|
*/
|
|
67
|
-
|
|
70
|
+
createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
|
|
68
71
|
/**
|
|
69
72
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
70
73
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
71
74
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
|
-
* @returns {Promise<OrderPlatformModel.
|
|
75
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
|
|
73
76
|
* @name createOrder
|
|
74
|
-
* @summary: Create order
|
|
75
|
-
* @description:
|
|
77
|
+
* @summary: Create order
|
|
78
|
+
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
76
79
|
*/
|
|
77
|
-
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
80
|
+
createOrder({ body, xOrderingSource, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
|
|
78
81
|
/**
|
|
79
|
-
* @param {OrderPlatformValidator.
|
|
82
|
+
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
80
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
81
84
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
82
|
-
* @returns {Promise<OrderPlatformModel.
|
|
83
|
-
*
|
|
84
|
-
* @
|
|
85
|
-
* @
|
|
86
|
-
* @description: Delete custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/deleteUserViews/).
|
|
85
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
86
|
+
* @name dispatchManifests
|
|
87
|
+
* @summary: Dispatch manifest
|
|
88
|
+
* @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
|
|
87
89
|
*/
|
|
88
|
-
|
|
90
|
+
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
89
91
|
/**
|
|
90
92
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
91
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
92
94
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
93
|
-
* @returns {Promise<OrderPlatformModel.
|
|
95
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
94
96
|
* @name downloadBulkActionTemplate
|
|
95
|
-
* @summary: Download bulk
|
|
97
|
+
* @summary: Download bulk template
|
|
96
98
|
* @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
97
99
|
*/
|
|
98
|
-
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
100
|
+
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
99
101
|
/**
|
|
100
102
|
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
101
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
-
* @returns {Promise<OrderPlatformModel.
|
|
104
|
-
* Success response
|
|
105
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
|
|
106
|
+
* - Success response
|
|
107
|
+
*
|
|
105
108
|
* @name downloadLanesReport
|
|
106
|
-
* @summary:
|
|
109
|
+
* @summary: Download Lane report
|
|
107
110
|
* @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
108
111
|
*/
|
|
109
|
-
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
112
|
+
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
|
|
110
113
|
/**
|
|
111
114
|
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
112
115
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
113
116
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
114
|
-
* @returns {Promise<OrderPlatformModel.
|
|
117
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
|
|
118
|
+
* Success response
|
|
115
119
|
* @name eInvoiceRetry
|
|
116
|
-
* @summary: Retry
|
|
117
|
-
* @description:
|
|
120
|
+
* @summary: Retry E-invoice
|
|
121
|
+
* @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
118
122
|
*/
|
|
119
|
-
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
123
|
+
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
|
|
120
124
|
/**
|
|
121
125
|
* @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
|
|
122
126
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
127
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
128
|
* @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
|
|
125
129
|
* @name failedOrderLogDetails
|
|
126
|
-
* @summary: Get failed order
|
|
127
|
-
* @description:
|
|
130
|
+
* @summary: Get failed order log
|
|
131
|
+
* @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
|
|
128
132
|
*/
|
|
129
133
|
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
130
134
|
/**
|
|
131
|
-
* @param {OrderPlatformValidator.
|
|
135
|
+
* @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
|
|
132
136
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
133
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
134
|
-
* @returns {Promise<OrderPlatformModel.
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* @
|
|
138
|
-
* @summary: Fetch credit balance detail.
|
|
139
|
-
* @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
138
|
+
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
139
|
+
* @name failedOrderLogs
|
|
140
|
+
* @summary: List failed order logs
|
|
141
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
140
142
|
*/
|
|
141
|
-
|
|
143
|
+
failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
|
|
142
144
|
/**
|
|
143
145
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
144
146
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -146,21 +148,43 @@ declare class Order {
|
|
|
146
148
|
* @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
|
|
147
149
|
* Success response
|
|
148
150
|
* @name fetchRefundModeConfig
|
|
149
|
-
* @summary:
|
|
151
|
+
* @summary: List refund modes
|
|
150
152
|
* @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
|
|
151
153
|
*/
|
|
152
154
|
fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
|
|
153
155
|
/**
|
|
154
|
-
* @param {OrderPlatformValidator.
|
|
156
|
+
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
155
157
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
158
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
|
-
* @returns {Promise<OrderPlatformModel.
|
|
159
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
|
|
158
160
|
* Success response
|
|
161
|
+
* @name generateInvoiceID
|
|
162
|
+
* @summary: Generate and attach invoice Id
|
|
163
|
+
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
164
|
+
*/
|
|
165
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
|
|
166
|
+
/**
|
|
167
|
+
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
168
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
169
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
|
|
171
|
+
* - Success response
|
|
172
|
+
*
|
|
159
173
|
* @name generatePOSReceiptByOrderId
|
|
160
|
-
* @summary: Generate POS receipt by order
|
|
174
|
+
* @summary: Generate POS receipt by order Id
|
|
161
175
|
* @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
|
|
162
176
|
*/
|
|
163
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
177
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
|
|
178
|
+
/**
|
|
179
|
+
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
180
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
|
|
183
|
+
* @name generateProcessManifest
|
|
184
|
+
* @summary: Process Order Manifest
|
|
185
|
+
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
186
|
+
*/
|
|
187
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
|
|
164
188
|
/**
|
|
165
189
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
166
190
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -168,196 +192,224 @@ declare class Order {
|
|
|
168
192
|
* @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
|
|
169
193
|
* Success response
|
|
170
194
|
* @name getAllowedStateTransition
|
|
171
|
-
* @summary: Get allowed state transition
|
|
172
|
-
* @description: Retrieve next possible states based on logged in user
|
|
195
|
+
* @summary: Get allowed state transition
|
|
196
|
+
* @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
173
197
|
*/
|
|
174
|
-
getAllowedStateTransition({ orderingChannel,
|
|
198
|
+
getAllowedStateTransition({ status, orderingChannel, orderingSource, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
|
|
175
199
|
/**
|
|
176
200
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
177
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
|
-
* @returns {Promise<OrderPlatformModel.
|
|
203
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
|
|
204
|
+
* Success response
|
|
180
205
|
* @name getAllowedTemplatesForBulk
|
|
181
|
-
* @summary:
|
|
182
|
-
* @description: Gets
|
|
206
|
+
* @summary: List bulk operation templates
|
|
207
|
+
* @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
183
208
|
*/
|
|
184
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
209
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
|
|
185
210
|
/**
|
|
186
211
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
187
212
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
213
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
-
* @returns {Promise<OrderPlatformModel.
|
|
214
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
|
|
215
|
+
* Success response
|
|
190
216
|
* @name getAnnouncements
|
|
191
|
-
* @summary:
|
|
217
|
+
* @summary: List announcements
|
|
192
218
|
* @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
|
|
193
219
|
*/
|
|
194
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
220
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
|
|
195
221
|
/**
|
|
196
222
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
197
223
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
|
-
* @returns {Promise<OrderPlatformModel.
|
|
200
|
-
* Success response
|
|
225
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
|
|
226
|
+
* - Success response
|
|
227
|
+
*
|
|
201
228
|
* @name getBagById
|
|
202
|
-
* @summary: Get bag
|
|
203
|
-
* @description:
|
|
229
|
+
* @summary: Get bag
|
|
230
|
+
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
204
231
|
*/
|
|
205
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
232
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
|
|
206
233
|
/**
|
|
207
234
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
208
235
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
209
236
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
210
|
-
* @returns {Promise<OrderPlatformModel.
|
|
237
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
|
|
238
|
+
* Success response
|
|
211
239
|
* @name getBags
|
|
212
|
-
* @summary:
|
|
213
|
-
* @description: Get
|
|
240
|
+
* @summary: List bags
|
|
241
|
+
* @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
214
242
|
*/
|
|
215
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
243
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
|
|
216
244
|
/**
|
|
217
245
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
218
246
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
219
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
-
* @returns {Promise<OrderPlatformModel.
|
|
221
|
-
* Success response
|
|
248
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
|
|
249
|
+
* - Success response
|
|
250
|
+
*
|
|
222
251
|
* @name getBulkActionTemplate
|
|
223
|
-
* @summary:
|
|
252
|
+
* @summary: List supported templates
|
|
224
253
|
* @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
|
|
225
254
|
*/
|
|
226
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
255
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
|
|
227
256
|
/**
|
|
228
257
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
229
258
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
230
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
231
|
-
* @returns {Promise<OrderPlatformModel.
|
|
260
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
232
261
|
* @name getBulkShipmentExcelFile
|
|
233
|
-
* @summary:
|
|
262
|
+
* @summary: Generate the report
|
|
234
263
|
* @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
235
264
|
*/
|
|
236
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
265
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
237
266
|
/**
|
|
238
|
-
* @param {OrderPlatformValidator.
|
|
267
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
239
268
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
240
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
241
|
-
* @returns {Promise<OrderPlatformModel.
|
|
242
|
-
* @name
|
|
243
|
-
* @summary: Get
|
|
244
|
-
* @description:
|
|
270
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
271
|
+
* @name getChannelConfig
|
|
272
|
+
* @summary: Get channel configuration
|
|
273
|
+
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
245
274
|
*/
|
|
246
|
-
|
|
275
|
+
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
247
276
|
/**
|
|
248
277
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
249
278
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
250
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
|
-
* @returns {Promise<OrderPlatformModel.
|
|
280
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
|
|
252
281
|
* @name getFileByStatus
|
|
253
|
-
* @summary:
|
|
282
|
+
* @summary: Download file used for Bulk operation
|
|
254
283
|
* @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
|
|
255
284
|
*/
|
|
256
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
285
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
|
|
257
286
|
/**
|
|
258
|
-
* @param {OrderPlatformValidator.
|
|
287
|
+
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
259
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
260
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
|
-
* @returns {Promise<OrderPlatformModel.
|
|
262
|
-
* @name
|
|
263
|
-
* @summary: Get
|
|
264
|
-
* @description: Get
|
|
290
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
|
|
291
|
+
* @name getLaneConfig
|
|
292
|
+
* @summary: Get lane configuration
|
|
293
|
+
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
265
294
|
*/
|
|
266
|
-
|
|
295
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponseSchema>;
|
|
267
296
|
/**
|
|
268
|
-
* @param {OrderPlatformValidator.
|
|
297
|
+
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
269
298
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
-
* @returns {Promise<OrderPlatformModel.
|
|
272
|
-
* @name
|
|
273
|
-
* @summary: Get
|
|
274
|
-
* @description: Get
|
|
300
|
+
* @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
|
|
301
|
+
* @name getManifestDetails
|
|
302
|
+
* @summary: Get a manifest
|
|
303
|
+
* @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
304
|
+
*/
|
|
305
|
+
getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
306
|
+
/**
|
|
307
|
+
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
308
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
309
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
|
+
* @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
|
|
311
|
+
* @name getManifestShipments
|
|
312
|
+
* @summary: List manifest shipments
|
|
313
|
+
* @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
|
|
275
314
|
*/
|
|
276
|
-
|
|
315
|
+
getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
|
|
277
316
|
/**
|
|
278
317
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
279
318
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
319
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
-
* @returns {Promise<OrderPlatformModel.
|
|
320
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
|
|
321
|
+
* Success response
|
|
282
322
|
* @name getManifestfilters
|
|
283
|
-
* @summary:
|
|
284
|
-
* @description:
|
|
323
|
+
* @summary: List filters
|
|
324
|
+
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
325
|
+
*/
|
|
326
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
|
|
327
|
+
/**
|
|
328
|
+
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
329
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
|
+
* @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
|
|
332
|
+
* @name getManifests
|
|
333
|
+
* @summary: List manifests
|
|
334
|
+
* @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
|
|
285
335
|
*/
|
|
286
|
-
|
|
336
|
+
getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
|
|
287
337
|
/**
|
|
288
338
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
289
339
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
290
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
|
-
* @returns {Promise<OrderPlatformModel.
|
|
341
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
|
|
342
|
+
* Success response
|
|
292
343
|
* @name getOrderById
|
|
293
|
-
* @summary: Get order
|
|
294
|
-
* @description:
|
|
344
|
+
* @summary: Get order
|
|
345
|
+
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
295
346
|
*/
|
|
296
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
347
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
|
|
297
348
|
/**
|
|
298
349
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
299
350
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
300
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
|
-
* @returns {Promise<OrderPlatformModel.
|
|
352
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
|
|
353
|
+
* Success response
|
|
302
354
|
* @name getOrders
|
|
303
|
-
* @summary:
|
|
304
|
-
* @description: Get
|
|
355
|
+
* @summary: List orders
|
|
356
|
+
* @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
305
357
|
*/
|
|
306
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType,
|
|
358
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
|
|
307
359
|
/**
|
|
308
360
|
* @param {Object} arg - Arg object.
|
|
309
361
|
* @param {string} [arg.lane] - Lane refers to a section where orders are
|
|
310
|
-
* assigned, indicating its grouping
|
|
362
|
+
* assigned, indicating its grouping.
|
|
311
363
|
* @param {string} [arg.searchType] - Search_type refers to the field that
|
|
312
|
-
* will be used as the target for the search operation
|
|
313
|
-
* @param {string} [arg.bagStatus] - Bag_status refers to
|
|
364
|
+
* will be used as the target for the search operation.
|
|
365
|
+
* @param {string} [arg.bagStatus] - Bag_status refers to status of the
|
|
314
366
|
* entity. Filters orders based on the status.
|
|
315
|
-
* @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
|
|
367
|
+
* @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
|
|
316
368
|
* estimated SLA time.
|
|
317
|
-
* @param {string} [arg.paymentMethods] -
|
|
318
|
-
*
|
|
369
|
+
* @param {string} [arg.paymentMethods] - Comma separated values of payment
|
|
370
|
+
* methods that were used to place order.
|
|
371
|
+
* @param {string} [arg.tags] - Tags refers to additional descriptive labels
|
|
319
372
|
* associated with the order
|
|
320
373
|
* @param {string} [arg.searchValue] - Search_value is matched against the
|
|
321
374
|
* field specified by the search_type
|
|
322
|
-
* @param {string} [arg.fromDate] -
|
|
323
|
-
* @param {string} [arg.toDate] -
|
|
324
|
-
* @param {string} [arg.startDate] -
|
|
325
|
-
* @param {string} [arg.endDate] -
|
|
375
|
+
* @param {string} [arg.fromDate] - Date time in UTC timezone as per ISO format.
|
|
376
|
+
* @param {string} [arg.toDate] - Date time in UTC timezone as per ISO format.
|
|
377
|
+
* @param {string} [arg.startDate] - Date time in UTC timezone as per ISO format.
|
|
378
|
+
* @param {string} [arg.endDate] - Date time in UTC timezone as per ISO format.
|
|
326
379
|
* @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
327
|
-
* @param {string} [arg.stores] -
|
|
328
|
-
*
|
|
329
|
-
* @param {
|
|
380
|
+
* @param {string} [arg.stores] - A comma-separated list of store IDs used
|
|
381
|
+
* to filter results to only those related to specific stores.
|
|
382
|
+
* @param {string} [arg.salesChannels] - A comma-separated list of sales
|
|
383
|
+
* channel IDs to filter results based on the sales channels involved.
|
|
384
|
+
* @param {number} [arg.pageSize] - Determines the number of results
|
|
385
|
+
* returned per page.
|
|
330
386
|
* @param {boolean} [arg.isPrioritySort] -
|
|
331
|
-
* @param {
|
|
387
|
+
* @param {string} [arg.customMeta] -
|
|
332
388
|
* @param {boolean} [arg.myOrders] -
|
|
333
389
|
* @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
|
|
334
390
|
* non-cross company order
|
|
335
|
-
* @param {string} [arg.customerId] -
|
|
391
|
+
* @param {string} [arg.customerId] - The unique identifier for the customer
|
|
392
|
+
* associated with the query, useful for filtering results to a specific customer.
|
|
336
393
|
* @param {string} [arg.orderType] -
|
|
337
|
-
* @param {
|
|
338
|
-
*
|
|
339
|
-
* operational statuses.
|
|
340
|
-
* @param {string} [arg.financialStatus] - Statuses relating to finance
|
|
341
|
-
* related operations in the order processing journey. Comma separated
|
|
342
|
-
* values of financial statuses.
|
|
343
|
-
* @param {string} [arg.logisticsStatus] - Statuses relating to delivery and
|
|
344
|
-
* pickup related operations in the order processing journey. Comma
|
|
345
|
-
* separated values of logistics statuses.
|
|
346
|
-
* @param {string} [arg.parentViewSlug] - Parent view is used for grouping
|
|
347
|
-
* of child views. Slug of parent view.
|
|
348
|
-
* @param {string} [arg.childViewSlug] - Child view is user configured view,
|
|
349
|
-
* which has filters added by the user on which shipments/orders are
|
|
350
|
-
* fetched. Slug of child view.
|
|
394
|
+
* @param {boolean} [arg.allowInactive] - Flag indicating whether inactive
|
|
395
|
+
* shipments are allowed
|
|
351
396
|
* @param {string} [arg.groupEntity] - Defines the grouping criterion for
|
|
352
397
|
* retrieving shipments or orders. It specifies whether the results should
|
|
353
398
|
* be organized based on shipment groups or order groups. For example,
|
|
354
399
|
* using 'shipments' groups results by shipment, while an invalid value
|
|
355
400
|
* like 'abcd' may not be recognized, leading to errors or default behavior.
|
|
356
|
-
* @
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
|
|
360
|
-
|
|
401
|
+
* @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
|
|
402
|
+
* listing orders. This is useful when fetching data for a specific date
|
|
403
|
+
* range while performing searches.
|
|
404
|
+
* @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
|
|
405
|
+
* Listing Orders, This is use when we want to get list of shipments or
|
|
406
|
+
* orders by cross store or cross company or fulfilling Store (by
|
|
407
|
+
* default), this is also depends on the login user accessType and store access
|
|
408
|
+
* @returns {Paginator<OrderPlatformModel.OrderListingResponseSchema>}
|
|
409
|
+
* @summary: List orders
|
|
410
|
+
* @description: Get a list of orders based on the filters provided.
|
|
411
|
+
*/
|
|
412
|
+
getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, }?: {
|
|
361
413
|
lane?: string;
|
|
362
414
|
searchType?: string;
|
|
363
415
|
bagStatus?: string;
|
|
@@ -374,177 +426,159 @@ declare class Order {
|
|
|
374
426
|
salesChannels?: string;
|
|
375
427
|
pageSize?: number;
|
|
376
428
|
isPrioritySort?: boolean;
|
|
377
|
-
customMeta?:
|
|
429
|
+
customMeta?: string;
|
|
378
430
|
myOrders?: boolean;
|
|
379
431
|
showCrossCompanyData?: boolean;
|
|
380
432
|
customerId?: string;
|
|
381
433
|
orderType?: string;
|
|
382
|
-
|
|
383
|
-
financialStatus?: string;
|
|
384
|
-
logisticsStatus?: string;
|
|
385
|
-
parentViewSlug?: string;
|
|
386
|
-
childViewSlug?: string;
|
|
434
|
+
allowInactive?: boolean;
|
|
387
435
|
groupEntity?: string;
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
392
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
|
-
* @returns {Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>}
|
|
394
|
-
* - Success response
|
|
395
|
-
*
|
|
396
|
-
* @name getRefundConfiguration
|
|
397
|
-
* @summary: refund configuration.
|
|
398
|
-
* @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundConfiguration/).
|
|
399
|
-
*/
|
|
400
|
-
getRefundConfiguration({ appId, requestHeaders }?: OrderPlatformValidator.GetRefundConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>;
|
|
401
|
-
/**
|
|
402
|
-
* @param {OrderPlatformValidator.GetRefundEnableStateListParam} arg - Arg object
|
|
403
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
404
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
|
-
* @returns {Promise<OrderPlatformModel.GetRefundStates>} - Success response
|
|
406
|
-
* @name getRefundEnableStateList
|
|
407
|
-
* @summary: Refund State Configurationb
|
|
408
|
-
* @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundEnableStateList/).
|
|
409
|
-
*/
|
|
410
|
-
getRefundEnableStateList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetRefundStates>;
|
|
411
|
-
/**
|
|
412
|
-
* @param {OrderPlatformValidator.GetRefundOptionsParam} arg - Arg object
|
|
413
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
414
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
415
|
-
* @returns {Promise<OrderPlatformModel.RefundOptionsSchemaResponse>} -
|
|
416
|
-
* Success response
|
|
417
|
-
* @name getRefundOptions
|
|
418
|
-
* @summary: Retrieve refund options with amount breakup for specific shipment and bags.
|
|
419
|
-
* @description: This API can be used for giving the refund amount with available option of MOPs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundOptions/).
|
|
420
|
-
*/
|
|
421
|
-
getRefundOptions({ shipmentId, bagIds, state, optinAppId, optinCompanyId, status, requestHeaders, }?: OrderPlatformValidator.GetRefundOptionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundOptionsSchemaResponse>;
|
|
422
|
-
/**
|
|
423
|
-
* @param {OrderPlatformValidator.GetRefundStateConfigurationParam} arg - Arg object
|
|
424
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
425
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
426
|
-
* @returns {Promise<OrderPlatformModel.GetRefundStateConfigurationResponse>}
|
|
427
|
-
* - Success response
|
|
428
|
-
*
|
|
429
|
-
* @name getRefundStateConfiguration
|
|
430
|
-
* @summary: Refund State Configuration
|
|
431
|
-
* @description: Refund State Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundStateConfiguration/).
|
|
432
|
-
*/
|
|
433
|
-
getRefundStateConfiguration({ appId, requestHeaders }?: OrderPlatformValidator.GetRefundStateConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetRefundStateConfigurationResponse>;
|
|
436
|
+
enforceDateFilter?: boolean;
|
|
437
|
+
fulfillmentType?: string;
|
|
438
|
+
}): Paginator<OrderPlatformModel.OrderListingResponseSchema>;
|
|
434
439
|
/**
|
|
435
440
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
436
441
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
437
442
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
|
-
* @returns {Promise<OrderPlatformModel.
|
|
443
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
|
|
439
444
|
* @name getRoleBasedActions
|
|
440
|
-
* @summary: Get role-based actions
|
|
445
|
+
* @summary: Get role-based actions
|
|
441
446
|
* @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
442
447
|
*/
|
|
443
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
448
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
|
|
444
449
|
/**
|
|
445
450
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
446
451
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
452
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
|
-
* @returns {Promise<OrderPlatformModel.
|
|
453
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
|
|
454
|
+
* Success response
|
|
449
455
|
* @name getShipmentById
|
|
450
|
-
* @summary: Get shipment
|
|
451
|
-
* @description:
|
|
456
|
+
* @summary: Get shipment details
|
|
457
|
+
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
452
458
|
*/
|
|
453
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
459
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
|
|
454
460
|
/**
|
|
455
461
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
456
462
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
457
463
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
|
-
* @returns {Promise<OrderPlatformModel.
|
|
464
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
465
|
+
* Success response
|
|
459
466
|
* @name getShipmentHistory
|
|
460
|
-
* @summary: Get shipment history
|
|
461
|
-
* @description:
|
|
467
|
+
* @summary: Get a shipment's history
|
|
468
|
+
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
462
469
|
*/
|
|
463
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
470
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
464
471
|
/**
|
|
465
472
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
466
473
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
467
474
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
|
-
* @returns {Promise<OrderPlatformModel.
|
|
469
|
-
* Success response
|
|
475
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
|
|
476
|
+
* - Success response
|
|
477
|
+
*
|
|
470
478
|
* @name getShipmentReasons
|
|
471
|
-
* @summary:
|
|
472
|
-
* @description:
|
|
479
|
+
* @summary: List bag cancellation reasons
|
|
480
|
+
* @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
|
|
473
481
|
*/
|
|
474
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
482
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
|
|
475
483
|
/**
|
|
476
484
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
477
485
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
478
486
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
479
|
-
* @returns {Promise<OrderPlatformModel.
|
|
487
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
480
488
|
* - Success response
|
|
481
489
|
*
|
|
482
490
|
* @name getShipments
|
|
483
|
-
* @summary:
|
|
484
|
-
* @description: Get
|
|
491
|
+
* @summary: List shipments
|
|
492
|
+
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
485
493
|
*/
|
|
486
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType,
|
|
494
|
+
getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
487
495
|
/**
|
|
488
496
|
* @param {Object} arg - Arg object.
|
|
489
497
|
* @param {string} [arg.lane] - Name of lane for which data is to be fetched
|
|
490
|
-
* @param {string} [arg.bagStatus] - Comma separated values of bag statuses
|
|
498
|
+
* @param {string} [arg.bagStatus] - Comma separated values of bag statuses.
|
|
499
|
+
* @param {string} [arg.statusAssigned] - Used to filter shipments based on
|
|
500
|
+
* status present in shipment_status_history. For more information on
|
|
501
|
+
* these statuses, refer to the Fynd Partners documentation.
|
|
491
502
|
* @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
|
|
492
|
-
* bag_status and override lane
|
|
493
|
-
* @param {number} [arg.timeToDispatch] -
|
|
494
|
-
* @param {string} [arg.searchType] -
|
|
495
|
-
*
|
|
503
|
+
* bag_status and override lane.
|
|
504
|
+
* @param {number} [arg.timeToDispatch] - Indicates the time to dispatch.
|
|
505
|
+
* @param {string} [arg.searchType] - Specifies the key used to determine
|
|
506
|
+
* the type of search being performed.
|
|
507
|
+
* @param {string} [arg.searchValue] - The value corresponding to the search
|
|
508
|
+
* type, such as a specific shipment ID or order ID.
|
|
496
509
|
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
497
510
|
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
498
|
-
* @param {string} [arg.startDate] - UTC
|
|
499
|
-
*
|
|
500
|
-
* @param {string} [arg.
|
|
501
|
-
*
|
|
502
|
-
* @param {string} [arg.
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
* @param {string} [arg.
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
* @param {string} [arg.
|
|
512
|
-
*
|
|
513
|
-
* @param {
|
|
514
|
-
*
|
|
515
|
-
* @param {string} [arg.
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
*
|
|
519
|
-
* @param {
|
|
520
|
-
*
|
|
521
|
-
* @param {
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
* @param {
|
|
511
|
+
* @param {string} [arg.startDate] - The UTC start date in ISO format
|
|
512
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
513
|
+
* @param {string} [arg.endDate] - The UTC end date in ISO format
|
|
514
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
515
|
+
* @param {string} [arg.statusAssignedStartDate] - Specifies the starting
|
|
516
|
+
* UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the
|
|
517
|
+
* lower boundary for filtering shipments based on the `created_at`
|
|
518
|
+
* timestamp of statuses in the shipment's status history. It allows
|
|
519
|
+
* filtering statuses that were created within a specific time range.
|
|
520
|
+
* @param {string} [arg.statusAssignedEndDate] - Specifies the ending UTC
|
|
521
|
+
* date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper
|
|
522
|
+
* boundary for filtering shipments based on the `created_at` timestamp of
|
|
523
|
+
* statuses in the shipment's status history.
|
|
524
|
+
* @param {string} [arg.dpIds] - A comma-separated list of delivery partner
|
|
525
|
+
* IDs to filter results by specific delivery partners.
|
|
526
|
+
* @param {string} [arg.stores] - A comma-separated list of store IDs used
|
|
527
|
+
* to filter results to only those related to specific stores.
|
|
528
|
+
* @param {string} [arg.salesChannels] - A comma-separated list of sales
|
|
529
|
+
* channel IDs to filter results based on the sales channels involved.
|
|
530
|
+
* @param {number} [arg.pageSize] - Determines the number of results
|
|
531
|
+
* returned per page.
|
|
532
|
+
* @param {boolean} [arg.fetchActiveShipment] - A boolean flag that
|
|
533
|
+
* indicates whether to include only active shipments in the results.
|
|
534
|
+
* @param {boolean} [arg.allowInactive] - A flag indicating whether to allow
|
|
535
|
+
* the inclusion of inactive shipments in the results.
|
|
536
|
+
* @param {boolean} [arg.excludeLockedShipments] - A flag to specify whether
|
|
537
|
+
* to exclude shipments that are locked from the results.
|
|
538
|
+
* @param {string} [arg.paymentMethods] - A comma-separated list of payment methods.
|
|
539
|
+
* @param {string} [arg.channelShipmentId] - The shipment ID used in the
|
|
540
|
+
* application, which can be used to reference specific shipments.
|
|
541
|
+
* @param {string} [arg.channelOrderId] - The order ID used in the application.
|
|
542
|
+
* @param {string} [arg.customMeta] - Custom metadata associated with the
|
|
543
|
+
* query, allowing for additional filtering or information to be passed.
|
|
544
|
+
* @param {string} [arg.orderingChannel] - The channel through which the
|
|
545
|
+
* order was placed.
|
|
546
|
+
* @param {string} [arg.companyAffiliateTag] - A tag used to identify the
|
|
547
|
+
* company's affiliation for filtering or reporting purposes.
|
|
548
|
+
* @param {boolean} [arg.myOrders] - A boolean flag indicating whether the
|
|
549
|
+
* query should return only the user's orders.
|
|
550
|
+
* @param {string} [arg.platformUserId] - The unique identifier of the user
|
|
551
|
+
* on the platform, useful for filtering orders related to a specific user.
|
|
552
|
+
* @param {string} [arg.sortType] - Determines the sorting order of the
|
|
553
|
+
* results based on specific criteria.
|
|
554
|
+
* @param {boolean} [arg.showCrossCompanyData] - A flag indicating whether
|
|
555
|
+
* to include data from both cross-company and non-cross-company orders in
|
|
556
|
+
* the results.
|
|
557
|
+
* @param {string} [arg.tags] - A comma-separated list of tags associated
|
|
558
|
+
* with the orders to filter results based on specific characteristics.
|
|
559
|
+
* @param {string} [arg.customerId] - The unique identifier for the customer
|
|
560
|
+
* associated with the query, useful for filtering results to a specific customer.
|
|
561
|
+
* @param {string} [arg.orderType] - The type of order being queried.
|
|
536
562
|
* @param {string} [arg.groupEntity] - Defines the grouping criterion for
|
|
537
563
|
* retrieving shipments or orders. It specifies whether the results should
|
|
538
564
|
* be organized based on shipment groups or order groups. For example,
|
|
539
565
|
* using 'shipments' groups results by shipment, while an invalid value
|
|
540
566
|
* like 'abcd' may not be recognized, leading to errors or default behavior.
|
|
541
|
-
* @
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
|
|
545
|
-
|
|
567
|
+
* @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
|
|
568
|
+
* listing shipments. This is useful when fetching data for a specific
|
|
569
|
+
* date range while performing searches.
|
|
570
|
+
* @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
|
|
571
|
+
* Listing Orders, This is use when we want to get list of shipments or
|
|
572
|
+
* orders by cross store or cross company or fulfilling Store (by
|
|
573
|
+
* default), this is also depends on the login user accessType and store access
|
|
574
|
+
* @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
575
|
+
* @summary: List shipments
|
|
576
|
+
* @description: Get a list of shipments based on the filters provided
|
|
577
|
+
*/
|
|
578
|
+
getShipmentsPaginator({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, }?: {
|
|
546
579
|
lane?: string;
|
|
547
580
|
bagStatus?: string;
|
|
581
|
+
statusAssigned?: string;
|
|
548
582
|
statusOverrideLane?: boolean;
|
|
549
583
|
timeToDispatch?: number;
|
|
550
584
|
searchType?: string;
|
|
@@ -553,6 +587,8 @@ declare class Order {
|
|
|
553
587
|
toDate?: string;
|
|
554
588
|
startDate?: string;
|
|
555
589
|
endDate?: string;
|
|
590
|
+
statusAssignedStartDate?: string;
|
|
591
|
+
statusAssignedEndDate?: string;
|
|
556
592
|
dpIds?: string;
|
|
557
593
|
stores?: string;
|
|
558
594
|
salesChannels?: string;
|
|
@@ -573,21 +609,29 @@ declare class Order {
|
|
|
573
609
|
tags?: string;
|
|
574
610
|
customerId?: string;
|
|
575
611
|
orderType?: string;
|
|
576
|
-
operationalStatus?: string;
|
|
577
|
-
financialStatus?: string;
|
|
578
|
-
logisticsStatus?: string;
|
|
579
|
-
parentViewSlug?: string;
|
|
580
|
-
childViewSlug?: string;
|
|
581
|
-
lockStatus?: string;
|
|
582
612
|
groupEntity?: string;
|
|
583
|
-
|
|
613
|
+
enforceDateFilter?: boolean;
|
|
614
|
+
fulfillmentType?: string;
|
|
615
|
+
}): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
616
|
+
/**
|
|
617
|
+
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
618
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
|
+
* @returns {Promise<Object>} - Success response
|
|
621
|
+
* @name getStateManagerConfig
|
|
622
|
+
* @summary: Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
|
|
623
|
+
* @description: This endpoint retrieves the ESM (Entity State Manager) configuration for a specific application within a company. The retrieval is based on parameters such as application ID, ordering channel, and entity type.
|
|
624
|
+
* The ESM config stores order processing configuration. Each document in the ESM config collection of Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions. This configuration is picked and accordingly features are enabled.
|
|
625
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
|
|
626
|
+
*/
|
|
627
|
+
getStateManagerConfig({ appId, orderingChannel, orderingSource, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
|
|
584
628
|
/**
|
|
585
629
|
* @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
|
|
586
630
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
587
631
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
588
632
|
* @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
|
|
589
633
|
* @name getStateTransitionMap
|
|
590
|
-
* @summary: Get state transition map
|
|
634
|
+
* @summary: Get state transition map
|
|
591
635
|
* @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
|
|
592
636
|
*/
|
|
593
637
|
getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
|
|
@@ -595,53 +639,45 @@ declare class Order {
|
|
|
595
639
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
596
640
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
597
641
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
598
|
-
* @returns {Promise<OrderPlatformModel.
|
|
642
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
|
|
643
|
+
* Success response
|
|
599
644
|
* @name getTemplate
|
|
600
|
-
* @summary:
|
|
601
|
-
* @description: Get the
|
|
602
|
-
*/
|
|
603
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
604
|
-
/**
|
|
605
|
-
* @param {OrderPlatformValidator.GetUserViewsParam} arg - Arg object
|
|
606
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
607
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
608
|
-
* @returns {Promise<OrderPlatformModel.UserViewsResponse>} - Success response
|
|
609
|
-
* @name getUserViews
|
|
610
|
-
* @summary: Get custom view for every unique user cross company pair.
|
|
611
|
-
* @description: Get custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getUserViews/).
|
|
645
|
+
* @summary: Download bulk operation templates
|
|
646
|
+
* @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
|
|
612
647
|
*/
|
|
613
|
-
|
|
648
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
|
|
614
649
|
/**
|
|
615
650
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
616
651
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
617
652
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
618
|
-
* @returns {Promise<OrderPlatformModel.
|
|
653
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
|
|
619
654
|
* @name getfilters
|
|
620
|
-
* @summary:
|
|
655
|
+
* @summary: List filters
|
|
621
656
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
622
657
|
*/
|
|
623
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
658
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
|
|
624
659
|
/**
|
|
625
660
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
626
661
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
627
662
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
628
|
-
* @returns {Promise<OrderPlatformModel.
|
|
629
|
-
* Success response
|
|
663
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
|
|
664
|
+
* - Success response
|
|
665
|
+
*
|
|
630
666
|
* @name invalidateShipmentCache
|
|
631
667
|
* @summary: Invalidate shipment cache
|
|
632
668
|
* @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
633
669
|
*/
|
|
634
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
670
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
|
|
635
671
|
/**
|
|
636
672
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
637
673
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
638
674
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
639
|
-
* @returns {Promise<OrderPlatformModel.
|
|
675
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
|
|
640
676
|
* @name jobDetails
|
|
641
|
-
* @summary:
|
|
642
|
-
* @description: Fetches details
|
|
677
|
+
* @summary: Get bulk operation details
|
|
678
|
+
* @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
|
|
643
679
|
*/
|
|
644
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
680
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
|
|
645
681
|
/**
|
|
646
682
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
647
683
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -652,126 +688,105 @@ declare class Order {
|
|
|
652
688
|
* @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
|
|
653
689
|
*/
|
|
654
690
|
orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
|
|
655
|
-
/**
|
|
656
|
-
* @param {OrderPlatformValidator.PostRefundConfigurationParam} arg - Arg object
|
|
657
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
658
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
659
|
-
* @returns {Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>}
|
|
660
|
-
* - Success response
|
|
661
|
-
*
|
|
662
|
-
* @name postRefundConfiguration
|
|
663
|
-
* @summary: refund configuration.
|
|
664
|
-
* @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postRefundConfiguration/).
|
|
665
|
-
*/
|
|
666
|
-
postRefundConfiguration({ appId, body, requestHeaders }?: OrderPlatformValidator.PostRefundConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>;
|
|
667
|
-
/**
|
|
668
|
-
* @param {OrderPlatformValidator.PostRefundStateConfigurationParam} arg - Arg object
|
|
669
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
670
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
671
|
-
* @returns {Promise<OrderPlatformModel.PostRefundStateConfigurationResponse>}
|
|
672
|
-
* - Success response
|
|
673
|
-
*
|
|
674
|
-
* @name postRefundStateConfiguration
|
|
675
|
-
* @summary: Refund State Configuration
|
|
676
|
-
* @description: Refund State Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postRefundStateConfiguration/).
|
|
677
|
-
*/
|
|
678
|
-
postRefundStateConfiguration({ appId, body, requestHeaders }?: OrderPlatformValidator.PostRefundStateConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PostRefundStateConfigurationResponse>;
|
|
679
691
|
/**
|
|
680
692
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
681
693
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
682
694
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
683
|
-
* @returns {Promise<OrderPlatformModel.
|
|
695
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
696
|
+
* Success response
|
|
684
697
|
* @name postShipmentHistory
|
|
685
|
-
* @summary:
|
|
686
|
-
* @description:
|
|
698
|
+
* @summary: Create shipment history
|
|
699
|
+
* @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
687
700
|
*/
|
|
688
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
701
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
689
702
|
/**
|
|
690
703
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
691
704
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
692
705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
693
|
-
* @returns {Promise<OrderPlatformModel.
|
|
706
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
|
|
707
|
+
* Success response
|
|
694
708
|
* @name reassignLocation
|
|
695
|
-
* @summary: Reassign location
|
|
696
|
-
* @description:
|
|
709
|
+
* @summary: Reassign location
|
|
710
|
+
* @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
|
|
697
711
|
*/
|
|
698
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
712
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
|
|
699
713
|
/**
|
|
700
714
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
701
715
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
702
716
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
703
|
-
* @returns {Promise<OrderPlatformModel.
|
|
717
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
704
718
|
* @name sendSmsNinja
|
|
705
|
-
* @summary: Send SMS
|
|
719
|
+
* @summary: Send SMS
|
|
706
720
|
* @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
707
721
|
*/
|
|
708
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
722
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
709
723
|
/**
|
|
710
724
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
711
725
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
712
726
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
713
|
-
* @returns {Promise<OrderPlatformModel.
|
|
727
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
|
|
728
|
+
* Success response
|
|
714
729
|
* @name sendUserMobileOTP
|
|
715
|
-
* @summary: Send user mobile OTP
|
|
716
|
-
* @description: Send a one-time OTP to a
|
|
730
|
+
* @summary: Send user mobile OTP
|
|
731
|
+
* @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
|
|
717
732
|
*/
|
|
718
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
733
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
|
|
719
734
|
/**
|
|
720
735
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
721
736
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
722
737
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
723
|
-
* @returns {Promise<OrderPlatformModel.
|
|
724
|
-
* Success response
|
|
738
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
|
|
739
|
+
* - Success response
|
|
740
|
+
*
|
|
725
741
|
* @name trackShipment
|
|
726
|
-
* @summary:
|
|
727
|
-
* @description: Retrieve courier partner tracking details for a given shipment
|
|
742
|
+
* @summary: Track shipment
|
|
743
|
+
* @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
|
|
728
744
|
*/
|
|
729
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
745
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
|
|
730
746
|
/**
|
|
731
|
-
* @param {OrderPlatformValidator.
|
|
747
|
+
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
732
748
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
733
749
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
|
-
* @returns {Promise<OrderPlatformModel.
|
|
735
|
-
* @name
|
|
736
|
-
* @summary:
|
|
737
|
-
* @description:
|
|
750
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
751
|
+
* @name updateAddress
|
|
752
|
+
* @summary: Update shipment address
|
|
753
|
+
* @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
738
754
|
*/
|
|
739
|
-
|
|
755
|
+
updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
740
756
|
/**
|
|
741
757
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
742
758
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
743
759
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
|
-
* @returns {Promise<OrderPlatformModel.
|
|
760
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
|
|
745
761
|
* - Success response
|
|
746
762
|
*
|
|
747
763
|
* @name updatePackagingDimensions
|
|
748
|
-
* @summary: Update packaging dimensions
|
|
749
|
-
* @description:
|
|
764
|
+
* @summary: Update packaging dimensions
|
|
765
|
+
* @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
750
766
|
*/
|
|
751
|
-
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
767
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
|
|
752
768
|
/**
|
|
753
|
-
* @param {OrderPlatformValidator.
|
|
769
|
+
* @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
|
|
754
770
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
755
771
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
756
|
-
* @returns {Promise<
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
* @
|
|
760
|
-
* @summary: Update shipment status.
|
|
761
|
-
* @description: Shipment action transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipment/).
|
|
772
|
+
* @returns {Promise<Object>} - Success response
|
|
773
|
+
* @name updatePaymentInfo
|
|
774
|
+
* @summary: Update payment details for an order, its shipments and its bags.
|
|
775
|
+
* @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
|
|
762
776
|
*/
|
|
763
|
-
|
|
777
|
+
updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
|
|
764
778
|
/**
|
|
765
779
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
766
780
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
781
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
|
-
* @returns {Promise<OrderPlatformModel.
|
|
769
|
-
* Success response
|
|
782
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
|
|
783
|
+
* - Success response
|
|
784
|
+
*
|
|
770
785
|
* @name updateShipmentLock
|
|
771
|
-
* @summary: Update shipment lock
|
|
772
|
-
* @description: Modify shipment/bag lock and
|
|
786
|
+
* @summary: Update a shipment lock
|
|
787
|
+
* @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
773
788
|
*/
|
|
774
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
789
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
|
|
775
790
|
/**
|
|
776
791
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
777
792
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -780,8 +795,8 @@ declare class Order {
|
|
|
780
795
|
* - Success response
|
|
781
796
|
*
|
|
782
797
|
* @name updateShipmentStatus
|
|
783
|
-
* @summary: Update shipment status
|
|
784
|
-
* @description:
|
|
798
|
+
* @summary: Update a shipment's status
|
|
799
|
+
* @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
|
|
785
800
|
*/
|
|
786
801
|
updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
|
|
787
802
|
/**
|
|
@@ -791,42 +806,30 @@ declare class Order {
|
|
|
791
806
|
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
|
|
792
807
|
* Success response
|
|
793
808
|
* @name updateShipmentTracking
|
|
794
|
-
* @summary: Update shipment tracking
|
|
795
|
-
* @description: Modify courier partner tracking details for a given shipment
|
|
809
|
+
* @summary: Update shipment tracking
|
|
810
|
+
* @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
|
|
796
811
|
*/
|
|
797
812
|
updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
|
|
798
813
|
/**
|
|
799
|
-
* @param {OrderPlatformValidator.
|
|
800
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
801
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
802
|
-
* @returns {Promise<OrderPlatformModel.CreateUpdateDeleteResponse>} -
|
|
803
|
-
* Success response
|
|
804
|
-
* @name updateUserViewPosition
|
|
805
|
-
* @summary: Update User view(Parent view and child view) position
|
|
806
|
-
* @description: Update User view(Parent view and child view) position - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateUserViewPosition/).
|
|
807
|
-
*/
|
|
808
|
-
updateUserViewPosition({ body, requestHeaders }?: OrderPlatformValidator.UpdateUserViewPositionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateUpdateDeleteResponse>;
|
|
809
|
-
/**
|
|
810
|
-
* @param {OrderPlatformValidator.UpdateUserViewsParam} arg - Arg object
|
|
814
|
+
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
811
815
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
812
816
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
|
-
* @returns {Promise<OrderPlatformModel.
|
|
814
|
-
*
|
|
815
|
-
* @
|
|
816
|
-
* @
|
|
817
|
-
* @description: Update custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateUserViews/).
|
|
817
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
818
|
+
* @name uploadConsents
|
|
819
|
+
* @summary: Upload consent
|
|
820
|
+
* @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
818
821
|
*/
|
|
819
|
-
|
|
822
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
820
823
|
/**
|
|
821
824
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
822
825
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
823
826
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
824
|
-
* @returns {Promise<OrderPlatformModel.
|
|
827
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
|
|
825
828
|
* @name verifyMobileOTP
|
|
826
|
-
* @summary: Verify
|
|
827
|
-
* @description:
|
|
829
|
+
* @summary: Verify mobile OTP
|
|
830
|
+
* @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
|
|
828
831
|
*/
|
|
829
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
832
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
|
|
830
833
|
}
|
|
831
834
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
832
835
|
import OrderPlatformModel = require("./OrderPlatformModel");
|