@gofynd/fdk-client-javascript 1.4.15-beta.14 → 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 +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- 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
|
@@ -6,12 +6,12 @@ declare class Catalog {
|
|
|
6
6
|
* @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
9
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
10
10
|
* @name addInventory
|
|
11
11
|
* @summary: Create Inventory
|
|
12
|
-
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://
|
|
12
|
+
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/addInventory/).
|
|
13
13
|
*/
|
|
14
|
-
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
14
|
+
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
15
15
|
/**
|
|
16
16
|
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
17
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -19,81 +19,93 @@ declare class Catalog {
|
|
|
19
19
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
20
20
|
* @name allSizes
|
|
21
21
|
* @summary: Get product sizes
|
|
22
|
-
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://
|
|
22
|
+
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/allSizes/).
|
|
23
23
|
*/
|
|
24
24
|
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
25
25
|
/**
|
|
26
26
|
* @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
|
|
27
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
29
|
+
* @returns {Promise<CatalogPlatformModel.BulkHsnResponseSchema>} - Success response
|
|
30
30
|
* @name bulkHsnCode
|
|
31
31
|
* @summary: Create Bulk update HSN
|
|
32
|
-
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://
|
|
32
|
+
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/bulkHsnCode/).
|
|
33
33
|
*/
|
|
34
|
-
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
34
|
+
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
|
|
35
35
|
/**
|
|
36
36
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
40
40
|
* @name createBulkInventory
|
|
41
41
|
* @summary: Create bulk inventory
|
|
42
|
-
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://
|
|
42
|
+
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkInventory/).
|
|
43
43
|
*/
|
|
44
|
-
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
44
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
45
45
|
/**
|
|
46
46
|
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
47
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
50
50
|
* @name createBulkInventoryJob
|
|
51
51
|
* @summary: Create bulk inventory upload job
|
|
52
|
-
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://
|
|
52
|
+
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkInventoryJob/).
|
|
53
53
|
*/
|
|
54
|
-
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
54
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
55
55
|
/**
|
|
56
56
|
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
57
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
59
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
60
60
|
* @name createBulkProductUploadJob
|
|
61
61
|
* @summary: Create products bulk upload
|
|
62
|
-
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://
|
|
62
|
+
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
63
63
|
*/
|
|
64
|
-
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
64
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
65
|
+
/**
|
|
66
|
+
* @param {CatalogPlatformValidator.CreateHsCodeParam} arg - Arg object
|
|
67
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
+
* @returns {Promise<CatalogPlatformModel.HSCodeItem>} - Success response
|
|
70
|
+
* @name createHsCode
|
|
71
|
+
* @summary: Create HS/SAC code
|
|
72
|
+
* @description: Create a new Harmonized System (HS) or Service Accounting Code (SAC). These codes are used for product and service identification in taxation and compliance processes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createHsCode/).
|
|
73
|
+
*/
|
|
74
|
+
createHsCode({ body, requestHeaders }?: CatalogPlatformValidator.CreateHsCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSCodeItem>;
|
|
65
75
|
/**
|
|
66
76
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
67
77
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
79
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
|
|
80
|
+
* Success response
|
|
70
81
|
* @name createInventoryExport
|
|
71
82
|
* @summary: Create inventory export
|
|
72
|
-
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://
|
|
83
|
+
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExport/).
|
|
73
84
|
*/
|
|
74
|
-
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
85
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
75
86
|
/**
|
|
76
87
|
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
77
88
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
90
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
|
|
91
|
+
* Success response
|
|
80
92
|
* @name createInventoryExportJob
|
|
81
93
|
* @summary: Create inventory export job
|
|
82
|
-
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://
|
|
94
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExportJob/).
|
|
83
95
|
*/
|
|
84
|
-
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
96
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
85
97
|
/**
|
|
86
98
|
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
87
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
88
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
89
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
101
|
+
* @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>}
|
|
90
102
|
* - Success response
|
|
91
103
|
*
|
|
92
104
|
* @name createMarketplaceOptin
|
|
93
105
|
* @summary: Create or Update opt-in infomation
|
|
94
|
-
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://
|
|
106
|
+
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createMarketplaceOptin/).
|
|
95
107
|
*/
|
|
96
|
-
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
108
|
+
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>;
|
|
97
109
|
/**
|
|
98
110
|
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
99
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -101,113 +113,160 @@ declare class Catalog {
|
|
|
101
113
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
102
114
|
* @name createProduct
|
|
103
115
|
* @summary: Create product
|
|
104
|
-
* @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://
|
|
116
|
+
* @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProduct/).
|
|
105
117
|
*/
|
|
106
118
|
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
107
119
|
/**
|
|
108
120
|
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
109
121
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
123
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
112
124
|
* @name createProductAssetsInBulk
|
|
113
125
|
* @summary: Create product assets in bulk
|
|
114
|
-
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://
|
|
126
|
+
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
115
127
|
*/
|
|
116
|
-
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
128
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
117
129
|
/**
|
|
118
|
-
* @param {CatalogPlatformValidator.
|
|
130
|
+
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
119
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
120
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
121
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
133
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
122
134
|
* - Success response
|
|
123
135
|
*
|
|
124
|
-
* @name createProductBundle
|
|
125
|
-
* @summary: Create product bundle
|
|
126
|
-
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
127
|
-
*/
|
|
128
|
-
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
129
|
-
/**
|
|
130
|
-
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
131
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
132
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
|
-
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
134
|
-
* Success response
|
|
135
136
|
* @name createProductExportJob
|
|
136
137
|
* @summary: Create product export job
|
|
137
|
-
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://
|
|
138
|
+
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductExportJob/).
|
|
138
139
|
*/
|
|
139
|
-
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
140
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
140
141
|
/**
|
|
141
142
|
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
142
143
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
144
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
145
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
145
146
|
* @name createProductsInBulk
|
|
146
147
|
* @summary: Create products in bulk
|
|
147
|
-
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://
|
|
148
|
+
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductsInBulk/).
|
|
148
149
|
*/
|
|
149
|
-
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
150
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
150
151
|
/**
|
|
151
152
|
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
152
153
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
153
154
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
154
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
155
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
155
156
|
* @name createSizeGuide
|
|
156
157
|
* @summary: Create size guide
|
|
157
|
-
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://
|
|
158
|
+
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createSizeGuide/).
|
|
158
159
|
*/
|
|
159
|
-
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
160
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
161
|
+
/**
|
|
162
|
+
* @param {CatalogPlatformValidator.CreateTaxParam} arg - Arg object
|
|
163
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
164
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
|
+
* @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
|
|
166
|
+
* @name createTax
|
|
167
|
+
* @summary: Create Tax Rule
|
|
168
|
+
* @description: Create a tax rule in a company, including its initial (live) version. The API supports both default (country-level) and region-specific versions by using optional parameters such as 'region_type' and 'areas'. This enables granular taxation rules scoped to different geographic regions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
|
|
169
|
+
*/
|
|
170
|
+
createTax({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateTax>;
|
|
171
|
+
/**
|
|
172
|
+
* @param {CatalogPlatformValidator.CreateTaxComponentNameParam} arg - Arg object
|
|
173
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
174
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
|
+
* @returns {Promise<CatalogPlatformModel.TaxComponentName>} - Success response
|
|
176
|
+
* @name createTaxComponentName
|
|
177
|
+
* @summary: Create tax component name
|
|
178
|
+
* @description: Tax components represent different types of taxes that may be applied to products or transactions,
|
|
179
|
+
* such as sales tax, value-added tax (VAT), goods and services tax, consumption tax,
|
|
180
|
+
* or other region-specific taxation systems. This endpoint allows companies to define and
|
|
181
|
+
* customize the names of tax components according to their local tax regulations and business requirements.
|
|
182
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
|
|
183
|
+
*/
|
|
184
|
+
createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxComponentName>;
|
|
185
|
+
/**
|
|
186
|
+
* @param {CatalogPlatformValidator.CreateTaxVersionParam} arg - Arg object
|
|
187
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
+
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
190
|
+
* @name createTaxVersion
|
|
191
|
+
* @summary: Create a tax version
|
|
192
|
+
* @description: Creates a tax version using the provided rule_id with support for scheduled applicability and optional region-level overrides. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/).
|
|
193
|
+
*/
|
|
194
|
+
createTaxVersion({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.CreateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
|
|
160
195
|
/**
|
|
161
196
|
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
162
197
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
163
198
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
164
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
199
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
165
200
|
* @name deleteBulkInventoryJob
|
|
166
201
|
* @summary: Delete inventory bulk upload job
|
|
167
|
-
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://
|
|
202
|
+
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
168
203
|
*/
|
|
169
|
-
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
204
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
170
205
|
/**
|
|
171
206
|
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
172
207
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
208
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
209
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
175
210
|
* @name deleteProduct
|
|
176
211
|
* @summary: Delete product
|
|
177
|
-
* @description: Users can delete a product
|
|
212
|
+
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProduct/).
|
|
178
213
|
*/
|
|
179
|
-
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
214
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
180
215
|
/**
|
|
181
216
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
182
217
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
218
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
219
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
185
220
|
* @name deleteProductBulkJob
|
|
186
221
|
* @summary: Delete product bulk-upload job
|
|
187
|
-
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://
|
|
222
|
+
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProductBulkJob/).
|
|
188
223
|
*/
|
|
189
|
-
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
224
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
190
225
|
/**
|
|
191
226
|
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
192
227
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
228
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
229
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
230
|
+
* Success response
|
|
195
231
|
* @name deleteRealtimeInventory
|
|
196
232
|
* @summary: Delete an inventory
|
|
197
|
-
* @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://
|
|
233
|
+
* @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
198
234
|
*/
|
|
199
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
235
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
200
236
|
/**
|
|
201
237
|
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
202
238
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
239
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
205
|
-
* Success response
|
|
240
|
+
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>}
|
|
241
|
+
* - Success response
|
|
242
|
+
*
|
|
206
243
|
* @name deleteSize
|
|
207
244
|
* @summary: Delete product size
|
|
208
|
-
* @description: Allows to delete size associated with product. - Check out [method documentation](https://
|
|
245
|
+
* @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/).
|
|
209
246
|
*/
|
|
210
|
-
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
247
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
|
|
248
|
+
/**
|
|
249
|
+
* @param {CatalogPlatformValidator.DeleteTaxRuleParam} arg - Arg object
|
|
250
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
251
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
252
|
+
* @returns {Promise<Object>} - Success response
|
|
253
|
+
* @name deleteTaxRule
|
|
254
|
+
* @summary: Delete a tax rule
|
|
255
|
+
* @description: Deletes a tax rule and all its associated versions. Note: A rule cannot be deleted if it is set as the default or is currently assigned to any product.
|
|
256
|
+
* To proceed with deletion, ensure you first assign another rule as the default and unlink this rule from all products.
|
|
257
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxRule/).
|
|
258
|
+
*/
|
|
259
|
+
deleteTaxRule({ ruleId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxRuleParam, { responseHeaders }?: object): Promise<any>;
|
|
260
|
+
/**
|
|
261
|
+
* @param {CatalogPlatformValidator.DeleteTaxVersionParam} arg - Arg object
|
|
262
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
263
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
264
|
+
* @returns {Promise<Object>} - Success response
|
|
265
|
+
* @name deleteTaxVersion
|
|
266
|
+
* @summary: Delete a tax version
|
|
267
|
+
* @description: Deletes a tax rule using the provided rule_id. Only future/scheduled version can be deleted. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxVersion/).
|
|
268
|
+
*/
|
|
269
|
+
deleteTaxVersion({ ruleId, versionId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxVersionParam, { responseHeaders }?: object): Promise<any>;
|
|
211
270
|
/**
|
|
212
271
|
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
213
272
|
* - Arg object
|
|
@@ -217,9 +276,9 @@ declare class Catalog {
|
|
|
217
276
|
* @returns {Promise<string>} - Success response
|
|
218
277
|
* @name downloadInventoryTemplateView
|
|
219
278
|
* @summary: Download inventory template data
|
|
220
|
-
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://
|
|
279
|
+
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
221
280
|
*/
|
|
222
|
-
downloadInventoryTemplateView({
|
|
281
|
+
downloadInventoryTemplateView({ schemaType, type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
223
282
|
/**
|
|
224
283
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
225
284
|
* - Arg object
|
|
@@ -229,19 +288,19 @@ declare class Catalog {
|
|
|
229
288
|
* @returns {Promise<string>} - Success response
|
|
230
289
|
* @name downloadProductTemplateViews
|
|
231
290
|
* @summary: Download product template view
|
|
232
|
-
* @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://
|
|
291
|
+
* @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
233
292
|
*/
|
|
234
293
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
235
294
|
/**
|
|
236
295
|
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
237
296
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
238
297
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
298
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
240
299
|
* @name editProduct
|
|
241
300
|
* @summary: Update a product
|
|
242
|
-
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://
|
|
301
|
+
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/editProduct/).
|
|
243
302
|
*/
|
|
244
|
-
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
303
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
245
304
|
/**
|
|
246
305
|
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
247
306
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -249,7 +308,7 @@ declare class Catalog {
|
|
|
249
308
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
250
309
|
* @name exportInventoryConfig
|
|
251
310
|
* @summary: Get export inventory configuration
|
|
252
|
-
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://
|
|
311
|
+
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/exportInventoryConfig/).
|
|
253
312
|
*/
|
|
254
313
|
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
255
314
|
/**
|
|
@@ -261,9 +320,19 @@ declare class Catalog {
|
|
|
261
320
|
*
|
|
262
321
|
* @name getAllProductHsnCodes
|
|
263
322
|
* @summary: List product HSN codes
|
|
264
|
-
* @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://
|
|
323
|
+
* @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
265
324
|
*/
|
|
266
325
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
326
|
+
/**
|
|
327
|
+
* @param {CatalogPlatformValidator.GetAllTaxRulesParam} arg - Arg object
|
|
328
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
329
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
|
+
* @returns {Promise<CatalogPlatformModel.TaxRules>} - Success response
|
|
331
|
+
* @name getAllTaxRules
|
|
332
|
+
* @summary: Get all tax rules of a company
|
|
333
|
+
* @description: Retrieves a list of all tax rules defined for a company, along with their details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllTaxRules/).
|
|
334
|
+
*/
|
|
335
|
+
getAllTaxRules({ q, statuses, page, limit, versionStatus, requestHeaders }?: CatalogPlatformValidator.GetAllTaxRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRules>;
|
|
267
336
|
/**
|
|
268
337
|
* @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
|
|
269
338
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -271,19 +340,20 @@ declare class Catalog {
|
|
|
271
340
|
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
272
341
|
* @name getAttribute
|
|
273
342
|
* @summary: Get attribute detail by slug
|
|
274
|
-
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://
|
|
343
|
+
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAttribute/).
|
|
275
344
|
*/
|
|
276
345
|
getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
|
|
277
346
|
/**
|
|
278
347
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
279
348
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
349
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
350
|
+
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponseSchema>} -
|
|
351
|
+
* Success response
|
|
282
352
|
* @name getCategoryData
|
|
283
353
|
* @summary: Get category by uid
|
|
284
|
-
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://
|
|
354
|
+
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCategoryData/).
|
|
285
355
|
*/
|
|
286
|
-
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
356
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponseSchema>;
|
|
287
357
|
/**
|
|
288
358
|
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
289
359
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -292,7 +362,7 @@ declare class Catalog {
|
|
|
292
362
|
* Success response
|
|
293
363
|
* @name getCompanyBrandDetail
|
|
294
364
|
* @summary: list Company Brand of Optin
|
|
295
|
-
* @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
365
|
+
* @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
296
366
|
*/
|
|
297
367
|
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
298
368
|
/**
|
|
@@ -302,7 +372,7 @@ declare class Catalog {
|
|
|
302
372
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
303
373
|
* @name getCompanyDetail
|
|
304
374
|
* @summary: Get Company
|
|
305
|
-
* @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
375
|
+
* @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyDetail/).
|
|
306
376
|
*/
|
|
307
377
|
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
308
378
|
/**
|
|
@@ -312,19 +382,33 @@ declare class Catalog {
|
|
|
312
382
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
313
383
|
* @name getCompanyMetrics
|
|
314
384
|
* @summary: Get company metrics
|
|
315
|
-
* @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://
|
|
385
|
+
* @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyMetrics/).
|
|
316
386
|
*/
|
|
317
387
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
318
388
|
/**
|
|
319
389
|
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
320
390
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
391
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
392
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
|
|
393
|
+
* Success response
|
|
323
394
|
* @name getDepartmentData
|
|
324
395
|
* @summary: Get department by uid
|
|
325
|
-
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://
|
|
396
|
+
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getDepartmentData/).
|
|
397
|
+
*/
|
|
398
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
399
|
+
/**
|
|
400
|
+
* @param {CatalogPlatformValidator.GetHsCodesParam} arg - Arg object
|
|
401
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
402
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
403
|
+
* @returns {Promise<CatalogPlatformModel.HSCodes>} - Success response
|
|
404
|
+
* @name getHsCodes
|
|
405
|
+
* @summary: Get HS/SAC codes
|
|
406
|
+
* @description: Retrieve a list of Harmonized System (HS)) or Service Accounting Code (SAC)) codes for a company.
|
|
407
|
+
* HS codes are used to classify goods in international trade, while SAC codes classify services for taxation purposes.
|
|
408
|
+
* Supports optional filtering and pagination.
|
|
409
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsCodes/).
|
|
326
410
|
*/
|
|
327
|
-
|
|
411
|
+
getHsCodes({ page, limit, type, q, requestHeaders }?: CatalogPlatformValidator.GetHsCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSCodes>;
|
|
328
412
|
/**
|
|
329
413
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
330
414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -332,19 +416,20 @@ declare class Catalog {
|
|
|
332
416
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
333
417
|
* @name getHsnCode
|
|
334
418
|
* @summary: List HSN code
|
|
335
|
-
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://
|
|
419
|
+
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsnCode/).
|
|
336
420
|
*/
|
|
337
421
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
338
422
|
/**
|
|
339
423
|
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
340
424
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
425
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
426
|
+
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponseSchema>} -
|
|
427
|
+
* Success response
|
|
343
428
|
* @name getInventories
|
|
344
429
|
* @summary: List Inventory
|
|
345
|
-
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://
|
|
430
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventories/).
|
|
346
431
|
*/
|
|
347
|
-
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
432
|
+
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponseSchema>;
|
|
348
433
|
/**
|
|
349
434
|
* @param {Object} arg - Arg object.
|
|
350
435
|
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
@@ -372,7 +457,7 @@ declare class Catalog {
|
|
|
372
457
|
* inventories less then or equal to provided date based on qty_type value.
|
|
373
458
|
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
374
459
|
* or Primary Identifier) of which inventory is to get.
|
|
375
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
460
|
+
* @returns {Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>}
|
|
376
461
|
* @summary: List Inventory
|
|
377
462
|
* @description: Allows to get Inventories data for particular company.
|
|
378
463
|
*/
|
|
@@ -391,7 +476,7 @@ declare class Catalog {
|
|
|
391
476
|
fromDate?: string;
|
|
392
477
|
toDate?: string;
|
|
393
478
|
sizeIdentifier?: string;
|
|
394
|
-
}): Paginator<CatalogPlatformModel.
|
|
479
|
+
}): Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>;
|
|
395
480
|
/**
|
|
396
481
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
397
482
|
* - Arg object
|
|
@@ -401,21 +486,30 @@ declare class Catalog {
|
|
|
401
486
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
402
487
|
* @name getInventoryBulkUploadHistory
|
|
403
488
|
* @summary: List bulk inventory upload history
|
|
404
|
-
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://
|
|
489
|
+
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
405
490
|
*/
|
|
406
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
491
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, tags, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
407
492
|
/**
|
|
408
493
|
* @param {Object} arg - Arg object.
|
|
409
494
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
410
495
|
* page. Default is 12.
|
|
411
496
|
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
497
|
+
* @param {string} [arg.startDate] - Filter results by the job's start date.
|
|
498
|
+
* @param {string} [arg.endDate] - Filter results by the job's end date.
|
|
499
|
+
* @param {string} [arg.stage] - Filter results by the current stage of the
|
|
500
|
+
* import job.
|
|
501
|
+
* @param {string} [arg.tags] - Filter results by the tags of the import job.
|
|
412
502
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
413
503
|
* @summary: List bulk inventory upload history
|
|
414
504
|
* @description: Helps to get bulk Inventory upload jobs status.
|
|
415
505
|
*/
|
|
416
|
-
getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
|
|
506
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, tags, }?: {
|
|
417
507
|
pageSize?: number;
|
|
418
508
|
search?: string;
|
|
509
|
+
startDate?: string;
|
|
510
|
+
endDate?: string;
|
|
511
|
+
stage?: string;
|
|
512
|
+
tags?: string;
|
|
419
513
|
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
420
514
|
/**
|
|
421
515
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
@@ -425,7 +519,7 @@ declare class Catalog {
|
|
|
425
519
|
* Success response
|
|
426
520
|
* @name getInventoryBySize
|
|
427
521
|
* @summary: List inventory by size
|
|
428
|
-
* @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." - Check out [method documentation](https://
|
|
522
|
+
* @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySize/).
|
|
429
523
|
*/
|
|
430
524
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
431
525
|
/**
|
|
@@ -458,7 +552,7 @@ declare class Catalog {
|
|
|
458
552
|
*
|
|
459
553
|
* @name getInventoryBySizeIdentifier
|
|
460
554
|
* @summary: List inventory by size
|
|
461
|
-
* @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://
|
|
555
|
+
* @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
462
556
|
*/
|
|
463
557
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
464
558
|
/**
|
|
@@ -488,7 +582,7 @@ declare class Catalog {
|
|
|
488
582
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
489
583
|
* @name getInventoryExport
|
|
490
584
|
* @summary: list product inventory
|
|
491
|
-
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://
|
|
585
|
+
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryExport/).
|
|
492
586
|
*/
|
|
493
587
|
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
494
588
|
/**
|
|
@@ -498,7 +592,7 @@ declare class Catalog {
|
|
|
498
592
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
499
593
|
* @name getMarketplaceOptinDetail
|
|
500
594
|
* @summary: Get opt-in
|
|
501
|
-
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://
|
|
595
|
+
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
502
596
|
*/
|
|
503
597
|
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
504
598
|
/**
|
|
@@ -508,61 +602,53 @@ declare class Catalog {
|
|
|
508
602
|
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
509
603
|
* @name getMarketplaces
|
|
510
604
|
* @summary: List marketplaces
|
|
511
|
-
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://
|
|
605
|
+
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaces/).
|
|
512
606
|
*/
|
|
513
607
|
getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
|
|
514
|
-
/**
|
|
515
|
-
* @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
516
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
517
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
518
|
-
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
519
|
-
* @name getOptimalLocations
|
|
520
|
-
* @summary: Get optimal locations
|
|
521
|
-
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
522
|
-
*/
|
|
523
|
-
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
524
608
|
/**
|
|
525
609
|
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
526
610
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
527
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
528
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
612
|
+
* @returns {Promise<CatalogPlatformModel.SingleProductResponseSchema>} -
|
|
613
|
+
* Success response
|
|
529
614
|
* @name getProduct
|
|
530
615
|
* @summary: Get a product
|
|
531
|
-
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://
|
|
616
|
+
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProduct/).
|
|
532
617
|
*/
|
|
533
|
-
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
618
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
|
|
534
619
|
/**
|
|
535
620
|
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
536
621
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
537
622
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
538
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
623
|
+
* @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
|
|
539
624
|
* @name getProductAssetsInBulk
|
|
540
625
|
* @summary: Get product assets
|
|
541
|
-
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://
|
|
626
|
+
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
542
627
|
*/
|
|
543
|
-
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
628
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
544
629
|
/**
|
|
545
630
|
* @param {Object} arg - Arg object.
|
|
546
631
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
547
632
|
* page. Default is 12.
|
|
548
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
633
|
+
* @returns {Paginator<CatalogPlatformModel.BulkAssetResponseSchema>}
|
|
549
634
|
* @summary: Get product assets
|
|
550
635
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company.
|
|
551
636
|
*/
|
|
552
637
|
getProductAssetsInBulkPaginator({ pageSize }?: {
|
|
553
638
|
pageSize?: number;
|
|
554
|
-
}): Paginator<CatalogPlatformModel.
|
|
639
|
+
}): Paginator<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
555
640
|
/**
|
|
556
641
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
557
642
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
643
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
560
|
-
* Success response
|
|
644
|
+
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponseSchema>}
|
|
645
|
+
* - Success response
|
|
646
|
+
*
|
|
561
647
|
* @name getProductAttributes
|
|
562
648
|
* @summary: List product attributes
|
|
563
|
-
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://
|
|
649
|
+
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductAttributes/).
|
|
564
650
|
*/
|
|
565
|
-
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
651
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
|
|
566
652
|
/**
|
|
567
653
|
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
568
654
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -570,7 +656,7 @@ declare class Catalog {
|
|
|
570
656
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
571
657
|
* @name getProductBulkUploadHistory
|
|
572
658
|
* @summary: List product bulk upload history
|
|
573
|
-
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://
|
|
659
|
+
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
574
660
|
*/
|
|
575
661
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
576
662
|
/**
|
|
@@ -587,59 +673,39 @@ declare class Catalog {
|
|
|
587
673
|
pageSize?: number;
|
|
588
674
|
}): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
|
|
589
675
|
/**
|
|
590
|
-
* @param {CatalogPlatformValidator.
|
|
676
|
+
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
591
677
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
592
678
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
593
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
679
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
594
680
|
* - Success response
|
|
595
681
|
*
|
|
596
|
-
* @name getProductBundle
|
|
597
|
-
* @summary: List product bundles
|
|
598
|
-
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
599
|
-
*/
|
|
600
|
-
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
601
|
-
/**
|
|
602
|
-
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
603
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
604
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
605
|
-
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
606
|
-
* Success response
|
|
607
|
-
* @name getProductBundleDetail
|
|
608
|
-
* @summary: Get product bundle
|
|
609
|
-
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
610
|
-
*/
|
|
611
|
-
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
612
|
-
/**
|
|
613
|
-
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
614
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
615
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
616
|
-
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
617
|
-
* Success response
|
|
618
682
|
* @name getProductExportJobs
|
|
619
683
|
* @summary: Get product export jobs
|
|
620
|
-
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://
|
|
684
|
+
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductExportJobs/).
|
|
621
685
|
*/
|
|
622
|
-
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
686
|
+
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
623
687
|
/**
|
|
624
688
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
625
689
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
626
690
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
627
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
691
|
+
* @returns {Promise<CatalogPlatformModel.ProductListingResponseSchema>} -
|
|
692
|
+
* Success response
|
|
628
693
|
* @name getProductSize
|
|
629
694
|
* @summary: List product size
|
|
630
|
-
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://
|
|
695
|
+
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductSize/).
|
|
631
696
|
*/
|
|
632
|
-
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
697
|
+
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
|
|
633
698
|
/**
|
|
634
699
|
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
635
700
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
636
701
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
637
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
702
|
+
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>} -
|
|
703
|
+
* Success response
|
|
638
704
|
* @name getProductTags
|
|
639
705
|
* @summary: List product tags
|
|
640
|
-
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://
|
|
706
|
+
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductTags/).
|
|
641
707
|
*/
|
|
642
|
-
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
708
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
|
|
643
709
|
/**
|
|
644
710
|
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
645
711
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -647,7 +713,7 @@ declare class Catalog {
|
|
|
647
713
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
648
714
|
* @name getProductValidation
|
|
649
715
|
* @summary: Get valid products
|
|
650
|
-
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://
|
|
716
|
+
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductValidation/).
|
|
651
717
|
*/
|
|
652
718
|
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
653
719
|
/**
|
|
@@ -658,7 +724,7 @@ declare class Catalog {
|
|
|
658
724
|
* Success response
|
|
659
725
|
* @name getProducts
|
|
660
726
|
* @summary: List products
|
|
661
|
-
* @description: Retrieve a list of available products - Check out [method documentation](https://
|
|
727
|
+
* @description: Retrieve a list of available products - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProducts/).
|
|
662
728
|
*/
|
|
663
729
|
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
664
730
|
/**
|
|
@@ -702,12 +768,13 @@ declare class Catalog {
|
|
|
702
768
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
703
769
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
704
770
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
705
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
771
|
+
* @returns {Promise<CatalogPlatformModel.CrossSellingResponseSchema>} -
|
|
772
|
+
* Success response
|
|
706
773
|
* @name getSellerInsights
|
|
707
774
|
* @summary: Get seller catalog counts
|
|
708
|
-
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://
|
|
775
|
+
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSellerInsights/).
|
|
709
776
|
*/
|
|
710
|
-
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
777
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
|
|
711
778
|
/**
|
|
712
779
|
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
713
780
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -715,19 +782,19 @@ declare class Catalog {
|
|
|
715
782
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
716
783
|
* @name getSingleProductHSNCode
|
|
717
784
|
* @summary: Get product HSN code
|
|
718
|
-
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://
|
|
785
|
+
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
719
786
|
*/
|
|
720
787
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
721
788
|
/**
|
|
722
789
|
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
723
790
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
724
791
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
725
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
792
|
+
* @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
|
|
726
793
|
* @name getSizeGuide
|
|
727
794
|
* @summary: Get size guide
|
|
728
|
-
* @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://
|
|
795
|
+
* @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuide/).
|
|
729
796
|
*/
|
|
730
|
-
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
797
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
|
|
731
798
|
/**
|
|
732
799
|
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
733
800
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -735,7 +802,7 @@ declare class Catalog {
|
|
|
735
802
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
736
803
|
* @name getSizeGuides
|
|
737
804
|
* @summary: List size guides
|
|
738
|
-
* @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://
|
|
805
|
+
* @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuides/).
|
|
739
806
|
*/
|
|
740
807
|
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
741
808
|
/**
|
|
@@ -745,7 +812,7 @@ declare class Catalog {
|
|
|
745
812
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
746
813
|
* @name getStoreDetail
|
|
747
814
|
* @summary: Get selling location
|
|
748
|
-
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://
|
|
815
|
+
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getStoreDetail/).
|
|
749
816
|
*/
|
|
750
817
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
751
818
|
/**
|
|
@@ -761,23 +828,44 @@ declare class Catalog {
|
|
|
761
828
|
q?: string;
|
|
762
829
|
pageSize?: number;
|
|
763
830
|
}): Paginator<CatalogPlatformModel.OptinStoreDetails>;
|
|
831
|
+
/**
|
|
832
|
+
* @param {CatalogPlatformValidator.GetTaxComponentNamesParam} arg - Arg object
|
|
833
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
834
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
835
|
+
* @returns {Promise<CatalogPlatformModel.GetTaxComponents>} - Success response
|
|
836
|
+
* @name getTaxComponentNames
|
|
837
|
+
* @summary: Get component names
|
|
838
|
+
* @description: Retrieve the list of all tax component names for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxComponentNames/).
|
|
839
|
+
*/
|
|
840
|
+
getTaxComponentNames({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetTaxComponents>;
|
|
841
|
+
/**
|
|
842
|
+
* @param {CatalogPlatformValidator.GetTaxVersionDetailsParam} arg - Arg object
|
|
843
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
844
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
845
|
+
* @returns {Promise<CatalogPlatformModel.TaxRuleVersion>} - Success response
|
|
846
|
+
* @name getTaxVersionDetails
|
|
847
|
+
* @summary: Get tax versions for a tax rule
|
|
848
|
+
* @description: Retrieve the versions of a tax rule. You can filter results by version status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxVersionDetails/).
|
|
849
|
+
*/
|
|
850
|
+
getTaxVersionDetails({ ruleId, versionStatus, q, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRuleVersion>;
|
|
764
851
|
/**
|
|
765
852
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
766
853
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
854
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
855
|
+
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponseSchema>} -
|
|
856
|
+
* Success response
|
|
769
857
|
* @name getVariantsOfProducts
|
|
770
858
|
* @summary: Get variants
|
|
771
|
-
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://
|
|
859
|
+
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getVariantsOfProducts/).
|
|
772
860
|
*/
|
|
773
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
861
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
774
862
|
/**
|
|
775
863
|
* @param {Object} arg - Arg object.
|
|
776
864
|
* @param {number} arg.itemId - Get list of variants of item Id
|
|
777
865
|
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
778
866
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
779
867
|
* page. Default is 10.
|
|
780
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
868
|
+
* @returns {Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>}
|
|
781
869
|
* @summary: Get variants
|
|
782
870
|
* @description: Retrieve variants of a specific product.
|
|
783
871
|
*/
|
|
@@ -785,48 +873,49 @@ declare class Catalog {
|
|
|
785
873
|
itemId: number;
|
|
786
874
|
variantType: string;
|
|
787
875
|
pageSize?: number;
|
|
788
|
-
}): Paginator<CatalogPlatformModel.
|
|
876
|
+
}): Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
789
877
|
/**
|
|
790
878
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
791
879
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
792
880
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
793
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
881
|
+
* @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
|
|
794
882
|
* @name listCategories
|
|
795
883
|
* @summary: List categories
|
|
796
|
-
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://
|
|
884
|
+
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listCategories/).
|
|
797
885
|
*/
|
|
798
|
-
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
886
|
+
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
|
|
799
887
|
/**
|
|
800
888
|
* @param {Object} arg - Arg object.
|
|
801
|
-
* @param {
|
|
889
|
+
* @param {number[]} [arg.level] - Get category for multiple levels
|
|
802
890
|
* @param {number} [arg.department] - Get category for multiple departments filtered
|
|
803
891
|
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
804
892
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
805
893
|
* page. Default is 10.
|
|
806
894
|
* @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
|
|
807
895
|
* @param {string} [arg.slug] - Get category by slug
|
|
808
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
896
|
+
* @returns {Paginator<CatalogPlatformModel.CategoryResponseSchema>}
|
|
809
897
|
* @summary: List categories
|
|
810
898
|
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
|
|
811
899
|
*/
|
|
812
900
|
listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
|
|
813
|
-
level?:
|
|
901
|
+
level?: number[];
|
|
814
902
|
department?: number;
|
|
815
903
|
q?: string;
|
|
816
904
|
pageSize?: number;
|
|
817
905
|
uids?: number[];
|
|
818
906
|
slug?: string;
|
|
819
|
-
}): Paginator<CatalogPlatformModel.
|
|
907
|
+
}): Paginator<CatalogPlatformModel.CategoryResponseSchema>;
|
|
820
908
|
/**
|
|
821
909
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
822
910
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
823
911
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
824
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
912
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
|
|
913
|
+
* Success response
|
|
825
914
|
* @name listDepartmentsData
|
|
826
915
|
* @summary: List company department
|
|
827
|
-
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://
|
|
916
|
+
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listDepartmentsData/).
|
|
828
917
|
*/
|
|
829
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
918
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
830
919
|
/**
|
|
831
920
|
* @param {Object} arg - Arg object.
|
|
832
921
|
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
@@ -839,7 +928,7 @@ declare class Catalog {
|
|
|
839
928
|
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
840
929
|
* whether they are active or inactive.
|
|
841
930
|
* @param {string} [arg.slug] - Can filter by slug
|
|
842
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
931
|
+
* @returns {Paginator<CatalogPlatformModel.DepartmentsResponseSchema>}
|
|
843
932
|
* @summary: List company department
|
|
844
933
|
* @description: Allows you to list all departments data for a specific company.
|
|
845
934
|
*/
|
|
@@ -850,66 +939,67 @@ declare class Catalog {
|
|
|
850
939
|
search?: string;
|
|
851
940
|
isActive?: boolean;
|
|
852
941
|
slug?: string;
|
|
853
|
-
}): Paginator<CatalogPlatformModel.
|
|
942
|
+
}): Paginator<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
854
943
|
/**
|
|
855
944
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
856
945
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
857
946
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
858
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
947
|
+
* @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
|
|
859
948
|
* @name listHSNCodes
|
|
860
949
|
* @summary: List HSN codes
|
|
861
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://
|
|
950
|
+
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listHSNCodes/).
|
|
862
951
|
*/
|
|
863
|
-
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
952
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
|
|
864
953
|
/**
|
|
865
954
|
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
866
955
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
867
956
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
868
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
957
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>}
|
|
869
958
|
* - Success response
|
|
870
959
|
*
|
|
871
960
|
* @name listInventoryExport
|
|
872
961
|
* @summary: List inventory export jobs
|
|
873
|
-
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://
|
|
962
|
+
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listInventoryExport/).
|
|
874
963
|
*/
|
|
875
|
-
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
964
|
+
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
|
|
876
965
|
/**
|
|
877
966
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
878
967
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
879
968
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
880
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
969
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
|
|
881
970
|
* @name listProductTemplate
|
|
882
971
|
* @summary: List product templates
|
|
883
|
-
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://
|
|
972
|
+
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplate/).
|
|
884
973
|
*/
|
|
885
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
974
|
+
listProductTemplate({ department, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
886
975
|
/**
|
|
887
976
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
888
977
|
* - Arg object
|
|
889
978
|
*
|
|
890
979
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
891
980
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
892
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
981
|
+
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>}
|
|
893
982
|
* - Success response
|
|
894
983
|
*
|
|
895
984
|
* @name listProductTemplateCategories
|
|
896
985
|
* @summary: List product template categories
|
|
897
|
-
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://
|
|
986
|
+
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplateCategories/).
|
|
898
987
|
*/
|
|
899
|
-
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
988
|
+
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
|
|
900
989
|
/**
|
|
901
990
|
* @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
|
|
902
991
|
* - Arg object
|
|
903
992
|
*
|
|
904
993
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
905
994
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
906
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
907
|
-
* Success response
|
|
995
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
996
|
+
* - Success response
|
|
997
|
+
*
|
|
908
998
|
* @name listProductTemplateExportDetails
|
|
909
999
|
* @summary: List export product templates
|
|
910
|
-
* @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://
|
|
1000
|
+
* @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
911
1001
|
*/
|
|
912
|
-
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1002
|
+
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
913
1003
|
/**
|
|
914
1004
|
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
915
1005
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -918,9 +1008,23 @@ declare class Catalog {
|
|
|
918
1008
|
* Success response
|
|
919
1009
|
* @name listTemplateBrandTypeValues
|
|
920
1010
|
* @summary: List template brand
|
|
921
|
-
* @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://
|
|
1011
|
+
* @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
922
1012
|
*/
|
|
923
1013
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
1014
|
+
/**
|
|
1015
|
+
* @param {CatalogPlatformValidator.PartialUpdateProductParam} arg - Arg object
|
|
1016
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1017
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1018
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1019
|
+
* @name partialUpdateProduct
|
|
1020
|
+
* @summary: Patch a product
|
|
1021
|
+
* @description: Partially update an existing product in the catalog using PATCH method. This operation allows you to modify specific fields of a product without affecting other attributes. Only the fields provided in the request body will be updated, while all other existing product data remains unchanged.
|
|
1022
|
+
* For objects (e.g. attributes), merge keys shallowly: any key in the patch overrides the existing value.
|
|
1023
|
+
* For arrays of primitives (e.g. tags): replaced wholesale when present.
|
|
1024
|
+
* For arrays of objects (e.g. sizes): match on a unique identifier (seller_identifier) and apply the merge-patch per element; unmentioned elements remain unchanged.
|
|
1025
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/partialUpdateProduct/).
|
|
1026
|
+
*/
|
|
1027
|
+
partialUpdateProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.PartialUpdateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
924
1028
|
/**
|
|
925
1029
|
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
926
1030
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -928,97 +1032,142 @@ declare class Catalog {
|
|
|
928
1032
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
929
1033
|
* @name updateHsnCode
|
|
930
1034
|
* @summary: Update HSN code
|
|
931
|
-
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://
|
|
1035
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateHsnCode/).
|
|
932
1036
|
*/
|
|
933
1037
|
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
934
1038
|
/**
|
|
935
1039
|
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
936
1040
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
937
1041
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
938
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1042
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
1043
|
+
* Success response
|
|
939
1044
|
* @name updateInventories
|
|
940
1045
|
* @summary: Update inventories
|
|
941
|
-
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://
|
|
1046
|
+
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateInventories/).
|
|
942
1047
|
*/
|
|
943
|
-
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1048
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
944
1049
|
/**
|
|
945
|
-
* @param {CatalogPlatformValidator.
|
|
1050
|
+
* @param {CatalogPlatformValidator.UpdateLocationPriceParam} arg - Arg object
|
|
946
1051
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
947
1052
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
948
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1053
|
+
* @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
|
|
949
1054
|
* - Success response
|
|
950
1055
|
*
|
|
951
|
-
* @name
|
|
952
|
-
* @summary: Update
|
|
953
|
-
* @description:
|
|
1056
|
+
* @name updateLocationPrice
|
|
1057
|
+
* @summary: Update an Article Price
|
|
1058
|
+
* @description: enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationPrice/).
|
|
954
1059
|
*/
|
|
955
|
-
|
|
1060
|
+
updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
956
1061
|
/**
|
|
957
|
-
* @param {CatalogPlatformValidator.
|
|
1062
|
+
* @param {CatalogPlatformValidator.UpdateLocationQuantityParam} arg - Arg object
|
|
958
1063
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
959
1064
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
960
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1065
|
+
* @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
|
|
961
1066
|
* - Success response
|
|
962
1067
|
*
|
|
963
|
-
* @name
|
|
964
|
-
* @summary: Update
|
|
965
|
-
* @description:
|
|
1068
|
+
* @name updateLocationQuantity
|
|
1069
|
+
* @summary: Update an Article Quantity
|
|
1070
|
+
* @description: enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationQuantity/).
|
|
966
1071
|
*/
|
|
967
|
-
|
|
1072
|
+
updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
1073
|
+
/**
|
|
1074
|
+
* @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
|
|
1075
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1076
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1077
|
+
* @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>}
|
|
1078
|
+
* - Success response
|
|
1079
|
+
*
|
|
1080
|
+
* @name updateMarketplaceOptin
|
|
1081
|
+
* @summary: Update marketplace optin
|
|
1082
|
+
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateMarketplaceOptin/).
|
|
1083
|
+
*/
|
|
1084
|
+
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
|
|
968
1085
|
/**
|
|
969
1086
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
970
1087
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
971
1088
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
972
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1089
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
1090
|
+
* Success response
|
|
973
1091
|
* @name updateRealtimeInventory
|
|
974
1092
|
* @summary: Update an inventory
|
|
975
|
-
* @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://
|
|
1093
|
+
* @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateRealtimeInventory/).
|
|
976
1094
|
*/
|
|
977
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1095
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
978
1096
|
/**
|
|
979
1097
|
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
980
1098
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
981
1099
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
982
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1100
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
983
1101
|
* @name updateSizeGuide
|
|
984
1102
|
* @summary: Update size guide
|
|
985
|
-
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://
|
|
1103
|
+
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/).
|
|
1104
|
+
*/
|
|
1105
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1106
|
+
/**
|
|
1107
|
+
* @param {CatalogPlatformValidator.UpdateTaxRuleParam} arg - Arg object
|
|
1108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1109
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1110
|
+
* @returns {Promise<CatalogPlatformModel.TaxRule>} - Success response
|
|
1111
|
+
* @name updateTaxRule
|
|
1112
|
+
* @summary: Update Tax Rule
|
|
1113
|
+
* @description: Update the details of an existing tax rule for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/).
|
|
986
1114
|
*/
|
|
987
|
-
|
|
1115
|
+
updateTaxRule({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRule>;
|
|
988
1116
|
/**
|
|
989
|
-
* @param {CatalogPlatformValidator.
|
|
1117
|
+
* @param {CatalogPlatformValidator.UpdateTaxVersionParam} arg - Arg object
|
|
990
1118
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
991
1119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
992
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
993
|
-
* @name
|
|
994
|
-
* @summary:
|
|
995
|
-
* @description:
|
|
1120
|
+
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
1121
|
+
* @name updateTaxVersion
|
|
1122
|
+
* @summary: Update a tax version
|
|
1123
|
+
* @description: When updating a tax version, the rules differ depending on whether it is a live version (that is, its applicable_date is now or in the past) or a scheduled version (with an applicable_date in the future).
|
|
1124
|
+
* For live versions, only the component names may be modified and only when the corresponding _id also matches, while changes to fields such as applicable_date, scope, store_ids, areas, region_type, and any other properties are not allowed.
|
|
1125
|
+
* In contrast, for scheduled (future) versions, you may change the applicable_date using an ISO datetime representing the date and time the version takes effect (at the start of the local day); to avoid changing it, simply pass the current applicable_date value.
|
|
1126
|
+
* Components can be added, updated, or removed: new components may omit _id, and omitting a known _id from the request will remove that component. The scope (COUNTRY by default, or STORE or REGION) can be set; for STORE scope, store_ids are required—if not specified, the existing store_ids are used.
|
|
1127
|
+
* For REGION scope, areas are required and region_type can be provided or will default to the current setting. In all cases, component names are validated, and only one version per rule may exist for each local day.
|
|
1128
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/).
|
|
996
1129
|
*/
|
|
997
|
-
|
|
1130
|
+
updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
|
|
1131
|
+
/**
|
|
1132
|
+
* @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
|
|
1133
|
+
* - Arg object
|
|
1134
|
+
*
|
|
1135
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1136
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1137
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>}
|
|
1138
|
+
* - Success response
|
|
1139
|
+
*
|
|
1140
|
+
* @name validateProductGlobalTemplate
|
|
1141
|
+
* @summary: Validate product template
|
|
1142
|
+
* @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductGlobalTemplate/).
|
|
1143
|
+
*/
|
|
1144
|
+
validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
|
|
998
1145
|
/**
|
|
999
1146
|
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
1000
1147
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1001
1148
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1002
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1003
|
-
* Success response
|
|
1149
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>}
|
|
1150
|
+
* - Success response
|
|
1151
|
+
*
|
|
1004
1152
|
* @name validateProductTemplate
|
|
1005
1153
|
* @summary: Validate product template
|
|
1006
|
-
* @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://
|
|
1154
|
+
* @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplate/).
|
|
1007
1155
|
*/
|
|
1008
|
-
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1156
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
|
|
1009
1157
|
/**
|
|
1010
1158
|
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
1011
1159
|
* - Arg object
|
|
1012
1160
|
*
|
|
1013
1161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1014
1162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1015
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1016
|
-
* Success response
|
|
1163
|
+
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponseSchema>}
|
|
1164
|
+
* - Success response
|
|
1165
|
+
*
|
|
1017
1166
|
* @name validateProductTemplateSchema
|
|
1018
1167
|
* @summary: Validate product template schema
|
|
1019
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://
|
|
1168
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1020
1169
|
*/
|
|
1021
|
-
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1170
|
+
validateProductTemplateSchema({ itemType, schemaType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1022
1171
|
}
|
|
1023
1172
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
1024
1173
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|