@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -4,26 +4,33 @@ export = CatalogPlatformApplicationValidator;
|
|
|
4
4
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
5
5
|
* @property {CatalogPlatformModel.CollectionItemUpdateSchema} body
|
|
6
6
|
*/
|
|
7
|
+
/**
|
|
8
|
+
* @typedef AddProductsInPriceFactoryByZoneIdParam
|
|
9
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
10
|
+
* @property {CatalogPlatformModel.CreatePriceFactoryProductRequest} body
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef ClearCollectionItemsPriorityParam
|
|
14
|
+
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
15
|
+
*/
|
|
7
16
|
/**
|
|
8
17
|
* @typedef CreateAppCategoryReturnConfigurationParam
|
|
9
18
|
* @property {CatalogPlatformModel.BaseAppCategoryReturnConfig} body
|
|
10
19
|
*/
|
|
20
|
+
/**
|
|
21
|
+
* @typedef CreateAppPriceFactoryParam
|
|
22
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryRequestSchema} body
|
|
23
|
+
*/
|
|
11
24
|
/**
|
|
12
25
|
* @typedef CreateAppReturnConfigurationParam
|
|
13
26
|
* @property {CatalogPlatformModel.CreateUpdateAppReturnConfig} body
|
|
14
27
|
*/
|
|
28
|
+
/**
|
|
29
|
+
* @typedef CreateAutocompleteSettingsParam
|
|
30
|
+
* @property {CatalogPlatformModel.AutocompleteRequestSchema} body
|
|
31
|
+
*/
|
|
15
32
|
/**
|
|
16
33
|
* @typedef CreateCollectionParam
|
|
17
|
-
* @property {string} [q] - Get collection list filtered by q string,
|
|
18
|
-
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
19
|
-
* @property {string} [type] - Type of the collections
|
|
20
|
-
* @property {string[]} [tags] - Each response will contain next_id param, which
|
|
21
|
-
* should be sent back to make pagination work.
|
|
22
|
-
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
23
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
24
|
-
* set of results.
|
|
25
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
26
|
-
* Default is 12.
|
|
27
34
|
* @property {CatalogPlatformModel.CreateCollection} body
|
|
28
35
|
*/
|
|
29
36
|
/**
|
|
@@ -47,17 +54,58 @@ export = CatalogPlatformApplicationValidator;
|
|
|
47
54
|
* @typedef CreateGroupConfigurationParam
|
|
48
55
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
49
56
|
* particular group configuration type.
|
|
50
|
-
* @property {CatalogPlatformModel.
|
|
57
|
+
* @property {CatalogPlatformModel.AppConfigurationCreateDetail} body
|
|
51
58
|
*/
|
|
52
59
|
/**
|
|
53
60
|
* @typedef CreateListingConfigurationParam
|
|
54
61
|
* @property {string} configType - A `config_type` is a unique identifier for a
|
|
55
62
|
* particular listing configuration type.
|
|
56
|
-
* @property {CatalogPlatformModel.
|
|
63
|
+
* @property {CatalogPlatformModel.AppConfigurationsFilter} body
|
|
64
|
+
*/
|
|
65
|
+
/**
|
|
66
|
+
* @typedef CreateMerchandisingRuleBoostActionParam
|
|
67
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
68
|
+
* unique identifier for a particular merchandising rule.
|
|
69
|
+
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
70
|
+
*/
|
|
71
|
+
/**
|
|
72
|
+
* @typedef CreateMerchandisingRuleBuryActionParam
|
|
73
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
74
|
+
* unique identifier for a particular merchandising rule.
|
|
75
|
+
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
76
|
+
*/
|
|
77
|
+
/**
|
|
78
|
+
* @typedef CreateMerchandisingRuleHideActionParam
|
|
79
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
80
|
+
* unique identifier for a particular merchandising rule.
|
|
81
|
+
* @property {CatalogPlatformModel.HideRequest} body
|
|
82
|
+
*/
|
|
83
|
+
/**
|
|
84
|
+
* @typedef CreateMerchandisingRulePinActionParam
|
|
85
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
86
|
+
* unique identifier for a particular merchandising rule.
|
|
87
|
+
* @property {CatalogPlatformModel.PinRequest} body
|
|
88
|
+
*/
|
|
89
|
+
/**
|
|
90
|
+
* @typedef CreateMerchandisingRuleQueryParam
|
|
91
|
+
* @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
|
|
92
|
+
*/
|
|
93
|
+
/**
|
|
94
|
+
* @typedef CreateProductPriceFactoryBulkJobParam
|
|
95
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
96
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
57
97
|
*/
|
|
58
98
|
/**
|
|
59
99
|
* @typedef CreateSearchConfigurationParam
|
|
60
|
-
* @property {CatalogPlatformModel.
|
|
100
|
+
* @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
|
|
101
|
+
*/
|
|
102
|
+
/**
|
|
103
|
+
* @typedef CreateSearchRerankParam
|
|
104
|
+
* @property {CatalogPlatformModel.CreateSearchRerankRequest} body
|
|
105
|
+
*/
|
|
106
|
+
/**
|
|
107
|
+
* @typedef CreateSynonymsParam
|
|
108
|
+
* @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
|
|
61
109
|
*/
|
|
62
110
|
/**
|
|
63
111
|
* @typedef DeleteAppCategoryReturnConfigurationParam
|
|
@@ -86,18 +134,49 @@ export = CatalogPlatformApplicationValidator;
|
|
|
86
134
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
87
135
|
* particular configuration.
|
|
88
136
|
*/
|
|
137
|
+
/**
|
|
138
|
+
* @typedef DeleteMerchandisingRuleParam
|
|
139
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
140
|
+
* unique identifier for a particular merchandising rule.
|
|
141
|
+
*/
|
|
142
|
+
/**
|
|
143
|
+
* @typedef DeleteMerchandisingRulesPreviewParam
|
|
144
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
145
|
+
* unique identifier for a particular merchandising rule.
|
|
146
|
+
*/
|
|
89
147
|
/** @typedef DeleteSearchConfigurationParam */
|
|
90
148
|
/**
|
|
91
149
|
* @typedef DeleteSearchKeywordsParam
|
|
92
150
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
93
151
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
94
152
|
*/
|
|
153
|
+
/**
|
|
154
|
+
* @typedef DeleteSearchRerankConfigurationParam
|
|
155
|
+
* @property {string} id - An `id` is the identifier for a particular search
|
|
156
|
+
* rerank configuration. channel.
|
|
157
|
+
*/
|
|
158
|
+
/**
|
|
159
|
+
* @typedef DeleteSynonymParam
|
|
160
|
+
* @property {string} id - A `id` is a unique identifier of a synonym that is to
|
|
161
|
+
* be deleted.
|
|
162
|
+
*/
|
|
163
|
+
/**
|
|
164
|
+
* @typedef EditAppPriceFactoryParam
|
|
165
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
166
|
+
* @property {CatalogPlatformModel.EditAppPriceFactoryRequestSchema} body
|
|
167
|
+
*/
|
|
168
|
+
/**
|
|
169
|
+
* @typedef ExportProductsInPriceFactoryParam
|
|
170
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
171
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest} body
|
|
172
|
+
*/
|
|
173
|
+
/** @typedef ExportSynonymsParam */
|
|
95
174
|
/**
|
|
96
175
|
* @typedef GetAllCollectionsParam
|
|
97
176
|
* @property {string} [q] - Get collection list filtered by q string,
|
|
98
177
|
* @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
|
|
99
178
|
* @property {string} [type] - Type of the collections
|
|
100
|
-
* @property {string[]} [
|
|
179
|
+
* @property {string[]} [tag] - Each response will contain next_id param, which
|
|
101
180
|
* should be sent back to make pagination work.
|
|
102
181
|
* @property {boolean} [isActive] - Get collections filtered by active status.
|
|
103
182
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -105,7 +184,17 @@ export = CatalogPlatformApplicationValidator;
|
|
|
105
184
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
106
185
|
* Default is 12.
|
|
107
186
|
*/
|
|
108
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* @typedef GetAllSearchKeywordParam
|
|
189
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
190
|
+
* set of results
|
|
191
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
192
|
+
* Default is 12.
|
|
193
|
+
* @property {string} [q] - Search query with words name.Use this parameter to
|
|
194
|
+
* search keywords by words.
|
|
195
|
+
* @property {boolean} [isActive] - Can query for keywords based on whether they
|
|
196
|
+
* are active or inactive.
|
|
197
|
+
*/
|
|
109
198
|
/**
|
|
110
199
|
* @typedef GetAppCategoryReturnConfigParam
|
|
111
200
|
* @property {string} [q] - Get return configurations for categories by matching
|
|
@@ -150,10 +239,49 @@ export = CatalogPlatformApplicationValidator;
|
|
|
150
239
|
* Default is 20.
|
|
151
240
|
* @property {string[]} [tags] - Get locations filtered by tags.
|
|
152
241
|
* @property {string[]} [storeTypes] - Get locations filtered by store types.
|
|
242
|
+
* @property {number[]} [companyUids] - Filter stores by company IDs available
|
|
243
|
+
* in the application.
|
|
244
|
+
*/
|
|
245
|
+
/**
|
|
246
|
+
* @typedef GetAppPriceByIdParam
|
|
247
|
+
* @property {number} itemId - Unique identifier of the product
|
|
248
|
+
* @property {number[]} [storeIds] - An array of unique identifiers representing
|
|
249
|
+
* the store locations from which the product pricing should be fetched. If
|
|
250
|
+
* not provided, pricing for all applicable store locations will be returned.
|
|
251
|
+
* @property {string[]} [factoryTypeIds] - An array of unique factory type
|
|
252
|
+
* identifiers that specify that pricing from which factory type should be
|
|
253
|
+
* retrieved. This parameter allows filtering the price based on factory types.
|
|
254
|
+
* @property {number} [sellerId] - The company uid for which we want to fetch
|
|
255
|
+
* discounted pricing for a product
|
|
256
|
+
*/
|
|
257
|
+
/**
|
|
258
|
+
* @typedef GetAppPriceFactoriesParam
|
|
259
|
+
* @property {boolean} [isActive] - Gets price factory filtered by active status.
|
|
260
|
+
* @property {string} [factoryTypeId] - Gets price factory filtered by factory_type_id.
|
|
261
|
+
* @property {string} [code] - Gets price factory filtered by pricezone code.
|
|
262
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
263
|
+
* set of results.
|
|
264
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
265
|
+
* Default is 12.
|
|
266
|
+
*/
|
|
267
|
+
/**
|
|
268
|
+
* @typedef GetAppPriceFactoryParam
|
|
269
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
153
270
|
*/
|
|
154
271
|
/**
|
|
155
272
|
* @typedef GetAppProductParam
|
|
156
|
-
* @property {
|
|
273
|
+
* @property {number} itemId - Product id for a particular product.
|
|
274
|
+
*/
|
|
275
|
+
/**
|
|
276
|
+
* @typedef GetAppProductPricesParam
|
|
277
|
+
* @property {number[]} [itemIds] - List of item ids to get product prices
|
|
278
|
+
* filtered by items.
|
|
279
|
+
* @property {string[]} [factoryTypeIds] - List of factory type ids to get
|
|
280
|
+
* product prices filtered by factory type id.
|
|
281
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
282
|
+
* set of results
|
|
283
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
284
|
+
* Default is 10.
|
|
157
285
|
*/
|
|
158
286
|
/**
|
|
159
287
|
* @typedef GetAppProductsParam
|
|
@@ -175,7 +303,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
175
303
|
* set of results
|
|
176
304
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
177
305
|
* Default is 12.
|
|
178
|
-
* @property {string} [q] - Search query with brand name.
|
|
306
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
179
307
|
* search brands by brand name.
|
|
180
308
|
*/
|
|
181
309
|
/**
|
|
@@ -183,12 +311,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
183
311
|
* @property {string} [department] - The name of the department. Use this
|
|
184
312
|
* parameter to filter products by a particular department. See below the list
|
|
185
313
|
* of available departments. You can retrieve available departments from the
|
|
186
|
-
*
|
|
314
|
+
* **v1.0/departments/** API
|
|
187
315
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
188
316
|
* set of results
|
|
189
317
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
190
318
|
* Default is 12.
|
|
191
|
-
* @property {string} [q] - Search query with brand name.
|
|
319
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
192
320
|
* search brands by brand name.
|
|
193
321
|
* @property {number[]} [brandId] - Helps to sort the brands list on the basis
|
|
194
322
|
* of uid list.
|
|
@@ -201,8 +329,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
201
329
|
* set of results
|
|
202
330
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
203
331
|
* Default is 12.
|
|
204
|
-
* @property {string} [q] -
|
|
205
|
-
*
|
|
332
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
333
|
+
* search brands by brand name.
|
|
206
334
|
*/
|
|
207
335
|
/**
|
|
208
336
|
* @typedef GetApplicationDepartmentListingParam
|
|
@@ -210,32 +338,31 @@ export = CatalogPlatformApplicationValidator;
|
|
|
210
338
|
* set of results
|
|
211
339
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
212
340
|
* Default is 12.
|
|
213
|
-
* @property {string} [q] -
|
|
214
|
-
*
|
|
341
|
+
* @property {string} [q] - Search query with brand name.Use this parameter to
|
|
342
|
+
* search department by name.
|
|
215
343
|
*/
|
|
216
344
|
/**
|
|
217
345
|
* @typedef GetApplicationFilterKeysParam
|
|
218
346
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
219
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
220
|
-
* parameter in this format.
|
|
347
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
348
|
+
* parameter in this format.
|
|
349
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
221
350
|
*/
|
|
222
351
|
/**
|
|
223
352
|
* @typedef GetApplicationFilterValuesParam
|
|
224
|
-
* @property {string} filterKey - A `filter_key` is a filter key which
|
|
225
|
-
* all the available filter values.
|
|
353
|
+
* @property {string} filterKey - A `filter_key` is a filter key for a for which
|
|
354
|
+
* all the available filter values will returned. channel.
|
|
226
355
|
* @property {string} [c] - The search filter parameters for collection items.
|
|
227
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
228
|
-
* parameter in this format.
|
|
356
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
357
|
+
* parameter in this format.
|
|
358
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
229
359
|
* @property {string} [collectionId] - A `collection_id` is a unique identifier
|
|
230
|
-
* for a particular collection.
|
|
360
|
+
* for a particular collection. channel.
|
|
231
361
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
232
362
|
* set of results
|
|
233
363
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
234
364
|
* Default is 10.
|
|
235
|
-
* @property {string} [q] -
|
|
236
|
-
* specific data within the filter options. It acts as a query keyword that
|
|
237
|
-
* can refine the results by matching relevant filter values, such as a
|
|
238
|
-
* category name or any other applicable filter criteria.
|
|
365
|
+
* @property {string} [q] - Get Values filtered by q string
|
|
239
366
|
*/
|
|
240
367
|
/**
|
|
241
368
|
* @typedef GetApplicationProductsParam
|
|
@@ -265,23 +392,43 @@ export = CatalogPlatformApplicationValidator;
|
|
|
265
392
|
* number. Default is cursor.
|
|
266
393
|
* @property {string[]} [itemIds] - Item Ids of product
|
|
267
394
|
*/
|
|
268
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* @typedef GetAutocompleteConfigParam
|
|
397
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
398
|
+
* set of results
|
|
399
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
400
|
+
* Default is 12.
|
|
401
|
+
* @property {string} [q] - Search query with words name.Use this parameter to
|
|
402
|
+
* search keywords by words.
|
|
403
|
+
* @property {boolean} [isActive] - Can query for keywords based on whether they
|
|
404
|
+
* are active or inactive.
|
|
405
|
+
*/
|
|
269
406
|
/**
|
|
270
407
|
* @typedef GetAutocompleteKeywordDetailParam
|
|
271
408
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
272
409
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
273
410
|
*/
|
|
411
|
+
/**
|
|
412
|
+
* @typedef GetAutocompletePreviewParam
|
|
413
|
+
* @property {string} [q] - Get suggestions related to `q` string.
|
|
414
|
+
* @property {number} [categorySuggestion] - For getting related category suggestions.
|
|
415
|
+
* @property {number} [brandSuggestion] - For getting related brand suggestions.
|
|
416
|
+
* @property {number} [collectionSuggestion] - For getting collection suggestions.
|
|
417
|
+
* @property {number} [productSuggestion] - For getting product suggestions.
|
|
418
|
+
* @property {number} [querySuggestion] - For getting query suggestions.
|
|
419
|
+
*/
|
|
420
|
+
/** @typedef GetAutocompleteSettingsParam */
|
|
274
421
|
/** @typedef GetCatalogConfigurationParam */
|
|
275
422
|
/**
|
|
276
423
|
* @typedef GetCatalogInsightsParam
|
|
277
|
-
* @property {string} [brand] - Brand slug
|
|
424
|
+
* @property {string} [brand] - Brand slug
|
|
278
425
|
*/
|
|
279
426
|
/**
|
|
280
427
|
* @typedef GetCategoriesParam
|
|
281
428
|
* @property {string} [department] - The name of the department. Use this
|
|
282
429
|
* parameter to filter products by a particular department. See below the list
|
|
283
430
|
* of available departments. You can retrieve available departments from the
|
|
284
|
-
*
|
|
431
|
+
* **v1.0/departments/** API
|
|
285
432
|
*/
|
|
286
433
|
/**
|
|
287
434
|
* @typedef GetCollectionDetailParam
|
|
@@ -294,11 +441,14 @@ export = CatalogPlatformApplicationValidator;
|
|
|
294
441
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
295
442
|
* @property {string} [sortOn] - Each response will contain sort_on param, which
|
|
296
443
|
* should be sent back to make pagination work.
|
|
297
|
-
* @property {string} [pageId] - Each response will contain next_id param, which
|
|
298
|
-
* should be sent back to make pagination work.
|
|
299
444
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
300
445
|
* Default is 12.
|
|
301
446
|
* @property {number} [pageNo] - Identifies the specific page of results being requested.
|
|
447
|
+
* @property {boolean} [isPinned] - Number of items that are pinned and have
|
|
448
|
+
* priority in each page. Default is 12.
|
|
449
|
+
* @property {string} [q] - Get multiple products filtered by q string
|
|
450
|
+
* @property {boolean} [isExcluded] - Number of items that are excluded from
|
|
451
|
+
* collections in each page. Default is 12.
|
|
302
452
|
*/
|
|
303
453
|
/**
|
|
304
454
|
* @typedef GetConfigurationByTypeParam
|
|
@@ -310,18 +460,18 @@ export = CatalogPlatformApplicationValidator;
|
|
|
310
460
|
* a specific type of configuration.
|
|
311
461
|
* @property {string} [templateSlug] - Get configuration list filtered by
|
|
312
462
|
* `template_slug` string. This is for the details and comparision groups.
|
|
313
|
-
* @property {number} [pageNo] - The page number to navigate through the given
|
|
314
|
-
* set of results.
|
|
315
|
-
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
316
|
-
* @property {string} [q] - Get configuration list filtered by `q` string.
|
|
317
463
|
*/
|
|
318
464
|
/** @typedef GetConfigurationsParam */
|
|
465
|
+
/**
|
|
466
|
+
* @typedef GetConfigurationsFilterMetadataParam
|
|
467
|
+
* @property {string} filter - Filter whose values needs to be fetched.
|
|
468
|
+
*/
|
|
319
469
|
/** @typedef GetDepartmentsParam */
|
|
320
470
|
/**
|
|
321
471
|
* @typedef GetDiscountedInventoryBySizeIdentifierParam
|
|
322
|
-
* @property {number} itemId -
|
|
472
|
+
* @property {number} itemId - Item code of the product of which size is to be get.
|
|
323
473
|
* @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
|
|
324
|
-
* Primary Identifier).
|
|
474
|
+
* Primary Identifier) of which inventory is to get.
|
|
325
475
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
326
476
|
* set of results
|
|
327
477
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
@@ -349,12 +499,65 @@ export = CatalogPlatformApplicationValidator;
|
|
|
349
499
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
350
500
|
* Default is 12.
|
|
351
501
|
* @property {string} [search] - Get configuration list filtered by `search` string.
|
|
502
|
+
* @property {number[]} [uids] - Only for categories config type, Get
|
|
503
|
+
* configuration list filtered by `uids`.
|
|
504
|
+
*/
|
|
505
|
+
/**
|
|
506
|
+
* @typedef GetLivePreviewParam
|
|
507
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
508
|
+
* unique identifier for a particular merchandising rule.
|
|
509
|
+
* @property {string} [searchKeyword] - A sample query that can be used to get a
|
|
510
|
+
* live preview of the merchandising rule.
|
|
511
|
+
*/
|
|
512
|
+
/**
|
|
513
|
+
* @typedef GetMerchandisingQueryParam
|
|
514
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
515
|
+
* unique identifier for a particular merchandising rule.
|
|
516
|
+
*/
|
|
517
|
+
/**
|
|
518
|
+
* @typedef GetMerchandisingRuleBoostActionParam
|
|
519
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
520
|
+
* unique identifier for a particular merchandising rule.
|
|
521
|
+
*/
|
|
522
|
+
/**
|
|
523
|
+
* @typedef GetMerchandisingRuleBuryActionParam
|
|
524
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
525
|
+
* unique identifier for a particular merchandising rule.
|
|
526
|
+
*/
|
|
527
|
+
/**
|
|
528
|
+
* @typedef GetMerchandisingRuleHideActionParam
|
|
529
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
530
|
+
* unique identifier for a particular merchandising rule.
|
|
531
|
+
*/
|
|
532
|
+
/**
|
|
533
|
+
* @typedef GetMerchandisingRulePinActionParam
|
|
534
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
535
|
+
* unique identifier for a particular merchandising rule.
|
|
536
|
+
*/
|
|
537
|
+
/**
|
|
538
|
+
* @typedef GetMerchandisingRulesParam
|
|
539
|
+
* @property {string} [pageId] - Each response will contain next_id param, which
|
|
540
|
+
* should be sent back to make pagination work.
|
|
541
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
542
|
+
* Default is 12.
|
|
352
543
|
*/
|
|
353
544
|
/**
|
|
354
545
|
* @typedef GetProductDetailBySlugParam
|
|
355
546
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
356
547
|
* a product. You can retrieve these from the APIs that list products like
|
|
357
|
-
*
|
|
548
|
+
* **v1.0/products/**
|
|
549
|
+
*/
|
|
550
|
+
/**
|
|
551
|
+
* @typedef GetProductsInPriceFactoryByZoneIdParam
|
|
552
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
553
|
+
* @property {string} zoneId - An `zone_id` is a unique identifier for a
|
|
554
|
+
* particular price factory zone.
|
|
555
|
+
* @property {number} [itemId] - Gets price factory filtered by item_id.
|
|
556
|
+
* @property {string} [q] - Gets price factory filtered by search query.
|
|
557
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
558
|
+
* set of results.
|
|
559
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
560
|
+
* Default is 12.
|
|
358
561
|
*/
|
|
359
562
|
/** @typedef GetQueryFiltersParam */
|
|
360
563
|
/** @typedef GetSearchConfigurationParam */
|
|
@@ -363,20 +566,69 @@ export = CatalogPlatformApplicationValidator;
|
|
|
363
566
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
364
567
|
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
365
568
|
*/
|
|
569
|
+
/** @typedef GetSearchRerankParam */
|
|
570
|
+
/**
|
|
571
|
+
* @typedef GetSearchRerankDetailParam
|
|
572
|
+
* @property {string} id - An `id` is the identifier for a particular search
|
|
573
|
+
* rerank configuration. channel.
|
|
574
|
+
*/
|
|
575
|
+
/**
|
|
576
|
+
* @typedef GetSynonymsParam
|
|
577
|
+
* @property {string} [id] - Mongo id of the particular synonym
|
|
578
|
+
* @property {string} [name] - Synonym name
|
|
579
|
+
* @property {string} [type] - Synonym type - oneway/twoway
|
|
580
|
+
*/
|
|
581
|
+
/**
|
|
582
|
+
* @typedef PollBulkSynonymsParam
|
|
583
|
+
* @property {string} id - Id of the bulk job that needs to be polled.
|
|
584
|
+
*/
|
|
585
|
+
/**
|
|
586
|
+
* @typedef PollPriceFactoryJobsParam
|
|
587
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
588
|
+
* @property {string} [startDate] - Date that filters the jobs created after this date
|
|
589
|
+
* @property {string} [endDate] - Date that filters the jobs created before this date
|
|
590
|
+
* @property {string[]} [stage] - Filter jobs by the stage
|
|
591
|
+
* @property {boolean} [isActive] - Filter active or inactive jobs
|
|
592
|
+
* @property {string} [q] - Pass unique identifier for a particular job to poll
|
|
593
|
+
* @property {string[]} [type] - Pass type for a particular job to poll
|
|
594
|
+
*/
|
|
595
|
+
/**
|
|
596
|
+
* @typedef PollProductPriceFactoryBulkJobParam
|
|
597
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
598
|
+
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
599
|
+
*/
|
|
600
|
+
/**
|
|
601
|
+
* @typedef ProcessBulkSynonymsParam
|
|
602
|
+
* @property {CatalogPlatformModel.SynonymBulkProcessRequestSchema} body
|
|
603
|
+
*/
|
|
604
|
+
/**
|
|
605
|
+
* @typedef ProcessProductPriceFactoryBulkJobParam
|
|
606
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
607
|
+
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
608
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
609
|
+
*/
|
|
610
|
+
/**
|
|
611
|
+
* @typedef SampleBulkSynonymsFileParam
|
|
612
|
+
* @property {string} type - Type of the file
|
|
613
|
+
*/
|
|
614
|
+
/**
|
|
615
|
+
* @typedef SaveMerchandisingRulesParam
|
|
616
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
617
|
+
* unique identifier for a particular merchandising rule.
|
|
618
|
+
* @property {CatalogPlatformModel.MerchandisingRuleSave} body
|
|
619
|
+
*/
|
|
366
620
|
/**
|
|
367
621
|
* @typedef UpdateAllowSingleParam
|
|
368
|
-
* @property {CatalogPlatformModel.
|
|
622
|
+
* @property {CatalogPlatformModel.AllowSingleRequest} body
|
|
369
623
|
*/
|
|
370
624
|
/**
|
|
371
625
|
* @typedef UpdateAppBrandParam
|
|
372
|
-
* @property {number} brandUid -
|
|
373
|
-
* particular brand.
|
|
626
|
+
* @property {number} brandUid - Brand id for which the custom_json is associated.
|
|
374
627
|
* @property {CatalogPlatformModel.ApplicationBrandJson} body
|
|
375
628
|
*/
|
|
376
629
|
/**
|
|
377
630
|
* @typedef UpdateAppCategoryParam
|
|
378
|
-
* @property {
|
|
379
|
-
* particular category.
|
|
631
|
+
* @property {number} categoryUid - Category id for which the custom_json is associated.
|
|
380
632
|
* @property {CatalogPlatformModel.ApplicationCategoryJson} body
|
|
381
633
|
*/
|
|
382
634
|
/**
|
|
@@ -385,8 +637,8 @@ export = CatalogPlatformApplicationValidator;
|
|
|
385
637
|
*/
|
|
386
638
|
/**
|
|
387
639
|
* @typedef UpdateAppDepartmentParam
|
|
388
|
-
* @property {number} departmentUid -
|
|
389
|
-
*
|
|
640
|
+
* @property {number} departmentUid - Department id for which the custom_json is
|
|
641
|
+
* associated.
|
|
390
642
|
* @property {CatalogPlatformModel.ApplicationDepartmentJson} body
|
|
391
643
|
*/
|
|
392
644
|
/**
|
|
@@ -396,7 +648,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
396
648
|
*/
|
|
397
649
|
/**
|
|
398
650
|
* @typedef UpdateAppProductParam
|
|
399
|
-
* @property {number} itemId -
|
|
651
|
+
* @property {number} itemId - Product id for which the custom_meta is associated.
|
|
400
652
|
* @property {CatalogPlatformModel.ApplicationItemMeta} body
|
|
401
653
|
*/
|
|
402
654
|
/**
|
|
@@ -409,6 +661,12 @@ export = CatalogPlatformApplicationValidator;
|
|
|
409
661
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
410
662
|
* @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
|
|
411
663
|
*/
|
|
664
|
+
/**
|
|
665
|
+
* @typedef UpdateAutocompleteSettingsParam
|
|
666
|
+
* @property {string} id - An `id` is a unique identifier for a particular
|
|
667
|
+
* autocomplete settings config.
|
|
668
|
+
* @property {CatalogPlatformModel.AutocompleteRequestSchema} body
|
|
669
|
+
*/
|
|
412
670
|
/**
|
|
413
671
|
* @typedef UpdateCollectionParam
|
|
414
672
|
* @property {string} id - A `id` is a unique identifier of a collection.
|
|
@@ -416,7 +674,7 @@ export = CatalogPlatformApplicationValidator;
|
|
|
416
674
|
*/
|
|
417
675
|
/**
|
|
418
676
|
* @typedef UpdateDefaultSortParam
|
|
419
|
-
* @property {CatalogPlatformModel.
|
|
677
|
+
* @property {CatalogPlatformModel.DefaultKeyRequest} body
|
|
420
678
|
*/
|
|
421
679
|
/**
|
|
422
680
|
* @typedef UpdateGroupConfigurationParam
|
|
@@ -432,11 +690,41 @@ export = CatalogPlatformApplicationValidator;
|
|
|
432
690
|
* particular listing configuration type.
|
|
433
691
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
434
692
|
* particular configuration.
|
|
435
|
-
* @property {CatalogPlatformModel.
|
|
693
|
+
* @property {CatalogPlatformModel.AppConfigurationsFilterResponse} body
|
|
694
|
+
*/
|
|
695
|
+
/**
|
|
696
|
+
* @typedef UpdateMerchandisingRuleBoostActionParam
|
|
697
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
698
|
+
* unique identifier for a particular merchandising rule.
|
|
699
|
+
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
700
|
+
*/
|
|
701
|
+
/**
|
|
702
|
+
* @typedef UpdateMerchandisingRuleBuryActionParam
|
|
703
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
704
|
+
* unique identifier for a particular merchandising rule.
|
|
705
|
+
* @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
|
|
706
|
+
*/
|
|
707
|
+
/**
|
|
708
|
+
* @typedef UpdateMerchandisingRuleHideActionParam
|
|
709
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
710
|
+
* unique identifier for a particular merchandising rule.
|
|
711
|
+
* @property {CatalogPlatformModel.HideRequest} body
|
|
712
|
+
*/
|
|
713
|
+
/**
|
|
714
|
+
* @typedef UpdateMerchandisingRulePinActionParam
|
|
715
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
716
|
+
* unique identifier for a particular merchandising rule.
|
|
717
|
+
* @property {CatalogPlatformModel.PinRequest} body
|
|
718
|
+
*/
|
|
719
|
+
/**
|
|
720
|
+
* @typedef UpdateMerchandisingRuleQueryParam
|
|
721
|
+
* @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
|
|
722
|
+
* unique identifier for a particular merchandising rule.
|
|
723
|
+
* @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
|
|
436
724
|
*/
|
|
437
725
|
/**
|
|
438
726
|
* @typedef UpdateSearchConfigurationParam
|
|
439
|
-
* @property {CatalogPlatformModel.
|
|
727
|
+
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
|
|
440
728
|
*/
|
|
441
729
|
/**
|
|
442
730
|
* @typedef UpdateSearchKeywordsParam
|
|
@@ -444,13 +732,47 @@ export = CatalogPlatformApplicationValidator;
|
|
|
444
732
|
* detail. Pass the `id` of the keywords which you want to delete.
|
|
445
733
|
* @property {CatalogPlatformModel.CreateSearchKeyword} body
|
|
446
734
|
*/
|
|
735
|
+
/**
|
|
736
|
+
* @typedef UpdateSearchRerankConfigurationParam
|
|
737
|
+
* @property {string} id - An `id` is the identifier for a particular search
|
|
738
|
+
* rerank configuration. channel.
|
|
739
|
+
* @property {CatalogPlatformModel.UpdateSearchRerankRequest} body
|
|
740
|
+
*/
|
|
741
|
+
/**
|
|
742
|
+
* @typedef UpdateSynonymsParam
|
|
743
|
+
* @property {string} id - An `id` is a unique identifier for a particular
|
|
744
|
+
* synonym channel.
|
|
745
|
+
* @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
|
|
746
|
+
*/
|
|
747
|
+
/**
|
|
748
|
+
* @typedef UploadSynonymsParam
|
|
749
|
+
* @property {CatalogPlatformModel.SynonymUploadRequestSchema} body
|
|
750
|
+
*/
|
|
751
|
+
/**
|
|
752
|
+
* @typedef ValidateBulkSynonymsParam
|
|
753
|
+
* @property {CatalogPlatformModel.SynonymBulkValidateRequestSchema} body
|
|
754
|
+
*/
|
|
755
|
+
/**
|
|
756
|
+
* @typedef ValidateProductPriceFactoryBulkJobParam
|
|
757
|
+
* @property {string} id - An `id` is a unique identifier for a particular price factory.
|
|
758
|
+
* @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
|
|
759
|
+
* @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
|
|
760
|
+
*/
|
|
447
761
|
declare class CatalogPlatformApplicationValidator {
|
|
448
762
|
/** @returns {AddCollectionItemsParam} */
|
|
449
763
|
static addCollectionItems(): AddCollectionItemsParam;
|
|
764
|
+
/** @returns {AddProductsInPriceFactoryByZoneIdParam} */
|
|
765
|
+
static addProductsInPriceFactoryByZoneId(): AddProductsInPriceFactoryByZoneIdParam;
|
|
766
|
+
/** @returns {ClearCollectionItemsPriorityParam} */
|
|
767
|
+
static clearCollectionItemsPriority(): ClearCollectionItemsPriorityParam;
|
|
450
768
|
/** @returns {CreateAppCategoryReturnConfigurationParam} */
|
|
451
769
|
static createAppCategoryReturnConfiguration(): CreateAppCategoryReturnConfigurationParam;
|
|
770
|
+
/** @returns {CreateAppPriceFactoryParam} */
|
|
771
|
+
static createAppPriceFactory(): CreateAppPriceFactoryParam;
|
|
452
772
|
/** @returns {CreateAppReturnConfigurationParam} */
|
|
453
773
|
static createAppReturnConfiguration(): CreateAppReturnConfigurationParam;
|
|
774
|
+
/** @returns {CreateAutocompleteSettingsParam} */
|
|
775
|
+
static createAutocompleteSettings(): CreateAutocompleteSettingsParam;
|
|
454
776
|
/** @returns {CreateCollectionParam} */
|
|
455
777
|
static createCollection(): CreateCollectionParam;
|
|
456
778
|
/** @returns {CreateConfigurationByTypeParam} */
|
|
@@ -465,8 +787,24 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
465
787
|
static createGroupConfiguration(): CreateGroupConfigurationParam;
|
|
466
788
|
/** @returns {CreateListingConfigurationParam} */
|
|
467
789
|
static createListingConfiguration(): CreateListingConfigurationParam;
|
|
790
|
+
/** @returns {CreateMerchandisingRuleBoostActionParam} */
|
|
791
|
+
static createMerchandisingRuleBoostAction(): CreateMerchandisingRuleBoostActionParam;
|
|
792
|
+
/** @returns {CreateMerchandisingRuleBuryActionParam} */
|
|
793
|
+
static createMerchandisingRuleBuryAction(): CreateMerchandisingRuleBuryActionParam;
|
|
794
|
+
/** @returns {CreateMerchandisingRuleHideActionParam} */
|
|
795
|
+
static createMerchandisingRuleHideAction(): CreateMerchandisingRuleHideActionParam;
|
|
796
|
+
/** @returns {CreateMerchandisingRulePinActionParam} */
|
|
797
|
+
static createMerchandisingRulePinAction(): CreateMerchandisingRulePinActionParam;
|
|
798
|
+
/** @returns {CreateMerchandisingRuleQueryParam} */
|
|
799
|
+
static createMerchandisingRuleQuery(): CreateMerchandisingRuleQueryParam;
|
|
800
|
+
/** @returns {CreateProductPriceFactoryBulkJobParam} */
|
|
801
|
+
static createProductPriceFactoryBulkJob(): CreateProductPriceFactoryBulkJobParam;
|
|
468
802
|
/** @returns {CreateSearchConfigurationParam} */
|
|
469
803
|
static createSearchConfiguration(): CreateSearchConfigurationParam;
|
|
804
|
+
/** @returns {CreateSearchRerankParam} */
|
|
805
|
+
static createSearchRerank(): CreateSearchRerankParam;
|
|
806
|
+
/** @returns {CreateSynonymsParam} */
|
|
807
|
+
static createSynonyms(): CreateSynonymsParam;
|
|
470
808
|
/** @returns {DeleteAppCategoryReturnConfigurationParam} */
|
|
471
809
|
static deleteAppCategoryReturnConfiguration(): DeleteAppCategoryReturnConfigurationParam;
|
|
472
810
|
/** @returns {DeleteAutocompleteKeywordParam} */
|
|
@@ -477,22 +815,44 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
477
815
|
static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
|
|
478
816
|
/** @returns {DeleteListingConfigurationParam} */
|
|
479
817
|
static deleteListingConfiguration(): DeleteListingConfigurationParam;
|
|
818
|
+
/** @returns {DeleteMerchandisingRuleParam} */
|
|
819
|
+
static deleteMerchandisingRule(): DeleteMerchandisingRuleParam;
|
|
820
|
+
/** @returns {DeleteMerchandisingRulesPreviewParam} */
|
|
821
|
+
static deleteMerchandisingRulesPreview(): DeleteMerchandisingRulesPreviewParam;
|
|
480
822
|
/** @returns {DeleteSearchConfigurationParam} */
|
|
481
823
|
static deleteSearchConfiguration(): any;
|
|
482
824
|
/** @returns {DeleteSearchKeywordsParam} */
|
|
483
825
|
static deleteSearchKeywords(): DeleteSearchKeywordsParam;
|
|
826
|
+
/** @returns {DeleteSearchRerankConfigurationParam} */
|
|
827
|
+
static deleteSearchRerankConfiguration(): DeleteSearchRerankConfigurationParam;
|
|
828
|
+
/** @returns {DeleteSynonymParam} */
|
|
829
|
+
static deleteSynonym(): DeleteSynonymParam;
|
|
830
|
+
/** @returns {EditAppPriceFactoryParam} */
|
|
831
|
+
static editAppPriceFactory(): EditAppPriceFactoryParam;
|
|
832
|
+
/** @returns {ExportProductsInPriceFactoryParam} */
|
|
833
|
+
static exportProductsInPriceFactory(): ExportProductsInPriceFactoryParam;
|
|
834
|
+
/** @returns {ExportSynonymsParam} */
|
|
835
|
+
static exportSynonyms(): any;
|
|
484
836
|
/** @returns {GetAllCollectionsParam} */
|
|
485
837
|
static getAllCollections(): GetAllCollectionsParam;
|
|
486
838
|
/** @returns {GetAllSearchKeywordParam} */
|
|
487
|
-
static getAllSearchKeyword():
|
|
839
|
+
static getAllSearchKeyword(): GetAllSearchKeywordParam;
|
|
488
840
|
/** @returns {GetAppCategoryReturnConfigParam} */
|
|
489
841
|
static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
|
|
490
842
|
/** @returns {GetAppInventoryParam} */
|
|
491
843
|
static getAppInventory(): GetAppInventoryParam;
|
|
492
844
|
/** @returns {GetAppLocationsParam} */
|
|
493
845
|
static getAppLocations(): GetAppLocationsParam;
|
|
846
|
+
/** @returns {GetAppPriceByIdParam} */
|
|
847
|
+
static getAppPriceById(): GetAppPriceByIdParam;
|
|
848
|
+
/** @returns {GetAppPriceFactoriesParam} */
|
|
849
|
+
static getAppPriceFactories(): GetAppPriceFactoriesParam;
|
|
850
|
+
/** @returns {GetAppPriceFactoryParam} */
|
|
851
|
+
static getAppPriceFactory(): GetAppPriceFactoryParam;
|
|
494
852
|
/** @returns {GetAppProductParam} */
|
|
495
853
|
static getAppProduct(): GetAppProductParam;
|
|
854
|
+
/** @returns {GetAppProductPricesParam} */
|
|
855
|
+
static getAppProductPrices(): GetAppProductPricesParam;
|
|
496
856
|
/** @returns {GetAppProductsParam} */
|
|
497
857
|
static getAppProducts(): GetAppProductsParam;
|
|
498
858
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
@@ -512,9 +872,13 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
512
872
|
/** @returns {GetApplicationProductsParam} */
|
|
513
873
|
static getApplicationProducts(): GetApplicationProductsParam;
|
|
514
874
|
/** @returns {GetAutocompleteConfigParam} */
|
|
515
|
-
static getAutocompleteConfig():
|
|
875
|
+
static getAutocompleteConfig(): GetAutocompleteConfigParam;
|
|
516
876
|
/** @returns {GetAutocompleteKeywordDetailParam} */
|
|
517
877
|
static getAutocompleteKeywordDetail(): GetAutocompleteKeywordDetailParam;
|
|
878
|
+
/** @returns {GetAutocompletePreviewParam} */
|
|
879
|
+
static getAutocompletePreview(): GetAutocompletePreviewParam;
|
|
880
|
+
/** @returns {GetAutocompleteSettingsParam} */
|
|
881
|
+
static getAutocompleteSettings(): any;
|
|
518
882
|
/** @returns {GetCatalogConfigurationParam} */
|
|
519
883
|
static getCatalogConfiguration(): any;
|
|
520
884
|
/** @returns {GetCatalogInsightsParam} */
|
|
@@ -531,6 +895,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
531
895
|
static getConfigurationMetadata(): GetConfigurationMetadataParam;
|
|
532
896
|
/** @returns {GetConfigurationsParam} */
|
|
533
897
|
static getConfigurations(): any;
|
|
898
|
+
/** @returns {GetConfigurationsFilterMetadataParam} */
|
|
899
|
+
static getConfigurationsFilterMetadata(): GetConfigurationsFilterMetadataParam;
|
|
534
900
|
/** @returns {GetDepartmentsParam} */
|
|
535
901
|
static getDepartments(): any;
|
|
536
902
|
/** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
|
|
@@ -539,14 +905,50 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
539
905
|
static getGroupConfigurations(): GetGroupConfigurationsParam;
|
|
540
906
|
/** @returns {GetListingConfigurationsParam} */
|
|
541
907
|
static getListingConfigurations(): GetListingConfigurationsParam;
|
|
908
|
+
/** @returns {GetLivePreviewParam} */
|
|
909
|
+
static getLivePreview(): GetLivePreviewParam;
|
|
910
|
+
/** @returns {GetMerchandisingQueryParam} */
|
|
911
|
+
static getMerchandisingQuery(): GetMerchandisingQueryParam;
|
|
912
|
+
/** @returns {GetMerchandisingRuleBoostActionParam} */
|
|
913
|
+
static getMerchandisingRuleBoostAction(): GetMerchandisingRuleBoostActionParam;
|
|
914
|
+
/** @returns {GetMerchandisingRuleBuryActionParam} */
|
|
915
|
+
static getMerchandisingRuleBuryAction(): GetMerchandisingRuleBuryActionParam;
|
|
916
|
+
/** @returns {GetMerchandisingRuleHideActionParam} */
|
|
917
|
+
static getMerchandisingRuleHideAction(): GetMerchandisingRuleHideActionParam;
|
|
918
|
+
/** @returns {GetMerchandisingRulePinActionParam} */
|
|
919
|
+
static getMerchandisingRulePinAction(): GetMerchandisingRulePinActionParam;
|
|
920
|
+
/** @returns {GetMerchandisingRulesParam} */
|
|
921
|
+
static getMerchandisingRules(): GetMerchandisingRulesParam;
|
|
542
922
|
/** @returns {GetProductDetailBySlugParam} */
|
|
543
923
|
static getProductDetailBySlug(): GetProductDetailBySlugParam;
|
|
924
|
+
/** @returns {GetProductsInPriceFactoryByZoneIdParam} */
|
|
925
|
+
static getProductsInPriceFactoryByZoneId(): GetProductsInPriceFactoryByZoneIdParam;
|
|
544
926
|
/** @returns {GetQueryFiltersParam} */
|
|
545
927
|
static getQueryFilters(): any;
|
|
546
928
|
/** @returns {GetSearchConfigurationParam} */
|
|
547
929
|
static getSearchConfiguration(): any;
|
|
548
930
|
/** @returns {GetSearchKeywordsParam} */
|
|
549
931
|
static getSearchKeywords(): GetSearchKeywordsParam;
|
|
932
|
+
/** @returns {GetSearchRerankParam} */
|
|
933
|
+
static getSearchRerank(): any;
|
|
934
|
+
/** @returns {GetSearchRerankDetailParam} */
|
|
935
|
+
static getSearchRerankDetail(): GetSearchRerankDetailParam;
|
|
936
|
+
/** @returns {GetSynonymsParam} */
|
|
937
|
+
static getSynonyms(): GetSynonymsParam;
|
|
938
|
+
/** @returns {PollBulkSynonymsParam} */
|
|
939
|
+
static pollBulkSynonyms(): PollBulkSynonymsParam;
|
|
940
|
+
/** @returns {PollPriceFactoryJobsParam} */
|
|
941
|
+
static pollPriceFactoryJobs(): PollPriceFactoryJobsParam;
|
|
942
|
+
/** @returns {PollProductPriceFactoryBulkJobParam} */
|
|
943
|
+
static pollProductPriceFactoryBulkJob(): PollProductPriceFactoryBulkJobParam;
|
|
944
|
+
/** @returns {ProcessBulkSynonymsParam} */
|
|
945
|
+
static processBulkSynonyms(): ProcessBulkSynonymsParam;
|
|
946
|
+
/** @returns {ProcessProductPriceFactoryBulkJobParam} */
|
|
947
|
+
static processProductPriceFactoryBulkJob(): ProcessProductPriceFactoryBulkJobParam;
|
|
948
|
+
/** @returns {SampleBulkSynonymsFileParam} */
|
|
949
|
+
static sampleBulkSynonymsFile(): SampleBulkSynonymsFileParam;
|
|
950
|
+
/** @returns {SaveMerchandisingRulesParam} */
|
|
951
|
+
static saveMerchandisingRules(): SaveMerchandisingRulesParam;
|
|
550
952
|
/** @returns {UpdateAllowSingleParam} */
|
|
551
953
|
static updateAllowSingle(): UpdateAllowSingleParam;
|
|
552
954
|
/** @returns {UpdateAppBrandParam} */
|
|
@@ -565,6 +967,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
565
967
|
static updateAppReturnConfiguration(): UpdateAppReturnConfigurationParam;
|
|
566
968
|
/** @returns {UpdateAutocompleteKeywordParam} */
|
|
567
969
|
static updateAutocompleteKeyword(): UpdateAutocompleteKeywordParam;
|
|
970
|
+
/** @returns {UpdateAutocompleteSettingsParam} */
|
|
971
|
+
static updateAutocompleteSettings(): UpdateAutocompleteSettingsParam;
|
|
568
972
|
/** @returns {UpdateCollectionParam} */
|
|
569
973
|
static updateCollection(): UpdateCollectionParam;
|
|
570
974
|
/** @returns {UpdateDefaultSortParam} */
|
|
@@ -573,13 +977,33 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
573
977
|
static updateGroupConfiguration(): UpdateGroupConfigurationParam;
|
|
574
978
|
/** @returns {UpdateListingConfigurationParam} */
|
|
575
979
|
static updateListingConfiguration(): UpdateListingConfigurationParam;
|
|
980
|
+
/** @returns {UpdateMerchandisingRuleBoostActionParam} */
|
|
981
|
+
static updateMerchandisingRuleBoostAction(): UpdateMerchandisingRuleBoostActionParam;
|
|
982
|
+
/** @returns {UpdateMerchandisingRuleBuryActionParam} */
|
|
983
|
+
static updateMerchandisingRuleBuryAction(): UpdateMerchandisingRuleBuryActionParam;
|
|
984
|
+
/** @returns {UpdateMerchandisingRuleHideActionParam} */
|
|
985
|
+
static updateMerchandisingRuleHideAction(): UpdateMerchandisingRuleHideActionParam;
|
|
986
|
+
/** @returns {UpdateMerchandisingRulePinActionParam} */
|
|
987
|
+
static updateMerchandisingRulePinAction(): UpdateMerchandisingRulePinActionParam;
|
|
988
|
+
/** @returns {UpdateMerchandisingRuleQueryParam} */
|
|
989
|
+
static updateMerchandisingRuleQuery(): UpdateMerchandisingRuleQueryParam;
|
|
576
990
|
/** @returns {UpdateSearchConfigurationParam} */
|
|
577
991
|
static updateSearchConfiguration(): UpdateSearchConfigurationParam;
|
|
578
992
|
/** @returns {UpdateSearchKeywordsParam} */
|
|
579
993
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
994
|
+
/** @returns {UpdateSearchRerankConfigurationParam} */
|
|
995
|
+
static updateSearchRerankConfiguration(): UpdateSearchRerankConfigurationParam;
|
|
996
|
+
/** @returns {UpdateSynonymsParam} */
|
|
997
|
+
static updateSynonyms(): UpdateSynonymsParam;
|
|
998
|
+
/** @returns {UploadSynonymsParam} */
|
|
999
|
+
static uploadSynonyms(): UploadSynonymsParam;
|
|
1000
|
+
/** @returns {ValidateBulkSynonymsParam} */
|
|
1001
|
+
static validateBulkSynonyms(): ValidateBulkSynonymsParam;
|
|
1002
|
+
/** @returns {ValidateProductPriceFactoryBulkJobParam} */
|
|
1003
|
+
static validateProductPriceFactoryBulkJob(): ValidateProductPriceFactoryBulkJobParam;
|
|
580
1004
|
}
|
|
581
1005
|
declare namespace CatalogPlatformApplicationValidator {
|
|
582
|
-
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
1006
|
+
export { AddCollectionItemsParam, AddProductsInPriceFactoryByZoneIdParam, ClearCollectionItemsPriorityParam, CreateAppCategoryReturnConfigurationParam, CreateAppPriceFactoryParam, CreateAppReturnConfigurationParam, CreateAutocompleteSettingsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateMerchandisingRuleBoostActionParam, CreateMerchandisingRuleBuryActionParam, CreateMerchandisingRuleHideActionParam, CreateMerchandisingRulePinActionParam, CreateMerchandisingRuleQueryParam, CreateProductPriceFactoryBulkJobParam, CreateSearchConfigurationParam, CreateSearchRerankParam, CreateSynonymsParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteMerchandisingRuleParam, DeleteMerchandisingRulesPreviewParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, DeleteSearchRerankConfigurationParam, DeleteSynonymParam, EditAppPriceFactoryParam, ExportProductsInPriceFactoryParam, ExportSynonymsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppPriceByIdParam, GetAppPriceFactoriesParam, GetAppPriceFactoryParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetAutocompletePreviewParam, GetAutocompleteSettingsParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetConfigurationsFilterMetadataParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetLivePreviewParam, GetMerchandisingQueryParam, GetMerchandisingRuleBoostActionParam, GetMerchandisingRuleBuryActionParam, GetMerchandisingRuleHideActionParam, GetMerchandisingRulePinActionParam, GetMerchandisingRulesParam, GetProductDetailBySlugParam, GetProductsInPriceFactoryByZoneIdParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, GetSearchRerankParam, GetSearchRerankDetailParam, GetSynonymsParam, PollBulkSynonymsParam, PollPriceFactoryJobsParam, PollProductPriceFactoryBulkJobParam, ProcessBulkSynonymsParam, ProcessProductPriceFactoryBulkJobParam, SampleBulkSynonymsFileParam, SaveMerchandisingRulesParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateAutocompleteSettingsParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateMerchandisingRuleBoostActionParam, UpdateMerchandisingRuleBuryActionParam, UpdateMerchandisingRuleHideActionParam, UpdateMerchandisingRulePinActionParam, UpdateMerchandisingRuleQueryParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam, UpdateSearchRerankConfigurationParam, UpdateSynonymsParam, UploadSynonymsParam, ValidateBulkSynonymsParam, ValidateProductPriceFactoryBulkJobParam };
|
|
583
1007
|
}
|
|
584
1008
|
type AddCollectionItemsParam = {
|
|
585
1009
|
/**
|
|
@@ -588,44 +1012,32 @@ type AddCollectionItemsParam = {
|
|
|
588
1012
|
id: string;
|
|
589
1013
|
body: CatalogPlatformModel.CollectionItemUpdateSchema;
|
|
590
1014
|
};
|
|
1015
|
+
type AddProductsInPriceFactoryByZoneIdParam = {
|
|
1016
|
+
/**
|
|
1017
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1018
|
+
*/
|
|
1019
|
+
id: string;
|
|
1020
|
+
body: CatalogPlatformModel.CreatePriceFactoryProductRequest;
|
|
1021
|
+
};
|
|
1022
|
+
type ClearCollectionItemsPriorityParam = {
|
|
1023
|
+
/**
|
|
1024
|
+
* - A `id` is a unique identifier of a collection.
|
|
1025
|
+
*/
|
|
1026
|
+
id: string;
|
|
1027
|
+
};
|
|
591
1028
|
type CreateAppCategoryReturnConfigurationParam = {
|
|
592
1029
|
body: CatalogPlatformModel.BaseAppCategoryReturnConfig;
|
|
593
1030
|
};
|
|
1031
|
+
type CreateAppPriceFactoryParam = {
|
|
1032
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryRequestSchema;
|
|
1033
|
+
};
|
|
594
1034
|
type CreateAppReturnConfigurationParam = {
|
|
595
1035
|
body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
|
|
596
1036
|
};
|
|
1037
|
+
type CreateAutocompleteSettingsParam = {
|
|
1038
|
+
body: CatalogPlatformModel.AutocompleteRequestSchema;
|
|
1039
|
+
};
|
|
597
1040
|
type CreateCollectionParam = {
|
|
598
|
-
/**
|
|
599
|
-
* - Get collection list filtered by q string,
|
|
600
|
-
*/
|
|
601
|
-
q?: string;
|
|
602
|
-
/**
|
|
603
|
-
* - Get collection list filtered by scheduled status,
|
|
604
|
-
*/
|
|
605
|
-
scheduleStatus?: string;
|
|
606
|
-
/**
|
|
607
|
-
* - Type of the collections
|
|
608
|
-
*/
|
|
609
|
-
type?: string;
|
|
610
|
-
/**
|
|
611
|
-
* - Each response will contain next_id param, which
|
|
612
|
-
* should be sent back to make pagination work.
|
|
613
|
-
*/
|
|
614
|
-
tags?: string[];
|
|
615
|
-
/**
|
|
616
|
-
* - Get collections filtered by active status.
|
|
617
|
-
*/
|
|
618
|
-
isActive?: boolean;
|
|
619
|
-
/**
|
|
620
|
-
* - The page number to navigate through the given
|
|
621
|
-
* set of results.
|
|
622
|
-
*/
|
|
623
|
-
pageNo?: number;
|
|
624
|
-
/**
|
|
625
|
-
* - Number of items to retrieve in each page.
|
|
626
|
-
* Default is 12.
|
|
627
|
-
*/
|
|
628
|
-
pageSize?: number;
|
|
629
1041
|
body: CatalogPlatformModel.CreateCollection;
|
|
630
1042
|
};
|
|
631
1043
|
type CreateConfigurationByTypeParam = {
|
|
@@ -650,7 +1062,7 @@ type CreateGroupConfigurationParam = {
|
|
|
650
1062
|
* particular group configuration type.
|
|
651
1063
|
*/
|
|
652
1064
|
configType: string;
|
|
653
|
-
body: CatalogPlatformModel.
|
|
1065
|
+
body: CatalogPlatformModel.AppConfigurationCreateDetail;
|
|
654
1066
|
};
|
|
655
1067
|
type CreateListingConfigurationParam = {
|
|
656
1068
|
/**
|
|
@@ -658,10 +1070,58 @@ type CreateListingConfigurationParam = {
|
|
|
658
1070
|
* particular listing configuration type.
|
|
659
1071
|
*/
|
|
660
1072
|
configType: string;
|
|
661
|
-
body: CatalogPlatformModel.
|
|
1073
|
+
body: CatalogPlatformModel.AppConfigurationsFilter;
|
|
1074
|
+
};
|
|
1075
|
+
type CreateMerchandisingRuleBoostActionParam = {
|
|
1076
|
+
/**
|
|
1077
|
+
* - A `merchandising_rule_id` is a
|
|
1078
|
+
* unique identifier for a particular merchandising rule.
|
|
1079
|
+
*/
|
|
1080
|
+
merchandisingRuleId: string;
|
|
1081
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
1082
|
+
};
|
|
1083
|
+
type CreateMerchandisingRuleBuryActionParam = {
|
|
1084
|
+
/**
|
|
1085
|
+
* - A `merchandising_rule_id` is a
|
|
1086
|
+
* unique identifier for a particular merchandising rule.
|
|
1087
|
+
*/
|
|
1088
|
+
merchandisingRuleId: string;
|
|
1089
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
1090
|
+
};
|
|
1091
|
+
type CreateMerchandisingRuleHideActionParam = {
|
|
1092
|
+
/**
|
|
1093
|
+
* - A `merchandising_rule_id` is a
|
|
1094
|
+
* unique identifier for a particular merchandising rule.
|
|
1095
|
+
*/
|
|
1096
|
+
merchandisingRuleId: string;
|
|
1097
|
+
body: CatalogPlatformModel.HideRequest;
|
|
1098
|
+
};
|
|
1099
|
+
type CreateMerchandisingRulePinActionParam = {
|
|
1100
|
+
/**
|
|
1101
|
+
* - A `merchandising_rule_id` is a
|
|
1102
|
+
* unique identifier for a particular merchandising rule.
|
|
1103
|
+
*/
|
|
1104
|
+
merchandisingRuleId: string;
|
|
1105
|
+
body: CatalogPlatformModel.PinRequest;
|
|
1106
|
+
};
|
|
1107
|
+
type CreateMerchandisingRuleQueryParam = {
|
|
1108
|
+
body: CatalogPlatformModel.MerchandisingRuleQueryPost;
|
|
1109
|
+
};
|
|
1110
|
+
type CreateProductPriceFactoryBulkJobParam = {
|
|
1111
|
+
/**
|
|
1112
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1113
|
+
*/
|
|
1114
|
+
id: string;
|
|
1115
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
662
1116
|
};
|
|
663
1117
|
type CreateSearchConfigurationParam = {
|
|
664
|
-
body: CatalogPlatformModel.
|
|
1118
|
+
body: CatalogPlatformModel.CreateSearchConfigurationRequest;
|
|
1119
|
+
};
|
|
1120
|
+
type CreateSearchRerankParam = {
|
|
1121
|
+
body: CatalogPlatformModel.CreateSearchRerankRequest;
|
|
1122
|
+
};
|
|
1123
|
+
type CreateSynonymsParam = {
|
|
1124
|
+
body: CatalogPlatformModel.SynonymCreateRequestSchema;
|
|
665
1125
|
};
|
|
666
1126
|
type DeleteAppCategoryReturnConfigurationParam = {
|
|
667
1127
|
body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
|
|
@@ -703,6 +1163,20 @@ type DeleteListingConfigurationParam = {
|
|
|
703
1163
|
*/
|
|
704
1164
|
configId: string;
|
|
705
1165
|
};
|
|
1166
|
+
type DeleteMerchandisingRuleParam = {
|
|
1167
|
+
/**
|
|
1168
|
+
* - A `merchandising_rule_id` is a
|
|
1169
|
+
* unique identifier for a particular merchandising rule.
|
|
1170
|
+
*/
|
|
1171
|
+
merchandisingRuleId: string;
|
|
1172
|
+
};
|
|
1173
|
+
type DeleteMerchandisingRulesPreviewParam = {
|
|
1174
|
+
/**
|
|
1175
|
+
* - A `merchandising_rule_id` is a
|
|
1176
|
+
* unique identifier for a particular merchandising rule.
|
|
1177
|
+
*/
|
|
1178
|
+
merchandisingRuleId: string;
|
|
1179
|
+
};
|
|
706
1180
|
type DeleteSearchKeywordsParam = {
|
|
707
1181
|
/**
|
|
708
1182
|
* - A `id` is a unique identifier for a particular
|
|
@@ -710,6 +1184,34 @@ type DeleteSearchKeywordsParam = {
|
|
|
710
1184
|
*/
|
|
711
1185
|
id: string;
|
|
712
1186
|
};
|
|
1187
|
+
type DeleteSearchRerankConfigurationParam = {
|
|
1188
|
+
/**
|
|
1189
|
+
* - An `id` is the identifier for a particular search
|
|
1190
|
+
* rerank configuration. channel.
|
|
1191
|
+
*/
|
|
1192
|
+
id: string;
|
|
1193
|
+
};
|
|
1194
|
+
type DeleteSynonymParam = {
|
|
1195
|
+
/**
|
|
1196
|
+
* - A `id` is a unique identifier of a synonym that is to
|
|
1197
|
+
* be deleted.
|
|
1198
|
+
*/
|
|
1199
|
+
id: string;
|
|
1200
|
+
};
|
|
1201
|
+
type EditAppPriceFactoryParam = {
|
|
1202
|
+
/**
|
|
1203
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1204
|
+
*/
|
|
1205
|
+
id: string;
|
|
1206
|
+
body: CatalogPlatformModel.EditAppPriceFactoryRequestSchema;
|
|
1207
|
+
};
|
|
1208
|
+
type ExportProductsInPriceFactoryParam = {
|
|
1209
|
+
/**
|
|
1210
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1211
|
+
*/
|
|
1212
|
+
id: string;
|
|
1213
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest;
|
|
1214
|
+
};
|
|
713
1215
|
type GetAllCollectionsParam = {
|
|
714
1216
|
/**
|
|
715
1217
|
* - Get collection list filtered by q string,
|
|
@@ -727,7 +1229,7 @@ type GetAllCollectionsParam = {
|
|
|
727
1229
|
* - Each response will contain next_id param, which
|
|
728
1230
|
* should be sent back to make pagination work.
|
|
729
1231
|
*/
|
|
730
|
-
|
|
1232
|
+
tag?: string[];
|
|
731
1233
|
/**
|
|
732
1234
|
* - Get collections filtered by active status.
|
|
733
1235
|
*/
|
|
@@ -743,12 +1245,7 @@ type GetAllCollectionsParam = {
|
|
|
743
1245
|
*/
|
|
744
1246
|
pageSize?: number;
|
|
745
1247
|
};
|
|
746
|
-
type
|
|
747
|
-
/**
|
|
748
|
-
* - Get return configurations for categories by matching
|
|
749
|
-
* the search string with category names.
|
|
750
|
-
*/
|
|
751
|
-
q?: string;
|
|
1248
|
+
type GetAllSearchKeywordParam = {
|
|
752
1249
|
/**
|
|
753
1250
|
* - The page number to navigate through the given
|
|
754
1251
|
* set of results
|
|
@@ -756,19 +1253,46 @@ type GetAppCategoryReturnConfigParam = {
|
|
|
756
1253
|
pageNo?: number;
|
|
757
1254
|
/**
|
|
758
1255
|
* - Number of items to retrieve in each page.
|
|
759
|
-
* Default is
|
|
1256
|
+
* Default is 12.
|
|
760
1257
|
*/
|
|
761
1258
|
pageSize?: number;
|
|
762
|
-
};
|
|
763
|
-
type GetAppInventoryParam = {
|
|
764
1259
|
/**
|
|
765
|
-
* -
|
|
1260
|
+
* - Search query with words name.Use this parameter to
|
|
1261
|
+
* search keywords by words.
|
|
766
1262
|
*/
|
|
767
|
-
|
|
1263
|
+
q?: string;
|
|
768
1264
|
/**
|
|
769
|
-
* -
|
|
1265
|
+
* - Can query for keywords based on whether they
|
|
1266
|
+
* are active or inactive.
|
|
770
1267
|
*/
|
|
771
|
-
|
|
1268
|
+
isActive?: boolean;
|
|
1269
|
+
};
|
|
1270
|
+
type GetAppCategoryReturnConfigParam = {
|
|
1271
|
+
/**
|
|
1272
|
+
* - Get return configurations for categories by matching
|
|
1273
|
+
* the search string with category names.
|
|
1274
|
+
*/
|
|
1275
|
+
q?: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* - The page number to navigate through the given
|
|
1278
|
+
* set of results
|
|
1279
|
+
*/
|
|
1280
|
+
pageNo?: number;
|
|
1281
|
+
/**
|
|
1282
|
+
* - Number of items to retrieve in each page.
|
|
1283
|
+
* Default is 10.
|
|
1284
|
+
*/
|
|
1285
|
+
pageSize?: number;
|
|
1286
|
+
};
|
|
1287
|
+
type GetAppInventoryParam = {
|
|
1288
|
+
/**
|
|
1289
|
+
* - The Item Id of the product.
|
|
1290
|
+
*/
|
|
1291
|
+
itemIds?: number[];
|
|
1292
|
+
/**
|
|
1293
|
+
* - The Store Id of products to fetch inventory.
|
|
1294
|
+
*/
|
|
1295
|
+
storeIds?: number[];
|
|
772
1296
|
/**
|
|
773
1297
|
* - The Brand Id of products to fetch inventory.
|
|
774
1298
|
*/
|
|
@@ -853,12 +1377,92 @@ type GetAppLocationsParam = {
|
|
|
853
1377
|
* - Get locations filtered by store types.
|
|
854
1378
|
*/
|
|
855
1379
|
storeTypes?: string[];
|
|
1380
|
+
/**
|
|
1381
|
+
* - Filter stores by company IDs available
|
|
1382
|
+
* in the application.
|
|
1383
|
+
*/
|
|
1384
|
+
companyUids?: number[];
|
|
1385
|
+
};
|
|
1386
|
+
type GetAppPriceByIdParam = {
|
|
1387
|
+
/**
|
|
1388
|
+
* - Unique identifier of the product
|
|
1389
|
+
*/
|
|
1390
|
+
itemId: number;
|
|
1391
|
+
/**
|
|
1392
|
+
* - An array of unique identifiers representing
|
|
1393
|
+
* the store locations from which the product pricing should be fetched. If
|
|
1394
|
+
* not provided, pricing for all applicable store locations will be returned.
|
|
1395
|
+
*/
|
|
1396
|
+
storeIds?: number[];
|
|
1397
|
+
/**
|
|
1398
|
+
* - An array of unique factory type
|
|
1399
|
+
* identifiers that specify that pricing from which factory type should be
|
|
1400
|
+
* retrieved. This parameter allows filtering the price based on factory types.
|
|
1401
|
+
*/
|
|
1402
|
+
factoryTypeIds?: string[];
|
|
1403
|
+
/**
|
|
1404
|
+
* - The company uid for which we want to fetch
|
|
1405
|
+
* discounted pricing for a product
|
|
1406
|
+
*/
|
|
1407
|
+
sellerId?: number;
|
|
1408
|
+
};
|
|
1409
|
+
type GetAppPriceFactoriesParam = {
|
|
1410
|
+
/**
|
|
1411
|
+
* - Gets price factory filtered by active status.
|
|
1412
|
+
*/
|
|
1413
|
+
isActive?: boolean;
|
|
1414
|
+
/**
|
|
1415
|
+
* - Gets price factory filtered by factory_type_id.
|
|
1416
|
+
*/
|
|
1417
|
+
factoryTypeId?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* - Gets price factory filtered by pricezone code.
|
|
1420
|
+
*/
|
|
1421
|
+
code?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* - The page number to navigate through the given
|
|
1424
|
+
* set of results.
|
|
1425
|
+
*/
|
|
1426
|
+
pageNo?: number;
|
|
1427
|
+
/**
|
|
1428
|
+
* - Number of items to retrieve in each page.
|
|
1429
|
+
* Default is 12.
|
|
1430
|
+
*/
|
|
1431
|
+
pageSize?: number;
|
|
1432
|
+
};
|
|
1433
|
+
type GetAppPriceFactoryParam = {
|
|
1434
|
+
/**
|
|
1435
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1436
|
+
*/
|
|
1437
|
+
id: string;
|
|
856
1438
|
};
|
|
857
1439
|
type GetAppProductParam = {
|
|
858
1440
|
/**
|
|
859
1441
|
* - Product id for a particular product.
|
|
860
1442
|
*/
|
|
861
|
-
itemId:
|
|
1443
|
+
itemId: number;
|
|
1444
|
+
};
|
|
1445
|
+
type GetAppProductPricesParam = {
|
|
1446
|
+
/**
|
|
1447
|
+
* - List of item ids to get product prices
|
|
1448
|
+
* filtered by items.
|
|
1449
|
+
*/
|
|
1450
|
+
itemIds?: number[];
|
|
1451
|
+
/**
|
|
1452
|
+
* - List of factory type ids to get
|
|
1453
|
+
* product prices filtered by factory type id.
|
|
1454
|
+
*/
|
|
1455
|
+
factoryTypeIds?: string[];
|
|
1456
|
+
/**
|
|
1457
|
+
* - The page number to navigate through the given
|
|
1458
|
+
* set of results
|
|
1459
|
+
*/
|
|
1460
|
+
pageNo?: number;
|
|
1461
|
+
/**
|
|
1462
|
+
* - Number of items to retrieve in each page.
|
|
1463
|
+
* Default is 10.
|
|
1464
|
+
*/
|
|
1465
|
+
pageSize?: number;
|
|
862
1466
|
};
|
|
863
1467
|
type GetAppProductsParam = {
|
|
864
1468
|
/**
|
|
@@ -908,7 +1512,7 @@ type GetApplicationBrandListingParam = {
|
|
|
908
1512
|
*/
|
|
909
1513
|
pageSize?: number;
|
|
910
1514
|
/**
|
|
911
|
-
* - Search query with brand name.
|
|
1515
|
+
* - Search query with brand name.Use this parameter to
|
|
912
1516
|
* search brands by brand name.
|
|
913
1517
|
*/
|
|
914
1518
|
q?: string;
|
|
@@ -918,7 +1522,7 @@ type GetApplicationBrandsParam = {
|
|
|
918
1522
|
* - The name of the department. Use this
|
|
919
1523
|
* parameter to filter products by a particular department. See below the list
|
|
920
1524
|
* of available departments. You can retrieve available departments from the
|
|
921
|
-
*
|
|
1525
|
+
* **v1.0/departments/** API
|
|
922
1526
|
*/
|
|
923
1527
|
department?: string;
|
|
924
1528
|
/**
|
|
@@ -932,7 +1536,7 @@ type GetApplicationBrandsParam = {
|
|
|
932
1536
|
*/
|
|
933
1537
|
pageSize?: number;
|
|
934
1538
|
/**
|
|
935
|
-
* - Search query with brand name.
|
|
1539
|
+
* - Search query with brand name.Use this parameter to
|
|
936
1540
|
* search brands by brand name.
|
|
937
1541
|
*/
|
|
938
1542
|
q?: string;
|
|
@@ -959,8 +1563,8 @@ type GetApplicationCategoryListingParam = {
|
|
|
959
1563
|
*/
|
|
960
1564
|
pageSize?: number;
|
|
961
1565
|
/**
|
|
962
|
-
* -
|
|
963
|
-
*
|
|
1566
|
+
* - Search query with brand name.Use this parameter to
|
|
1567
|
+
* search brands by brand name.
|
|
964
1568
|
*/
|
|
965
1569
|
q?: string;
|
|
966
1570
|
};
|
|
@@ -976,34 +1580,36 @@ type GetApplicationDepartmentListingParam = {
|
|
|
976
1580
|
*/
|
|
977
1581
|
pageSize?: number;
|
|
978
1582
|
/**
|
|
979
|
-
* -
|
|
980
|
-
*
|
|
1583
|
+
* - Search query with brand name.Use this parameter to
|
|
1584
|
+
* search department by name.
|
|
981
1585
|
*/
|
|
982
1586
|
q?: string;
|
|
983
1587
|
};
|
|
984
1588
|
type GetApplicationFilterKeysParam = {
|
|
985
1589
|
/**
|
|
986
1590
|
* - The search filter parameters for collection items.
|
|
987
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
988
|
-
* parameter in this format.
|
|
1591
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1592
|
+
* parameter in this format.
|
|
1593
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
989
1594
|
*/
|
|
990
1595
|
c?: string;
|
|
991
1596
|
};
|
|
992
1597
|
type GetApplicationFilterValuesParam = {
|
|
993
1598
|
/**
|
|
994
|
-
* - A `filter_key` is a filter key which
|
|
995
|
-
* all the available filter values.
|
|
1599
|
+
* - A `filter_key` is a filter key for a for which
|
|
1600
|
+
* all the available filter values will returned. channel.
|
|
996
1601
|
*/
|
|
997
1602
|
filterKey: string;
|
|
998
1603
|
/**
|
|
999
1604
|
* - The search filter parameters for collection items.
|
|
1000
|
-
* All the parameter filtered from filter parameters will be passed in
|
|
1001
|
-
* parameter in this format.
|
|
1605
|
+
* All the parameter filtered from filter parameters will be passed in **c**
|
|
1606
|
+
* parameter in this format.
|
|
1607
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
1002
1608
|
*/
|
|
1003
1609
|
c?: string;
|
|
1004
1610
|
/**
|
|
1005
1611
|
* - A `collection_id` is a unique identifier
|
|
1006
|
-
* for a particular collection.
|
|
1612
|
+
* for a particular collection. channel.
|
|
1007
1613
|
*/
|
|
1008
1614
|
collectionId?: string;
|
|
1009
1615
|
/**
|
|
@@ -1017,10 +1623,7 @@ type GetApplicationFilterValuesParam = {
|
|
|
1017
1623
|
*/
|
|
1018
1624
|
pageSize?: number;
|
|
1019
1625
|
/**
|
|
1020
|
-
* -
|
|
1021
|
-
* specific data within the filter options. It acts as a query keyword that
|
|
1022
|
-
* can refine the results by matching relevant filter values, such as a
|
|
1023
|
-
* category name or any other applicable filter criteria.
|
|
1626
|
+
* - Get Values filtered by q string
|
|
1024
1627
|
*/
|
|
1025
1628
|
q?: string;
|
|
1026
1629
|
};
|
|
@@ -1084,6 +1687,28 @@ type GetApplicationProductsParam = {
|
|
|
1084
1687
|
*/
|
|
1085
1688
|
itemIds?: string[];
|
|
1086
1689
|
};
|
|
1690
|
+
type GetAutocompleteConfigParam = {
|
|
1691
|
+
/**
|
|
1692
|
+
* - The page number to navigate through the given
|
|
1693
|
+
* set of results
|
|
1694
|
+
*/
|
|
1695
|
+
pageNo?: number;
|
|
1696
|
+
/**
|
|
1697
|
+
* - Number of items to retrieve in each page.
|
|
1698
|
+
* Default is 12.
|
|
1699
|
+
*/
|
|
1700
|
+
pageSize?: number;
|
|
1701
|
+
/**
|
|
1702
|
+
* - Search query with words name.Use this parameter to
|
|
1703
|
+
* search keywords by words.
|
|
1704
|
+
*/
|
|
1705
|
+
q?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* - Can query for keywords based on whether they
|
|
1708
|
+
* are active or inactive.
|
|
1709
|
+
*/
|
|
1710
|
+
isActive?: boolean;
|
|
1711
|
+
};
|
|
1087
1712
|
type GetAutocompleteKeywordDetailParam = {
|
|
1088
1713
|
/**
|
|
1089
1714
|
* - A `id` is a unique identifier for a particular
|
|
@@ -1091,9 +1716,35 @@ type GetAutocompleteKeywordDetailParam = {
|
|
|
1091
1716
|
*/
|
|
1092
1717
|
id: string;
|
|
1093
1718
|
};
|
|
1719
|
+
type GetAutocompletePreviewParam = {
|
|
1720
|
+
/**
|
|
1721
|
+
* - Get suggestions related to `q` string.
|
|
1722
|
+
*/
|
|
1723
|
+
q?: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* - For getting related category suggestions.
|
|
1726
|
+
*/
|
|
1727
|
+
categorySuggestion?: number;
|
|
1728
|
+
/**
|
|
1729
|
+
* - For getting related brand suggestions.
|
|
1730
|
+
*/
|
|
1731
|
+
brandSuggestion?: number;
|
|
1732
|
+
/**
|
|
1733
|
+
* - For getting collection suggestions.
|
|
1734
|
+
*/
|
|
1735
|
+
collectionSuggestion?: number;
|
|
1736
|
+
/**
|
|
1737
|
+
* - For getting product suggestions.
|
|
1738
|
+
*/
|
|
1739
|
+
productSuggestion?: number;
|
|
1740
|
+
/**
|
|
1741
|
+
* - For getting query suggestions.
|
|
1742
|
+
*/
|
|
1743
|
+
querySuggestion?: number;
|
|
1744
|
+
};
|
|
1094
1745
|
type GetCatalogInsightsParam = {
|
|
1095
1746
|
/**
|
|
1096
|
-
* - Brand slug
|
|
1747
|
+
* - Brand slug
|
|
1097
1748
|
*/
|
|
1098
1749
|
brand?: string;
|
|
1099
1750
|
};
|
|
@@ -1102,7 +1753,7 @@ type GetCategoriesParam = {
|
|
|
1102
1753
|
* - The name of the department. Use this
|
|
1103
1754
|
* parameter to filter products by a particular department. See below the list
|
|
1104
1755
|
* of available departments. You can retrieve available departments from the
|
|
1105
|
-
*
|
|
1756
|
+
* **v1.0/departments/** API
|
|
1106
1757
|
*/
|
|
1107
1758
|
department?: string;
|
|
1108
1759
|
};
|
|
@@ -1124,11 +1775,6 @@ type GetCollectionItemsParam = {
|
|
|
1124
1775
|
* should be sent back to make pagination work.
|
|
1125
1776
|
*/
|
|
1126
1777
|
sortOn?: string;
|
|
1127
|
-
/**
|
|
1128
|
-
* - Each response will contain next_id param, which
|
|
1129
|
-
* should be sent back to make pagination work.
|
|
1130
|
-
*/
|
|
1131
|
-
pageId?: string;
|
|
1132
1778
|
/**
|
|
1133
1779
|
* - Number of items to retrieve in each page.
|
|
1134
1780
|
* Default is 12.
|
|
@@ -1138,6 +1784,20 @@ type GetCollectionItemsParam = {
|
|
|
1138
1784
|
* - Identifies the specific page of results being requested.
|
|
1139
1785
|
*/
|
|
1140
1786
|
pageNo?: number;
|
|
1787
|
+
/**
|
|
1788
|
+
* - Number of items that are pinned and have
|
|
1789
|
+
* priority in each page. Default is 12.
|
|
1790
|
+
*/
|
|
1791
|
+
isPinned?: boolean;
|
|
1792
|
+
/**
|
|
1793
|
+
* - Get multiple products filtered by q string
|
|
1794
|
+
*/
|
|
1795
|
+
q?: string;
|
|
1796
|
+
/**
|
|
1797
|
+
* - Number of items that are excluded from
|
|
1798
|
+
* collections in each page. Default is 12.
|
|
1799
|
+
*/
|
|
1800
|
+
isExcluded?: boolean;
|
|
1141
1801
|
};
|
|
1142
1802
|
type GetConfigurationByTypeParam = {
|
|
1143
1803
|
/**
|
|
@@ -1156,28 +1816,21 @@ type GetConfigurationMetadataParam = {
|
|
|
1156
1816
|
* `template_slug` string. This is for the details and comparision groups.
|
|
1157
1817
|
*/
|
|
1158
1818
|
templateSlug?: string;
|
|
1819
|
+
};
|
|
1820
|
+
type GetConfigurationsFilterMetadataParam = {
|
|
1159
1821
|
/**
|
|
1160
|
-
* -
|
|
1161
|
-
* set of results.
|
|
1162
|
-
*/
|
|
1163
|
-
pageNo?: number;
|
|
1164
|
-
/**
|
|
1165
|
-
* - Number of items to retrieve in each page.
|
|
1166
|
-
*/
|
|
1167
|
-
pageSize?: number;
|
|
1168
|
-
/**
|
|
1169
|
-
* - Get configuration list filtered by `q` string.
|
|
1822
|
+
* - Filter whose values needs to be fetched.
|
|
1170
1823
|
*/
|
|
1171
|
-
|
|
1824
|
+
filter: string;
|
|
1172
1825
|
};
|
|
1173
1826
|
type GetDiscountedInventoryBySizeIdentifierParam = {
|
|
1174
1827
|
/**
|
|
1175
|
-
* -
|
|
1828
|
+
* - Item code of the product of which size is to be get.
|
|
1176
1829
|
*/
|
|
1177
1830
|
itemId: number;
|
|
1178
1831
|
/**
|
|
1179
1832
|
* - Size Identifier (Seller Identifier or
|
|
1180
|
-
* Primary Identifier).
|
|
1833
|
+
* Primary Identifier) of which inventory is to get.
|
|
1181
1834
|
*/
|
|
1182
1835
|
sizeIdentifier: number;
|
|
1183
1836
|
/**
|
|
@@ -1241,15 +1894,108 @@ type GetListingConfigurationsParam = {
|
|
|
1241
1894
|
* - Get configuration list filtered by `search` string.
|
|
1242
1895
|
*/
|
|
1243
1896
|
search?: string;
|
|
1897
|
+
/**
|
|
1898
|
+
* - Only for categories config type, Get
|
|
1899
|
+
* configuration list filtered by `uids`.
|
|
1900
|
+
*/
|
|
1901
|
+
uids?: number[];
|
|
1902
|
+
};
|
|
1903
|
+
type GetLivePreviewParam = {
|
|
1904
|
+
/**
|
|
1905
|
+
* - A `merchandising_rule_id` is a
|
|
1906
|
+
* unique identifier for a particular merchandising rule.
|
|
1907
|
+
*/
|
|
1908
|
+
merchandisingRuleId: string;
|
|
1909
|
+
/**
|
|
1910
|
+
* - A sample query that can be used to get a
|
|
1911
|
+
* live preview of the merchandising rule.
|
|
1912
|
+
*/
|
|
1913
|
+
searchKeyword?: string;
|
|
1914
|
+
};
|
|
1915
|
+
type GetMerchandisingQueryParam = {
|
|
1916
|
+
/**
|
|
1917
|
+
* - A `merchandising_rule_id` is a
|
|
1918
|
+
* unique identifier for a particular merchandising rule.
|
|
1919
|
+
*/
|
|
1920
|
+
merchandisingRuleId: string;
|
|
1921
|
+
};
|
|
1922
|
+
type GetMerchandisingRuleBoostActionParam = {
|
|
1923
|
+
/**
|
|
1924
|
+
* - A `merchandising_rule_id` is a
|
|
1925
|
+
* unique identifier for a particular merchandising rule.
|
|
1926
|
+
*/
|
|
1927
|
+
merchandisingRuleId: string;
|
|
1928
|
+
};
|
|
1929
|
+
type GetMerchandisingRuleBuryActionParam = {
|
|
1930
|
+
/**
|
|
1931
|
+
* - A `merchandising_rule_id` is a
|
|
1932
|
+
* unique identifier for a particular merchandising rule.
|
|
1933
|
+
*/
|
|
1934
|
+
merchandisingRuleId: string;
|
|
1935
|
+
};
|
|
1936
|
+
type GetMerchandisingRuleHideActionParam = {
|
|
1937
|
+
/**
|
|
1938
|
+
* - A `merchandising_rule_id` is a
|
|
1939
|
+
* unique identifier for a particular merchandising rule.
|
|
1940
|
+
*/
|
|
1941
|
+
merchandisingRuleId: string;
|
|
1942
|
+
};
|
|
1943
|
+
type GetMerchandisingRulePinActionParam = {
|
|
1944
|
+
/**
|
|
1945
|
+
* - A `merchandising_rule_id` is a
|
|
1946
|
+
* unique identifier for a particular merchandising rule.
|
|
1947
|
+
*/
|
|
1948
|
+
merchandisingRuleId: string;
|
|
1949
|
+
};
|
|
1950
|
+
type GetMerchandisingRulesParam = {
|
|
1951
|
+
/**
|
|
1952
|
+
* - Each response will contain next_id param, which
|
|
1953
|
+
* should be sent back to make pagination work.
|
|
1954
|
+
*/
|
|
1955
|
+
pageId?: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* - Number of items to retrieve in each page.
|
|
1958
|
+
* Default is 12.
|
|
1959
|
+
*/
|
|
1960
|
+
pageSize?: number;
|
|
1244
1961
|
};
|
|
1245
1962
|
type GetProductDetailBySlugParam = {
|
|
1246
1963
|
/**
|
|
1247
1964
|
* - The unique identifier of a product. i.e; `slug` of
|
|
1248
1965
|
* a product. You can retrieve these from the APIs that list products like
|
|
1249
|
-
*
|
|
1966
|
+
* **v1.0/products/**
|
|
1250
1967
|
*/
|
|
1251
1968
|
slug: string;
|
|
1252
1969
|
};
|
|
1970
|
+
type GetProductsInPriceFactoryByZoneIdParam = {
|
|
1971
|
+
/**
|
|
1972
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
1973
|
+
*/
|
|
1974
|
+
id: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* - An `zone_id` is a unique identifier for a
|
|
1977
|
+
* particular price factory zone.
|
|
1978
|
+
*/
|
|
1979
|
+
zoneId: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* - Gets price factory filtered by item_id.
|
|
1982
|
+
*/
|
|
1983
|
+
itemId?: number;
|
|
1984
|
+
/**
|
|
1985
|
+
* - Gets price factory filtered by search query.
|
|
1986
|
+
*/
|
|
1987
|
+
q?: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* - The page number to navigate through the given
|
|
1990
|
+
* set of results.
|
|
1991
|
+
*/
|
|
1992
|
+
pageNo?: number;
|
|
1993
|
+
/**
|
|
1994
|
+
* - Number of items to retrieve in each page.
|
|
1995
|
+
* Default is 12.
|
|
1996
|
+
*/
|
|
1997
|
+
pageSize?: number;
|
|
1998
|
+
};
|
|
1253
1999
|
type GetSearchKeywordsParam = {
|
|
1254
2000
|
/**
|
|
1255
2001
|
* - A `id` is a unique identifier for a particular
|
|
@@ -1257,23 +2003,116 @@ type GetSearchKeywordsParam = {
|
|
|
1257
2003
|
*/
|
|
1258
2004
|
id: string;
|
|
1259
2005
|
};
|
|
2006
|
+
type GetSearchRerankDetailParam = {
|
|
2007
|
+
/**
|
|
2008
|
+
* - An `id` is the identifier for a particular search
|
|
2009
|
+
* rerank configuration. channel.
|
|
2010
|
+
*/
|
|
2011
|
+
id: string;
|
|
2012
|
+
};
|
|
2013
|
+
type GetSynonymsParam = {
|
|
2014
|
+
/**
|
|
2015
|
+
* - Mongo id of the particular synonym
|
|
2016
|
+
*/
|
|
2017
|
+
id?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* - Synonym name
|
|
2020
|
+
*/
|
|
2021
|
+
name?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* - Synonym type - oneway/twoway
|
|
2024
|
+
*/
|
|
2025
|
+
type?: string;
|
|
2026
|
+
};
|
|
2027
|
+
type PollBulkSynonymsParam = {
|
|
2028
|
+
/**
|
|
2029
|
+
* - Id of the bulk job that needs to be polled.
|
|
2030
|
+
*/
|
|
2031
|
+
id: string;
|
|
2032
|
+
};
|
|
2033
|
+
type PollPriceFactoryJobsParam = {
|
|
2034
|
+
/**
|
|
2035
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
2036
|
+
*/
|
|
2037
|
+
id: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* - Date that filters the jobs created after this date
|
|
2040
|
+
*/
|
|
2041
|
+
startDate?: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* - Date that filters the jobs created before this date
|
|
2044
|
+
*/
|
|
2045
|
+
endDate?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* - Filter jobs by the stage
|
|
2048
|
+
*/
|
|
2049
|
+
stage?: string[];
|
|
2050
|
+
/**
|
|
2051
|
+
* - Filter active or inactive jobs
|
|
2052
|
+
*/
|
|
2053
|
+
isActive?: boolean;
|
|
2054
|
+
/**
|
|
2055
|
+
* - Pass unique identifier for a particular job to poll
|
|
2056
|
+
*/
|
|
2057
|
+
q?: string;
|
|
2058
|
+
/**
|
|
2059
|
+
* - Pass type for a particular job to poll
|
|
2060
|
+
*/
|
|
2061
|
+
type?: string[];
|
|
2062
|
+
};
|
|
2063
|
+
type PollProductPriceFactoryBulkJobParam = {
|
|
2064
|
+
/**
|
|
2065
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
2066
|
+
*/
|
|
2067
|
+
id: string;
|
|
2068
|
+
/**
|
|
2069
|
+
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2070
|
+
*/
|
|
2071
|
+
jobId: string;
|
|
2072
|
+
};
|
|
2073
|
+
type ProcessBulkSynonymsParam = {
|
|
2074
|
+
body: CatalogPlatformModel.SynonymBulkProcessRequestSchema;
|
|
2075
|
+
};
|
|
2076
|
+
type ProcessProductPriceFactoryBulkJobParam = {
|
|
2077
|
+
/**
|
|
2078
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
2079
|
+
*/
|
|
2080
|
+
id: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2083
|
+
*/
|
|
2084
|
+
jobId: string;
|
|
2085
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
2086
|
+
};
|
|
2087
|
+
type SampleBulkSynonymsFileParam = {
|
|
2088
|
+
/**
|
|
2089
|
+
* - Type of the file
|
|
2090
|
+
*/
|
|
2091
|
+
type: string;
|
|
2092
|
+
};
|
|
2093
|
+
type SaveMerchandisingRulesParam = {
|
|
2094
|
+
/**
|
|
2095
|
+
* - A `merchandising_rule_id` is a
|
|
2096
|
+
* unique identifier for a particular merchandising rule.
|
|
2097
|
+
*/
|
|
2098
|
+
merchandisingRuleId: string;
|
|
2099
|
+
body: CatalogPlatformModel.MerchandisingRuleSave;
|
|
2100
|
+
};
|
|
1260
2101
|
type UpdateAllowSingleParam = {
|
|
1261
|
-
body: CatalogPlatformModel.
|
|
2102
|
+
body: CatalogPlatformModel.AllowSingleRequest;
|
|
1262
2103
|
};
|
|
1263
2104
|
type UpdateAppBrandParam = {
|
|
1264
2105
|
/**
|
|
1265
|
-
* -
|
|
1266
|
-
* particular brand.
|
|
2106
|
+
* - Brand id for which the custom_json is associated.
|
|
1267
2107
|
*/
|
|
1268
2108
|
brandUid: number;
|
|
1269
2109
|
body: CatalogPlatformModel.ApplicationBrandJson;
|
|
1270
2110
|
};
|
|
1271
2111
|
type UpdateAppCategoryParam = {
|
|
1272
2112
|
/**
|
|
1273
|
-
* -
|
|
1274
|
-
* particular category.
|
|
2113
|
+
* - Category id for which the custom_json is associated.
|
|
1275
2114
|
*/
|
|
1276
|
-
categoryUid:
|
|
2115
|
+
categoryUid: number;
|
|
1277
2116
|
body: CatalogPlatformModel.ApplicationCategoryJson;
|
|
1278
2117
|
};
|
|
1279
2118
|
type UpdateAppCategoryReturnConfigurationParam = {
|
|
@@ -1281,8 +2120,8 @@ type UpdateAppCategoryReturnConfigurationParam = {
|
|
|
1281
2120
|
};
|
|
1282
2121
|
type UpdateAppDepartmentParam = {
|
|
1283
2122
|
/**
|
|
1284
|
-
* -
|
|
1285
|
-
*
|
|
2123
|
+
* - Department id for which the custom_json is
|
|
2124
|
+
* associated.
|
|
1286
2125
|
*/
|
|
1287
2126
|
departmentUid: number;
|
|
1288
2127
|
body: CatalogPlatformModel.ApplicationDepartmentJson;
|
|
@@ -1296,7 +2135,7 @@ type UpdateAppLocationParam = {
|
|
|
1296
2135
|
};
|
|
1297
2136
|
type UpdateAppProductParam = {
|
|
1298
2137
|
/**
|
|
1299
|
-
* -
|
|
2138
|
+
* - Product id for which the custom_meta is associated.
|
|
1300
2139
|
*/
|
|
1301
2140
|
itemId: number;
|
|
1302
2141
|
body: CatalogPlatformModel.ApplicationItemMeta;
|
|
@@ -1312,6 +2151,14 @@ type UpdateAutocompleteKeywordParam = {
|
|
|
1312
2151
|
id: string;
|
|
1313
2152
|
body: CatalogPlatformModel.CreateAutocompleteKeyword;
|
|
1314
2153
|
};
|
|
2154
|
+
type UpdateAutocompleteSettingsParam = {
|
|
2155
|
+
/**
|
|
2156
|
+
* - An `id` is a unique identifier for a particular
|
|
2157
|
+
* autocomplete settings config.
|
|
2158
|
+
*/
|
|
2159
|
+
id: string;
|
|
2160
|
+
body: CatalogPlatformModel.AutocompleteRequestSchema;
|
|
2161
|
+
};
|
|
1315
2162
|
type UpdateCollectionParam = {
|
|
1316
2163
|
/**
|
|
1317
2164
|
* - A `id` is a unique identifier of a collection.
|
|
@@ -1320,7 +2167,7 @@ type UpdateCollectionParam = {
|
|
|
1320
2167
|
body: CatalogPlatformModel.UpdateCollection;
|
|
1321
2168
|
};
|
|
1322
2169
|
type UpdateDefaultSortParam = {
|
|
1323
|
-
body: CatalogPlatformModel.
|
|
2170
|
+
body: CatalogPlatformModel.DefaultKeyRequest;
|
|
1324
2171
|
};
|
|
1325
2172
|
type UpdateGroupConfigurationParam = {
|
|
1326
2173
|
/**
|
|
@@ -1346,10 +2193,50 @@ type UpdateListingConfigurationParam = {
|
|
|
1346
2193
|
* particular configuration.
|
|
1347
2194
|
*/
|
|
1348
2195
|
configId: string;
|
|
1349
|
-
body: CatalogPlatformModel.
|
|
2196
|
+
body: CatalogPlatformModel.AppConfigurationsFilterResponse;
|
|
2197
|
+
};
|
|
2198
|
+
type UpdateMerchandisingRuleBoostActionParam = {
|
|
2199
|
+
/**
|
|
2200
|
+
* - A `merchandising_rule_id` is a
|
|
2201
|
+
* unique identifier for a particular merchandising rule.
|
|
2202
|
+
*/
|
|
2203
|
+
merchandisingRuleId: string;
|
|
2204
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
2205
|
+
};
|
|
2206
|
+
type UpdateMerchandisingRuleBuryActionParam = {
|
|
2207
|
+
/**
|
|
2208
|
+
* - A `merchandising_rule_id` is a
|
|
2209
|
+
* unique identifier for a particular merchandising rule.
|
|
2210
|
+
*/
|
|
2211
|
+
merchandisingRuleId: string;
|
|
2212
|
+
body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
|
|
2213
|
+
};
|
|
2214
|
+
type UpdateMerchandisingRuleHideActionParam = {
|
|
2215
|
+
/**
|
|
2216
|
+
* - A `merchandising_rule_id` is a
|
|
2217
|
+
* unique identifier for a particular merchandising rule.
|
|
2218
|
+
*/
|
|
2219
|
+
merchandisingRuleId: string;
|
|
2220
|
+
body: CatalogPlatformModel.HideRequest;
|
|
2221
|
+
};
|
|
2222
|
+
type UpdateMerchandisingRulePinActionParam = {
|
|
2223
|
+
/**
|
|
2224
|
+
* - A `merchandising_rule_id` is a
|
|
2225
|
+
* unique identifier for a particular merchandising rule.
|
|
2226
|
+
*/
|
|
2227
|
+
merchandisingRuleId: string;
|
|
2228
|
+
body: CatalogPlatformModel.PinRequest;
|
|
2229
|
+
};
|
|
2230
|
+
type UpdateMerchandisingRuleQueryParam = {
|
|
2231
|
+
/**
|
|
2232
|
+
* - A `merchandising_rule_id` is a
|
|
2233
|
+
* unique identifier for a particular merchandising rule.
|
|
2234
|
+
*/
|
|
2235
|
+
merchandisingRuleId: string;
|
|
2236
|
+
body: CatalogPlatformModel.MerchandisingRuleQueryPost;
|
|
1350
2237
|
};
|
|
1351
2238
|
type UpdateSearchConfigurationParam = {
|
|
1352
|
-
body: CatalogPlatformModel.
|
|
2239
|
+
body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
|
|
1353
2240
|
};
|
|
1354
2241
|
type UpdateSearchKeywordsParam = {
|
|
1355
2242
|
/**
|
|
@@ -1359,13 +2246,47 @@ type UpdateSearchKeywordsParam = {
|
|
|
1359
2246
|
id: string;
|
|
1360
2247
|
body: CatalogPlatformModel.CreateSearchKeyword;
|
|
1361
2248
|
};
|
|
2249
|
+
type UpdateSearchRerankConfigurationParam = {
|
|
2250
|
+
/**
|
|
2251
|
+
* - An `id` is the identifier for a particular search
|
|
2252
|
+
* rerank configuration. channel.
|
|
2253
|
+
*/
|
|
2254
|
+
id: string;
|
|
2255
|
+
body: CatalogPlatformModel.UpdateSearchRerankRequest;
|
|
2256
|
+
};
|
|
2257
|
+
type UpdateSynonymsParam = {
|
|
2258
|
+
/**
|
|
2259
|
+
* - An `id` is a unique identifier for a particular
|
|
2260
|
+
* synonym channel.
|
|
2261
|
+
*/
|
|
2262
|
+
id: string;
|
|
2263
|
+
body: CatalogPlatformModel.SynonymCreateRequestSchema;
|
|
2264
|
+
};
|
|
2265
|
+
type UploadSynonymsParam = {
|
|
2266
|
+
body: CatalogPlatformModel.SynonymUploadRequestSchema;
|
|
2267
|
+
};
|
|
2268
|
+
type ValidateBulkSynonymsParam = {
|
|
2269
|
+
body: CatalogPlatformModel.SynonymBulkValidateRequestSchema;
|
|
2270
|
+
};
|
|
2271
|
+
type ValidateProductPriceFactoryBulkJobParam = {
|
|
2272
|
+
/**
|
|
2273
|
+
* - An `id` is a unique identifier for a particular price factory.
|
|
2274
|
+
*/
|
|
2275
|
+
id: string;
|
|
2276
|
+
/**
|
|
2277
|
+
* - A `job_id` is a unique identifier for a particular bulk job.
|
|
2278
|
+
*/
|
|
2279
|
+
jobId: string;
|
|
2280
|
+
body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
|
|
2281
|
+
};
|
|
1362
2282
|
type DeleteSearchConfigurationParam = any;
|
|
1363
|
-
type
|
|
2283
|
+
type ExportSynonymsParam = any;
|
|
1364
2284
|
type GetAppReturnConfigurationParam = any;
|
|
1365
|
-
type
|
|
2285
|
+
type GetAutocompleteSettingsParam = any;
|
|
1366
2286
|
type GetCatalogConfigurationParam = any;
|
|
1367
2287
|
type GetConfigurationsParam = any;
|
|
1368
2288
|
type GetDepartmentsParam = any;
|
|
1369
2289
|
type GetQueryFiltersParam = any;
|
|
1370
2290
|
type GetSearchConfigurationParam = any;
|
|
2291
|
+
type GetSearchRerankParam = any;
|
|
1371
2292
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|