@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
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 +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- 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 +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -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 +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- 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 +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -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 +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -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 +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- 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 +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -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 +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -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 +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -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 +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- 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 +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -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,9 +222,9 @@ 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
|
-
downloadInventoryTemplateView({
|
|
227
|
+
downloadInventoryTemplateView({ schemaType, type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
228
228
|
/**
|
|
229
229
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
230
230
|
* - Arg object
|
|
@@ -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,21 +409,28 @@ 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, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
414
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, 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
|
|
418
418
|
* page. Default is 12.
|
|
419
419
|
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
420
|
+
* @param {string} [arg.startDate] - Filter results by the job's start date.
|
|
421
|
+
* @param {string} [arg.endDate] - Filter results by the job's end date.
|
|
422
|
+
* @param {string} [arg.stage] - Filter results by the current stage of the
|
|
423
|
+
* import job.
|
|
420
424
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
421
425
|
* @summary: List bulk inventory upload history
|
|
422
426
|
* @description: Helps to get bulk Inventory upload jobs status.
|
|
423
427
|
*/
|
|
424
|
-
getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
|
|
428
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, }?: {
|
|
425
429
|
pageSize?: number;
|
|
426
430
|
search?: string;
|
|
431
|
+
startDate?: string;
|
|
432
|
+
endDate?: string;
|
|
433
|
+
stage?: string;
|
|
427
434
|
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
428
435
|
/**
|
|
429
436
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
@@ -433,7 +440,7 @@ declare class Catalog {
|
|
|
433
440
|
* Success response
|
|
434
441
|
* @name getInventoryBySize
|
|
435
442
|
* @summary: List inventory by size
|
|
436
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySize/).
|
|
437
444
|
*/
|
|
438
445
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
439
446
|
/**
|
|
@@ -466,7 +473,7 @@ declare class Catalog {
|
|
|
466
473
|
*
|
|
467
474
|
* @name getInventoryBySizeIdentifier
|
|
468
475
|
* @summary: List inventory by size
|
|
469
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
470
477
|
*/
|
|
471
478
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
472
479
|
/**
|
|
@@ -496,7 +503,7 @@ declare class Catalog {
|
|
|
496
503
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
497
504
|
* @name getInventoryExport
|
|
498
505
|
* @summary: list product inventory
|
|
499
|
-
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://
|
|
506
|
+
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryExport/).
|
|
500
507
|
*/
|
|
501
508
|
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
502
509
|
/**
|
|
@@ -506,7 +513,7 @@ declare class Catalog {
|
|
|
506
513
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
507
514
|
* @name getMarketplaceOptinDetail
|
|
508
515
|
* @summary: Get opt-in
|
|
509
|
-
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://
|
|
516
|
+
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
510
517
|
*/
|
|
511
518
|
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
512
519
|
/**
|
|
@@ -516,7 +523,7 @@ declare class Catalog {
|
|
|
516
523
|
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
517
524
|
* @name getMarketplaces
|
|
518
525
|
* @summary: List marketplaces
|
|
519
|
-
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://
|
|
526
|
+
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaces/).
|
|
520
527
|
*/
|
|
521
528
|
getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
|
|
522
529
|
/**
|
|
@@ -527,7 +534,7 @@ declare class Catalog {
|
|
|
527
534
|
* Success response
|
|
528
535
|
* @name getOptimalLocations
|
|
529
536
|
* @summary: Get optimal locations
|
|
530
|
-
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://
|
|
537
|
+
* @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/).
|
|
531
538
|
*/
|
|
532
539
|
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponseSchema>;
|
|
533
540
|
/**
|
|
@@ -538,7 +545,7 @@ declare class Catalog {
|
|
|
538
545
|
* Success response
|
|
539
546
|
* @name getProduct
|
|
540
547
|
* @summary: Get a product
|
|
541
|
-
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://
|
|
548
|
+
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProduct/).
|
|
542
549
|
*/
|
|
543
550
|
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
|
|
544
551
|
/**
|
|
@@ -548,7 +555,7 @@ declare class Catalog {
|
|
|
548
555
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
|
|
549
556
|
* @name getProductAssetsInBulk
|
|
550
557
|
* @summary: Get product assets
|
|
551
|
-
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://
|
|
558
|
+
* @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/).
|
|
552
559
|
*/
|
|
553
560
|
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
554
561
|
/**
|
|
@@ -571,7 +578,7 @@ declare class Catalog {
|
|
|
571
578
|
*
|
|
572
579
|
* @name getProductAttributes
|
|
573
580
|
* @summary: List product attributes
|
|
574
|
-
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://
|
|
581
|
+
* @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/).
|
|
575
582
|
*/
|
|
576
583
|
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
|
|
577
584
|
/**
|
|
@@ -581,7 +588,7 @@ declare class Catalog {
|
|
|
581
588
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
582
589
|
* @name getProductBulkUploadHistory
|
|
583
590
|
* @summary: List product bulk upload history
|
|
584
|
-
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://
|
|
591
|
+
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
585
592
|
*/
|
|
586
593
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
587
594
|
/**
|
|
@@ -606,7 +613,7 @@ declare class Catalog {
|
|
|
606
613
|
*
|
|
607
614
|
* @name getProductBundle
|
|
608
615
|
* @summary: List product bundles
|
|
609
|
-
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
616
|
+
* @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/).
|
|
610
617
|
*/
|
|
611
618
|
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
|
|
612
619
|
/**
|
|
@@ -618,7 +625,7 @@ declare class Catalog {
|
|
|
618
625
|
*
|
|
619
626
|
* @name getProductBundleDetail
|
|
620
627
|
* @summary: Get product bundle
|
|
621
|
-
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://
|
|
628
|
+
* @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/).
|
|
622
629
|
*/
|
|
623
630
|
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
|
|
624
631
|
/**
|
|
@@ -630,7 +637,7 @@ declare class Catalog {
|
|
|
630
637
|
*
|
|
631
638
|
* @name getProductExportJobs
|
|
632
639
|
* @summary: Get product export jobs
|
|
633
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductExportJobs/).
|
|
634
641
|
*/
|
|
635
642
|
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
636
643
|
/**
|
|
@@ -641,7 +648,7 @@ declare class Catalog {
|
|
|
641
648
|
* Success response
|
|
642
649
|
* @name getProductSize
|
|
643
650
|
* @summary: List product size
|
|
644
|
-
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://
|
|
651
|
+
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductSize/).
|
|
645
652
|
*/
|
|
646
653
|
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
|
|
647
654
|
/**
|
|
@@ -652,7 +659,7 @@ declare class Catalog {
|
|
|
652
659
|
* Success response
|
|
653
660
|
* @name getProductTags
|
|
654
661
|
* @summary: List product tags
|
|
655
|
-
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://
|
|
662
|
+
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductTags/).
|
|
656
663
|
*/
|
|
657
664
|
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
|
|
658
665
|
/**
|
|
@@ -662,7 +669,7 @@ declare class Catalog {
|
|
|
662
669
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
663
670
|
* @name getProductValidation
|
|
664
671
|
* @summary: Get valid products
|
|
665
|
-
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://
|
|
672
|
+
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductValidation/).
|
|
666
673
|
*/
|
|
667
674
|
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
668
675
|
/**
|
|
@@ -673,7 +680,7 @@ declare class Catalog {
|
|
|
673
680
|
* Success response
|
|
674
681
|
* @name getProducts
|
|
675
682
|
* @summary: List products
|
|
676
|
-
* @description: Retrieve a list of available products - Check out [method documentation](https://
|
|
683
|
+
* @description: Retrieve a list of available products - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProducts/).
|
|
677
684
|
*/
|
|
678
685
|
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
679
686
|
/**
|
|
@@ -721,7 +728,7 @@ declare class Catalog {
|
|
|
721
728
|
* Success response
|
|
722
729
|
* @name getSellerInsights
|
|
723
730
|
* @summary: Get seller catalog counts
|
|
724
|
-
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://
|
|
731
|
+
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSellerInsights/).
|
|
725
732
|
*/
|
|
726
733
|
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
|
|
727
734
|
/**
|
|
@@ -731,7 +738,7 @@ declare class Catalog {
|
|
|
731
738
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
732
739
|
* @name getSingleProductHSNCode
|
|
733
740
|
* @summary: Get product HSN code
|
|
734
|
-
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://
|
|
741
|
+
* @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/).
|
|
735
742
|
*/
|
|
736
743
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
737
744
|
/**
|
|
@@ -741,7 +748,7 @@ declare class Catalog {
|
|
|
741
748
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
|
|
742
749
|
* @name getSizeGuide
|
|
743
750
|
* @summary: Get size guide
|
|
744
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuide/).
|
|
745
752
|
*/
|
|
746
753
|
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
|
|
747
754
|
/**
|
|
@@ -751,7 +758,7 @@ declare class Catalog {
|
|
|
751
758
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
752
759
|
* @name getSizeGuides
|
|
753
760
|
* @summary: List size guides
|
|
754
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuides/).
|
|
755
762
|
*/
|
|
756
763
|
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
757
764
|
/**
|
|
@@ -761,7 +768,7 @@ declare class Catalog {
|
|
|
761
768
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
762
769
|
* @name getStoreDetail
|
|
763
770
|
* @summary: Get selling location
|
|
764
|
-
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://
|
|
771
|
+
* @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/).
|
|
765
772
|
*/
|
|
766
773
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
767
774
|
/**
|
|
@@ -785,7 +792,7 @@ declare class Catalog {
|
|
|
785
792
|
* Success response
|
|
786
793
|
* @name getVariantsOfProducts
|
|
787
794
|
* @summary: Get variants
|
|
788
|
-
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://
|
|
795
|
+
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getVariantsOfProducts/).
|
|
789
796
|
*/
|
|
790
797
|
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
791
798
|
/**
|
|
@@ -810,7 +817,7 @@ declare class Catalog {
|
|
|
810
817
|
* @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
|
|
811
818
|
* @name listCategories
|
|
812
819
|
* @summary: List categories
|
|
813
|
-
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://
|
|
820
|
+
* @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/).
|
|
814
821
|
*/
|
|
815
822
|
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
|
|
816
823
|
/**
|
|
@@ -842,7 +849,7 @@ declare class Catalog {
|
|
|
842
849
|
* Success response
|
|
843
850
|
* @name listDepartmentsData
|
|
844
851
|
* @summary: List company department
|
|
845
|
-
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://
|
|
852
|
+
* @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/).
|
|
846
853
|
*/
|
|
847
854
|
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
848
855
|
/**
|
|
@@ -876,7 +883,7 @@ declare class Catalog {
|
|
|
876
883
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
|
|
877
884
|
* @name listHSNCodes
|
|
878
885
|
* @summary: List HSN codes
|
|
879
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://
|
|
886
|
+
* @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/).
|
|
880
887
|
*/
|
|
881
888
|
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
|
|
882
889
|
/**
|
|
@@ -888,7 +895,7 @@ declare class Catalog {
|
|
|
888
895
|
*
|
|
889
896
|
* @name listInventoryExport
|
|
890
897
|
* @summary: List inventory export jobs
|
|
891
|
-
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://
|
|
898
|
+
* @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/).
|
|
892
899
|
*/
|
|
893
900
|
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
|
|
894
901
|
/**
|
|
@@ -898,9 +905,9 @@ declare class Catalog {
|
|
|
898
905
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
|
|
899
906
|
* @name listProductTemplate
|
|
900
907
|
* @summary: List product templates
|
|
901
|
-
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://
|
|
908
|
+
* @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/).
|
|
902
909
|
*/
|
|
903
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
910
|
+
listProductTemplate({ department, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
904
911
|
/**
|
|
905
912
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
906
913
|
* - Arg object
|
|
@@ -912,7 +919,7 @@ declare class Catalog {
|
|
|
912
919
|
*
|
|
913
920
|
* @name listProductTemplateCategories
|
|
914
921
|
* @summary: List product template categories
|
|
915
|
-
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://
|
|
922
|
+
* @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/).
|
|
916
923
|
*/
|
|
917
924
|
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
|
|
918
925
|
/**
|
|
@@ -926,7 +933,7 @@ declare class Catalog {
|
|
|
926
933
|
*
|
|
927
934
|
* @name listProductTemplateExportDetails
|
|
928
935
|
* @summary: List export product templates
|
|
929
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
930
937
|
*/
|
|
931
938
|
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
932
939
|
/**
|
|
@@ -937,7 +944,7 @@ declare class Catalog {
|
|
|
937
944
|
* Success response
|
|
938
945
|
* @name listTemplateBrandTypeValues
|
|
939
946
|
* @summary: List template brand
|
|
940
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
941
948
|
*/
|
|
942
949
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
943
950
|
/**
|
|
@@ -947,7 +954,7 @@ declare class Catalog {
|
|
|
947
954
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
948
955
|
* @name updateHsnCode
|
|
949
956
|
* @summary: Update HSN code
|
|
950
|
-
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://
|
|
957
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateHsnCode/).
|
|
951
958
|
*/
|
|
952
959
|
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
953
960
|
/**
|
|
@@ -958,7 +965,7 @@ declare class Catalog {
|
|
|
958
965
|
* Success response
|
|
959
966
|
* @name updateInventories
|
|
960
967
|
* @summary: Update inventories
|
|
961
|
-
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://
|
|
968
|
+
* @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/).
|
|
962
969
|
*/
|
|
963
970
|
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
964
971
|
/**
|
|
@@ -970,7 +977,7 @@ declare class Catalog {
|
|
|
970
977
|
*
|
|
971
978
|
* @name updateLocationPrice
|
|
972
979
|
* @summary: Update an Article Price
|
|
973
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationPrice/).
|
|
974
981
|
*/
|
|
975
982
|
updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
976
983
|
/**
|
|
@@ -982,7 +989,7 @@ declare class Catalog {
|
|
|
982
989
|
*
|
|
983
990
|
* @name updateLocationQuantity
|
|
984
991
|
* @summary: Update an Article Quantity
|
|
985
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationQuantity/).
|
|
986
993
|
*/
|
|
987
994
|
updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
988
995
|
/**
|
|
@@ -994,7 +1001,7 @@ declare class Catalog {
|
|
|
994
1001
|
*
|
|
995
1002
|
* @name updateMarketplaceOptin
|
|
996
1003
|
* @summary: Update marketplace optin
|
|
997
|
-
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://
|
|
1004
|
+
* @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/).
|
|
998
1005
|
*/
|
|
999
1006
|
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
|
|
1000
1007
|
/**
|
|
@@ -1006,7 +1013,7 @@ declare class Catalog {
|
|
|
1006
1013
|
*
|
|
1007
1014
|
* @name updateProductBundle
|
|
1008
1015
|
* @summary: Update product bundle
|
|
1009
|
-
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
1016
|
+
* @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/).
|
|
1010
1017
|
*/
|
|
1011
1018
|
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
1012
1019
|
/**
|
|
@@ -1017,7 +1024,7 @@ declare class Catalog {
|
|
|
1017
1024
|
* Success response
|
|
1018
1025
|
* @name updateRealtimeInventory
|
|
1019
1026
|
* @summary: Update an inventory
|
|
1020
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateRealtimeInventory/).
|
|
1021
1028
|
*/
|
|
1022
1029
|
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
1023
1030
|
/**
|
|
@@ -1027,7 +1034,7 @@ declare class Catalog {
|
|
|
1027
1034
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1028
1035
|
* @name updateSizeGuide
|
|
1029
1036
|
* @summary: Update size guide
|
|
1030
|
-
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://
|
|
1037
|
+
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/).
|
|
1031
1038
|
*/
|
|
1032
1039
|
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1033
1040
|
/**
|
|
@@ -1037,7 +1044,7 @@ declare class Catalog {
|
|
|
1037
1044
|
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
1038
1045
|
* @name uploadBulkProducts
|
|
1039
1046
|
* @summary: Upload bulk products
|
|
1040
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
|
|
1041
1048
|
*/
|
|
1042
1049
|
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
1043
1050
|
/**
|
|
@@ -1051,7 +1058,7 @@ declare class Catalog {
|
|
|
1051
1058
|
*
|
|
1052
1059
|
* @name validateProductGlobalTemplate
|
|
1053
1060
|
* @summary: Validate product template
|
|
1054
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductGlobalTemplate/).
|
|
1055
1062
|
*/
|
|
1056
1063
|
validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
|
|
1057
1064
|
/**
|
|
@@ -1063,7 +1070,7 @@ declare class Catalog {
|
|
|
1063
1070
|
*
|
|
1064
1071
|
* @name validateProductTemplate
|
|
1065
1072
|
* @summary: Validate product template
|
|
1066
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplate/).
|
|
1067
1074
|
*/
|
|
1068
1075
|
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
|
|
1069
1076
|
/**
|
|
@@ -1077,9 +1084,9 @@ declare class Catalog {
|
|
|
1077
1084
|
*
|
|
1078
1085
|
* @name validateProductTemplateSchema
|
|
1079
1086
|
* @summary: Validate product template schema
|
|
1080
|
-
* @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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1081
1088
|
*/
|
|
1082
|
-
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1089
|
+
validateProductTemplateSchema({ itemType, schemaType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
1083
1090
|
}
|
|
1084
1091
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
1085
1092
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|