@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- 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 +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- 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 +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- 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 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -8,7 +8,7 @@ declare class Catalog {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
10
10
|
* @name addInventory
|
|
11
|
-
* @summary: Add Inventory for particular size and store
|
|
11
|
+
* @summary: Add Inventory for particular size and store
|
|
12
12
|
* @description: Allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
13
13
|
*/
|
|
14
14
|
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -18,7 +18,7 @@ declare class Catalog {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
20
20
|
* @name allSizes
|
|
21
|
-
* @summary: Get all product sizes
|
|
21
|
+
* @summary: Get all product sizes
|
|
22
22
|
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
23
23
|
*/
|
|
24
24
|
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
@@ -28,7 +28,7 @@ declare class Catalog {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
|
|
30
30
|
* @name bulkHsnCode
|
|
31
|
-
* @summary: Bulk update HSN codes
|
|
31
|
+
* @summary: Bulk update HSN codes
|
|
32
32
|
* @description: Perform bulk updates of HSN codes for products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
33
33
|
*/
|
|
34
34
|
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
|
|
@@ -38,7 +38,7 @@ declare class Catalog {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
40
40
|
* @name createBulkInventory
|
|
41
|
-
* @summary: Create bulk inventory
|
|
41
|
+
* @summary: Create bulk inventory
|
|
42
42
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
|
|
43
43
|
*/
|
|
44
44
|
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -48,7 +48,7 @@ declare class Catalog {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
50
50
|
* @name createBulkInventoryJob
|
|
51
|
-
* @summary: Create bulk inventory upload job
|
|
51
|
+
* @summary: Create bulk inventory upload job
|
|
52
52
|
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
53
53
|
*/
|
|
54
54
|
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
@@ -58,7 +58,7 @@ declare class Catalog {
|
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
60
60
|
* @name createBulkProductUploadJob
|
|
61
|
-
* @summary: Create a Bulk product to upload job
|
|
61
|
+
* @summary: Create a Bulk product to upload job
|
|
62
62
|
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
63
63
|
*/
|
|
64
64
|
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
@@ -68,7 +68,7 @@ declare class Catalog {
|
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
70
70
|
* @name createCategories
|
|
71
|
-
* @summary: Create categories
|
|
71
|
+
* @summary: Create categories
|
|
72
72
|
* @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
73
73
|
*/
|
|
74
74
|
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
@@ -79,7 +79,7 @@ declare class Catalog {
|
|
|
79
79
|
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
80
80
|
* Success response
|
|
81
81
|
* @name createDepartments
|
|
82
|
-
* @summary: Create departments
|
|
82
|
+
* @summary: Create departments
|
|
83
83
|
* @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
84
84
|
*/
|
|
85
85
|
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
@@ -89,7 +89,7 @@ declare class Catalog {
|
|
|
89
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
90
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
91
91
|
* @name createInventoryExport
|
|
92
|
-
* @summary: Create inventory export
|
|
92
|
+
* @summary: Create inventory export
|
|
93
93
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
94
94
|
*/
|
|
95
95
|
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
@@ -99,7 +99,7 @@ declare class Catalog {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
101
101
|
* @name createInventoryExportJob
|
|
102
|
-
* @summary: Create inventory export job
|
|
102
|
+
* @summary: Create inventory export job
|
|
103
103
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
104
104
|
*/
|
|
105
105
|
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
@@ -109,7 +109,7 @@ declare class Catalog {
|
|
|
109
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
110
|
* @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
|
|
111
111
|
* @name createMarketplaceOptin
|
|
112
|
-
* @summary: Create/Update opt-in infomation
|
|
112
|
+
* @summary: Create/Update opt-in infomation
|
|
113
113
|
* @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
114
114
|
*/
|
|
115
115
|
createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
|
|
@@ -119,7 +119,7 @@ declare class Catalog {
|
|
|
119
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
121
121
|
* @name createProduct
|
|
122
|
-
* @summary: Create a product
|
|
122
|
+
* @summary: Create a product
|
|
123
123
|
* @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
124
124
|
*/
|
|
125
125
|
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -129,7 +129,7 @@ declare class Catalog {
|
|
|
129
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
130
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
131
131
|
* @name createProductAssetsInBulk
|
|
132
|
-
* @summary: Create product assets in bulk
|
|
132
|
+
* @summary: Create product assets in bulk
|
|
133
133
|
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
134
134
|
*/
|
|
135
135
|
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -141,7 +141,7 @@ declare class Catalog {
|
|
|
141
141
|
* - Success response
|
|
142
142
|
*
|
|
143
143
|
* @name createProductBundle
|
|
144
|
-
* @summary: Create a product bundle
|
|
144
|
+
* @summary: Create a product bundle
|
|
145
145
|
* @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
146
146
|
*/
|
|
147
147
|
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
@@ -152,7 +152,7 @@ declare class Catalog {
|
|
|
152
152
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
153
153
|
* Success response
|
|
154
154
|
* @name createProductExportJob
|
|
155
|
-
* @summary: Create product export job
|
|
155
|
+
* @summary: Create product export job
|
|
156
156
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
157
157
|
*/
|
|
158
158
|
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
@@ -162,7 +162,7 @@ declare class Catalog {
|
|
|
162
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
163
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
164
164
|
* @name createProductsInBulk
|
|
165
|
-
* @summary: Create products in bulk
|
|
165
|
+
* @summary: Create products in bulk
|
|
166
166
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
|
|
167
167
|
*/
|
|
168
168
|
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -172,7 +172,7 @@ declare class Catalog {
|
|
|
172
172
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
173
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
174
174
|
* @name createSizeGuide
|
|
175
|
-
* @summary: Create a size guide
|
|
175
|
+
* @summary: Create a size guide
|
|
176
176
|
* @description: Allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
177
177
|
*/
|
|
178
178
|
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -182,7 +182,7 @@ declare class Catalog {
|
|
|
182
182
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
183
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
184
184
|
* @name deleteBulkInventoryJob
|
|
185
|
-
* @summary: Delete inventory bulk upload job
|
|
185
|
+
* @summary: Delete inventory bulk upload job
|
|
186
186
|
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
187
187
|
*/
|
|
188
188
|
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -192,7 +192,7 @@ declare class Catalog {
|
|
|
192
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
193
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
194
194
|
* @name deleteProduct
|
|
195
|
-
* @summary: Delete a product
|
|
195
|
+
* @summary: Delete a product
|
|
196
196
|
* @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
197
197
|
*/
|
|
198
198
|
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -202,7 +202,7 @@ declare class Catalog {
|
|
|
202
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
204
204
|
* @name deleteProductBulkJob
|
|
205
|
-
* @summary: Delete product bulk upload job
|
|
205
|
+
* @summary: Delete product bulk upload job
|
|
206
206
|
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
207
207
|
*/
|
|
208
208
|
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -212,7 +212,7 @@ declare class Catalog {
|
|
|
212
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
214
214
|
* @name deleteRealtimeInventory
|
|
215
|
-
* @summary: Delete realtime inventory
|
|
215
|
+
* @summary: Delete realtime inventory
|
|
216
216
|
* @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
217
217
|
*/
|
|
218
218
|
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
@@ -223,7 +223,7 @@ declare class Catalog {
|
|
|
223
223
|
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
224
224
|
* Success response
|
|
225
225
|
* @name deleteSize
|
|
226
|
-
* @summary: Delete product size
|
|
226
|
+
* @summary: Delete product size
|
|
227
227
|
* @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
228
228
|
*/
|
|
229
229
|
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
@@ -235,7 +235,7 @@ declare class Catalog {
|
|
|
235
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
236
|
* @returns {Promise<string>} - Success response
|
|
237
237
|
* @name downloadInventoryTemplateView
|
|
238
|
-
* @summary: Download inventory template view
|
|
238
|
+
* @summary: Download inventory template view
|
|
239
239
|
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
240
240
|
*/
|
|
241
241
|
downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
@@ -247,7 +247,7 @@ declare class Catalog {
|
|
|
247
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
248
|
* @returns {Promise<string>} - Success response
|
|
249
249
|
* @name downloadProductTemplateViews
|
|
250
|
-
* @summary: Download product template views
|
|
250
|
+
* @summary: Download product template views
|
|
251
251
|
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
252
252
|
*/
|
|
253
253
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
@@ -257,7 +257,7 @@ declare class Catalog {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
259
259
|
* @name editProduct
|
|
260
|
-
* @summary: Edit a product
|
|
260
|
+
* @summary: Edit a product
|
|
261
261
|
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
262
262
|
*/
|
|
263
263
|
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -267,7 +267,7 @@ declare class Catalog {
|
|
|
267
267
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
268
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
269
269
|
* @name exportInventoryConfig
|
|
270
|
-
* @summary: Export inventory configuration
|
|
270
|
+
* @summary: Export inventory configuration
|
|
271
271
|
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
|
|
272
272
|
*/
|
|
273
273
|
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
@@ -279,7 +279,7 @@ declare class Catalog {
|
|
|
279
279
|
* - Success response
|
|
280
280
|
*
|
|
281
281
|
* @name getAllProductHsnCodes
|
|
282
|
-
* @summary: Get all product HSN codes
|
|
282
|
+
* @summary: Get all product HSN codes
|
|
283
283
|
* @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
284
284
|
*/
|
|
285
285
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
@@ -289,7 +289,7 @@ declare class Catalog {
|
|
|
289
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
290
|
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
291
291
|
* @name getCategoryData
|
|
292
|
-
* @summary: Get category data
|
|
292
|
+
* @summary: Get category data
|
|
293
293
|
* @description: Retrieve detailed information about a specific category with the associated meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
294
294
|
*/
|
|
295
295
|
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
@@ -300,7 +300,7 @@ declare class Catalog {
|
|
|
300
300
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
|
|
301
301
|
* Success response
|
|
302
302
|
* @name getCompanyBrandDetail
|
|
303
|
-
* @summary: Get the Company Brand details of Optin
|
|
303
|
+
* @summary: Get the Company Brand details of Optin
|
|
304
304
|
* @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
305
305
|
*/
|
|
306
306
|
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
@@ -310,7 +310,7 @@ declare class Catalog {
|
|
|
310
310
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
311
311
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
312
312
|
* @name getCompanyDetail
|
|
313
|
-
* @summary: Get the Company details
|
|
313
|
+
* @summary: Get the Company details
|
|
314
314
|
* @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
|
|
315
315
|
*/
|
|
316
316
|
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
@@ -320,7 +320,7 @@ declare class Catalog {
|
|
|
320
320
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
321
321
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
322
322
|
* @name getCompanyMetrics
|
|
323
|
-
* @summary: Get company metrics
|
|
323
|
+
* @summary: Get company metrics
|
|
324
324
|
* @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
325
325
|
*/
|
|
326
326
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
@@ -330,7 +330,7 @@ declare class Catalog {
|
|
|
330
330
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
331
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
332
332
|
* @name getDepartmentData
|
|
333
|
-
* @summary: Get department data
|
|
333
|
+
* @summary: Get department data
|
|
334
334
|
* @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
335
335
|
*/
|
|
336
336
|
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
@@ -340,7 +340,7 @@ declare class Catalog {
|
|
|
340
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
341
341
|
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
342
342
|
* @name getGenderAttribute
|
|
343
|
-
* @summary: Get gender attribute
|
|
343
|
+
* @summary: Get gender attribute
|
|
344
344
|
* @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
345
345
|
*/
|
|
346
346
|
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
@@ -350,7 +350,7 @@ declare class Catalog {
|
|
|
350
350
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
351
351
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
352
352
|
* @name getHsnCode
|
|
353
|
-
* @summary: Get HSN code
|
|
353
|
+
* @summary: Get HSN code
|
|
354
354
|
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
355
355
|
*/
|
|
356
356
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
@@ -360,7 +360,7 @@ declare class Catalog {
|
|
|
360
360
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
361
361
|
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
362
362
|
* @name getInventories
|
|
363
|
-
* @summary: Retrieve inventories
|
|
363
|
+
* @summary: Retrieve inventories
|
|
364
364
|
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
365
365
|
*/
|
|
366
366
|
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
@@ -376,7 +376,7 @@ declare class Catalog {
|
|
|
376
376
|
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
377
377
|
* or Primary Identifier) of which inventory is to get.
|
|
378
378
|
* @returns {Paginator<CatalogPlatformModel.GetInventoriesResponse>}
|
|
379
|
-
* @summary: Retrieve inventories
|
|
379
|
+
* @summary: Retrieve inventories
|
|
380
380
|
* @description: Allows to get Inventories data for particular company.
|
|
381
381
|
*/
|
|
382
382
|
getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
|
|
@@ -396,7 +396,7 @@ declare class Catalog {
|
|
|
396
396
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
397
397
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
398
398
|
* @name getInventoryBulkUploadHistory
|
|
399
|
-
* @summary: Retrieve inventory bulk upload history
|
|
399
|
+
* @summary: Retrieve inventory bulk upload history
|
|
400
400
|
* @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
401
401
|
*/
|
|
402
402
|
getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
@@ -405,7 +405,7 @@ declare class Catalog {
|
|
|
405
405
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
406
406
|
* page. Default is 12.
|
|
407
407
|
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
408
|
-
* @summary: Retrieve inventory bulk upload history
|
|
408
|
+
* @summary: Retrieve inventory bulk upload history
|
|
409
409
|
* @description: Helps to get bulk Inventory upload jobs data.
|
|
410
410
|
*/
|
|
411
411
|
getInventoryBulkUploadHistoryPaginator({ pageSize }?: {
|
|
@@ -418,7 +418,7 @@ declare class Catalog {
|
|
|
418
418
|
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
419
419
|
* Success response
|
|
420
420
|
* @name getInventoryBySize
|
|
421
|
-
* @summary: Get inventory by size
|
|
421
|
+
* @summary: Get inventory by size
|
|
422
422
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
|
|
423
423
|
*/
|
|
424
424
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
@@ -431,7 +431,7 @@ declare class Catalog {
|
|
|
431
431
|
* @param {string} [arg.q] - Search with help of store code.
|
|
432
432
|
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
433
433
|
* @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
|
|
434
|
-
* @summary: Get inventory by size
|
|
434
|
+
* @summary: Get inventory by size
|
|
435
435
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
436
436
|
*/
|
|
437
437
|
getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
|
|
@@ -451,7 +451,7 @@ declare class Catalog {
|
|
|
451
451
|
* - Success response
|
|
452
452
|
*
|
|
453
453
|
* @name getInventoryBySizeIdentifier
|
|
454
|
-
* @summary: Get inventory by size identifier
|
|
454
|
+
* @summary: Get inventory by size identifier
|
|
455
455
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
456
456
|
*/
|
|
457
457
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
@@ -465,7 +465,7 @@ declare class Catalog {
|
|
|
465
465
|
* @param {string} [arg.q] - Search with help of store code.
|
|
466
466
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
467
467
|
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
468
|
-
* @summary: Get inventory by size identifier
|
|
468
|
+
* @summary: Get inventory by size identifier
|
|
469
469
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
470
470
|
*/
|
|
471
471
|
getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
@@ -481,7 +481,7 @@ declare class Catalog {
|
|
|
481
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
482
|
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
483
483
|
* @name getInventoryExport
|
|
484
|
-
* @summary: Retrieve inventory export data
|
|
484
|
+
* @summary: Retrieve inventory export data
|
|
485
485
|
* @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
486
486
|
*/
|
|
487
487
|
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
@@ -491,7 +491,7 @@ declare class Catalog {
|
|
|
491
491
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
492
|
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
493
493
|
* @name getMarketplaceOptinDetail
|
|
494
|
-
* @summary: Get opt-in infomation
|
|
494
|
+
* @summary: Get opt-in infomation
|
|
495
495
|
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
496
496
|
*/
|
|
497
497
|
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
@@ -511,7 +511,7 @@ declare class Catalog {
|
|
|
511
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
512
512
|
* @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
|
|
513
513
|
* @name getOptimalLocations
|
|
514
|
-
* @summary: Get optimal locations
|
|
514
|
+
* @summary: Get optimal locations
|
|
515
515
|
* @description: Retrieve the most suitable locations based on certain criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
516
516
|
*/
|
|
517
517
|
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
|
|
@@ -521,7 +521,7 @@ declare class Catalog {
|
|
|
521
521
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
522
522
|
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
523
523
|
* @name getProduct
|
|
524
|
-
* @summary: Get product details
|
|
524
|
+
* @summary: Get product details
|
|
525
525
|
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
526
526
|
*/
|
|
527
527
|
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
@@ -531,7 +531,7 @@ declare class Catalog {
|
|
|
531
531
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
532
532
|
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
533
533
|
* @name getProductAssetsInBulk
|
|
534
|
-
* @summary: Retrieve product assets in bulk
|
|
534
|
+
* @summary: Retrieve product assets in bulk
|
|
535
535
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
536
536
|
*/
|
|
537
537
|
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
@@ -540,7 +540,7 @@ declare class Catalog {
|
|
|
540
540
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
541
541
|
* page. Default is 12.
|
|
542
542
|
* @returns {Paginator<CatalogPlatformModel.BulkAssetResponse>}
|
|
543
|
-
* @summary: Retrieve product assets in bulk
|
|
543
|
+
* @summary: Retrieve product assets in bulk
|
|
544
544
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company.
|
|
545
545
|
*/
|
|
546
546
|
getProductAssetsInBulkPaginator({ pageSize }?: {
|
|
@@ -553,7 +553,7 @@ declare class Catalog {
|
|
|
553
553
|
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
554
554
|
* Success response
|
|
555
555
|
* @name getProductAttributes
|
|
556
|
-
* @summary: Get product attributes
|
|
556
|
+
* @summary: Get product attributes
|
|
557
557
|
* @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
558
558
|
*/
|
|
559
559
|
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
@@ -563,7 +563,7 @@ declare class Catalog {
|
|
|
563
563
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
564
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
565
565
|
* @name getProductBulkUploadHistory
|
|
566
|
-
* @summary: Retrieve product bulk upload history
|
|
566
|
+
* @summary: Retrieve product bulk upload history
|
|
567
567
|
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
568
568
|
*/
|
|
569
569
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
@@ -573,7 +573,7 @@ declare class Catalog {
|
|
|
573
573
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
574
574
|
* page. Default is 12.
|
|
575
575
|
* @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
|
|
576
|
-
* @summary: Retrieve product bulk upload history
|
|
576
|
+
* @summary: Retrieve product bulk upload history
|
|
577
577
|
* @description: Helps to get bulk product upload jobs data.
|
|
578
578
|
*/
|
|
579
579
|
getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
|
|
@@ -588,7 +588,7 @@ declare class Catalog {
|
|
|
588
588
|
* - Success response
|
|
589
589
|
*
|
|
590
590
|
* @name getProductBundle
|
|
591
|
-
* @summary: Retrieve product bundles
|
|
591
|
+
* @summary: Retrieve product bundles
|
|
592
592
|
* @description: Retrieve a list of product bundles available in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
593
593
|
*/
|
|
594
594
|
getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
@@ -599,7 +599,7 @@ declare class Catalog {
|
|
|
599
599
|
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
600
600
|
* Success response
|
|
601
601
|
* @name getProductBundleDetail
|
|
602
|
-
* @summary: Get product bundle details
|
|
602
|
+
* @summary: Get product bundle details
|
|
603
603
|
* @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
604
604
|
*/
|
|
605
605
|
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
@@ -610,7 +610,7 @@ declare class Catalog {
|
|
|
610
610
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
611
611
|
* Success response
|
|
612
612
|
* @name getProductExportJobs
|
|
613
|
-
* @summary: Retrieve product export jobs
|
|
613
|
+
* @summary: Retrieve product export jobs
|
|
614
614
|
* @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
615
615
|
*/
|
|
616
616
|
getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
@@ -620,7 +620,7 @@ declare class Catalog {
|
|
|
620
620
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
621
621
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
|
|
622
622
|
* @name getProductSize
|
|
623
|
-
* @summary: Get product size details
|
|
623
|
+
* @summary: Get product size details
|
|
624
624
|
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
625
625
|
*/
|
|
626
626
|
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
|
|
@@ -630,7 +630,7 @@ declare class Catalog {
|
|
|
630
630
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
631
631
|
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
632
632
|
* @name getProductTags
|
|
633
|
-
* @summary: Get product tags
|
|
633
|
+
* @summary: Get product tags
|
|
634
634
|
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
635
635
|
*/
|
|
636
636
|
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
@@ -640,7 +640,7 @@ declare class Catalog {
|
|
|
640
640
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
641
641
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
642
642
|
* @name getProductValidation
|
|
643
|
-
* @summary: Get product validation
|
|
643
|
+
* @summary: Get product validation
|
|
644
644
|
* @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
645
645
|
*/
|
|
646
646
|
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
@@ -651,7 +651,7 @@ declare class Catalog {
|
|
|
651
651
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
652
652
|
* Success response
|
|
653
653
|
* @name getProducts
|
|
654
|
-
* @summary: Retrieve products
|
|
654
|
+
* @summary: Retrieve products
|
|
655
655
|
* @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
656
656
|
*/
|
|
657
657
|
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
@@ -669,7 +669,7 @@ declare class Catalog {
|
|
|
669
669
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
670
670
|
* page. Default is 10.
|
|
671
671
|
* @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
|
|
672
|
-
* @summary: Retrieve products
|
|
672
|
+
* @summary: Retrieve products
|
|
673
673
|
* @description: Retrieve a list of products available
|
|
674
674
|
*/
|
|
675
675
|
getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageSize, }?: {
|
|
@@ -688,7 +688,7 @@ declare class Catalog {
|
|
|
688
688
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
689
689
|
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
690
690
|
* @name getSellerInsights
|
|
691
|
-
* @summary: Get seller insights
|
|
691
|
+
* @summary: Get seller insights
|
|
692
692
|
* @description: Retrieve insights and analytics related to sellers within the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
693
693
|
*/
|
|
694
694
|
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
@@ -698,7 +698,7 @@ declare class Catalog {
|
|
|
698
698
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
699
699
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
700
700
|
* @name getSingleProductHSNCode
|
|
701
|
-
* @summary: Get single product HSN code
|
|
701
|
+
* @summary: Get single product HSN code
|
|
702
702
|
* @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
703
703
|
*/
|
|
704
704
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
@@ -708,7 +708,7 @@ declare class Catalog {
|
|
|
708
708
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
709
709
|
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
710
710
|
* @name getSizeGuide
|
|
711
|
-
* @summary: Get size guide details
|
|
711
|
+
* @summary: Get size guide details
|
|
712
712
|
* @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
713
713
|
*/
|
|
714
714
|
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
@@ -718,7 +718,7 @@ declare class Catalog {
|
|
|
718
718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
719
719
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
720
720
|
* @name getSizeGuides
|
|
721
|
-
* @summary: Retrieve size guides
|
|
721
|
+
* @summary: Retrieve size guides
|
|
722
722
|
* @description: Allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
|
|
723
723
|
*/
|
|
724
724
|
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
@@ -728,7 +728,7 @@ declare class Catalog {
|
|
|
728
728
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
729
729
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
730
730
|
* @name getStoreDetail
|
|
731
|
-
* @summary: Get store details
|
|
731
|
+
* @summary: Get store details
|
|
732
732
|
* @description: Retrieve the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
|
|
733
733
|
*/
|
|
734
734
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
@@ -738,7 +738,7 @@ declare class Catalog {
|
|
|
738
738
|
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
739
739
|
* the page for the company id.
|
|
740
740
|
* @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
|
|
741
|
-
* @summary: Get store details
|
|
741
|
+
* @summary: Get store details
|
|
742
742
|
* @description: Retrieve the details of the store associated with the company ID passed.
|
|
743
743
|
*/
|
|
744
744
|
getStoreDetailPaginator({ q, pageSize }?: {
|
|
@@ -751,7 +751,7 @@ declare class Catalog {
|
|
|
751
751
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
752
752
|
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
753
753
|
* @name getVariantsOfProducts
|
|
754
|
-
* @summary: Get variants of products
|
|
754
|
+
* @summary: Get variants of products
|
|
755
755
|
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
756
756
|
*/
|
|
757
757
|
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
@@ -762,7 +762,7 @@ declare class Catalog {
|
|
|
762
762
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
763
763
|
* page. Default is 10.
|
|
764
764
|
* @returns {Paginator<CatalogPlatformModel.ProductVariantsResponse>}
|
|
765
|
-
* @summary: Get variants of products
|
|
765
|
+
* @summary: Get variants of products
|
|
766
766
|
* @description: Retrieve variants of a specific product.
|
|
767
767
|
*/
|
|
768
768
|
getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
|
|
@@ -776,7 +776,7 @@ declare class Catalog {
|
|
|
776
776
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
777
777
|
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
778
778
|
* @name listCategories
|
|
779
|
-
* @summary: List categories
|
|
779
|
+
* @summary: List categories
|
|
780
780
|
* @description: Retrieve a list of meta associated available product categories in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
781
781
|
*/
|
|
782
782
|
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
@@ -790,7 +790,7 @@ declare class Catalog {
|
|
|
790
790
|
* @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
|
|
791
791
|
* @param {string} [arg.slug] - Get category by slug
|
|
792
792
|
* @returns {Paginator<CatalogPlatformModel.CategoryResponse>}
|
|
793
|
-
* @summary: List categories
|
|
793
|
+
* @summary: List categories
|
|
794
794
|
* @description: Retrieve a list of meta associated available product categories in the catalog.
|
|
795
795
|
*/
|
|
796
796
|
listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
|
|
@@ -807,7 +807,7 @@ declare class Catalog {
|
|
|
807
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
808
808
|
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
809
809
|
* @name listDepartmentsData
|
|
810
|
-
* @summary: List department data
|
|
810
|
+
* @summary: List department data
|
|
811
811
|
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
812
812
|
*/
|
|
813
813
|
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
@@ -824,7 +824,7 @@ declare class Catalog {
|
|
|
824
824
|
* whether they are active or inactive.
|
|
825
825
|
* @param {string} [arg.slug] - Can filter by slug
|
|
826
826
|
* @returns {Paginator<CatalogPlatformModel.DepartmentsResponse>}
|
|
827
|
-
* @summary: List department data
|
|
827
|
+
* @summary: List department data
|
|
828
828
|
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
829
829
|
*/
|
|
830
830
|
listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
|
|
@@ -841,7 +841,7 @@ declare class Catalog {
|
|
|
841
841
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
842
842
|
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
843
843
|
* @name listHSNCodes
|
|
844
|
-
* @summary: List HSN codes
|
|
844
|
+
* @summary: List HSN codes
|
|
845
845
|
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
846
846
|
*/
|
|
847
847
|
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
@@ -853,7 +853,7 @@ declare class Catalog {
|
|
|
853
853
|
* - Success response
|
|
854
854
|
*
|
|
855
855
|
* @name listInventoryExport
|
|
856
|
-
* @summary: List inventory exports
|
|
856
|
+
* @summary: List inventory exports
|
|
857
857
|
* @description: Helps you the retrieve the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
858
858
|
*/
|
|
859
859
|
listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
@@ -863,7 +863,7 @@ declare class Catalog {
|
|
|
863
863
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
864
864
|
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
865
865
|
* @name listProductTemplate
|
|
866
|
-
* @summary: List product templates
|
|
866
|
+
* @summary: List product templates
|
|
867
867
|
* @description: Allows you to list all product templates, also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
868
868
|
*/
|
|
869
869
|
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
@@ -877,7 +877,7 @@ declare class Catalog {
|
|
|
877
877
|
* - Success response
|
|
878
878
|
*
|
|
879
879
|
* @name listProductTemplateCategories
|
|
880
|
-
* @summary: List product template categories
|
|
880
|
+
* @summary: List product template categories
|
|
881
881
|
* @description: Allows you to list all product categories values for the departments specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
882
882
|
*/
|
|
883
883
|
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
@@ -890,7 +890,7 @@ declare class Catalog {
|
|
|
890
890
|
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
891
891
|
* Success response
|
|
892
892
|
* @name listProductTemplateExportDetails
|
|
893
|
-
* @summary: List product template export details
|
|
893
|
+
* @summary: List product template export details
|
|
894
894
|
* @description: Retrieve export details related to product templates. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
895
895
|
*/
|
|
896
896
|
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
@@ -901,7 +901,7 @@ declare class Catalog {
|
|
|
901
901
|
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
902
902
|
* Success response
|
|
903
903
|
* @name listTemplateBrandTypeValues
|
|
904
|
-
* @summary: List template brand type values
|
|
904
|
+
* @summary: List template brand type values
|
|
905
905
|
* @description: Retrieve values related to template brand types. The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
906
906
|
*/
|
|
907
907
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
@@ -911,7 +911,7 @@ declare class Catalog {
|
|
|
911
911
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
912
912
|
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
913
913
|
* @name updateCategory
|
|
914
|
-
* @summary: Update category data
|
|
914
|
+
* @summary: Update category data
|
|
915
915
|
* @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
916
916
|
*/
|
|
917
917
|
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
@@ -921,7 +921,7 @@ declare class Catalog {
|
|
|
921
921
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
922
922
|
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
923
923
|
* @name updateDepartment
|
|
924
|
-
* @summary: Update department data
|
|
924
|
+
* @summary: Update department data
|
|
925
925
|
* @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
926
926
|
*/
|
|
927
927
|
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
@@ -931,7 +931,7 @@ declare class Catalog {
|
|
|
931
931
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
932
932
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
933
933
|
* @name updateHsnCode
|
|
934
|
-
* @summary: Update HSN code
|
|
934
|
+
* @summary: Update HSN code
|
|
935
935
|
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
|
|
936
936
|
*/
|
|
937
937
|
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
@@ -941,7 +941,7 @@ declare class Catalog {
|
|
|
941
941
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
942
942
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
943
943
|
* @name updateInventories
|
|
944
|
-
* @summary: Update inventories
|
|
944
|
+
* @summary: Update inventories
|
|
945
945
|
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
946
946
|
*/
|
|
947
947
|
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
@@ -965,7 +965,7 @@ declare class Catalog {
|
|
|
965
965
|
* - Success response
|
|
966
966
|
*
|
|
967
967
|
* @name updateProductBundle
|
|
968
|
-
* @summary: Update a product bundle
|
|
968
|
+
* @summary: Update a product bundle
|
|
969
969
|
* @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
970
970
|
*/
|
|
971
971
|
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
@@ -975,7 +975,7 @@ declare class Catalog {
|
|
|
975
975
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
976
976
|
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
977
977
|
* @name updateRealtimeInventory
|
|
978
|
-
* @summary: Update realtime inventory
|
|
978
|
+
* @summary: Update realtime inventory
|
|
979
979
|
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
980
980
|
*/
|
|
981
981
|
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
@@ -985,7 +985,7 @@ declare class Catalog {
|
|
|
985
985
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
986
986
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
987
987
|
* @name updateSizeGuide
|
|
988
|
-
* @summary: Update a size guide
|
|
988
|
+
* @summary: Update a size guide
|
|
989
989
|
* @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
990
990
|
*/
|
|
991
991
|
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
@@ -995,7 +995,7 @@ declare class Catalog {
|
|
|
995
995
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
996
996
|
* @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
|
|
997
997
|
* @name uploadBulkProducts
|
|
998
|
-
* @summary: Upload bulk products
|
|
998
|
+
* @summary: Upload bulk products
|
|
999
999
|
* @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
1000
1000
|
*/
|
|
1001
1001
|
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
@@ -1006,7 +1006,7 @@ declare class Catalog {
|
|
|
1006
1006
|
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
1007
1007
|
* Success response
|
|
1008
1008
|
* @name validateProductTemplate
|
|
1009
|
-
* @summary: Validate product template
|
|
1009
|
+
* @summary: Validate product template
|
|
1010
1010
|
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
1011
1011
|
*/
|
|
1012
1012
|
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
@@ -1019,7 +1019,7 @@ declare class Catalog {
|
|
|
1019
1019
|
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
1020
1020
|
* Success response
|
|
1021
1021
|
* @name validateProductTemplateSchema
|
|
1022
|
-
* @summary: Validate product template schema
|
|
1022
|
+
* @summary: Validate product template schema
|
|
1023
1023
|
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1024
1024
|
*/
|
|
1025
1025
|
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|