@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -42,7 +42,7 @@ declare class Catalog {
|
|
|
42
42
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
43
43
|
* @name followById
|
|
44
44
|
* @summary: Create item, brand, product
|
|
45
|
-
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://
|
|
45
|
+
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/followById/).
|
|
46
46
|
*/
|
|
47
47
|
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
48
48
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Catalog {
|
|
|
51
51
|
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
52
52
|
* @name getBrandDetailBySlug
|
|
53
53
|
* @summary: Get a brand
|
|
54
|
-
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
54
|
+
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrandDetailBySlug/).
|
|
55
55
|
*/
|
|
56
56
|
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponseSchema>;
|
|
57
57
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Catalog {
|
|
|
60
60
|
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
61
61
|
* @name getBrands
|
|
62
62
|
* @summary: List brands
|
|
63
|
-
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://
|
|
63
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrands/).
|
|
64
64
|
*/
|
|
65
65
|
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponseSchema>;
|
|
66
66
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Catalog {
|
|
|
84
84
|
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
85
85
|
* @name getCategories
|
|
86
86
|
* @summary: List product categories
|
|
87
|
-
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://
|
|
87
|
+
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategories/).
|
|
88
88
|
*/
|
|
89
89
|
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponseSchema>;
|
|
90
90
|
/**
|
|
@@ -93,7 +93,7 @@ declare class Catalog {
|
|
|
93
93
|
* @returns {Promise<CategoryMetaResponseSchema>} - Success response
|
|
94
94
|
* @name getCategoryDetailBySlug
|
|
95
95
|
* @summary: Get category by slug
|
|
96
|
-
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
96
|
+
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
97
97
|
*/
|
|
98
98
|
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponseSchema>;
|
|
99
99
|
/**
|
|
@@ -102,7 +102,7 @@ declare class Catalog {
|
|
|
102
102
|
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
103
103
|
* @name getCollectionDetailBySlug
|
|
104
104
|
* @summary: Get a collection
|
|
105
|
-
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://
|
|
105
|
+
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
106
106
|
*/
|
|
107
107
|
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponseSchema>;
|
|
108
108
|
/**
|
|
@@ -111,7 +111,7 @@ declare class Catalog {
|
|
|
111
111
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
112
112
|
* @name getCollectionItemsBySlug
|
|
113
113
|
* @summary: Lists items of collection
|
|
114
|
-
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://
|
|
114
|
+
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
115
115
|
*/
|
|
116
116
|
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponseSchema>;
|
|
117
117
|
/**
|
|
@@ -149,7 +149,7 @@ declare class Catalog {
|
|
|
149
149
|
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
150
150
|
* @name getCollections
|
|
151
151
|
* @summary: List collections
|
|
152
|
-
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://
|
|
152
|
+
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollections/).
|
|
153
153
|
*/
|
|
154
154
|
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponseSchema>;
|
|
155
155
|
/**
|
|
@@ -173,7 +173,7 @@ declare class Catalog {
|
|
|
173
173
|
* Success response
|
|
174
174
|
* @name getComparedFrequentlyProductBySlug
|
|
175
175
|
* @summary: List frequent products
|
|
176
|
-
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://
|
|
176
|
+
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
177
177
|
*/
|
|
178
178
|
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponseSchema>;
|
|
179
179
|
/**
|
|
@@ -182,7 +182,7 @@ declare class Catalog {
|
|
|
182
182
|
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
183
183
|
* @name getDepartments
|
|
184
184
|
* @summary: List departments
|
|
185
|
-
* @description: List all departments associated with available products. - Check out [method documentation](https://
|
|
185
|
+
* @description: List all departments associated with available products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getDepartments/).
|
|
186
186
|
*/
|
|
187
187
|
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponseSchema>;
|
|
188
188
|
/**
|
|
@@ -191,7 +191,7 @@ declare class Catalog {
|
|
|
191
191
|
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
192
192
|
* @name getFollowIds
|
|
193
193
|
* @summary: List Ids of followed item, brand, product
|
|
194
|
-
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://
|
|
194
|
+
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowIds/).
|
|
195
195
|
*/
|
|
196
196
|
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponseSchema>;
|
|
197
197
|
/**
|
|
@@ -200,7 +200,7 @@ declare class Catalog {
|
|
|
200
200
|
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
201
201
|
* @name getFollowedListing
|
|
202
202
|
* @summary: List followed products, brands
|
|
203
|
-
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://
|
|
203
|
+
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowedListing/).
|
|
204
204
|
*/
|
|
205
205
|
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponseSchema>;
|
|
206
206
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Catalog {
|
|
|
222
222
|
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
223
223
|
* @name getFollowerCountById
|
|
224
224
|
* @summary: Get follower count
|
|
225
|
-
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://
|
|
225
|
+
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowerCountById/).
|
|
226
226
|
*/
|
|
227
227
|
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponseSchema>;
|
|
228
228
|
/**
|
|
@@ -231,7 +231,7 @@ declare class Catalog {
|
|
|
231
231
|
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
232
232
|
* @name getHomeProducts
|
|
233
233
|
* @summary: List homepage-featured products
|
|
234
|
-
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://
|
|
234
|
+
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getHomeProducts/).
|
|
235
235
|
*/
|
|
236
236
|
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponseSchema>;
|
|
237
237
|
/**
|
|
@@ -254,7 +254,7 @@ declare class Catalog {
|
|
|
254
254
|
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
255
255
|
* @name getInStockLocations
|
|
256
256
|
* @summary: List stores with inventory
|
|
257
|
-
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://
|
|
257
|
+
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getInStockLocations/).
|
|
258
258
|
*/
|
|
259
259
|
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
260
260
|
/**
|
|
@@ -286,7 +286,7 @@ declare class Catalog {
|
|
|
286
286
|
* @returns {Promise<StoreDetails>} - Success response
|
|
287
287
|
* @name getLocationDetailsById
|
|
288
288
|
* @summary: Get selling location
|
|
289
|
-
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://
|
|
289
|
+
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getLocationDetailsById/).
|
|
290
290
|
*/
|
|
291
291
|
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<StoreDetails>;
|
|
292
292
|
/**
|
|
@@ -295,7 +295,7 @@ declare class Catalog {
|
|
|
295
295
|
* @returns {Promise<ProductBundle>} - Success response
|
|
296
296
|
* @name getProductBundlesBySlug
|
|
297
297
|
* @summary: List product bundles
|
|
298
|
-
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://
|
|
298
|
+
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductBundlesBySlug/).
|
|
299
299
|
*/
|
|
300
300
|
getProductBundlesBySlug({ slug, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
301
301
|
/**
|
|
@@ -304,7 +304,7 @@ declare class Catalog {
|
|
|
304
304
|
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
305
305
|
* @name getProductComparisonBySlugs
|
|
306
306
|
* @summary: List products for comparison
|
|
307
|
-
* @description: Get all the products that have the same category. - Check out [method documentation](https://
|
|
307
|
+
* @description: Get all the products that have the same category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
308
308
|
*/
|
|
309
309
|
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponseSchema>;
|
|
310
310
|
/**
|
|
@@ -313,7 +313,7 @@ declare class Catalog {
|
|
|
313
313
|
* @returns {Promise<ProductDetail>} - Success response
|
|
314
314
|
* @name getProductDetailBySlug
|
|
315
315
|
* @summary: Get a product
|
|
316
|
-
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://
|
|
316
|
+
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductDetailBySlug/).
|
|
317
317
|
*/
|
|
318
318
|
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductDetail>;
|
|
319
319
|
/**
|
|
@@ -322,7 +322,7 @@ declare class Catalog {
|
|
|
322
322
|
* @returns {Promise<ProductSizePriceResponseV4>} - Success response
|
|
323
323
|
* @name getProductPriceBySlug
|
|
324
324
|
* @summary: Get product price
|
|
325
|
-
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://
|
|
325
|
+
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
326
326
|
*/
|
|
327
327
|
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
328
328
|
/**
|
|
@@ -331,7 +331,7 @@ declare class Catalog {
|
|
|
331
331
|
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
332
332
|
* @name getProductSellersBySlug
|
|
333
333
|
* @summary: List sellers
|
|
334
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://
|
|
334
|
+
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
335
335
|
*/
|
|
336
336
|
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
337
337
|
/**
|
|
@@ -361,7 +361,7 @@ declare class Catalog {
|
|
|
361
361
|
* @returns {Promise<ProductSizes>} - Success response
|
|
362
362
|
* @name getProductSizesBySlug
|
|
363
363
|
* @summary: List sizes
|
|
364
|
-
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://
|
|
364
|
+
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSizesBySlug/).
|
|
365
365
|
*/
|
|
366
366
|
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizes>;
|
|
367
367
|
/**
|
|
@@ -370,7 +370,7 @@ declare class Catalog {
|
|
|
370
370
|
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
371
371
|
* @name getProductStockByIds
|
|
372
372
|
* @summary: Get product stocks
|
|
373
|
-
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://
|
|
373
|
+
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockByIds/).
|
|
374
374
|
*/
|
|
375
375
|
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponseSchema>;
|
|
376
376
|
/**
|
|
@@ -379,7 +379,7 @@ declare class Catalog {
|
|
|
379
379
|
* @returns {Promise<ProductStockPolling>} - Success response
|
|
380
380
|
* @name getProductStockForTimeByIds
|
|
381
381
|
* @summary: List future stock
|
|
382
|
-
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://
|
|
382
|
+
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
383
383
|
*/
|
|
384
384
|
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
385
385
|
/**
|
|
@@ -400,7 +400,7 @@ declare class Catalog {
|
|
|
400
400
|
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
401
401
|
* @name getProductVariantsBySlug
|
|
402
402
|
* @summary: List product variants
|
|
403
|
-
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://
|
|
403
|
+
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductVariantsBySlug/).
|
|
404
404
|
*/
|
|
405
405
|
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponseSchema>;
|
|
406
406
|
/**
|
|
@@ -409,7 +409,7 @@ declare class Catalog {
|
|
|
409
409
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
410
410
|
* @name getProducts
|
|
411
411
|
* @summary: List products
|
|
412
|
-
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://
|
|
412
|
+
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProducts/).
|
|
413
413
|
*/
|
|
414
414
|
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponseSchema>;
|
|
415
415
|
/**
|
|
@@ -443,7 +443,7 @@ declare class Catalog {
|
|
|
443
443
|
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
444
444
|
* @name getSearchResults
|
|
445
445
|
* @summary: List product, brand, category
|
|
446
|
-
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://
|
|
446
|
+
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSearchResults/).
|
|
447
447
|
*/
|
|
448
448
|
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponseSchema>;
|
|
449
449
|
/**
|
|
@@ -452,7 +452,7 @@ declare class Catalog {
|
|
|
452
452
|
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
453
453
|
* @name getSimilarComparisonProductBySlug
|
|
454
454
|
* @summary: List similar products
|
|
455
|
-
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://
|
|
455
|
+
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
456
456
|
*/
|
|
457
457
|
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponseSchema>;
|
|
458
458
|
/**
|
|
@@ -461,7 +461,7 @@ declare class Catalog {
|
|
|
461
461
|
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
462
462
|
* @name getStores
|
|
463
463
|
* @summary: List available stores
|
|
464
|
-
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://
|
|
464
|
+
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getStores/).
|
|
465
465
|
*/
|
|
466
466
|
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponseSchema>;
|
|
467
467
|
/**
|
|
@@ -495,7 +495,7 @@ declare class Catalog {
|
|
|
495
495
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
496
496
|
* @name unfollowById
|
|
497
497
|
* @summary: Delete item, brand, product
|
|
498
|
-
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://
|
|
498
|
+
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/unfollowById/).
|
|
499
499
|
*/
|
|
500
500
|
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
501
501
|
}
|
|
@@ -85,7 +85,7 @@ class Catalog {
|
|
|
85
85
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
86
86
|
* @name followById
|
|
87
87
|
* @summary: Create item, brand, product
|
|
88
|
-
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://
|
|
88
|
+
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/followById/).
|
|
89
89
|
*/
|
|
90
90
|
async followById(
|
|
91
91
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -134,7 +134,7 @@ class Catalog {
|
|
|
134
134
|
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
135
135
|
* @name getBrandDetailBySlug
|
|
136
136
|
* @summary: Get a brand
|
|
137
|
-
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
137
|
+
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrandDetailBySlug/).
|
|
138
138
|
*/
|
|
139
139
|
async getBrandDetailBySlug(
|
|
140
140
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,7 +180,7 @@ class Catalog {
|
|
|
180
180
|
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
181
181
|
* @name getBrands
|
|
182
182
|
* @summary: List brands
|
|
183
|
-
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://
|
|
183
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrands/).
|
|
184
184
|
*/
|
|
185
185
|
async getBrands(
|
|
186
186
|
{ department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -252,7 +252,7 @@ class Catalog {
|
|
|
252
252
|
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
253
253
|
* @name getCategories
|
|
254
254
|
* @summary: List product categories
|
|
255
|
-
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://
|
|
255
|
+
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategories/).
|
|
256
256
|
*/
|
|
257
257
|
async getCategories(
|
|
258
258
|
{ department, requestHeaders } = { requestHeaders: {} },
|
|
@@ -290,7 +290,7 @@ class Catalog {
|
|
|
290
290
|
* @returns {Promise<CategoryMetaResponseSchema>} - Success response
|
|
291
291
|
* @name getCategoryDetailBySlug
|
|
292
292
|
* @summary: Get category by slug
|
|
293
|
-
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
293
|
+
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
294
294
|
*/
|
|
295
295
|
async getCategoryDetailBySlug(
|
|
296
296
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -336,7 +336,7 @@ class Catalog {
|
|
|
336
336
|
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
337
337
|
* @name getCollectionDetailBySlug
|
|
338
338
|
* @summary: Get a collection
|
|
339
|
-
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://
|
|
339
|
+
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
340
340
|
*/
|
|
341
341
|
async getCollectionDetailBySlug(
|
|
342
342
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -382,7 +382,7 @@ class Catalog {
|
|
|
382
382
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
383
383
|
* @name getCollectionItemsBySlug
|
|
384
384
|
* @summary: Lists items of collection
|
|
385
|
-
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://
|
|
385
|
+
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
386
386
|
*/
|
|
387
387
|
async getCollectionItemsBySlug(
|
|
388
388
|
{
|
|
@@ -502,7 +502,7 @@ class Catalog {
|
|
|
502
502
|
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
503
503
|
* @name getCollections
|
|
504
504
|
* @summary: List collections
|
|
505
|
-
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://
|
|
505
|
+
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollections/).
|
|
506
506
|
*/
|
|
507
507
|
async getCollections(
|
|
508
508
|
{ pageNo, pageSize, tag, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -575,7 +575,7 @@ class Catalog {
|
|
|
575
575
|
* Success response
|
|
576
576
|
* @name getComparedFrequentlyProductBySlug
|
|
577
577
|
* @summary: List frequent products
|
|
578
|
-
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://
|
|
578
|
+
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
579
579
|
*/
|
|
580
580
|
async getComparedFrequentlyProductBySlug(
|
|
581
581
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -621,7 +621,7 @@ class Catalog {
|
|
|
621
621
|
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
622
622
|
* @name getDepartments
|
|
623
623
|
* @summary: List departments
|
|
624
|
-
* @description: List all departments associated with available products. - Check out [method documentation](https://
|
|
624
|
+
* @description: List all departments associated with available products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getDepartments/).
|
|
625
625
|
*/
|
|
626
626
|
async getDepartments(
|
|
627
627
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -658,7 +658,7 @@ class Catalog {
|
|
|
658
658
|
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
659
659
|
* @name getFollowIds
|
|
660
660
|
* @summary: List Ids of followed item, brand, product
|
|
661
|
-
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://
|
|
661
|
+
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowIds/).
|
|
662
662
|
*/
|
|
663
663
|
async getFollowIds(
|
|
664
664
|
{ collectionType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -696,7 +696,7 @@ class Catalog {
|
|
|
696
696
|
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
697
697
|
* @name getFollowedListing
|
|
698
698
|
* @summary: List followed products, brands
|
|
699
|
-
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://
|
|
699
|
+
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowedListing/).
|
|
700
700
|
*/
|
|
701
701
|
async getFollowedListing(
|
|
702
702
|
{ collectionType, pageId, pageSize, requestHeaders } = {
|
|
@@ -776,7 +776,7 @@ class Catalog {
|
|
|
776
776
|
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
777
777
|
* @name getFollowerCountById
|
|
778
778
|
* @summary: Get follower count
|
|
779
|
-
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://
|
|
779
|
+
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowerCountById/).
|
|
780
780
|
*/
|
|
781
781
|
async getFollowerCountById(
|
|
782
782
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -825,7 +825,7 @@ class Catalog {
|
|
|
825
825
|
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
826
826
|
* @name getHomeProducts
|
|
827
827
|
* @summary: List homepage-featured products
|
|
828
|
-
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://
|
|
828
|
+
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getHomeProducts/).
|
|
829
829
|
*/
|
|
830
830
|
async getHomeProducts(
|
|
831
831
|
{ sortOn, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -896,7 +896,7 @@ class Catalog {
|
|
|
896
896
|
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
897
897
|
* @name getInStockLocations
|
|
898
898
|
* @summary: List stores with inventory
|
|
899
|
-
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://
|
|
899
|
+
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getInStockLocations/).
|
|
900
900
|
*/
|
|
901
901
|
async getInStockLocations(
|
|
902
902
|
{
|
|
@@ -996,7 +996,7 @@ class Catalog {
|
|
|
996
996
|
* @returns {Promise<StoreDetails>} - Success response
|
|
997
997
|
* @name getLocationDetailsById
|
|
998
998
|
* @summary: Get selling location
|
|
999
|
-
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://
|
|
999
|
+
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getLocationDetailsById/).
|
|
1000
1000
|
*/
|
|
1001
1001
|
async getLocationDetailsById(
|
|
1002
1002
|
{ locationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1042,7 +1042,7 @@ class Catalog {
|
|
|
1042
1042
|
* @returns {Promise<ProductBundle>} - Success response
|
|
1043
1043
|
* @name getProductBundlesBySlug
|
|
1044
1044
|
* @summary: List product bundles
|
|
1045
|
-
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://
|
|
1045
|
+
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductBundlesBySlug/).
|
|
1046
1046
|
*/
|
|
1047
1047
|
async getProductBundlesBySlug(
|
|
1048
1048
|
{ slug, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1081,7 +1081,7 @@ class Catalog {
|
|
|
1081
1081
|
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
1082
1082
|
* @name getProductComparisonBySlugs
|
|
1083
1083
|
* @summary: List products for comparison
|
|
1084
|
-
* @description: Get all the products that have the same category. - Check out [method documentation](https://
|
|
1084
|
+
* @description: Get all the products that have the same category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
1085
1085
|
*/
|
|
1086
1086
|
async getProductComparisonBySlugs(
|
|
1087
1087
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1119,7 +1119,7 @@ class Catalog {
|
|
|
1119
1119
|
* @returns {Promise<ProductDetail>} - Success response
|
|
1120
1120
|
* @name getProductDetailBySlug
|
|
1121
1121
|
* @summary: Get a product
|
|
1122
|
-
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://
|
|
1122
|
+
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductDetailBySlug/).
|
|
1123
1123
|
*/
|
|
1124
1124
|
async getProductDetailBySlug(
|
|
1125
1125
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1165,7 +1165,7 @@ class Catalog {
|
|
|
1165
1165
|
* @returns {Promise<ProductSizePriceResponseV4>} - Success response
|
|
1166
1166
|
* @name getProductPriceBySlug
|
|
1167
1167
|
* @summary: Get product price
|
|
1168
|
-
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://
|
|
1168
|
+
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
1169
1169
|
*/
|
|
1170
1170
|
async getProductPriceBySlug(
|
|
1171
1171
|
{ slug, size, storeId, moq, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1213,7 +1213,7 @@ class Catalog {
|
|
|
1213
1213
|
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
1214
1214
|
* @name getProductSellersBySlug
|
|
1215
1215
|
* @summary: List sellers
|
|
1216
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://
|
|
1216
|
+
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
1217
1217
|
*/
|
|
1218
1218
|
async getProductSellersBySlug(
|
|
1219
1219
|
{ slug, size, strategy, pageNo, pageSize, requestHeaders } = {
|
|
@@ -1302,7 +1302,7 @@ class Catalog {
|
|
|
1302
1302
|
* @returns {Promise<ProductSizes>} - Success response
|
|
1303
1303
|
* @name getProductSizesBySlug
|
|
1304
1304
|
* @summary: List sizes
|
|
1305
|
-
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://
|
|
1305
|
+
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSizesBySlug/).
|
|
1306
1306
|
*/
|
|
1307
1307
|
async getProductSizesBySlug(
|
|
1308
1308
|
{ slug, storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1349,7 +1349,7 @@ class Catalog {
|
|
|
1349
1349
|
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
1350
1350
|
* @name getProductStockByIds
|
|
1351
1351
|
* @summary: Get product stocks
|
|
1352
|
-
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://
|
|
1352
|
+
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockByIds/).
|
|
1353
1353
|
*/
|
|
1354
1354
|
async getProductStockByIds(
|
|
1355
1355
|
{ itemId, alu, skuCode, ean, upc, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1391,7 +1391,7 @@ class Catalog {
|
|
|
1391
1391
|
* @returns {Promise<ProductStockPolling>} - Success response
|
|
1392
1392
|
* @name getProductStockForTimeByIds
|
|
1393
1393
|
* @summary: List future stock
|
|
1394
|
-
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://
|
|
1394
|
+
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
1395
1395
|
*/
|
|
1396
1396
|
async getProductStockForTimeByIds(
|
|
1397
1397
|
{ timestamp, pageSize, pageId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1460,7 +1460,7 @@ class Catalog {
|
|
|
1460
1460
|
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
1461
1461
|
* @name getProductVariantsBySlug
|
|
1462
1462
|
* @summary: List product variants
|
|
1463
|
-
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://
|
|
1463
|
+
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductVariantsBySlug/).
|
|
1464
1464
|
*/
|
|
1465
1465
|
async getProductVariantsBySlug(
|
|
1466
1466
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1506,7 +1506,7 @@ class Catalog {
|
|
|
1506
1506
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
1507
1507
|
* @name getProducts
|
|
1508
1508
|
* @summary: List products
|
|
1509
|
-
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://
|
|
1509
|
+
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProducts/).
|
|
1510
1510
|
*/
|
|
1511
1511
|
async getProducts(
|
|
1512
1512
|
{
|
|
@@ -1605,7 +1605,7 @@ class Catalog {
|
|
|
1605
1605
|
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
1606
1606
|
* @name getSearchResults
|
|
1607
1607
|
* @summary: List product, brand, category
|
|
1608
|
-
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://
|
|
1608
|
+
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSearchResults/).
|
|
1609
1609
|
*/
|
|
1610
1610
|
async getSearchResults(
|
|
1611
1611
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1643,7 +1643,7 @@ class Catalog {
|
|
|
1643
1643
|
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
1644
1644
|
* @name getSimilarComparisonProductBySlug
|
|
1645
1645
|
* @summary: List similar products
|
|
1646
|
-
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://
|
|
1646
|
+
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
1647
1647
|
*/
|
|
1648
1648
|
async getSimilarComparisonProductBySlug(
|
|
1649
1649
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1689,7 +1689,7 @@ class Catalog {
|
|
|
1689
1689
|
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
1690
1690
|
* @name getStores
|
|
1691
1691
|
* @summary: List available stores
|
|
1692
|
-
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://
|
|
1692
|
+
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getStores/).
|
|
1693
1693
|
*/
|
|
1694
1694
|
async getStores(
|
|
1695
1695
|
{
|
|
@@ -1794,7 +1794,7 @@ class Catalog {
|
|
|
1794
1794
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
1795
1795
|
* @name unfollowById
|
|
1796
1796
|
* @summary: Delete item, brand, product
|
|
1797
|
-
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://
|
|
1797
|
+
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/unfollowById/).
|
|
1798
1798
|
*/
|
|
1799
1799
|
async unfollowById(
|
|
1800
1800
|
{ collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -14,7 +14,7 @@ declare class Common {
|
|
|
14
14
|
* @returns {Promise<Locations>} - Success response
|
|
15
15
|
* @name getLocations
|
|
16
16
|
* @summary: Get a location
|
|
17
|
-
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://
|
|
17
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/getLocations/).
|
|
18
18
|
*/
|
|
19
19
|
getLocations({ locationType, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Locations>;
|
|
20
20
|
/**
|
|
@@ -23,7 +23,7 @@ declare class Common {
|
|
|
23
23
|
* @returns {Promise<ApplicationResponseSchema>} - Success response
|
|
24
24
|
* @name searchApplication
|
|
25
25
|
* @summary: Get sales channel
|
|
26
|
-
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://
|
|
26
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/searchApplication/).
|
|
27
27
|
*/
|
|
28
28
|
searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponseSchema>;
|
|
29
29
|
}
|
|
@@ -38,7 +38,7 @@ class Common {
|
|
|
38
38
|
* @returns {Promise<Locations>} - Success response
|
|
39
39
|
* @name getLocations
|
|
40
40
|
* @summary: Get a location
|
|
41
|
-
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://
|
|
41
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/getLocations/).
|
|
42
42
|
*/
|
|
43
43
|
async getLocations(
|
|
44
44
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -77,7 +77,7 @@ class Common {
|
|
|
77
77
|
* @returns {Promise<ApplicationResponseSchema>} - Success response
|
|
78
78
|
* @name searchApplication
|
|
79
79
|
* @summary: Get sales channel
|
|
80
|
-
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://
|
|
80
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/common/searchApplication/).
|
|
81
81
|
*/
|
|
82
82
|
async searchApplication(
|
|
83
83
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -15,7 +15,7 @@ declare class Communication {
|
|
|
15
15
|
* @returns {Promise<CommunicationConsent>} - Success response
|
|
16
16
|
* @name getCommunicationConsent
|
|
17
17
|
* @summary: Retrieve consent status
|
|
18
|
-
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://
|
|
18
|
+
* @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/getCommunicationConsent/).
|
|
19
19
|
*/
|
|
20
20
|
getCommunicationConsent({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsent>;
|
|
21
21
|
/**
|
|
@@ -24,7 +24,7 @@ declare class Communication {
|
|
|
24
24
|
* @returns {Promise<PushtokenRes>} - Success response
|
|
25
25
|
* @name upsertAppPushtoken
|
|
26
26
|
* @summary: Update or adds app push token
|
|
27
|
-
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://
|
|
27
|
+
* @description: Update or inserts the push token of the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertAppPushtoken/).
|
|
28
28
|
*/
|
|
29
29
|
upsertAppPushtoken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PushtokenRes>;
|
|
30
30
|
/**
|
|
@@ -33,7 +33,7 @@ declare class Communication {
|
|
|
33
33
|
* @returns {Promise<CommunicationConsentRes>} - Success response
|
|
34
34
|
* @name upsertCommunicationConsent
|
|
35
35
|
* @summary: Update or adds consent settings
|
|
36
|
-
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://
|
|
36
|
+
* @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/communication/upsertCommunicationConsent/).
|
|
37
37
|
*/
|
|
38
38
|
upsertCommunicationConsent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsentRes>;
|
|
39
39
|
}
|