@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.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 +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -9,7 +9,7 @@ declare class Catalog {
|
|
|
9
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
14
|
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ 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
|
/**
|
|
@@ -29,7 +29,7 @@ declare class Catalog {
|
|
|
29
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
34
|
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Catalog {
|
|
|
39
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
44
|
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
45
45
|
/**
|
|
@@ -49,7 +49,7 @@ declare class Catalog {
|
|
|
49
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
54
|
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
55
55
|
/**
|
|
@@ -59,7 +59,7 @@ declare class Catalog {
|
|
|
59
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
64
|
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
65
65
|
/**
|
|
@@ -70,7 +70,7 @@ declare class Catalog {
|
|
|
70
70
|
* Success response
|
|
71
71
|
* @name createInventoryExport
|
|
72
72
|
* @summary: Create inventory export
|
|
73
|
-
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://
|
|
73
|
+
* @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/).
|
|
74
74
|
*/
|
|
75
75
|
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
76
76
|
/**
|
|
@@ -81,7 +81,7 @@ declare class Catalog {
|
|
|
81
81
|
* Success response
|
|
82
82
|
* @name createInventoryExportJob
|
|
83
83
|
* @summary: Create inventory export job
|
|
84
|
-
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://
|
|
84
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExportJob/).
|
|
85
85
|
*/
|
|
86
86
|
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
87
87
|
/**
|
|
@@ -93,7 +93,7 @@ declare class Catalog {
|
|
|
93
93
|
*
|
|
94
94
|
* @name createMarketplaceOptin
|
|
95
95
|
* @summary: Create or Update opt-in infomation
|
|
96
|
-
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://
|
|
96
|
+
* @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/).
|
|
97
97
|
*/
|
|
98
98
|
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>;
|
|
99
99
|
/**
|
|
@@ -103,7 +103,7 @@ declare class Catalog {
|
|
|
103
103
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
104
104
|
* @name createProduct
|
|
105
105
|
* @summary: Create product
|
|
106
|
-
* @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://
|
|
106
|
+
* @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/).
|
|
107
107
|
*/
|
|
108
108
|
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
109
109
|
/**
|
|
@@ -113,7 +113,7 @@ declare class Catalog {
|
|
|
113
113
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
114
114
|
* @name createProductAssetsInBulk
|
|
115
115
|
* @summary: Create product assets in bulk
|
|
116
|
-
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://
|
|
116
|
+
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
117
117
|
*/
|
|
118
118
|
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
119
119
|
/**
|
|
@@ -125,7 +125,7 @@ declare class Catalog {
|
|
|
125
125
|
*
|
|
126
126
|
* @name createProductBundle
|
|
127
127
|
* @summary: Create product bundle
|
|
128
|
-
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://
|
|
128
|
+
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductBundle/).
|
|
129
129
|
*/
|
|
130
130
|
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
131
131
|
/**
|
|
@@ -137,7 +137,7 @@ declare class Catalog {
|
|
|
137
137
|
*
|
|
138
138
|
* @name createProductExportJob
|
|
139
139
|
* @summary: Create product export job
|
|
140
|
-
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://
|
|
140
|
+
* @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/).
|
|
141
141
|
*/
|
|
142
142
|
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
143
143
|
/**
|
|
@@ -147,7 +147,7 @@ declare class Catalog {
|
|
|
147
147
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
148
148
|
* @name createProductsInBulk
|
|
149
149
|
* @summary: Create products in bulk
|
|
150
|
-
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://
|
|
150
|
+
* @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/).
|
|
151
151
|
*/
|
|
152
152
|
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
153
153
|
/**
|
|
@@ -157,7 +157,7 @@ declare class Catalog {
|
|
|
157
157
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
158
158
|
* @name createSizeGuide
|
|
159
159
|
* @summary: Create size guide
|
|
160
|
-
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://
|
|
160
|
+
* @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/).
|
|
161
161
|
*/
|
|
162
162
|
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
163
163
|
/**
|
|
@@ -167,7 +167,7 @@ declare class Catalog {
|
|
|
167
167
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
168
168
|
* @name deleteBulkInventoryJob
|
|
169
169
|
* @summary: Delete inventory bulk upload job
|
|
170
|
-
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://
|
|
170
|
+
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
171
171
|
*/
|
|
172
172
|
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
173
173
|
/**
|
|
@@ -177,7 +177,7 @@ declare class Catalog {
|
|
|
177
177
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
178
178
|
* @name deleteProduct
|
|
179
179
|
* @summary: Delete product
|
|
180
|
-
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://
|
|
180
|
+
* @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/).
|
|
181
181
|
*/
|
|
182
182
|
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
183
183
|
/**
|
|
@@ -187,7 +187,7 @@ declare class Catalog {
|
|
|
187
187
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
188
188
|
* @name deleteProductBulkJob
|
|
189
189
|
* @summary: Delete product bulk-upload job
|
|
190
|
-
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://
|
|
190
|
+
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProductBulkJob/).
|
|
191
191
|
*/
|
|
192
192
|
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
193
193
|
/**
|
|
@@ -198,7 +198,7 @@ declare class Catalog {
|
|
|
198
198
|
* Success response
|
|
199
199
|
* @name deleteRealtimeInventory
|
|
200
200
|
* @summary: Delete an inventory
|
|
201
|
-
* @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://
|
|
201
|
+
* @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/).
|
|
202
202
|
*/
|
|
203
203
|
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
204
204
|
/**
|
|
@@ -210,7 +210,7 @@ declare class Catalog {
|
|
|
210
210
|
*
|
|
211
211
|
* @name deleteSize
|
|
212
212
|
* @summary: Delete product size
|
|
213
|
-
* @description: Allows to delete size associated with product. - Check out [method documentation](https://
|
|
213
|
+
* @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/).
|
|
214
214
|
*/
|
|
215
215
|
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
|
|
216
216
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Catalog {
|
|
|
222
222
|
* @returns {Promise<string>} - Success response
|
|
223
223
|
* @name downloadInventoryTemplateView
|
|
224
224
|
* @summary: Download inventory template data
|
|
225
|
-
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://
|
|
225
|
+
* @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/).
|
|
226
226
|
*/
|
|
227
227
|
downloadInventoryTemplateView({ schemaType, type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
228
228
|
/**
|
|
@@ -234,7 +234,7 @@ declare class Catalog {
|
|
|
234
234
|
* @returns {Promise<string>} - Success response
|
|
235
235
|
* @name downloadProductTemplateViews
|
|
236
236
|
* @summary: Download product template view
|
|
237
|
-
* @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://
|
|
237
|
+
* @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/).
|
|
238
238
|
*/
|
|
239
239
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
240
240
|
/**
|
|
@@ -244,7 +244,7 @@ declare class Catalog {
|
|
|
244
244
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
245
245
|
* @name editProduct
|
|
246
246
|
* @summary: Update a product
|
|
247
|
-
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://
|
|
247
|
+
* @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/).
|
|
248
248
|
*/
|
|
249
249
|
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
250
250
|
/**
|
|
@@ -254,7 +254,7 @@ declare class Catalog {
|
|
|
254
254
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
255
255
|
* @name exportInventoryConfig
|
|
256
256
|
* @summary: Get export inventory configuration
|
|
257
|
-
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://
|
|
257
|
+
* @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/).
|
|
258
258
|
*/
|
|
259
259
|
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
260
260
|
/**
|
|
@@ -266,7 +266,7 @@ declare class Catalog {
|
|
|
266
266
|
*
|
|
267
267
|
* @name getAllProductHsnCodes
|
|
268
268
|
* @summary: List product HSN codes
|
|
269
|
-
* @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://
|
|
269
|
+
* @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/).
|
|
270
270
|
*/
|
|
271
271
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
272
272
|
/**
|
|
@@ -276,7 +276,7 @@ declare class Catalog {
|
|
|
276
276
|
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
277
277
|
* @name getAttribute
|
|
278
278
|
* @summary: Get attribute detail by slug
|
|
279
|
-
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://
|
|
279
|
+
* @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/).
|
|
280
280
|
*/
|
|
281
281
|
getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
|
|
282
282
|
/**
|
|
@@ -287,7 +287,7 @@ declare class Catalog {
|
|
|
287
287
|
* Success response
|
|
288
288
|
* @name getCategoryData
|
|
289
289
|
* @summary: Get category by uid
|
|
290
|
-
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://
|
|
290
|
+
* @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/).
|
|
291
291
|
*/
|
|
292
292
|
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponseSchema>;
|
|
293
293
|
/**
|
|
@@ -298,7 +298,7 @@ declare class Catalog {
|
|
|
298
298
|
* Success response
|
|
299
299
|
* @name getCompanyBrandDetail
|
|
300
300
|
* @summary: list Company Brand of Optin
|
|
301
|
-
* @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
301
|
+
* @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/).
|
|
302
302
|
*/
|
|
303
303
|
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
304
304
|
/**
|
|
@@ -308,7 +308,7 @@ declare class Catalog {
|
|
|
308
308
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
309
309
|
* @name getCompanyDetail
|
|
310
310
|
* @summary: Get Company
|
|
311
|
-
* @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
311
|
+
* @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/).
|
|
312
312
|
*/
|
|
313
313
|
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
314
314
|
/**
|
|
@@ -318,7 +318,7 @@ declare class Catalog {
|
|
|
318
318
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
319
319
|
* @name getCompanyMetrics
|
|
320
320
|
* @summary: Get company metrics
|
|
321
|
-
* @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://
|
|
321
|
+
* @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/).
|
|
322
322
|
*/
|
|
323
323
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
324
324
|
/**
|
|
@@ -329,7 +329,7 @@ declare class Catalog {
|
|
|
329
329
|
* Success response
|
|
330
330
|
* @name getDepartmentData
|
|
331
331
|
* @summary: Get department by uid
|
|
332
|
-
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://
|
|
332
|
+
* @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/).
|
|
333
333
|
*/
|
|
334
334
|
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
335
335
|
/**
|
|
@@ -339,7 +339,7 @@ declare class Catalog {
|
|
|
339
339
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
340
340
|
* @name getHsnCode
|
|
341
341
|
* @summary: List HSN code
|
|
342
|
-
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://
|
|
342
|
+
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsnCode/).
|
|
343
343
|
*/
|
|
344
344
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
345
345
|
/**
|
|
@@ -350,7 +350,7 @@ declare class Catalog {
|
|
|
350
350
|
* Success response
|
|
351
351
|
* @name getInventories
|
|
352
352
|
* @summary: List Inventory
|
|
353
|
-
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://
|
|
353
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventories/).
|
|
354
354
|
*/
|
|
355
355
|
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>;
|
|
356
356
|
/**
|
|
@@ -409,9 +409,9 @@ declare class Catalog {
|
|
|
409
409
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
410
410
|
* @name getInventoryBulkUploadHistory
|
|
411
411
|
* @summary: List bulk inventory upload history
|
|
412
|
-
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://
|
|
412
|
+
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
413
413
|
*/
|
|
414
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
414
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, tags, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
415
415
|
/**
|
|
416
416
|
* @param {Object} arg - Arg object.
|
|
417
417
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
@@ -421,16 +421,18 @@ declare class Catalog {
|
|
|
421
421
|
* @param {string} [arg.endDate] - Filter results by the job's end date.
|
|
422
422
|
* @param {string} [arg.stage] - Filter results by the current stage of the
|
|
423
423
|
* import job.
|
|
424
|
+
* @param {string} [arg.tags] - Filter results by the tags of the import job.
|
|
424
425
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
425
426
|
* @summary: List bulk inventory upload history
|
|
426
427
|
* @description: Helps to get bulk Inventory upload jobs status.
|
|
427
428
|
*/
|
|
428
|
-
getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, }?: {
|
|
429
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, tags, }?: {
|
|
429
430
|
pageSize?: number;
|
|
430
431
|
search?: string;
|
|
431
432
|
startDate?: string;
|
|
432
433
|
endDate?: string;
|
|
433
434
|
stage?: string;
|
|
435
|
+
tags?: string;
|
|
434
436
|
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
435
437
|
/**
|
|
436
438
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
@@ -440,7 +442,7 @@ declare class Catalog {
|
|
|
440
442
|
* Success response
|
|
441
443
|
* @name getInventoryBySize
|
|
442
444
|
* @summary: List inventory by size
|
|
443
|
-
* @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://
|
|
445
|
+
* @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/).
|
|
444
446
|
*/
|
|
445
447
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
446
448
|
/**
|
|
@@ -473,7 +475,7 @@ declare class Catalog {
|
|
|
473
475
|
*
|
|
474
476
|
* @name getInventoryBySizeIdentifier
|
|
475
477
|
* @summary: List inventory by size
|
|
476
|
-
* @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://
|
|
478
|
+
* @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/).
|
|
477
479
|
*/
|
|
478
480
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
479
481
|
/**
|
|
@@ -503,7 +505,7 @@ declare class Catalog {
|
|
|
503
505
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
504
506
|
* @name getInventoryExport
|
|
505
507
|
* @summary: list product inventory
|
|
506
|
-
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://
|
|
508
|
+
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryExport/).
|
|
507
509
|
*/
|
|
508
510
|
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
509
511
|
/**
|
|
@@ -513,7 +515,7 @@ declare class Catalog {
|
|
|
513
515
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
514
516
|
* @name getMarketplaceOptinDetail
|
|
515
517
|
* @summary: Get opt-in
|
|
516
|
-
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://
|
|
518
|
+
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
517
519
|
*/
|
|
518
520
|
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
519
521
|
/**
|
|
@@ -523,7 +525,7 @@ declare class Catalog {
|
|
|
523
525
|
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
524
526
|
* @name getMarketplaces
|
|
525
527
|
* @summary: List marketplaces
|
|
526
|
-
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://
|
|
528
|
+
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaces/).
|
|
527
529
|
*/
|
|
528
530
|
getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
|
|
529
531
|
/**
|
|
@@ -534,7 +536,7 @@ declare class Catalog {
|
|
|
534
536
|
* Success response
|
|
535
537
|
* @name getOptimalLocations
|
|
536
538
|
* @summary: Get optimal locations
|
|
537
|
-
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://
|
|
539
|
+
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getOptimalLocations/).
|
|
538
540
|
*/
|
|
539
541
|
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponseSchema>;
|
|
540
542
|
/**
|
|
@@ -545,7 +547,7 @@ declare class Catalog {
|
|
|
545
547
|
* Success response
|
|
546
548
|
* @name getProduct
|
|
547
549
|
* @summary: Get a product
|
|
548
|
-
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://
|
|
550
|
+
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProduct/).
|
|
549
551
|
*/
|
|
550
552
|
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
|
|
551
553
|
/**
|
|
@@ -555,7 +557,7 @@ declare class Catalog {
|
|
|
555
557
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
|
|
556
558
|
* @name getProductAssetsInBulk
|
|
557
559
|
* @summary: Get product assets
|
|
558
|
-
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://
|
|
560
|
+
* @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/).
|
|
559
561
|
*/
|
|
560
562
|
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
561
563
|
/**
|
|
@@ -578,7 +580,7 @@ declare class Catalog {
|
|
|
578
580
|
*
|
|
579
581
|
* @name getProductAttributes
|
|
580
582
|
* @summary: List product attributes
|
|
581
|
-
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://
|
|
583
|
+
* @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/).
|
|
582
584
|
*/
|
|
583
585
|
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
|
|
584
586
|
/**
|
|
@@ -588,7 +590,7 @@ declare class Catalog {
|
|
|
588
590
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
589
591
|
* @name getProductBulkUploadHistory
|
|
590
592
|
* @summary: List product bulk upload history
|
|
591
|
-
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://
|
|
593
|
+
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
592
594
|
*/
|
|
593
595
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
594
596
|
/**
|
|
@@ -613,7 +615,7 @@ declare class Catalog {
|
|
|
613
615
|
*
|
|
614
616
|
* @name getProductBundle
|
|
615
617
|
* @summary: List product bundles
|
|
616
|
-
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
618
|
+
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundle/).
|
|
617
619
|
*/
|
|
618
620
|
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
|
|
619
621
|
/**
|
|
@@ -625,7 +627,7 @@ declare class Catalog {
|
|
|
625
627
|
*
|
|
626
628
|
* @name getProductBundleDetail
|
|
627
629
|
* @summary: Get product bundle
|
|
628
|
-
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://
|
|
630
|
+
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundleDetail/).
|
|
629
631
|
*/
|
|
630
632
|
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
|
|
631
633
|
/**
|
|
@@ -637,7 +639,7 @@ declare class Catalog {
|
|
|
637
639
|
*
|
|
638
640
|
* @name getProductExportJobs
|
|
639
641
|
* @summary: Get product export jobs
|
|
640
|
-
* @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://
|
|
642
|
+
* @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/).
|
|
641
643
|
*/
|
|
642
644
|
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
643
645
|
/**
|
|
@@ -648,7 +650,7 @@ declare class Catalog {
|
|
|
648
650
|
* Success response
|
|
649
651
|
* @name getProductSize
|
|
650
652
|
* @summary: List product size
|
|
651
|
-
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://
|
|
653
|
+
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductSize/).
|
|
652
654
|
*/
|
|
653
655
|
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
|
|
654
656
|
/**
|
|
@@ -659,7 +661,7 @@ declare class Catalog {
|
|
|
659
661
|
* Success response
|
|
660
662
|
* @name getProductTags
|
|
661
663
|
* @summary: List product tags
|
|
662
|
-
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://
|
|
664
|
+
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductTags/).
|
|
663
665
|
*/
|
|
664
666
|
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
|
|
665
667
|
/**
|
|
@@ -669,7 +671,7 @@ declare class Catalog {
|
|
|
669
671
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
670
672
|
* @name getProductValidation
|
|
671
673
|
* @summary: Get valid products
|
|
672
|
-
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://
|
|
674
|
+
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductValidation/).
|
|
673
675
|
*/
|
|
674
676
|
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
675
677
|
/**
|
|
@@ -680,7 +682,7 @@ declare class Catalog {
|
|
|
680
682
|
* Success response
|
|
681
683
|
* @name getProducts
|
|
682
684
|
* @summary: List products
|
|
683
|
-
* @description: Retrieve a list of available products - Check out [method documentation](https://
|
|
685
|
+
* @description: Retrieve a list of available products - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProducts/).
|
|
684
686
|
*/
|
|
685
687
|
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
686
688
|
/**
|
|
@@ -728,7 +730,7 @@ declare class Catalog {
|
|
|
728
730
|
* Success response
|
|
729
731
|
* @name getSellerInsights
|
|
730
732
|
* @summary: Get seller catalog counts
|
|
731
|
-
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://
|
|
733
|
+
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSellerInsights/).
|
|
732
734
|
*/
|
|
733
735
|
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
|
|
734
736
|
/**
|
|
@@ -738,7 +740,7 @@ declare class Catalog {
|
|
|
738
740
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
739
741
|
* @name getSingleProductHSNCode
|
|
740
742
|
* @summary: Get product HSN code
|
|
741
|
-
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://
|
|
743
|
+
* @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/).
|
|
742
744
|
*/
|
|
743
745
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
744
746
|
/**
|
|
@@ -748,7 +750,7 @@ declare class Catalog {
|
|
|
748
750
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
|
|
749
751
|
* @name getSizeGuide
|
|
750
752
|
* @summary: Get size guide
|
|
751
|
-
* @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://
|
|
753
|
+
* @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/).
|
|
752
754
|
*/
|
|
753
755
|
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
|
|
754
756
|
/**
|
|
@@ -758,7 +760,7 @@ declare class Catalog {
|
|
|
758
760
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
759
761
|
* @name getSizeGuides
|
|
760
762
|
* @summary: List size guides
|
|
761
|
-
* @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://
|
|
763
|
+
* @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/).
|
|
762
764
|
*/
|
|
763
765
|
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
764
766
|
/**
|
|
@@ -768,7 +770,7 @@ declare class Catalog {
|
|
|
768
770
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
769
771
|
* @name getStoreDetail
|
|
770
772
|
* @summary: Get selling location
|
|
771
|
-
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://
|
|
773
|
+
* @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/).
|
|
772
774
|
*/
|
|
773
775
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
774
776
|
/**
|
|
@@ -792,7 +794,7 @@ declare class Catalog {
|
|
|
792
794
|
* Success response
|
|
793
795
|
* @name getVariantsOfProducts
|
|
794
796
|
* @summary: Get variants
|
|
795
|
-
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://
|
|
797
|
+
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getVariantsOfProducts/).
|
|
796
798
|
*/
|
|
797
799
|
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
798
800
|
/**
|
|
@@ -817,7 +819,7 @@ declare class Catalog {
|
|
|
817
819
|
* @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
|
|
818
820
|
* @name listCategories
|
|
819
821
|
* @summary: List categories
|
|
820
|
-
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://
|
|
822
|
+
* @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/).
|
|
821
823
|
*/
|
|
822
824
|
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
|
|
823
825
|
/**
|
|
@@ -849,7 +851,7 @@ declare class Catalog {
|
|
|
849
851
|
* Success response
|
|
850
852
|
* @name listDepartmentsData
|
|
851
853
|
* @summary: List company department
|
|
852
|
-
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://
|
|
854
|
+
* @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/).
|
|
853
855
|
*/
|
|
854
856
|
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
855
857
|
/**
|
|
@@ -883,7 +885,7 @@ declare class Catalog {
|
|
|
883
885
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
|
|
884
886
|
* @name listHSNCodes
|
|
885
887
|
* @summary: List HSN codes
|
|
886
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://
|
|
888
|
+
* @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/).
|
|
887
889
|
*/
|
|
888
890
|
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
|
|
889
891
|
/**
|
|
@@ -895,7 +897,7 @@ declare class Catalog {
|
|
|
895
897
|
*
|
|
896
898
|
* @name listInventoryExport
|
|
897
899
|
* @summary: List inventory export jobs
|
|
898
|
-
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://
|
|
900
|
+
* @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/).
|
|
899
901
|
*/
|
|
900
902
|
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
|
|
901
903
|
/**
|
|
@@ -905,7 +907,7 @@ declare class Catalog {
|
|
|
905
907
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
|
|
906
908
|
* @name listProductTemplate
|
|
907
909
|
* @summary: List product templates
|
|
908
|
-
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://
|
|
910
|
+
* @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/).
|
|
909
911
|
*/
|
|
910
912
|
listProductTemplate({ department, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
911
913
|
/**
|
|
@@ -919,7 +921,7 @@ declare class Catalog {
|
|
|
919
921
|
*
|
|
920
922
|
* @name listProductTemplateCategories
|
|
921
923
|
* @summary: List product template categories
|
|
922
|
-
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://
|
|
924
|
+
* @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/).
|
|
923
925
|
*/
|
|
924
926
|
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
|
|
925
927
|
/**
|
|
@@ -933,7 +935,7 @@ declare class Catalog {
|
|
|
933
935
|
*
|
|
934
936
|
* @name listProductTemplateExportDetails
|
|
935
937
|
* @summary: List export product templates
|
|
936
|
-
* @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://
|
|
938
|
+
* @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/).
|
|
937
939
|
*/
|
|
938
940
|
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
939
941
|
/**
|
|
@@ -944,7 +946,7 @@ declare class Catalog {
|
|
|
944
946
|
* Success response
|
|
945
947
|
* @name listTemplateBrandTypeValues
|
|
946
948
|
* @summary: List template brand
|
|
947
|
-
* @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://
|
|
949
|
+
* @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/).
|
|
948
950
|
*/
|
|
949
951
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
950
952
|
/**
|
|
@@ -954,7 +956,7 @@ declare class Catalog {
|
|
|
954
956
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
955
957
|
* @name updateHsnCode
|
|
956
958
|
* @summary: Update HSN code
|
|
957
|
-
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://
|
|
959
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateHsnCode/).
|
|
958
960
|
*/
|
|
959
961
|
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
960
962
|
/**
|
|
@@ -965,7 +967,7 @@ declare class Catalog {
|
|
|
965
967
|
* Success response
|
|
966
968
|
* @name updateInventories
|
|
967
969
|
* @summary: Update inventories
|
|
968
|
-
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://
|
|
970
|
+
* @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/).
|
|
969
971
|
*/
|
|
970
972
|
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
971
973
|
/**
|
|
@@ -977,7 +979,7 @@ declare class Catalog {
|
|
|
977
979
|
*
|
|
978
980
|
* @name updateLocationPrice
|
|
979
981
|
* @summary: Update an Article Price
|
|
980
|
-
* @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://
|
|
982
|
+
* @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/).
|
|
981
983
|
*/
|
|
982
984
|
updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
983
985
|
/**
|
|
@@ -989,7 +991,7 @@ declare class Catalog {
|
|
|
989
991
|
*
|
|
990
992
|
* @name updateLocationQuantity
|
|
991
993
|
* @summary: Update an Article Quantity
|
|
992
|
-
* @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://
|
|
994
|
+
* @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/).
|
|
993
995
|
*/
|
|
994
996
|
updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
995
997
|
/**
|
|
@@ -1001,7 +1003,7 @@ declare class Catalog {
|
|
|
1001
1003
|
*
|
|
1002
1004
|
* @name updateMarketplaceOptin
|
|
1003
1005
|
* @summary: Update marketplace optin
|
|
1004
|
-
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://
|
|
1006
|
+
* @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/).
|
|
1005
1007
|
*/
|
|
1006
1008
|
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
|
|
1007
1009
|
/**
|
|
@@ -1013,7 +1015,7 @@ declare class Catalog {
|
|
|
1013
1015
|
*
|
|
1014
1016
|
* @name updateProductBundle
|
|
1015
1017
|
* @summary: Update product bundle
|
|
1016
|
-
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
1018
|
+
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateProductBundle/).
|
|
1017
1019
|
*/
|
|
1018
1020
|
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
1019
1021
|
/**
|
|
@@ -1024,7 +1026,7 @@ declare class Catalog {
|
|
|
1024
1026
|
* Success response
|
|
1025
1027
|
* @name updateRealtimeInventory
|
|
1026
1028
|
* @summary: Update an inventory
|
|
1027
|
-
* @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://
|
|
1029
|
+
* @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/).
|
|
1028
1030
|
*/
|
|
1029
1031
|
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
1030
1032
|
/**
|
|
@@ -1034,7 +1036,7 @@ declare class Catalog {
|
|
|
1034
1036
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1035
1037
|
* @name updateSizeGuide
|
|
1036
1038
|
* @summary: Update size guide
|
|
1037
|
-
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://
|
|
1039
|
+
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/).
|
|
1038
1040
|
*/
|
|
1039
1041
|
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1040
1042
|
/**
|
|
@@ -1044,7 +1046,7 @@ declare class Catalog {
|
|
|
1044
1046
|
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
1045
1047
|
* @name uploadBulkProducts
|
|
1046
1048
|
* @summary: Upload bulk products
|
|
1047
|
-
* @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://
|
|
1049
|
+
* @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
|
|
1048
1050
|
*/
|
|
1049
1051
|
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
1050
1052
|
/**
|
|
@@ -1058,7 +1060,7 @@ declare class Catalog {
|
|
|
1058
1060
|
*
|
|
1059
1061
|
* @name validateProductGlobalTemplate
|
|
1060
1062
|
* @summary: Validate product template
|
|
1061
|
-
* @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://
|
|
1063
|
+
* @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/).
|
|
1062
1064
|
*/
|
|
1063
1065
|
validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
|
|
1064
1066
|
/**
|
|
@@ -1070,7 +1072,7 @@ declare class Catalog {
|
|
|
1070
1072
|
*
|
|
1071
1073
|
* @name validateProductTemplate
|
|
1072
1074
|
* @summary: Validate product template
|
|
1073
|
-
* @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://
|
|
1075
|
+
* @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/).
|
|
1074
1076
|
*/
|
|
1075
1077
|
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
|
|
1076
1078
|
/**
|
|
@@ -1084,7 +1086,7 @@ declare class Catalog {
|
|
|
1084
1086
|
*
|
|
1085
1087
|
* @name validateProductTemplateSchema
|
|
1086
1088
|
* @summary: Validate product template schema
|
|
1087
|
-
* @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://
|
|
1089
|
+
* @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/).
|
|
1088
1090
|
*/
|
|
1089
1091
|
validateProductTemplateSchema({ itemType, schemaType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1090
1092
|
}
|