@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -14,7 +14,7 @@ declare class Catalog {
|
|
|
14
14
|
*
|
|
15
15
|
* @name addCollectionItems
|
|
16
16
|
* @summary: Create items in a collection
|
|
17
|
-
* @description: Adds items to a collection specified by its id - Check out [method documentation](https://
|
|
17
|
+
* @description: Adds items to a collection specified by its id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/addCollectionItems/).
|
|
18
18
|
*/
|
|
19
19
|
addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
|
|
20
20
|
/**
|
|
@@ -26,7 +26,7 @@ declare class Catalog {
|
|
|
26
26
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
27
27
|
* @name createAppCategoryReturnConfiguration
|
|
28
28
|
* @summary: Create return configuration
|
|
29
|
-
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://
|
|
29
|
+
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
30
30
|
*/
|
|
31
31
|
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
32
32
|
/**
|
|
@@ -38,20 +38,21 @@ declare class Catalog {
|
|
|
38
38
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
39
39
|
* @name createAppReturnConfiguration
|
|
40
40
|
* @summary: Create product return configuration
|
|
41
|
-
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://
|
|
41
|
+
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
42
42
|
*/
|
|
43
43
|
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
44
44
|
/**
|
|
45
45
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
46
46
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
-
* Success response
|
|
48
|
+
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
|
|
49
|
+
* - Success response
|
|
50
|
+
*
|
|
50
51
|
* @name createCollection
|
|
51
52
|
* @summary: Create a collection
|
|
52
|
-
* @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://
|
|
53
|
+
* @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createCollection/).
|
|
53
54
|
*/
|
|
54
|
-
createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
55
|
+
createCollection({ body, q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponseSchema>;
|
|
55
56
|
/**
|
|
56
57
|
* @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
|
|
57
58
|
* - Arg object
|
|
@@ -62,7 +63,7 @@ declare class Catalog {
|
|
|
62
63
|
* Success response
|
|
63
64
|
* @name createConfigurationByType
|
|
64
65
|
* @summary: Create configuration
|
|
65
|
-
* @description: Add configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://
|
|
66
|
+
* @description: Add configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createConfigurationByType/).
|
|
66
67
|
*/
|
|
67
68
|
createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
68
69
|
/**
|
|
@@ -75,7 +76,7 @@ declare class Catalog {
|
|
|
75
76
|
* Success response
|
|
76
77
|
* @name createConfigurationProductListing
|
|
77
78
|
* @summary: Create product listing configuration
|
|
78
|
-
* @description: Add configuration for products & listing specific to a company and an sales channel. - Check out [method documentation](https://
|
|
79
|
+
* @description: Add configuration for products & listing specific to a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createConfigurationProductListing/).
|
|
79
80
|
*/
|
|
80
81
|
createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
81
82
|
/**
|
|
@@ -84,14 +85,14 @@ declare class Catalog {
|
|
|
84
85
|
*
|
|
85
86
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
86
87
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
87
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
88
|
+
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
|
|
88
89
|
* - Success response
|
|
89
90
|
*
|
|
90
91
|
* @name createCustomAutocompleteRule
|
|
91
92
|
* @summary: Create autocomplete configurations
|
|
92
|
-
* @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://
|
|
93
|
+
* @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
93
94
|
*/
|
|
94
|
-
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
95
|
+
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>;
|
|
95
96
|
/**
|
|
96
97
|
* @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
|
|
97
98
|
* - Arg object
|
|
@@ -101,7 +102,7 @@ declare class Catalog {
|
|
|
101
102
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
102
103
|
* @name createCustomKeyword
|
|
103
104
|
* @summary: Create search keywords
|
|
104
|
-
* @description: Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results. - Check out [method documentation](https://
|
|
105
|
+
* @description: Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createCustomKeyword/).
|
|
105
106
|
*/
|
|
106
107
|
createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
107
108
|
/**
|
|
@@ -113,7 +114,7 @@ declare class Catalog {
|
|
|
113
114
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
114
115
|
* @name createGroupConfiguration
|
|
115
116
|
* @summary: Create group configuration
|
|
116
|
-
* @description: Create group configuration for a specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
117
|
+
* @description: Create group configuration for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createGroupConfiguration/).
|
|
117
118
|
*/
|
|
118
119
|
createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
119
120
|
/**
|
|
@@ -125,47 +126,60 @@ declare class Catalog {
|
|
|
125
126
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
126
127
|
* @name createListingConfiguration
|
|
127
128
|
* @summary: Create listing configuration
|
|
128
|
-
* @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://
|
|
129
|
+
* @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createListingConfiguration/).
|
|
129
130
|
*/
|
|
130
131
|
createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
132
|
+
/**
|
|
133
|
+
* @param {CatalogPlatformApplicationValidator.CreatePriceFactoryParam} arg
|
|
134
|
+
* - Arg object
|
|
135
|
+
*
|
|
136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
139
|
+
* @name createPriceFactory
|
|
140
|
+
* @summary: Create a Price Factory for an Application
|
|
141
|
+
* @description: Creates a new price factory configuration for the specified application under a given company. A price factory allows defining region-based or international pricing strategies using fixed or percentage-based adjustments per currency.
|
|
142
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createPriceFactory/).
|
|
143
|
+
*/
|
|
144
|
+
createPriceFactory({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreatePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
131
145
|
/**
|
|
132
146
|
* @param {CatalogPlatformApplicationValidator.CreateSearchConfigurationParam} arg
|
|
133
147
|
* - Arg object
|
|
134
148
|
*
|
|
135
149
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
136
150
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
137
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
151
|
+
* @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
|
|
138
152
|
* - Success response
|
|
139
153
|
*
|
|
140
154
|
* @name createSearchConfiguration
|
|
141
155
|
* @summary: Create search configuration
|
|
142
|
-
* @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://
|
|
156
|
+
* @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createSearchConfiguration/).
|
|
143
157
|
*/
|
|
144
|
-
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
158
|
+
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>;
|
|
145
159
|
/**
|
|
146
160
|
* @param {CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam} arg
|
|
147
161
|
* - Arg object
|
|
148
162
|
*
|
|
149
163
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
150
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
151
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
165
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
152
166
|
* @name deleteAppCategoryReturnConfiguration
|
|
153
167
|
* @summary: Delete product return configuration
|
|
154
|
-
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://
|
|
168
|
+
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
155
169
|
*/
|
|
156
|
-
deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
170
|
+
deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
157
171
|
/**
|
|
158
172
|
* @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
|
|
159
173
|
* - Arg object
|
|
160
174
|
*
|
|
161
175
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
177
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
164
178
|
* @name deleteAutocompleteKeyword
|
|
165
179
|
* @summary: Delete autocomplete keyword
|
|
166
|
-
* @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://
|
|
180
|
+
* @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
167
181
|
*/
|
|
168
|
-
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
182
|
+
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
|
|
169
183
|
/**
|
|
170
184
|
* @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
|
|
171
185
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -175,7 +189,7 @@ declare class Catalog {
|
|
|
175
189
|
*
|
|
176
190
|
* @name deleteCollection
|
|
177
191
|
* @summary: Delete a collection
|
|
178
|
-
* @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://
|
|
192
|
+
* @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteCollection/).
|
|
179
193
|
*/
|
|
180
194
|
deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
|
|
181
195
|
/**
|
|
@@ -184,63 +198,92 @@ declare class Catalog {
|
|
|
184
198
|
*
|
|
185
199
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
200
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
201
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
202
|
+
* Success response
|
|
188
203
|
* @name deleteGroupConfiguration
|
|
189
204
|
* @summary: Delete group configuration
|
|
190
|
-
* @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
205
|
+
* @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
191
206
|
*/
|
|
192
|
-
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
207
|
+
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
193
208
|
/**
|
|
194
209
|
* @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
|
|
195
210
|
* - Arg object
|
|
196
211
|
*
|
|
197
212
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
213
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
214
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
215
|
+
* Success response
|
|
200
216
|
* @name deleteListingConfiguration
|
|
201
217
|
* @summary: Delete listing configuration
|
|
202
|
-
* @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
218
|
+
* @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteListingConfiguration/).
|
|
203
219
|
*/
|
|
204
|
-
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
220
|
+
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
221
|
+
/**
|
|
222
|
+
* @param {CatalogPlatformApplicationValidator.DeletePriceFactoryParam} arg
|
|
223
|
+
* - Arg object
|
|
224
|
+
*
|
|
225
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
226
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
228
|
+
* @name deletePriceFactory
|
|
229
|
+
* @summary: Delete a Price Factory Configuration
|
|
230
|
+
* @description: Deletes a specific price factory configuration associated with a given company and application. This action is typically irreversible and will remove the pricing logic tied to the specified price factory ID.
|
|
231
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deletePriceFactory/).
|
|
232
|
+
*/
|
|
233
|
+
deletePriceFactory({ priceFactoryId, requestHeaders }?: CatalogPlatformApplicationValidator.DeletePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
205
234
|
/**
|
|
206
235
|
* @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
|
|
207
236
|
* - Arg object
|
|
208
237
|
*
|
|
209
238
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
210
239
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
211
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
240
|
+
* @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
|
|
212
241
|
* - Success response
|
|
213
242
|
*
|
|
214
243
|
* @name deleteSearchConfiguration
|
|
215
244
|
* @summary: Delete search configuration
|
|
216
|
-
* @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://
|
|
245
|
+
* @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSearchConfiguration/).
|
|
217
246
|
*/
|
|
218
|
-
deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
247
|
+
deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>;
|
|
219
248
|
/**
|
|
220
249
|
* @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
|
|
221
250
|
* - Arg object
|
|
222
251
|
*
|
|
223
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
253
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
254
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
226
255
|
* @name deleteSearchKeywords
|
|
227
256
|
* @summary: Delete search keywords
|
|
228
|
-
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://
|
|
257
|
+
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSearchKeywords/).
|
|
258
|
+
*/
|
|
259
|
+
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
|
|
260
|
+
/**
|
|
261
|
+
* @param {CatalogPlatformApplicationValidator.FollowProductByIdParam} arg
|
|
262
|
+
* - Arg object
|
|
263
|
+
*
|
|
264
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
265
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
266
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
267
|
+
* @name followProductById
|
|
268
|
+
* @summary: Follow a Specific Product by ID
|
|
269
|
+
* @description: This endpoint enables a user to follow a specific product identified by its unique item ID for a sales channel.
|
|
270
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/followProductById/).
|
|
229
271
|
*/
|
|
230
|
-
|
|
272
|
+
followProductById({ userId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.FollowProductByIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowProduct>;
|
|
231
273
|
/**
|
|
232
274
|
* @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
|
|
233
275
|
* - Arg object
|
|
234
276
|
*
|
|
235
277
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
236
278
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
238
|
-
* Success response
|
|
279
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
280
|
+
* - Success response
|
|
281
|
+
*
|
|
239
282
|
* @name getAllCollections
|
|
240
283
|
* @summary: List collections
|
|
241
|
-
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://
|
|
284
|
+
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllCollections/).
|
|
242
285
|
*/
|
|
243
|
-
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
286
|
+
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>;
|
|
244
287
|
/**
|
|
245
288
|
* @param {Object} arg - Arg object.
|
|
246
289
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -256,7 +299,7 @@ declare class Catalog {
|
|
|
256
299
|
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
257
300
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
258
301
|
* page. Default is 12.
|
|
259
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
302
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
260
303
|
* @summary: List collections
|
|
261
304
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
262
305
|
*/
|
|
@@ -269,58 +312,61 @@ declare class Catalog {
|
|
|
269
312
|
tags?: string[];
|
|
270
313
|
isActive?: boolean;
|
|
271
314
|
pageSize?: number;
|
|
272
|
-
}): Paginator<CatalogPlatformModel.
|
|
315
|
+
}): Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>;
|
|
273
316
|
/**
|
|
274
317
|
* @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
|
|
275
318
|
* - Arg object
|
|
276
319
|
*
|
|
277
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
278
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
322
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
|
|
323
|
+
* Success response
|
|
280
324
|
* @name getAllSearchKeyword
|
|
281
325
|
* @summary: List search keywords
|
|
282
|
-
* @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://
|
|
326
|
+
* @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllSearchKeyword/).
|
|
283
327
|
*/
|
|
284
|
-
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
328
|
+
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>;
|
|
285
329
|
/**
|
|
286
330
|
* @param {CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam} arg
|
|
287
331
|
* - Arg object
|
|
288
332
|
*
|
|
289
333
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
290
334
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
335
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
|
|
292
336
|
* - Success response
|
|
293
337
|
*
|
|
294
338
|
* @name getAppCategoryReturnConfig
|
|
295
339
|
* @summary: Get category return configuration
|
|
296
|
-
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://
|
|
340
|
+
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
297
341
|
*/
|
|
298
|
-
getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
342
|
+
getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>;
|
|
299
343
|
/**
|
|
300
344
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
301
345
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
302
346
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
303
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
347
|
+
* @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
|
|
348
|
+
* Success response
|
|
304
349
|
* @name getAppInventory
|
|
305
350
|
* @summary: List sales channel inventory
|
|
306
|
-
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products
|
|
351
|
+
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppInventory/).
|
|
307
352
|
*/
|
|
308
|
-
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
353
|
+
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponseSchema>;
|
|
309
354
|
/**
|
|
310
355
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
311
356
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
357
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
313
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
358
|
+
* @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
|
|
314
359
|
* @name getAppLocations
|
|
315
|
-
* @summary:
|
|
316
|
-
* @description: Retrieve all stores associated with
|
|
360
|
+
* @summary: Retrieve stores for a sales channel
|
|
361
|
+
* @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppLocations/).
|
|
317
362
|
*/
|
|
318
|
-
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
363
|
+
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSchema>;
|
|
319
364
|
/**
|
|
320
365
|
* @param {Object} arg - Arg object.
|
|
321
|
-
* @param {
|
|
322
|
-
*
|
|
323
|
-
*
|
|
366
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
367
|
+
* a particular seller account.
|
|
368
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
369
|
+
* identifier for a particular sale channel.
|
|
324
370
|
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
325
371
|
* basis of location type.
|
|
326
372
|
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
@@ -332,12 +378,12 @@ declare class Catalog {
|
|
|
332
378
|
* page. Default is 20.
|
|
333
379
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
334
380
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
335
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
336
|
-
* @summary:
|
|
337
|
-
* @description: Retrieve all stores associated with
|
|
381
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSchema>}
|
|
382
|
+
* @summary: Retrieve stores for a sales channel
|
|
383
|
+
* @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status.
|
|
338
384
|
*/
|
|
339
385
|
getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
|
|
340
|
-
companyId:
|
|
386
|
+
companyId: number;
|
|
341
387
|
applicationId: string;
|
|
342
388
|
storeType?: string;
|
|
343
389
|
uid?: number[];
|
|
@@ -346,31 +392,45 @@ declare class Catalog {
|
|
|
346
392
|
pageSize?: number;
|
|
347
393
|
tags?: string[];
|
|
348
394
|
storeTypes?: string[];
|
|
349
|
-
}): Paginator<CatalogPlatformModel.
|
|
395
|
+
}): Paginator<CatalogPlatformModel.LocationListSchema>;
|
|
350
396
|
/**
|
|
351
397
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
352
398
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
353
399
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
354
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
400
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
|
|
401
|
+
* Success response
|
|
355
402
|
* @name getAppProduct
|
|
356
403
|
* @summary: Get sales channel product
|
|
357
|
-
* @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://
|
|
404
|
+
* @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppProduct/).
|
|
405
|
+
*/
|
|
406
|
+
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>;
|
|
407
|
+
/**
|
|
408
|
+
* @param {CatalogPlatformApplicationValidator.GetAppProductPricesParam} arg
|
|
409
|
+
* - Arg object
|
|
410
|
+
*
|
|
411
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
412
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
413
|
+
* @returns {Promise<CatalogPlatformModel.AppProductPricesSchema>} - Success response
|
|
414
|
+
* @name getAppProductPrices
|
|
415
|
+
* @summary: Get prices for specific raw product items
|
|
416
|
+
* @description: Fetch pricing details for multiple raw products by their item IDs, scoped to a particular company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppProductPrices/).
|
|
358
417
|
*/
|
|
359
|
-
|
|
418
|
+
getAppProductPrices({ itemIds, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductPricesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppProductPricesSchema>;
|
|
360
419
|
/**
|
|
361
420
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
362
421
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
363
422
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
364
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
365
|
-
* Success response
|
|
423
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
424
|
+
* - Success response
|
|
425
|
+
*
|
|
366
426
|
* @name getAppProducts
|
|
367
427
|
* @summary: List sales channel products
|
|
368
|
-
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://
|
|
428
|
+
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppProducts/).
|
|
369
429
|
*/
|
|
370
|
-
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
430
|
+
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponseSchema>;
|
|
371
431
|
/**
|
|
372
432
|
* @param {Object} arg - Arg object.
|
|
373
|
-
* @param {
|
|
433
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
374
434
|
* a particular seller account.
|
|
375
435
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
376
436
|
* identifier for a particular sale channel.
|
|
@@ -384,12 +444,12 @@ declare class Catalog {
|
|
|
384
444
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
385
445
|
* page. Default is 10.
|
|
386
446
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
387
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
447
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
388
448
|
* @summary: List sales channel products
|
|
389
449
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
390
450
|
*/
|
|
391
451
|
getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
|
|
392
|
-
companyId:
|
|
452
|
+
companyId: number;
|
|
393
453
|
applicationId: string;
|
|
394
454
|
brandIds?: number[];
|
|
395
455
|
categoryIds?: number[];
|
|
@@ -398,75 +458,20 @@ declare class Catalog {
|
|
|
398
458
|
itemIds?: number[];
|
|
399
459
|
pageSize?: number;
|
|
400
460
|
q?: string;
|
|
401
|
-
}): Paginator<CatalogPlatformModel.
|
|
461
|
+
}): Paginator<CatalogPlatformModel.RawProductListingResponseSchema>;
|
|
402
462
|
/**
|
|
403
463
|
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
404
464
|
* - Arg object
|
|
405
465
|
*
|
|
406
466
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
407
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
408
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
468
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
|
|
469
|
+
* Success response
|
|
409
470
|
* @name getAppReturnConfiguration
|
|
410
|
-
* @summary:
|
|
411
|
-
* @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://
|
|
412
|
-
*/
|
|
413
|
-
getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponse>;
|
|
414
|
-
/**
|
|
415
|
-
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
416
|
-
* - Arg object
|
|
417
|
-
*
|
|
418
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
419
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
420
|
-
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
421
|
-
* - Success response
|
|
422
|
-
*
|
|
423
|
-
* @name getAppicationProducts
|
|
424
|
-
* @summary: List sales channel products
|
|
425
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
|
|
426
|
-
*/
|
|
427
|
-
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
428
|
-
/**
|
|
429
|
-
* @param {Object} arg - Arg object.
|
|
430
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
431
|
-
* a particular seller account.
|
|
432
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
433
|
-
* identifier for a particular sale channel.
|
|
434
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
435
|
-
* complete name of a either a product, brand or category
|
|
436
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
437
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
438
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
439
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
440
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
441
|
-
* in **c** parameter in this format.
|
|
442
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
443
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
444
|
-
* filter details. This flag is used to fetch all filters
|
|
445
|
-
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
446
|
-
* the dependent products in the listing.
|
|
447
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
448
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
449
|
-
* discount in either ascending or descending order. See the supported
|
|
450
|
-
* values below.
|
|
451
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
452
|
-
* page. Default is 12.
|
|
453
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
454
|
-
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
455
|
-
* @summary: List sales channel products
|
|
456
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
471
|
+
* @summary: Get product-return configuration
|
|
472
|
+
* @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppReturnConfiguration/).
|
|
457
473
|
*/
|
|
458
|
-
|
|
459
|
-
companyId: string;
|
|
460
|
-
applicationId: string;
|
|
461
|
-
q?: string;
|
|
462
|
-
f?: string;
|
|
463
|
-
c?: string;
|
|
464
|
-
filters?: boolean;
|
|
465
|
-
isDependent?: boolean;
|
|
466
|
-
sortOn?: string;
|
|
467
|
-
pageSize?: number;
|
|
468
|
-
itemIds?: number[];
|
|
469
|
-
}): Paginator<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
474
|
+
getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>;
|
|
470
475
|
/**
|
|
471
476
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
472
477
|
* - Arg object
|
|
@@ -477,7 +482,7 @@ declare class Catalog {
|
|
|
477
482
|
* Success response
|
|
478
483
|
* @name getApplicationBrandListing
|
|
479
484
|
* @summary: List sales channel brands
|
|
480
|
-
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://
|
|
485
|
+
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationBrandListing/).
|
|
481
486
|
*/
|
|
482
487
|
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationBrandListingSchema>;
|
|
483
488
|
/**
|
|
@@ -506,12 +511,13 @@ declare class Catalog {
|
|
|
506
511
|
*
|
|
507
512
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
508
513
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
509
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
514
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
|
|
515
|
+
* Success response
|
|
510
516
|
* @name getApplicationBrands
|
|
511
517
|
* @summary: List brands
|
|
512
|
-
* @description: List all the brands. - Check out [method documentation](https://
|
|
518
|
+
* @description: List all the brands. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationBrands/).
|
|
513
519
|
*/
|
|
514
|
-
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
520
|
+
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponseSchema>;
|
|
515
521
|
/**
|
|
516
522
|
* @param {Object} arg - Arg object.
|
|
517
523
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -528,7 +534,7 @@ declare class Catalog {
|
|
|
528
534
|
* parameter to search brands by brand name.
|
|
529
535
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
530
536
|
* basis of uid list.
|
|
531
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
537
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
|
|
532
538
|
* @summary: List brands
|
|
533
539
|
* @description: List all the brands.
|
|
534
540
|
*/
|
|
@@ -539,7 +545,7 @@ declare class Catalog {
|
|
|
539
545
|
pageSize?: number;
|
|
540
546
|
q?: string;
|
|
541
547
|
brandId?: number[];
|
|
542
|
-
}): Paginator<CatalogPlatformModel.
|
|
548
|
+
}): Paginator<CatalogPlatformModel.BrandListingResponseSchema>;
|
|
543
549
|
/**
|
|
544
550
|
* @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
|
|
545
551
|
* - Arg object
|
|
@@ -551,7 +557,7 @@ declare class Catalog {
|
|
|
551
557
|
*
|
|
552
558
|
* @name getApplicationCategoryListing
|
|
553
559
|
* @summary: List sales channel categories
|
|
554
|
-
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://
|
|
560
|
+
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationCategoryListing/).
|
|
555
561
|
*/
|
|
556
562
|
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>;
|
|
557
563
|
/**
|
|
@@ -583,17 +589,17 @@ declare class Catalog {
|
|
|
583
589
|
*
|
|
584
590
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
585
591
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
586
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
592
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
587
593
|
* - Success response
|
|
588
594
|
*
|
|
589
595
|
* @name getApplicationDepartmentListing
|
|
590
596
|
* @summary: List sales channel departments
|
|
591
|
-
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names - Check out [method documentation](https://
|
|
597
|
+
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationDepartmentListing/).
|
|
592
598
|
*/
|
|
593
|
-
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
599
|
+
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
|
|
594
600
|
/**
|
|
595
601
|
* @param {Object} arg - Arg object.
|
|
596
|
-
* @param {
|
|
602
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
597
603
|
* a particular seller account.
|
|
598
604
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
599
605
|
* identifier for a particular sale channel.
|
|
@@ -601,69 +607,129 @@ declare class Catalog {
|
|
|
601
607
|
* page. Default is 12.
|
|
602
608
|
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
603
609
|
* filter results based on a keyword or specific value.
|
|
604
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
610
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
605
611
|
* @summary: List sales channel departments
|
|
606
612
|
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
|
|
607
613
|
*/
|
|
608
614
|
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
609
|
-
companyId:
|
|
615
|
+
companyId: number;
|
|
610
616
|
applicationId: string;
|
|
611
617
|
pageSize?: number;
|
|
612
618
|
q?: string;
|
|
613
|
-
}): Paginator<CatalogPlatformModel.
|
|
619
|
+
}): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
|
|
614
620
|
/**
|
|
615
621
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
616
622
|
* - Arg object
|
|
617
623
|
*
|
|
618
624
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
625
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
621
|
-
* Success response
|
|
626
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
|
|
627
|
+
* - Success response
|
|
628
|
+
*
|
|
622
629
|
* @name getApplicationFilterKeys
|
|
623
630
|
* @summary: List filter keys
|
|
624
|
-
* @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://
|
|
631
|
+
* @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationFilterKeys/).
|
|
625
632
|
*/
|
|
626
|
-
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
633
|
+
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>;
|
|
627
634
|
/**
|
|
628
635
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
629
636
|
* - Arg object
|
|
630
637
|
*
|
|
631
638
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
632
639
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
633
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
634
|
-
* Success response
|
|
640
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
|
|
641
|
+
* - Success response
|
|
642
|
+
*
|
|
635
643
|
* @name getApplicationFilterValues
|
|
636
644
|
* @summary: List product filters
|
|
637
645
|
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
638
|
-
* - Check out [method documentation](https://
|
|
646
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationFilterValues/).
|
|
647
|
+
*/
|
|
648
|
+
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>;
|
|
649
|
+
/**
|
|
650
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
|
|
651
|
+
* - Arg object
|
|
652
|
+
*
|
|
653
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
654
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
655
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
656
|
+
* - Success response
|
|
657
|
+
*
|
|
658
|
+
* @name getApplicationProducts
|
|
659
|
+
* @summary: List sales channel products
|
|
660
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getApplicationProducts/).
|
|
639
661
|
*/
|
|
640
|
-
|
|
662
|
+
getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
663
|
+
/**
|
|
664
|
+
* @param {Object} arg - Arg object.
|
|
665
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
666
|
+
* a particular seller account.
|
|
667
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
668
|
+
* identifier for a particular sale channel.
|
|
669
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
670
|
+
* complete name of a either a product, brand or category
|
|
671
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
672
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
673
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
674
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
675
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
676
|
+
* in **c** parameter in this format.
|
|
677
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
678
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
679
|
+
* filter details. This flag is used to fetch all filters
|
|
680
|
+
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
681
|
+
* the dependent products in the listing.
|
|
682
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
683
|
+
* Supported values include latest, popular, price_asc, price_dsc,
|
|
684
|
+
* discount_asc, discount_dsc. Custom sort keys configured via listing
|
|
685
|
+
* configuration (e.g., best_selling) are also supported for cohort-based sorting.
|
|
686
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
687
|
+
* page. Default is 12.
|
|
688
|
+
* @param {string[]} [arg.itemIds] - Item Ids of product
|
|
689
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
690
|
+
* @summary: List sales channel products
|
|
691
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
692
|
+
*/
|
|
693
|
+
getApplicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
694
|
+
companyId: number;
|
|
695
|
+
applicationId: string;
|
|
696
|
+
q?: string;
|
|
697
|
+
f?: string;
|
|
698
|
+
c?: string;
|
|
699
|
+
filters?: boolean;
|
|
700
|
+
isDependent?: boolean;
|
|
701
|
+
sortOn?: string;
|
|
702
|
+
pageSize?: number;
|
|
703
|
+
itemIds?: string[];
|
|
704
|
+
}): Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
641
705
|
/**
|
|
642
706
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
643
707
|
* - Arg object
|
|
644
708
|
*
|
|
645
709
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
646
710
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
647
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
648
|
-
* Success response
|
|
711
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
712
|
+
* - Success response
|
|
713
|
+
*
|
|
649
714
|
* @name getAutocompleteConfig
|
|
650
715
|
* @summary: Get autocomplete configuration
|
|
651
|
-
* @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://
|
|
716
|
+
* @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAutocompleteConfig/).
|
|
652
717
|
*/
|
|
653
|
-
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
718
|
+
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
654
719
|
/**
|
|
655
720
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
|
|
656
721
|
* - Arg object
|
|
657
722
|
*
|
|
658
723
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
659
724
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
661
|
-
* Success response
|
|
725
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
726
|
+
* - Success response
|
|
727
|
+
*
|
|
662
728
|
* @name getAutocompleteKeywordDetail
|
|
663
729
|
* @summary: Get autocomplete keyword
|
|
664
|
-
* @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://
|
|
730
|
+
* @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
665
731
|
*/
|
|
666
|
-
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
732
|
+
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
667
733
|
/**
|
|
668
734
|
* @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
|
|
669
735
|
* - Arg object
|
|
@@ -675,7 +741,7 @@ declare class Catalog {
|
|
|
675
741
|
*
|
|
676
742
|
* @name getCatalogConfiguration
|
|
677
743
|
* @summary: Get catalog configuration meta data
|
|
678
|
-
* @description: Retrieve configuration meta data for the catalog specific to a company and an sales channel. - Check out [method documentation](https://
|
|
744
|
+
* @description: Retrieve configuration meta data for the catalog specific to a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCatalogConfiguration/).
|
|
679
745
|
*/
|
|
680
746
|
getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
|
|
681
747
|
/**
|
|
@@ -684,48 +750,52 @@ declare class Catalog {
|
|
|
684
750
|
*
|
|
685
751
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
686
752
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
753
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
|
|
754
|
+
* Success response
|
|
688
755
|
* @name getCatalogInsights
|
|
689
756
|
* @summary: Get catalog counts
|
|
690
|
-
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://
|
|
757
|
+
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCatalogInsights/).
|
|
691
758
|
*/
|
|
692
|
-
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
759
|
+
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponseSchema>;
|
|
693
760
|
/**
|
|
694
761
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
695
762
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
696
763
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
697
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
764
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
|
|
765
|
+
* Success response
|
|
698
766
|
* @name getCategories
|
|
699
767
|
* @summary: List categories
|
|
700
|
-
* @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://
|
|
768
|
+
* @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCategories/).
|
|
701
769
|
*/
|
|
702
|
-
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
770
|
+
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponseSchema>;
|
|
703
771
|
/**
|
|
704
772
|
* @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
|
|
705
773
|
* - Arg object
|
|
706
774
|
*
|
|
707
775
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
708
776
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
709
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
710
|
-
* Success response
|
|
777
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
|
|
778
|
+
* - Success response
|
|
779
|
+
*
|
|
711
780
|
* @name getCollectionDetail
|
|
712
781
|
* @summary: Get a collection
|
|
713
|
-
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://
|
|
782
|
+
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionDetail/).
|
|
714
783
|
*/
|
|
715
|
-
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
784
|
+
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>;
|
|
716
785
|
/**
|
|
717
786
|
* @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
|
|
718
787
|
* - Arg object
|
|
719
788
|
*
|
|
720
789
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
721
790
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
722
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
723
|
-
* Success response
|
|
791
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchemaV2>}
|
|
792
|
+
* - Success response
|
|
793
|
+
*
|
|
724
794
|
* @name getCollectionItems
|
|
725
795
|
* @summary: List items of collection
|
|
726
|
-
* @description: Get items from a collection specified by its
|
|
796
|
+
* @description: Get items from a collection specified by its collection_id with enhanced search capabilities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionItems/).
|
|
727
797
|
*/
|
|
728
|
-
getCollectionItems({
|
|
798
|
+
getCollectionItems({ collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchemaV2>;
|
|
729
799
|
/**
|
|
730
800
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
|
|
731
801
|
* - Arg object
|
|
@@ -737,22 +807,23 @@ declare class Catalog {
|
|
|
737
807
|
*
|
|
738
808
|
* @name getConfigurationByType
|
|
739
809
|
* @summary: Get configuration
|
|
740
|
-
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://
|
|
810
|
+
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationByType/).
|
|
741
811
|
*/
|
|
742
|
-
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
812
|
+
getConfigurationByType({ type, includeInactive, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
743
813
|
/**
|
|
744
814
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationMetadataParam} arg
|
|
745
815
|
* - Arg object
|
|
746
816
|
*
|
|
747
817
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
748
818
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
749
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
750
|
-
* Success response
|
|
819
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
|
|
820
|
+
* - Success response
|
|
821
|
+
*
|
|
751
822
|
* @name getConfigurationMetadata
|
|
752
823
|
* @summary: Get configuration metadata
|
|
753
|
-
* @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
824
|
+
* @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurationMetadata/).
|
|
754
825
|
*/
|
|
755
|
-
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
826
|
+
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>;
|
|
756
827
|
/**
|
|
757
828
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
|
|
758
829
|
* - Arg object
|
|
@@ -763,82 +834,152 @@ declare class Catalog {
|
|
|
763
834
|
* Success response
|
|
764
835
|
* @name getConfigurations
|
|
765
836
|
* @summary: Get product configurations
|
|
766
|
-
* @description: Retrieve a detailed configurations for product catalog specific to a company and an sales channel. - Check out [method documentation](https://
|
|
837
|
+
* @description: Retrieve a detailed configurations for product catalog specific to a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getConfigurations/).
|
|
767
838
|
*/
|
|
768
839
|
getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
769
840
|
/**
|
|
770
841
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
771
842
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
772
843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
773
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
844
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
|
|
845
|
+
* Success response
|
|
774
846
|
* @name getDepartments
|
|
775
847
|
* @summary: List departments
|
|
776
|
-
* @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://
|
|
848
|
+
* @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getDepartments/).
|
|
777
849
|
*/
|
|
778
|
-
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
850
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponseSchema>;
|
|
779
851
|
/**
|
|
780
852
|
* @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
|
|
781
853
|
* - Arg object
|
|
782
854
|
*
|
|
783
855
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
784
856
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
785
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
857
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
|
|
786
858
|
* - Success response
|
|
787
859
|
*
|
|
788
860
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
789
861
|
* @summary: Get discounted inventory
|
|
790
|
-
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://
|
|
862
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getDiscountedInventoryBySizeIdentifier/).
|
|
791
863
|
*/
|
|
792
|
-
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize,
|
|
864
|
+
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>;
|
|
793
865
|
/**
|
|
794
866
|
* @param {Object} arg - Arg object.
|
|
795
|
-
* @param {number} arg.companyId -
|
|
796
|
-
*
|
|
797
|
-
* @param {string} arg.applicationId -
|
|
798
|
-
*
|
|
799
|
-
* @param {
|
|
800
|
-
*
|
|
867
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
868
|
+
* a particular seller account.
|
|
869
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
870
|
+
* identifier for a particular sale channel.
|
|
871
|
+
* @param {number} arg.itemId - A `item_id` is a unique identifier for a
|
|
872
|
+
* specific product.
|
|
873
|
+
* @param {number} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
874
|
+
* or Primary Identifier).
|
|
801
875
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
802
876
|
* page. Default is 12.
|
|
803
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
804
877
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
805
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
878
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
|
|
806
879
|
* @summary: Get discounted inventory
|
|
807
880
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
808
881
|
*/
|
|
809
|
-
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize,
|
|
882
|
+
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, locationIds, }?: {
|
|
810
883
|
companyId: number;
|
|
811
884
|
applicationId: string;
|
|
812
885
|
itemId: number;
|
|
813
|
-
sizeIdentifier:
|
|
886
|
+
sizeIdentifier: number;
|
|
814
887
|
pageSize?: number;
|
|
815
|
-
q?: string;
|
|
816
888
|
locationIds?: number[];
|
|
817
|
-
}): Paginator<CatalogPlatformModel.
|
|
889
|
+
}): Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>;
|
|
890
|
+
/**
|
|
891
|
+
* @param {CatalogPlatformApplicationValidator.GetFollowedProductsParam} arg
|
|
892
|
+
* - Arg object
|
|
893
|
+
*
|
|
894
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
895
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
896
|
+
* @returns {Promise<CatalogPlatformModel.FollowedProducts>} - Success response
|
|
897
|
+
* @name getFollowedProducts
|
|
898
|
+
* @summary: Retrieve followed products by user
|
|
899
|
+
* @description: List all product ids a user has wishlisted or is following for sales channel.
|
|
900
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
|
|
901
|
+
*/
|
|
902
|
+
getFollowedProducts({ userId, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
|
|
818
903
|
/**
|
|
819
904
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
820
905
|
* - Arg object
|
|
821
906
|
*
|
|
822
907
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
823
908
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
824
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
909
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
825
910
|
* @name getGroupConfigurations
|
|
826
911
|
* @summary: Get group configurations
|
|
827
|
-
* @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://
|
|
912
|
+
* @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getGroupConfigurations/).
|
|
828
913
|
*/
|
|
829
|
-
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
914
|
+
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
|
|
830
915
|
/**
|
|
831
916
|
* @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
|
|
832
917
|
* - Arg object
|
|
833
918
|
*
|
|
834
919
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
835
920
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
836
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
921
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
837
922
|
* @name getListingConfigurations
|
|
838
923
|
* @summary: Get listing configurations
|
|
839
|
-
* @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
924
|
+
* @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getListingConfigurations/).
|
|
840
925
|
*/
|
|
841
|
-
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
926
|
+
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
|
|
927
|
+
/**
|
|
928
|
+
* @param {CatalogPlatformApplicationValidator.GetPriceFactoriesParam} arg
|
|
929
|
+
* - Arg object
|
|
930
|
+
*
|
|
931
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
932
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
933
|
+
* @returns {Promise<CatalogPlatformModel.PriceFactoryListResponseSchema>}
|
|
934
|
+
* - Success response
|
|
935
|
+
*
|
|
936
|
+
* @name getPriceFactories
|
|
937
|
+
* @summary: Retrieve Price Factories for an Application
|
|
938
|
+
* @description: Fetches a paginated list of price factories configured for the specified application within a company. Supports optional filters such as brand IDs, category IDs, seller identifier, item code, slug, and name to narrow down the results.
|
|
939
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactories/).
|
|
940
|
+
*/
|
|
941
|
+
getPriceFactories({ q, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryListResponseSchema>;
|
|
942
|
+
/**
|
|
943
|
+
* @param {CatalogPlatformApplicationValidator.GetPriceFactoryParam} arg - Arg object
|
|
944
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
945
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
946
|
+
* @returns {Promise<CatalogPlatformModel.PriceFactoryConfigSchema>} -
|
|
947
|
+
* Success response
|
|
948
|
+
* @name getPriceFactory
|
|
949
|
+
* @summary: Retrieve a Specific Price Factory Configuration
|
|
950
|
+
* @description: Retrieves detailed information about a specific price factory configuration for the given application and company, using the unique price factory ID. This includes currency strategies, adjustment values, zone mapping, and audit metadata.
|
|
951
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactory/).
|
|
952
|
+
*/
|
|
953
|
+
getPriceFactory({ priceFactoryId, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryConfigSchema>;
|
|
954
|
+
/**
|
|
955
|
+
* @param {CatalogPlatformApplicationValidator.GetPriceFactoryProductParam} arg
|
|
956
|
+
* - Arg object
|
|
957
|
+
*
|
|
958
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
959
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
960
|
+
* @returns {Promise<CatalogPlatformModel.PriceFactoryProductResponseSchema>}
|
|
961
|
+
* - Success response
|
|
962
|
+
*
|
|
963
|
+
* @name getPriceFactoryProduct
|
|
964
|
+
* @summary: Update marketplace optin
|
|
965
|
+
* @description: get price related information of item for given price factory - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactoryProduct/).
|
|
966
|
+
*/
|
|
967
|
+
getPriceFactoryProduct({ priceFactoryId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoryProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryProductResponseSchema>;
|
|
968
|
+
/**
|
|
969
|
+
* @param {CatalogPlatformApplicationValidator.GetPriceFactoryProductsParam} arg
|
|
970
|
+
* - Arg object
|
|
971
|
+
*
|
|
972
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
973
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
974
|
+
* @returns {Promise<CatalogPlatformModel.PriceFactoryProductListResponseSchema>}
|
|
975
|
+
* - Success response
|
|
976
|
+
*
|
|
977
|
+
* @name getPriceFactoryProducts
|
|
978
|
+
* @summary: Get Products associated with a Price Factory
|
|
979
|
+
* @description: Retrieves a paginated list of products linked to a specific price factory configuration for the given application and company. This endpoint returns item-level details such as pricing by currency, delivery zones, seller identifiers, media, and size-level configurations. Useful for viewing how pricing strategies are applied across different items.
|
|
980
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactoryProducts/).
|
|
981
|
+
*/
|
|
982
|
+
getPriceFactoryProducts({ priceFactoryId, brandIds, categoryIds, sellerIdentifier, itemCode, slug, name, active, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetPriceFactoryProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryProductListResponseSchema>;
|
|
842
983
|
/**
|
|
843
984
|
* @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
|
|
844
985
|
* - Arg object
|
|
@@ -848,58 +989,74 @@ declare class Catalog {
|
|
|
848
989
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
849
990
|
* @name getProductDetailBySlug
|
|
850
991
|
* @summary: Get product details
|
|
851
|
-
* @description: Retrieve detailed product information using a product slug. - Check out [method documentation](https://
|
|
992
|
+
* @description: Retrieve detailed product information using a product slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductDetailBySlug/).
|
|
852
993
|
*/
|
|
853
994
|
getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
|
|
854
995
|
/**
|
|
855
996
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
856
997
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
857
998
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
858
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
999
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
|
|
1000
|
+
* Success response
|
|
859
1001
|
* @name getQueryFilters
|
|
860
1002
|
* @summary: Get collection query filters
|
|
861
|
-
* @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://
|
|
1003
|
+
* @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getQueryFilters/).
|
|
862
1004
|
*/
|
|
863
|
-
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1005
|
+
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>;
|
|
864
1006
|
/**
|
|
865
1007
|
* @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
|
|
866
1008
|
* - Arg object
|
|
867
1009
|
*
|
|
868
1010
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
869
1011
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1012
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
|
|
871
1013
|
* - Success response
|
|
872
1014
|
*
|
|
873
1015
|
* @name getSearchConfiguration
|
|
874
1016
|
* @summary: Get Search configuration
|
|
875
|
-
* @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://
|
|
1017
|
+
* @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSearchConfiguration/).
|
|
876
1018
|
*/
|
|
877
|
-
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1019
|
+
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>;
|
|
878
1020
|
/**
|
|
879
1021
|
* @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
|
|
880
1022
|
* - Arg object
|
|
881
1023
|
*
|
|
882
1024
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
883
1025
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
884
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
885
|
-
* Success response
|
|
1026
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
|
|
1027
|
+
* - Success response
|
|
1028
|
+
*
|
|
886
1029
|
* @name getSearchKeywords
|
|
887
1030
|
* @summary: Get search keywords
|
|
888
|
-
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://
|
|
1031
|
+
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSearchKeywords/).
|
|
1032
|
+
*/
|
|
1033
|
+
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>;
|
|
1034
|
+
/**
|
|
1035
|
+
* @param {CatalogPlatformApplicationValidator.UnfollowProductByIdParam} arg
|
|
1036
|
+
* - Arg object
|
|
1037
|
+
*
|
|
1038
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1039
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1040
|
+
* @returns {Promise<CatalogPlatformModel.FollowProduct>} - Success response
|
|
1041
|
+
* @name unfollowProductById
|
|
1042
|
+
* @summary: Unfollow a Specific Product by ID
|
|
1043
|
+
* @description: This endpoint allows a user to unfollow a previously followed product using its unique item ID for a sales channel.
|
|
1044
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/unfollowProductById/).
|
|
889
1045
|
*/
|
|
890
|
-
|
|
1046
|
+
unfollowProductById({ userId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.UnfollowProductByIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowProduct>;
|
|
891
1047
|
/**
|
|
892
1048
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
893
1049
|
* - Arg object
|
|
894
1050
|
*
|
|
895
1051
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
896
1052
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
897
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1053
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1054
|
+
* Success response
|
|
898
1055
|
* @name updateAllowSingle
|
|
899
1056
|
* @summary: Update 'Allow Single' setting
|
|
900
|
-
* @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://
|
|
1057
|
+
* @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAllowSingle/).
|
|
901
1058
|
*/
|
|
902
|
-
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1059
|
+
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
903
1060
|
/**
|
|
904
1061
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
905
1062
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -907,7 +1064,7 @@ declare class Catalog {
|
|
|
907
1064
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
908
1065
|
* @name updateAppBrand
|
|
909
1066
|
* @summary: Update sales channel brand
|
|
910
|
-
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://
|
|
1067
|
+
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppBrand/).
|
|
911
1068
|
*/
|
|
912
1069
|
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
913
1070
|
/**
|
|
@@ -919,7 +1076,7 @@ declare class Catalog {
|
|
|
919
1076
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
920
1077
|
* @name updateAppCategory
|
|
921
1078
|
* @summary: Update sales channel category
|
|
922
|
-
* @description: Modify category data related to the sales channel
|
|
1079
|
+
* @description: Modify category data related to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppCategory/).
|
|
923
1080
|
*/
|
|
924
1081
|
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
925
1082
|
/**
|
|
@@ -928,12 +1085,12 @@ declare class Catalog {
|
|
|
928
1085
|
*
|
|
929
1086
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
930
1087
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
931
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1088
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
932
1089
|
* @name updateAppCategoryReturnConfiguration
|
|
933
1090
|
* @summary: Update return Configuration
|
|
934
|
-
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://
|
|
1091
|
+
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
935
1092
|
*/
|
|
936
|
-
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1093
|
+
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
937
1094
|
/**
|
|
938
1095
|
* @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
|
|
939
1096
|
* - Arg object
|
|
@@ -943,7 +1100,7 @@ declare class Catalog {
|
|
|
943
1100
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
944
1101
|
* @name updateAppDepartment
|
|
945
1102
|
* @summary: Update sales channel department
|
|
946
|
-
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://
|
|
1103
|
+
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppDepartment/).
|
|
947
1104
|
*/
|
|
948
1105
|
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
949
1106
|
/**
|
|
@@ -955,7 +1112,7 @@ declare class Catalog {
|
|
|
955
1112
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
956
1113
|
* @name updateAppLocation
|
|
957
1114
|
* @summary: Update sales channel location
|
|
958
|
-
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://
|
|
1115
|
+
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppLocation/).
|
|
959
1116
|
*/
|
|
960
1117
|
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
961
1118
|
/**
|
|
@@ -965,7 +1122,7 @@ declare class Catalog {
|
|
|
965
1122
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
966
1123
|
* @name updateAppProduct
|
|
967
1124
|
* @summary: Update sales channel product
|
|
968
|
-
* @description: Allows to update data associated to a item by its item_id for
|
|
1125
|
+
* @description: Allows to update data associated to a item by its item_id for a sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppProduct/).
|
|
969
1126
|
*/
|
|
970
1127
|
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
971
1128
|
/**
|
|
@@ -977,7 +1134,7 @@ declare class Catalog {
|
|
|
977
1134
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
978
1135
|
* @name updateAppReturnConfiguration
|
|
979
1136
|
* @summary: Update product return configuration
|
|
980
|
-
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://
|
|
1137
|
+
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
981
1138
|
*/
|
|
982
1139
|
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
983
1140
|
/**
|
|
@@ -986,13 +1143,14 @@ declare class Catalog {
|
|
|
986
1143
|
*
|
|
987
1144
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
988
1145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
989
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
990
|
-
* Success response
|
|
1146
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
1147
|
+
* - Success response
|
|
1148
|
+
*
|
|
991
1149
|
* @name updateAutocompleteKeyword
|
|
992
1150
|
* @summary: Update autocomplete keyword
|
|
993
|
-
* @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://
|
|
1151
|
+
* @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
994
1152
|
*/
|
|
995
|
-
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1153
|
+
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
996
1154
|
/**
|
|
997
1155
|
* @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
|
|
998
1156
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1000,7 +1158,7 @@ declare class Catalog {
|
|
|
1000
1158
|
* @returns {Promise<CatalogPlatformModel.UpdateCollection>} - Success response
|
|
1001
1159
|
* @name updateCollection
|
|
1002
1160
|
* @summary: Update a collection
|
|
1003
|
-
* @description: Update a collection by it's id. On successful request, returns the updated collection - Check out [method documentation](https://
|
|
1161
|
+
* @description: Update a collection by it's id. On successful request, returns the updated collection - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateCollection/).
|
|
1004
1162
|
*/
|
|
1005
1163
|
updateCollection({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateCollection>;
|
|
1006
1164
|
/**
|
|
@@ -1009,12 +1167,13 @@ declare class Catalog {
|
|
|
1009
1167
|
*
|
|
1010
1168
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1011
1169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1012
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1170
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1171
|
+
* Success response
|
|
1013
1172
|
* @name updateDefaultSort
|
|
1014
1173
|
* @summary: Update default sorting
|
|
1015
|
-
* @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://
|
|
1174
|
+
* @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateDefaultSort/).
|
|
1016
1175
|
*/
|
|
1017
|
-
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1176
|
+
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
1018
1177
|
/**
|
|
1019
1178
|
* @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
|
|
1020
1179
|
* - Arg object
|
|
@@ -1024,7 +1183,7 @@ declare class Catalog {
|
|
|
1024
1183
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
1025
1184
|
* @name updateGroupConfiguration
|
|
1026
1185
|
* @summary: Update group configuration
|
|
1027
|
-
* @description: Modify group configurations by its slug for specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
1186
|
+
* @description: Modify group configurations by its slug for specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateGroupConfiguration/).
|
|
1028
1187
|
*/
|
|
1029
1188
|
updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
1030
1189
|
/**
|
|
@@ -1036,23 +1195,49 @@ declare class Catalog {
|
|
|
1036
1195
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
1037
1196
|
* @name updateListingConfiguration
|
|
1038
1197
|
* @summary: Update listing configuration
|
|
1039
|
-
* @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://
|
|
1198
|
+
* @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateListingConfiguration/).
|
|
1040
1199
|
*/
|
|
1041
1200
|
updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
1201
|
+
/**
|
|
1202
|
+
* @param {CatalogPlatformApplicationValidator.UpdatePriceFactoryParam} arg
|
|
1203
|
+
* - Arg object
|
|
1204
|
+
*
|
|
1205
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1206
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1207
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1208
|
+
* @name updatePriceFactory
|
|
1209
|
+
* @summary: Update an Existing Price Factory Configuration
|
|
1210
|
+
* @description: Allows partial update of an existing price factory configuration for a specific application and company using the provided price factory ID. Fields such as name, currencies, pricing strategies, or zone mapping can be modified.
|
|
1211
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updatePriceFactory/).
|
|
1212
|
+
*/
|
|
1213
|
+
updatePriceFactory({ priceFactoryId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdatePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1214
|
+
/**
|
|
1215
|
+
* @param {CatalogPlatformApplicationValidator.UpdatePriceFactoryProductParam} arg
|
|
1216
|
+
* - Arg object
|
|
1217
|
+
*
|
|
1218
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1219
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1220
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1221
|
+
* @name updatePriceFactoryProduct
|
|
1222
|
+
* @summary: Partially update price factory product configuration
|
|
1223
|
+
* @description: Updates specific fields in the price factory product configuration. Use this to partially update pricing or status for a given product and size without overwriting the entire configuration.
|
|
1224
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updatePriceFactoryProduct/).
|
|
1225
|
+
*/
|
|
1226
|
+
updatePriceFactoryProduct({ priceFactoryId, itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdatePriceFactoryProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1042
1227
|
/**
|
|
1043
1228
|
* @param {CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam} arg
|
|
1044
1229
|
* - Arg object
|
|
1045
1230
|
*
|
|
1046
1231
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1047
1232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1048
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1233
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
|
|
1049
1234
|
* - Success response
|
|
1050
1235
|
*
|
|
1051
1236
|
* @name updateSearchConfiguration
|
|
1052
1237
|
* @summary: Update search configuration
|
|
1053
|
-
* @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://
|
|
1238
|
+
* @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSearchConfiguration/).
|
|
1054
1239
|
*/
|
|
1055
|
-
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1240
|
+
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>;
|
|
1056
1241
|
/**
|
|
1057
1242
|
* @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
|
|
1058
1243
|
* - Arg object
|
|
@@ -1062,7 +1247,7 @@ declare class Catalog {
|
|
|
1062
1247
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
1063
1248
|
* @name updateSearchKeywords
|
|
1064
1249
|
* @summary: Update search keywords
|
|
1065
|
-
* @description: Update a specific search keyword by its id for a specific company and sales channel. - Check out [method documentation](https://
|
|
1250
|
+
* @description: Update a specific search keyword by its id for a specific company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSearchKeywords/).
|
|
1066
1251
|
*/
|
|
1067
1252
|
updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
1068
1253
|
}
|