@gofynd/fdk-client-javascript 3.3.5 → 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 +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -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 +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -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 +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -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 +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 +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 +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 +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -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
|
@@ -21,7 +21,7 @@ class Catalog {
|
|
|
21
21
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
22
22
|
* @name addInventory
|
|
23
23
|
* @summary: Create Inventory
|
|
24
|
-
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://
|
|
24
|
+
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/addInventory/).
|
|
25
25
|
*/
|
|
26
26
|
async addInventory(
|
|
27
27
|
{ itemId, size, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -104,7 +104,7 @@ class Catalog {
|
|
|
104
104
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
105
105
|
* @name allSizes
|
|
106
106
|
* @summary: Get product sizes
|
|
107
|
-
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://
|
|
107
|
+
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/allSizes/).
|
|
108
108
|
*/
|
|
109
109
|
async allSizes(
|
|
110
110
|
{ itemId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,7 +181,7 @@ class Catalog {
|
|
|
181
181
|
* @returns {Promise<CatalogPlatformModel.BulkHsnResponseSchema>} - Success response
|
|
182
182
|
* @name bulkHsnCode
|
|
183
183
|
* @summary: Create Bulk update HSN
|
|
184
|
-
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://
|
|
184
|
+
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/bulkHsnCode/).
|
|
185
185
|
*/
|
|
186
186
|
async bulkHsnCode(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,7 +258,7 @@ class Catalog {
|
|
|
258
258
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
259
259
|
* @name createBulkInventory
|
|
260
260
|
* @summary: Create bulk inventory
|
|
261
|
-
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://
|
|
261
|
+
* @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/).
|
|
262
262
|
*/
|
|
263
263
|
async createBulkInventory(
|
|
264
264
|
{ batchId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -339,7 +339,7 @@ class Catalog {
|
|
|
339
339
|
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
340
340
|
* @name createBulkInventoryJob
|
|
341
341
|
* @summary: Create bulk inventory upload job
|
|
342
|
-
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://
|
|
342
|
+
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkInventoryJob/).
|
|
343
343
|
*/
|
|
344
344
|
async createBulkInventoryJob(
|
|
345
345
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -420,7 +420,7 @@ class Catalog {
|
|
|
420
420
|
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
421
421
|
* @name createBulkProductUploadJob
|
|
422
422
|
* @summary: Create products bulk upload
|
|
423
|
-
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://
|
|
423
|
+
* @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/).
|
|
424
424
|
*/
|
|
425
425
|
async createBulkProductUploadJob(
|
|
426
426
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -502,7 +502,7 @@ class Catalog {
|
|
|
502
502
|
* Success response
|
|
503
503
|
* @name createInventoryExport
|
|
504
504
|
* @summary: Create inventory export
|
|
505
|
-
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://
|
|
505
|
+
* @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/).
|
|
506
506
|
*/
|
|
507
507
|
async createInventoryExport(
|
|
508
508
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,7 +582,7 @@ class Catalog {
|
|
|
582
582
|
* Success response
|
|
583
583
|
* @name createInventoryExportJob
|
|
584
584
|
* @summary: Create inventory export job
|
|
585
|
-
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://
|
|
585
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExportJob/).
|
|
586
586
|
*/
|
|
587
587
|
async createInventoryExportJob(
|
|
588
588
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -665,7 +665,7 @@ class Catalog {
|
|
|
665
665
|
*
|
|
666
666
|
* @name createMarketplaceOptin
|
|
667
667
|
* @summary: Create or Update opt-in infomation
|
|
668
|
-
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://
|
|
668
|
+
* @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/).
|
|
669
669
|
*/
|
|
670
670
|
async createMarketplaceOptin(
|
|
671
671
|
{ marketplaceSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -748,7 +748,7 @@ class Catalog {
|
|
|
748
748
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
749
749
|
* @name createProduct
|
|
750
750
|
* @summary: Create product
|
|
751
|
-
* @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://
|
|
751
|
+
* @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/).
|
|
752
752
|
*/
|
|
753
753
|
async createProduct(
|
|
754
754
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -827,7 +827,7 @@ class Catalog {
|
|
|
827
827
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
828
828
|
* @name createProductAssetsInBulk
|
|
829
829
|
* @summary: Create product assets in bulk
|
|
830
|
-
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://
|
|
830
|
+
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
831
831
|
*/
|
|
832
832
|
async createProductAssetsInBulk(
|
|
833
833
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -910,7 +910,7 @@ class Catalog {
|
|
|
910
910
|
*
|
|
911
911
|
* @name createProductBundle
|
|
912
912
|
* @summary: Create product bundle
|
|
913
|
-
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://
|
|
913
|
+
* @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/).
|
|
914
914
|
*/
|
|
915
915
|
async createProductBundle(
|
|
916
916
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -991,7 +991,7 @@ class Catalog {
|
|
|
991
991
|
*
|
|
992
992
|
* @name createProductExportJob
|
|
993
993
|
* @summary: Create product export job
|
|
994
|
-
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://
|
|
994
|
+
* @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/).
|
|
995
995
|
*/
|
|
996
996
|
async createProductExportJob(
|
|
997
997
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1072,7 +1072,7 @@ class Catalog {
|
|
|
1072
1072
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1073
1073
|
* @name createProductsInBulk
|
|
1074
1074
|
* @summary: Create products in bulk
|
|
1075
|
-
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://
|
|
1075
|
+
* @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/).
|
|
1076
1076
|
*/
|
|
1077
1077
|
async createProductsInBulk(
|
|
1078
1078
|
{ batchId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1153,7 +1153,7 @@ class Catalog {
|
|
|
1153
1153
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1154
1154
|
* @name createSizeGuide
|
|
1155
1155
|
* @summary: Create size guide
|
|
1156
|
-
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://
|
|
1156
|
+
* @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/).
|
|
1157
1157
|
*/
|
|
1158
1158
|
async createSizeGuide(
|
|
1159
1159
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1232,7 +1232,7 @@ class Catalog {
|
|
|
1232
1232
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1233
1233
|
* @name deleteBulkInventoryJob
|
|
1234
1234
|
* @summary: Delete inventory bulk upload job
|
|
1235
|
-
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://
|
|
1235
|
+
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
1236
1236
|
*/
|
|
1237
1237
|
async deleteBulkInventoryJob(
|
|
1238
1238
|
{ batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1313,7 +1313,7 @@ class Catalog {
|
|
|
1313
1313
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1314
1314
|
* @name deleteProduct
|
|
1315
1315
|
* @summary: Delete product
|
|
1316
|
-
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://
|
|
1316
|
+
* @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/).
|
|
1317
1317
|
*/
|
|
1318
1318
|
async deleteProduct(
|
|
1319
1319
|
{ itemId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1392,7 +1392,7 @@ class Catalog {
|
|
|
1392
1392
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1393
1393
|
* @name deleteProductBulkJob
|
|
1394
1394
|
* @summary: Delete product bulk-upload job
|
|
1395
|
-
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://
|
|
1395
|
+
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProductBulkJob/).
|
|
1396
1396
|
*/
|
|
1397
1397
|
async deleteProductBulkJob(
|
|
1398
1398
|
{ batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1472,7 +1472,7 @@ class Catalog {
|
|
|
1472
1472
|
* Success response
|
|
1473
1473
|
* @name deleteRealtimeInventory
|
|
1474
1474
|
* @summary: Delete an inventory
|
|
1475
|
-
* @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://
|
|
1475
|
+
* @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/).
|
|
1476
1476
|
*/
|
|
1477
1477
|
async deleteRealtimeInventory(
|
|
1478
1478
|
{ itemId, sellerIdentifier, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1559,7 +1559,7 @@ class Catalog {
|
|
|
1559
1559
|
*
|
|
1560
1560
|
* @name deleteSize
|
|
1561
1561
|
* @summary: Delete product size
|
|
1562
|
-
* @description: Allows to delete size associated with product. - Check out [method documentation](https://
|
|
1562
|
+
* @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/).
|
|
1563
1563
|
*/
|
|
1564
1564
|
async deleteSize(
|
|
1565
1565
|
{ itemId, size, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1640,7 +1640,7 @@ class Catalog {
|
|
|
1640
1640
|
* @returns {Promise<string>} - Success response
|
|
1641
1641
|
* @name downloadInventoryTemplateView
|
|
1642
1642
|
* @summary: Download inventory template data
|
|
1643
|
-
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://
|
|
1643
|
+
* @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/).
|
|
1644
1644
|
*/
|
|
1645
1645
|
async downloadInventoryTemplateView(
|
|
1646
1646
|
{ schemaType, type, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1724,7 +1724,7 @@ class Catalog {
|
|
|
1724
1724
|
* @returns {Promise<string>} - Success response
|
|
1725
1725
|
* @name downloadProductTemplateViews
|
|
1726
1726
|
* @summary: Download product template view
|
|
1727
|
-
* @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://
|
|
1727
|
+
* @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/).
|
|
1728
1728
|
*/
|
|
1729
1729
|
async downloadProductTemplateViews(
|
|
1730
1730
|
{ slug, itemType, type, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1808,7 +1808,7 @@ class Catalog {
|
|
|
1808
1808
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1809
1809
|
* @name editProduct
|
|
1810
1810
|
* @summary: Update a product
|
|
1811
|
-
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://
|
|
1811
|
+
* @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/).
|
|
1812
1812
|
*/
|
|
1813
1813
|
async editProduct(
|
|
1814
1814
|
{ itemId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1887,7 +1887,7 @@ class Catalog {
|
|
|
1887
1887
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
1888
1888
|
* @name exportInventoryConfig
|
|
1889
1889
|
* @summary: Get export inventory configuration
|
|
1890
|
-
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://
|
|
1890
|
+
* @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/).
|
|
1891
1891
|
*/
|
|
1892
1892
|
async exportInventoryConfig(
|
|
1893
1893
|
{ filterType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1969,7 +1969,7 @@ class Catalog {
|
|
|
1969
1969
|
*
|
|
1970
1970
|
* @name getAllProductHsnCodes
|
|
1971
1971
|
* @summary: List product HSN codes
|
|
1972
|
-
* @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://
|
|
1972
|
+
* @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/).
|
|
1973
1973
|
*/
|
|
1974
1974
|
async getAllProductHsnCodes(
|
|
1975
1975
|
{ pageNo, pageSize, q, type, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2058,7 +2058,7 @@ class Catalog {
|
|
|
2058
2058
|
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
2059
2059
|
* @name getAttribute
|
|
2060
2060
|
* @summary: Get attribute detail by slug
|
|
2061
|
-
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://
|
|
2061
|
+
* @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/).
|
|
2062
2062
|
*/
|
|
2063
2063
|
async getAttribute(
|
|
2064
2064
|
{ attributeSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2138,7 +2138,7 @@ class Catalog {
|
|
|
2138
2138
|
* Success response
|
|
2139
2139
|
* @name getCategoryData
|
|
2140
2140
|
* @summary: Get category by uid
|
|
2141
|
-
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://
|
|
2141
|
+
* @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/).
|
|
2142
2142
|
*/
|
|
2143
2143
|
async getCategoryData(
|
|
2144
2144
|
{ uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2218,7 +2218,7 @@ class Catalog {
|
|
|
2218
2218
|
* Success response
|
|
2219
2219
|
* @name getCompanyBrandDetail
|
|
2220
2220
|
* @summary: list Company Brand of Optin
|
|
2221
|
-
* @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
2221
|
+
* @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/).
|
|
2222
2222
|
*/
|
|
2223
2223
|
async getCompanyBrandDetail(
|
|
2224
2224
|
{ isActive, q, pageNo, pageSize, marketplace, requestHeaders } = {
|
|
@@ -2312,7 +2312,7 @@ class Catalog {
|
|
|
2312
2312
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
2313
2313
|
* @name getCompanyDetail
|
|
2314
2314
|
* @summary: Get Company
|
|
2315
|
-
* @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://
|
|
2315
|
+
* @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/).
|
|
2316
2316
|
*/
|
|
2317
2317
|
async getCompanyDetail(
|
|
2318
2318
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2387,7 +2387,7 @@ class Catalog {
|
|
|
2387
2387
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
2388
2388
|
* @name getCompanyMetrics
|
|
2389
2389
|
* @summary: Get company metrics
|
|
2390
|
-
* @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://
|
|
2390
|
+
* @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/).
|
|
2391
2391
|
*/
|
|
2392
2392
|
async getCompanyMetrics(
|
|
2393
2393
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2463,7 +2463,7 @@ class Catalog {
|
|
|
2463
2463
|
* Success response
|
|
2464
2464
|
* @name getDepartmentData
|
|
2465
2465
|
* @summary: Get department by uid
|
|
2466
|
-
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://
|
|
2466
|
+
* @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/).
|
|
2467
2467
|
*/
|
|
2468
2468
|
async getDepartmentData(
|
|
2469
2469
|
{ uid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2542,7 +2542,7 @@ class Catalog {
|
|
|
2542
2542
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
2543
2543
|
* @name getHsnCode
|
|
2544
2544
|
* @summary: List HSN code
|
|
2545
|
-
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://
|
|
2545
|
+
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsnCode/).
|
|
2546
2546
|
*/
|
|
2547
2547
|
async getHsnCode(
|
|
2548
2548
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2620,7 +2620,7 @@ class Catalog {
|
|
|
2620
2620
|
* Success response
|
|
2621
2621
|
* @name getInventories
|
|
2622
2622
|
* @summary: List Inventory
|
|
2623
|
-
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://
|
|
2623
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventories/).
|
|
2624
2624
|
*/
|
|
2625
2625
|
async getInventories(
|
|
2626
2626
|
{
|
|
@@ -2850,7 +2850,7 @@ class Catalog {
|
|
|
2850
2850
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
2851
2851
|
* @name getInventoryBulkUploadHistory
|
|
2852
2852
|
* @summary: List bulk inventory upload history
|
|
2853
|
-
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://
|
|
2853
|
+
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
2854
2854
|
*/
|
|
2855
2855
|
async getInventoryBulkUploadHistory(
|
|
2856
2856
|
{ pageNo, pageSize, search, startDate, endDate, stage, requestHeaders } = {
|
|
@@ -2993,7 +2993,7 @@ class Catalog {
|
|
|
2993
2993
|
* Success response
|
|
2994
2994
|
* @name getInventoryBySize
|
|
2995
2995
|
* @summary: List inventory by size
|
|
2996
|
-
* @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://
|
|
2996
|
+
* @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/).
|
|
2997
2997
|
*/
|
|
2998
2998
|
async getInventoryBySize(
|
|
2999
2999
|
{ itemId, size, pageNo, pageSize, q, sellable, requestHeaders } = {
|
|
@@ -3128,7 +3128,7 @@ class Catalog {
|
|
|
3128
3128
|
*
|
|
3129
3129
|
* @name getInventoryBySizeIdentifier
|
|
3130
3130
|
* @summary: List inventory by size
|
|
3131
|
-
* @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://
|
|
3131
|
+
* @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/).
|
|
3132
3132
|
*/
|
|
3133
3133
|
async getInventoryBySizeIdentifier(
|
|
3134
3134
|
{
|
|
@@ -3274,7 +3274,7 @@ class Catalog {
|
|
|
3274
3274
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
3275
3275
|
* @name getInventoryExport
|
|
3276
3276
|
* @summary: list product inventory
|
|
3277
|
-
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://
|
|
3277
|
+
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryExport/).
|
|
3278
3278
|
*/
|
|
3279
3279
|
async getInventoryExport(
|
|
3280
3280
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3349,7 +3349,7 @@ class Catalog {
|
|
|
3349
3349
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
3350
3350
|
* @name getMarketplaceOptinDetail
|
|
3351
3351
|
* @summary: Get opt-in
|
|
3352
|
-
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://
|
|
3352
|
+
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
3353
3353
|
*/
|
|
3354
3354
|
async getMarketplaceOptinDetail(
|
|
3355
3355
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3426,7 +3426,7 @@ class Catalog {
|
|
|
3426
3426
|
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
3427
3427
|
* @name getMarketplaces
|
|
3428
3428
|
* @summary: List marketplaces
|
|
3429
|
-
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://
|
|
3429
|
+
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaces/).
|
|
3430
3430
|
*/
|
|
3431
3431
|
async getMarketplaces(
|
|
3432
3432
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3502,7 +3502,7 @@ class Catalog {
|
|
|
3502
3502
|
* Success response
|
|
3503
3503
|
* @name getOptimalLocations
|
|
3504
3504
|
* @summary: Get optimal locations
|
|
3505
|
-
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://
|
|
3505
|
+
* @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/).
|
|
3506
3506
|
*/
|
|
3507
3507
|
async getOptimalLocations(
|
|
3508
3508
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3582,7 +3582,7 @@ class Catalog {
|
|
|
3582
3582
|
* Success response
|
|
3583
3583
|
* @name getProduct
|
|
3584
3584
|
* @summary: Get a product
|
|
3585
|
-
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://
|
|
3585
|
+
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProduct/).
|
|
3586
3586
|
*/
|
|
3587
3587
|
async getProduct(
|
|
3588
3588
|
{ itemId, brandUid, itemCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3665,7 +3665,7 @@ class Catalog {
|
|
|
3665
3665
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
|
|
3666
3666
|
* @name getProductAssetsInBulk
|
|
3667
3667
|
* @summary: Get product assets
|
|
3668
|
-
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://
|
|
3668
|
+
* @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/).
|
|
3669
3669
|
*/
|
|
3670
3670
|
async getProductAssetsInBulk(
|
|
3671
3671
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3780,7 +3780,7 @@ class Catalog {
|
|
|
3780
3780
|
*
|
|
3781
3781
|
* @name getProductAttributes
|
|
3782
3782
|
* @summary: List product attributes
|
|
3783
|
-
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://
|
|
3783
|
+
* @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/).
|
|
3784
3784
|
*/
|
|
3785
3785
|
async getProductAttributes(
|
|
3786
3786
|
{ category, filter, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3863,7 +3863,7 @@ class Catalog {
|
|
|
3863
3863
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
3864
3864
|
* @name getProductBulkUploadHistory
|
|
3865
3865
|
* @summary: List product bulk upload history
|
|
3866
|
-
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://
|
|
3866
|
+
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
3867
3867
|
*/
|
|
3868
3868
|
async getProductBulkUploadHistory(
|
|
3869
3869
|
{ search, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3983,7 +3983,7 @@ class Catalog {
|
|
|
3983
3983
|
*
|
|
3984
3984
|
* @name getProductBundle
|
|
3985
3985
|
* @summary: List product bundles
|
|
3986
|
-
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
3986
|
+
* @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/).
|
|
3987
3987
|
*/
|
|
3988
3988
|
async getProductBundle(
|
|
3989
3989
|
{ q, slug, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4074,7 +4074,7 @@ class Catalog {
|
|
|
4074
4074
|
*
|
|
4075
4075
|
* @name getProductBundleDetail
|
|
4076
4076
|
* @summary: Get product bundle
|
|
4077
|
-
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://
|
|
4077
|
+
* @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/).
|
|
4078
4078
|
*/
|
|
4079
4079
|
async getProductBundleDetail(
|
|
4080
4080
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4157,7 +4157,7 @@ class Catalog {
|
|
|
4157
4157
|
*
|
|
4158
4158
|
* @name getProductExportJobs
|
|
4159
4159
|
* @summary: Get product export jobs
|
|
4160
|
-
* @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://
|
|
4160
|
+
* @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/).
|
|
4161
4161
|
*/
|
|
4162
4162
|
async getProductExportJobs(
|
|
4163
4163
|
{ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
|
|
@@ -4255,7 +4255,7 @@ class Catalog {
|
|
|
4255
4255
|
* Success response
|
|
4256
4256
|
* @name getProductSize
|
|
4257
4257
|
* @summary: List product size
|
|
4258
|
-
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://
|
|
4258
|
+
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductSize/).
|
|
4259
4259
|
*/
|
|
4260
4260
|
async getProductSize(
|
|
4261
4261
|
{ itemId, itemCode, brandUid, uid, requestHeaders } = {
|
|
@@ -4346,7 +4346,7 @@ class Catalog {
|
|
|
4346
4346
|
* Success response
|
|
4347
4347
|
* @name getProductTags
|
|
4348
4348
|
* @summary: List product tags
|
|
4349
|
-
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://
|
|
4349
|
+
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductTags/).
|
|
4350
4350
|
*/
|
|
4351
4351
|
async getProductTags(
|
|
4352
4352
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4421,7 +4421,7 @@ class Catalog {
|
|
|
4421
4421
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
4422
4422
|
* @name getProductValidation
|
|
4423
4423
|
* @summary: Get valid products
|
|
4424
|
-
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://
|
|
4424
|
+
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductValidation/).
|
|
4425
4425
|
*/
|
|
4426
4426
|
async getProductValidation(
|
|
4427
4427
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4497,7 +4497,7 @@ class Catalog {
|
|
|
4497
4497
|
* Success response
|
|
4498
4498
|
* @name getProducts
|
|
4499
4499
|
* @summary: List products
|
|
4500
|
-
* @description: Retrieve a list of available products - Check out [method documentation](https://
|
|
4500
|
+
* @description: Retrieve a list of available products - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProducts/).
|
|
4501
4501
|
*/
|
|
4502
4502
|
async getProducts(
|
|
4503
4503
|
{
|
|
@@ -4704,7 +4704,7 @@ class Catalog {
|
|
|
4704
4704
|
* Success response
|
|
4705
4705
|
* @name getSellerInsights
|
|
4706
4706
|
* @summary: Get seller catalog counts
|
|
4707
|
-
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://
|
|
4707
|
+
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSellerInsights/).
|
|
4708
4708
|
*/
|
|
4709
4709
|
async getSellerInsights(
|
|
4710
4710
|
{ sellerAppId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4783,7 +4783,7 @@ class Catalog {
|
|
|
4783
4783
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
4784
4784
|
* @name getSingleProductHSNCode
|
|
4785
4785
|
* @summary: Get product HSN code
|
|
4786
|
-
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://
|
|
4786
|
+
* @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/).
|
|
4787
4787
|
*/
|
|
4788
4788
|
async getSingleProductHSNCode(
|
|
4789
4789
|
{ reportingHsn, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4860,7 +4860,7 @@ class Catalog {
|
|
|
4860
4860
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
|
|
4861
4861
|
* @name getSizeGuide
|
|
4862
4862
|
* @summary: Get size guide
|
|
4863
|
-
* @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://
|
|
4863
|
+
* @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/).
|
|
4864
4864
|
*/
|
|
4865
4865
|
async getSizeGuide(
|
|
4866
4866
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4939,7 +4939,7 @@ class Catalog {
|
|
|
4939
4939
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
4940
4940
|
* @name getSizeGuides
|
|
4941
4941
|
* @summary: List size guides
|
|
4942
|
-
* @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://
|
|
4942
|
+
* @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/).
|
|
4943
4943
|
*/
|
|
4944
4944
|
async getSizeGuides(
|
|
4945
4945
|
{ active, q, tag, pageNo, pageSize, brandId, requestHeaders } = {
|
|
@@ -5036,7 +5036,7 @@ class Catalog {
|
|
|
5036
5036
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
5037
5037
|
* @name getStoreDetail
|
|
5038
5038
|
* @summary: Get selling location
|
|
5039
|
-
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://
|
|
5039
|
+
* @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/).
|
|
5040
5040
|
*/
|
|
5041
5041
|
async getStoreDetail(
|
|
5042
5042
|
{ q, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5153,7 +5153,7 @@ class Catalog {
|
|
|
5153
5153
|
* Success response
|
|
5154
5154
|
* @name getVariantsOfProducts
|
|
5155
5155
|
* @summary: Get variants
|
|
5156
|
-
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://
|
|
5156
|
+
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getVariantsOfProducts/).
|
|
5157
5157
|
*/
|
|
5158
5158
|
async getVariantsOfProducts(
|
|
5159
5159
|
{ itemId, variantType, pageNo, pageSize, requestHeaders } = {
|
|
@@ -5274,7 +5274,7 @@ class Catalog {
|
|
|
5274
5274
|
* @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
|
|
5275
5275
|
* @name listCategories
|
|
5276
5276
|
* @summary: List categories
|
|
5277
|
-
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://
|
|
5277
|
+
* @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/).
|
|
5278
5278
|
*/
|
|
5279
5279
|
async listCategories(
|
|
5280
5280
|
{ level, department, q, pageNo, pageSize, uids, slug, requestHeaders } = {
|
|
@@ -5413,7 +5413,7 @@ class Catalog {
|
|
|
5413
5413
|
* Success response
|
|
5414
5414
|
* @name listDepartmentsData
|
|
5415
5415
|
* @summary: List company department
|
|
5416
|
-
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://
|
|
5416
|
+
* @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/).
|
|
5417
5417
|
*/
|
|
5418
5418
|
async listDepartmentsData(
|
|
5419
5419
|
{
|
|
@@ -5568,7 +5568,7 @@ class Catalog {
|
|
|
5568
5568
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
|
|
5569
5569
|
* @name listHSNCodes
|
|
5570
5570
|
* @summary: List HSN codes
|
|
5571
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://
|
|
5571
|
+
* @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/).
|
|
5572
5572
|
*/
|
|
5573
5573
|
async listHSNCodes(
|
|
5574
5574
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5645,7 +5645,7 @@ class Catalog {
|
|
|
5645
5645
|
*
|
|
5646
5646
|
* @name listInventoryExport
|
|
5647
5647
|
* @summary: List inventory export jobs
|
|
5648
|
-
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://
|
|
5648
|
+
* @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/).
|
|
5649
5649
|
*/
|
|
5650
5650
|
async listInventoryExport(
|
|
5651
5651
|
{ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
|
|
@@ -5742,7 +5742,7 @@ class Catalog {
|
|
|
5742
5742
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
|
|
5743
5743
|
* @name listProductTemplate
|
|
5744
5744
|
* @summary: List product templates
|
|
5745
|
-
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://
|
|
5745
|
+
* @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/).
|
|
5746
5746
|
*/
|
|
5747
5747
|
async listProductTemplate(
|
|
5748
5748
|
{ department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5832,7 +5832,7 @@ class Catalog {
|
|
|
5832
5832
|
*
|
|
5833
5833
|
* @name listProductTemplateCategories
|
|
5834
5834
|
* @summary: List product template categories
|
|
5835
|
-
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://
|
|
5835
|
+
* @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/).
|
|
5836
5836
|
*/
|
|
5837
5837
|
async listProductTemplateCategories(
|
|
5838
5838
|
{ departments, itemType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5921,7 +5921,7 @@ class Catalog {
|
|
|
5921
5921
|
*
|
|
5922
5922
|
* @name listProductTemplateExportDetails
|
|
5923
5923
|
* @summary: List export product templates
|
|
5924
|
-
* @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://
|
|
5924
|
+
* @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/).
|
|
5925
5925
|
*/
|
|
5926
5926
|
async listProductTemplateExportDetails(
|
|
5927
5927
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5999,7 +5999,7 @@ class Catalog {
|
|
|
5999
5999
|
* Success response
|
|
6000
6000
|
* @name listTemplateBrandTypeValues
|
|
6001
6001
|
* @summary: List template brand
|
|
6002
|
-
* @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://
|
|
6002
|
+
* @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/).
|
|
6003
6003
|
*/
|
|
6004
6004
|
async listTemplateBrandTypeValues(
|
|
6005
6005
|
{ filter, templateTag, itemType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6087,7 +6087,7 @@ class Catalog {
|
|
|
6087
6087
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
6088
6088
|
* @name updateHsnCode
|
|
6089
6089
|
* @summary: Update HSN code
|
|
6090
|
-
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://
|
|
6090
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateHsnCode/).
|
|
6091
6091
|
*/
|
|
6092
6092
|
async updateHsnCode(
|
|
6093
6093
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6169,7 +6169,7 @@ class Catalog {
|
|
|
6169
6169
|
* Success response
|
|
6170
6170
|
* @name updateInventories
|
|
6171
6171
|
* @summary: Update inventories
|
|
6172
|
-
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://
|
|
6172
|
+
* @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/).
|
|
6173
6173
|
*/
|
|
6174
6174
|
async updateInventories(
|
|
6175
6175
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6250,7 +6250,7 @@ class Catalog {
|
|
|
6250
6250
|
*
|
|
6251
6251
|
* @name updateLocationPrice
|
|
6252
6252
|
* @summary: Update an Article Price
|
|
6253
|
-
* @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://
|
|
6253
|
+
* @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/).
|
|
6254
6254
|
*/
|
|
6255
6255
|
async updateLocationPrice(
|
|
6256
6256
|
{ storeId, sellerIdentifier, body, requestHeaders } = {
|
|
@@ -6337,7 +6337,7 @@ class Catalog {
|
|
|
6337
6337
|
*
|
|
6338
6338
|
* @name updateLocationQuantity
|
|
6339
6339
|
* @summary: Update an Article Quantity
|
|
6340
|
-
* @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://
|
|
6340
|
+
* @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/).
|
|
6341
6341
|
*/
|
|
6342
6342
|
async updateLocationQuantity(
|
|
6343
6343
|
{ storeId, sellerIdentifier, body, requestHeaders } = {
|
|
@@ -6426,7 +6426,7 @@ class Catalog {
|
|
|
6426
6426
|
*
|
|
6427
6427
|
* @name updateMarketplaceOptin
|
|
6428
6428
|
* @summary: Update marketplace optin
|
|
6429
|
-
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://
|
|
6429
|
+
* @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/).
|
|
6430
6430
|
*/
|
|
6431
6431
|
async updateMarketplaceOptin(
|
|
6432
6432
|
{ marketplaceSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6511,7 +6511,7 @@ class Catalog {
|
|
|
6511
6511
|
*
|
|
6512
6512
|
* @name updateProductBundle
|
|
6513
6513
|
* @summary: Update product bundle
|
|
6514
|
-
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://
|
|
6514
|
+
* @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/).
|
|
6515
6515
|
*/
|
|
6516
6516
|
async updateProductBundle(
|
|
6517
6517
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6593,7 +6593,7 @@ class Catalog {
|
|
|
6593
6593
|
* Success response
|
|
6594
6594
|
* @name updateRealtimeInventory
|
|
6595
6595
|
* @summary: Update an inventory
|
|
6596
|
-
* @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://
|
|
6596
|
+
* @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/).
|
|
6597
6597
|
*/
|
|
6598
6598
|
async updateRealtimeInventory(
|
|
6599
6599
|
{ itemId, sellerIdentifier, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6678,7 +6678,7 @@ class Catalog {
|
|
|
6678
6678
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
6679
6679
|
* @name updateSizeGuide
|
|
6680
6680
|
* @summary: Update size guide
|
|
6681
|
-
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://
|
|
6681
|
+
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/).
|
|
6682
6682
|
*/
|
|
6683
6683
|
async updateSizeGuide(
|
|
6684
6684
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6759,7 +6759,7 @@ class Catalog {
|
|
|
6759
6759
|
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
6760
6760
|
* @name uploadBulkProducts
|
|
6761
6761
|
* @summary: Upload bulk products
|
|
6762
|
-
* @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://
|
|
6762
|
+
* @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/).
|
|
6763
6763
|
*/
|
|
6764
6764
|
async uploadBulkProducts(
|
|
6765
6765
|
{ department, productType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6848,7 +6848,7 @@ class Catalog {
|
|
|
6848
6848
|
*
|
|
6849
6849
|
* @name validateProductGlobalTemplate
|
|
6850
6850
|
* @summary: Validate product template
|
|
6851
|
-
* @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://
|
|
6851
|
+
* @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/).
|
|
6852
6852
|
*/
|
|
6853
6853
|
async validateProductGlobalTemplate(
|
|
6854
6854
|
{ itemType, bulk, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6935,7 +6935,7 @@ class Catalog {
|
|
|
6935
6935
|
*
|
|
6936
6936
|
* @name validateProductTemplate
|
|
6937
6937
|
* @summary: Validate product template
|
|
6938
|
-
* @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://
|
|
6938
|
+
* @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/).
|
|
6939
6939
|
*/
|
|
6940
6940
|
async validateProductTemplate(
|
|
6941
6941
|
{ slug, itemType, bulk, requestHeaders } = { requestHeaders: {} },
|
|
@@ -7026,7 +7026,7 @@ class Catalog {
|
|
|
7026
7026
|
*
|
|
7027
7027
|
* @name validateProductTemplateSchema
|
|
7028
7028
|
* @summary: Validate product template schema
|
|
7029
|
-
* @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://
|
|
7029
|
+
* @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/).
|
|
7030
7030
|
*/
|
|
7031
7031
|
async validateProductTemplateSchema(
|
|
7032
7032
|
{ itemType, schemaType, requestHeaders } = { requestHeaders: {} },
|