@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -25,8 +25,8 @@ class Catalog {
|
|
|
25
25
|
* - Success response
|
|
26
26
|
*
|
|
27
27
|
* @name addCollectionItems
|
|
28
|
-
* @summary:
|
|
29
|
-
* @description: Adds items to a collection specified by its
|
|
28
|
+
* @summary: Create items in a collection
|
|
29
|
+
* @description: Adds items to a collection specified by its id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
|
|
30
30
|
*/
|
|
31
31
|
async addCollectionItems(
|
|
32
32
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -108,8 +108,8 @@ class Catalog {
|
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
110
110
|
* @name createAppCategoryReturnConfiguration
|
|
111
|
-
* @summary: Create
|
|
112
|
-
* @description: Create Category level
|
|
111
|
+
* @summary: Create return configuration
|
|
112
|
+
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
113
113
|
*/
|
|
114
114
|
async createAppCategoryReturnConfiguration(
|
|
115
115
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -189,8 +189,8 @@ class Catalog {
|
|
|
189
189
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
190
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
191
191
|
* @name createAppReturnConfiguration
|
|
192
|
-
* @summary: Create
|
|
193
|
-
* @description:
|
|
192
|
+
* @summary: Create product return configuration
|
|
193
|
+
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
194
194
|
*/
|
|
195
195
|
async createAppReturnConfiguration(
|
|
196
196
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -269,8 +269,8 @@ class Catalog {
|
|
|
269
269
|
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
|
|
270
270
|
* Success response
|
|
271
271
|
* @name createCollection
|
|
272
|
-
* @summary:
|
|
273
|
-
* @description: Create a collection to
|
|
272
|
+
* @summary: Create a collection
|
|
273
|
+
* @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
274
274
|
*/
|
|
275
275
|
async createCollection(
|
|
276
276
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -351,8 +351,8 @@ class Catalog {
|
|
|
351
351
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
352
352
|
* Success response
|
|
353
353
|
* @name createConfigurationByType
|
|
354
|
-
* @summary: Create configuration
|
|
355
|
-
* @description: Add configuration for
|
|
354
|
+
* @summary: Create configuration
|
|
355
|
+
* @description: Add configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
|
|
356
356
|
*/
|
|
357
357
|
async createConfigurationByType(
|
|
358
358
|
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -435,8 +435,8 @@ class Catalog {
|
|
|
435
435
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
436
436
|
* Success response
|
|
437
437
|
* @name createConfigurationProductListing
|
|
438
|
-
* @summary: Create
|
|
439
|
-
* @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
438
|
+
* @summary: Create product listing configuration
|
|
439
|
+
* @description: Add configuration for products & listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
440
440
|
*/
|
|
441
441
|
async createConfigurationProductListing(
|
|
442
442
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -518,8 +518,8 @@ class Catalog {
|
|
|
518
518
|
* - Success response
|
|
519
519
|
*
|
|
520
520
|
* @name createCustomAutocompleteRule
|
|
521
|
-
* @summary: Create
|
|
522
|
-
* @description:
|
|
521
|
+
* @summary: Create autocomplete configurations
|
|
522
|
+
* @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
523
523
|
*/
|
|
524
524
|
async createCustomAutocompleteRule(
|
|
525
525
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -599,8 +599,8 @@ class Catalog {
|
|
|
599
599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
600
600
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
601
601
|
* @name createCustomKeyword
|
|
602
|
-
* @summary: Create
|
|
603
|
-
* @description: Create a Custom Search Keywords.
|
|
602
|
+
* @summary: Create search keywords
|
|
603
|
+
* @description: Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
|
|
604
604
|
*/
|
|
605
605
|
async createCustomKeyword(
|
|
606
606
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -681,7 +681,7 @@ class Catalog {
|
|
|
681
681
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
682
682
|
* @name createGroupConfiguration
|
|
683
683
|
* @summary: Create group configuration
|
|
684
|
-
* @description: Create configuration for
|
|
684
|
+
* @description: Create group configuration for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
|
|
685
685
|
*/
|
|
686
686
|
async createGroupConfiguration(
|
|
687
687
|
{ configType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -764,7 +764,7 @@ class Catalog {
|
|
|
764
764
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
765
765
|
* @name createListingConfiguration
|
|
766
766
|
* @summary: Create listing configuration
|
|
767
|
-
* @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
767
|
+
* @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
768
768
|
*/
|
|
769
769
|
async createListingConfiguration(
|
|
770
770
|
{ configType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -849,7 +849,7 @@ class Catalog {
|
|
|
849
849
|
*
|
|
850
850
|
* @name createSearchConfiguration
|
|
851
851
|
* @summary: Create search configuration
|
|
852
|
-
* @description: Create search configuration for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
852
|
+
* @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
853
853
|
*/
|
|
854
854
|
async createSearchConfiguration(
|
|
855
855
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -929,8 +929,8 @@ class Catalog {
|
|
|
929
929
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
930
930
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
931
931
|
* @name deleteAppCategoryReturnConfiguration
|
|
932
|
-
* @summary: Delete
|
|
933
|
-
* @description: Delete Category level
|
|
932
|
+
* @summary: Delete product return configuration
|
|
933
|
+
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
934
934
|
*/
|
|
935
935
|
async deleteAppCategoryReturnConfiguration(
|
|
936
936
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1010,8 +1010,8 @@ class Catalog {
|
|
|
1010
1010
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1011
1011
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1012
1012
|
* @name deleteAutocompleteKeyword
|
|
1013
|
-
* @summary: Delete autocomplete
|
|
1014
|
-
* @description: Delete
|
|
1013
|
+
* @summary: Delete autocomplete keyword
|
|
1014
|
+
* @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
1015
1015
|
*/
|
|
1016
1016
|
async deleteAutocompleteKeyword(
|
|
1017
1017
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1173,7 +1173,7 @@ class Catalog {
|
|
|
1173
1173
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1174
1174
|
* @name deleteGroupConfiguration
|
|
1175
1175
|
* @summary: Delete group configuration
|
|
1176
|
-
* @description: Delete
|
|
1176
|
+
* @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
1177
1177
|
*/
|
|
1178
1178
|
async deleteGroupConfiguration(
|
|
1179
1179
|
{ configType, groupSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1256,7 +1256,7 @@ class Catalog {
|
|
|
1256
1256
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1257
1257
|
* @name deleteListingConfiguration
|
|
1258
1258
|
* @summary: Delete listing configuration
|
|
1259
|
-
* @description: Remove a specific listing configuration
|
|
1259
|
+
* @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
1260
1260
|
*/
|
|
1261
1261
|
async deleteListingConfiguration(
|
|
1262
1262
|
{ configType, configId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1340,8 +1340,8 @@ class Catalog {
|
|
|
1340
1340
|
* - Success response
|
|
1341
1341
|
*
|
|
1342
1342
|
* @name deleteSearchConfiguration
|
|
1343
|
-
* @summary: Delete
|
|
1344
|
-
* @description: Delete
|
|
1343
|
+
* @summary: Delete search configuration
|
|
1344
|
+
* @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
|
|
1345
1345
|
*/
|
|
1346
1346
|
async deleteSearchConfiguration(
|
|
1347
1347
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1418,7 +1418,7 @@ class Catalog {
|
|
|
1418
1418
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1419
1419
|
* @name deleteSearchKeywords
|
|
1420
1420
|
* @summary: Delete search keywords
|
|
1421
|
-
* @description: Delete a keywords by
|
|
1421
|
+
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
|
|
1422
1422
|
*/
|
|
1423
1423
|
async deleteSearchKeywords(
|
|
1424
1424
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1499,8 +1499,8 @@ class Catalog {
|
|
|
1499
1499
|
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
1500
1500
|
* Success response
|
|
1501
1501
|
* @name getAllCollections
|
|
1502
|
-
* @summary:
|
|
1503
|
-
* @description:
|
|
1502
|
+
* @summary: List collections
|
|
1503
|
+
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
|
|
1504
1504
|
*/
|
|
1505
1505
|
async getAllCollections(
|
|
1506
1506
|
{
|
|
@@ -1616,8 +1616,8 @@ class Catalog {
|
|
|
1616
1616
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1617
1617
|
* page. Default is 12.
|
|
1618
1618
|
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
|
|
1619
|
-
* @summary:
|
|
1620
|
-
* @description:
|
|
1619
|
+
* @summary: List collections
|
|
1620
|
+
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
1621
1621
|
*/
|
|
1622
1622
|
getAllCollectionsPaginator({
|
|
1623
1623
|
companyId,
|
|
@@ -1663,8 +1663,8 @@ class Catalog {
|
|
|
1663
1663
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1664
1664
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
1665
1665
|
* @name getAllSearchKeyword
|
|
1666
|
-
* @summary:
|
|
1667
|
-
* @description:
|
|
1666
|
+
* @summary: List search keywords
|
|
1667
|
+
* @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
1668
1668
|
*/
|
|
1669
1669
|
async getAllSearchKeyword(
|
|
1670
1670
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1742,8 +1742,8 @@ class Catalog {
|
|
|
1742
1742
|
* - Success response
|
|
1743
1743
|
*
|
|
1744
1744
|
* @name getAppCategoryReturnConfig
|
|
1745
|
-
* @summary: Get
|
|
1746
|
-
* @description: Get all category level configuration level set for an
|
|
1745
|
+
* @summary: Get category return configuration
|
|
1746
|
+
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
1747
1747
|
*/
|
|
1748
1748
|
async getAppCategoryReturnConfig(
|
|
1749
1749
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1817,8 +1817,8 @@ class Catalog {
|
|
|
1817
1817
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1818
1818
|
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
1819
1819
|
* @name getAppInventory
|
|
1820
|
-
* @summary:
|
|
1821
|
-
* @description: Retrieve inventory data related to the
|
|
1820
|
+
* @summary: List sales channel inventory
|
|
1821
|
+
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
1822
1822
|
*/
|
|
1823
1823
|
async getAppInventory(
|
|
1824
1824
|
{
|
|
@@ -1924,8 +1924,8 @@ class Catalog {
|
|
|
1924
1924
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1925
1925
|
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
1926
1926
|
* @name getAppLocations
|
|
1927
|
-
* @summary:
|
|
1928
|
-
* @description: Retrieve
|
|
1927
|
+
* @summary: List sales channels
|
|
1928
|
+
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
1929
1929
|
*/
|
|
1930
1930
|
async getAppLocations(
|
|
1931
1931
|
{
|
|
@@ -2046,8 +2046,8 @@ class Catalog {
|
|
|
2046
2046
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
2047
2047
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
2048
2048
|
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
2049
|
-
* @summary:
|
|
2050
|
-
* @description: Retrieve
|
|
2049
|
+
* @summary: List sales channels
|
|
2050
|
+
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified)
|
|
2051
2051
|
*/
|
|
2052
2052
|
getAppLocationsPaginator({
|
|
2053
2053
|
companyId,
|
|
@@ -2093,8 +2093,8 @@ class Catalog {
|
|
|
2093
2093
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2094
2094
|
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
2095
2095
|
* @name getAppProduct
|
|
2096
|
-
* @summary:
|
|
2097
|
-
* @description:
|
|
2096
|
+
* @summary: Get sales channel product
|
|
2097
|
+
* @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
|
|
2098
2098
|
*/
|
|
2099
2099
|
async getAppProduct(
|
|
2100
2100
|
{ itemId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2173,8 +2173,8 @@ class Catalog {
|
|
|
2173
2173
|
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
2174
2174
|
* Success response
|
|
2175
2175
|
* @name getAppProducts
|
|
2176
|
-
* @summary:
|
|
2177
|
-
* @description: Retrieve products specific to the
|
|
2176
|
+
* @summary: List sales channel products
|
|
2177
|
+
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
2178
2178
|
*/
|
|
2179
2179
|
async getAppProducts(
|
|
2180
2180
|
{
|
|
@@ -2295,8 +2295,8 @@ class Catalog {
|
|
|
2295
2295
|
* page. Default is 10.
|
|
2296
2296
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
2297
2297
|
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
2298
|
-
* @summary:
|
|
2299
|
-
* @description: Retrieve products specific to the
|
|
2298
|
+
* @summary: List sales channel products
|
|
2299
|
+
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
2300
2300
|
*/
|
|
2301
2301
|
getAppProductsPaginator({
|
|
2302
2302
|
companyId,
|
|
@@ -2344,8 +2344,8 @@ class Catalog {
|
|
|
2344
2344
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2345
2345
|
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
|
|
2346
2346
|
* @name getAppReturnConfiguration
|
|
2347
|
-
* @summary:
|
|
2348
|
-
* @description: Get Product Return configuration set at an
|
|
2347
|
+
* @summary: get product-return configuration
|
|
2348
|
+
* @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
|
|
2349
2349
|
*/
|
|
2350
2350
|
async getAppReturnConfiguration(
|
|
2351
2351
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2423,8 +2423,8 @@ class Catalog {
|
|
|
2423
2423
|
* - Success response
|
|
2424
2424
|
*
|
|
2425
2425
|
* @name getAppicationProducts
|
|
2426
|
-
* @summary:
|
|
2427
|
-
* @description: Retrieve products associated with the
|
|
2426
|
+
* @summary: List sales channel products
|
|
2427
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
|
|
2428
2428
|
*/
|
|
2429
2429
|
async getAppicationProducts(
|
|
2430
2430
|
{
|
|
@@ -2567,8 +2567,8 @@ class Catalog {
|
|
|
2567
2567
|
* page. Default is 12.
|
|
2568
2568
|
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
2569
2569
|
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2570
|
-
* @summary:
|
|
2571
|
-
* @description: Retrieve products associated with the
|
|
2570
|
+
* @summary: List sales channel products
|
|
2571
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
2572
2572
|
*/
|
|
2573
2573
|
getAppicationProductsPaginator({
|
|
2574
2574
|
companyId,
|
|
@@ -2620,8 +2620,8 @@ class Catalog {
|
|
|
2620
2620
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2621
2621
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2622
2622
|
* @name getApplicationBrandListing
|
|
2623
|
-
* @summary:
|
|
2624
|
-
* @description: Retrieve brand listings related to the
|
|
2623
|
+
* @summary: List sales channel brands
|
|
2624
|
+
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
|
|
2625
2625
|
*/
|
|
2626
2626
|
async getApplicationBrandListing(
|
|
2627
2627
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2711,8 +2711,8 @@ class Catalog {
|
|
|
2711
2711
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2712
2712
|
* to search brands by brand name.
|
|
2713
2713
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2714
|
-
* @summary:
|
|
2715
|
-
* @description: Retrieve brand listings related to the
|
|
2714
|
+
* @summary: List sales channel brands
|
|
2715
|
+
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
|
|
2716
2716
|
*/
|
|
2717
2717
|
getApplicationBrandListingPaginator({
|
|
2718
2718
|
companyId,
|
|
@@ -2750,8 +2750,8 @@ class Catalog {
|
|
|
2750
2750
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2751
2751
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2752
2752
|
* @name getApplicationBrands
|
|
2753
|
-
* @summary:
|
|
2754
|
-
* @description: List all the brands
|
|
2753
|
+
* @summary: List brands
|
|
2754
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
2755
2755
|
*/
|
|
2756
2756
|
async getApplicationBrands(
|
|
2757
2757
|
{ department, pageNo, pageSize, q, brandId, requestHeaders } = {
|
|
@@ -2855,8 +2855,8 @@ class Catalog {
|
|
|
2855
2855
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
2856
2856
|
* basis of uid list.
|
|
2857
2857
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2858
|
-
* @summary:
|
|
2859
|
-
* @description: List all the brands
|
|
2858
|
+
* @summary: List brands
|
|
2859
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc
|
|
2860
2860
|
*/
|
|
2861
2861
|
getApplicationBrandsPaginator({
|
|
2862
2862
|
companyId,
|
|
@@ -2898,8 +2898,8 @@ class Catalog {
|
|
|
2898
2898
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2899
2899
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2900
2900
|
* @name getApplicationCategoryListing
|
|
2901
|
-
* @summary:
|
|
2902
|
-
* @description: Retrieve category listings related to the
|
|
2901
|
+
* @summary: List sales channel categories
|
|
2902
|
+
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
|
|
2903
2903
|
*/
|
|
2904
2904
|
async getApplicationCategoryListing(
|
|
2905
2905
|
{ departmentId, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -2996,8 +2996,8 @@ class Catalog {
|
|
|
2996
2996
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2997
2997
|
* to search brands by brand name.
|
|
2998
2998
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2999
|
-
* @summary:
|
|
3000
|
-
* @description: Retrieve category listings related to the
|
|
2999
|
+
* @summary: List sales channel categories
|
|
3000
|
+
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
|
|
3001
3001
|
*/
|
|
3002
3002
|
getApplicationCategoryListingPaginator({
|
|
3003
3003
|
companyId,
|
|
@@ -3039,8 +3039,8 @@ class Catalog {
|
|
|
3039
3039
|
* - Success response
|
|
3040
3040
|
*
|
|
3041
3041
|
* @name getApplicationDepartmentListing
|
|
3042
|
-
* @summary:
|
|
3043
|
-
* @description: Retrieve department listings related to the
|
|
3042
|
+
* @summary: List sales channel departments
|
|
3043
|
+
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
|
|
3044
3044
|
*/
|
|
3045
3045
|
async getApplicationDepartmentListing(
|
|
3046
3046
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3130,8 +3130,8 @@ class Catalog {
|
|
|
3130
3130
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
3131
3131
|
* to search department by name.
|
|
3132
3132
|
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
3133
|
-
* @summary:
|
|
3134
|
-
* @description: Retrieve department listings related to the
|
|
3133
|
+
* @summary: List sales channel departments
|
|
3134
|
+
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
|
|
3135
3135
|
*/
|
|
3136
3136
|
getApplicationDepartmentListingPaginator({
|
|
3137
3137
|
companyId,
|
|
@@ -3170,8 +3170,8 @@ class Catalog {
|
|
|
3170
3170
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
3171
3171
|
* Success response
|
|
3172
3172
|
* @name getApplicationFilterKeys
|
|
3173
|
-
* @summary:
|
|
3174
|
-
* @description:
|
|
3173
|
+
* @summary: List filter keys
|
|
3174
|
+
* @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
|
|
3175
3175
|
*/
|
|
3176
3176
|
async getApplicationFilterKeys(
|
|
3177
3177
|
{ c, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3253,8 +3253,9 @@ class Catalog {
|
|
|
3253
3253
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
3254
3254
|
* Success response
|
|
3255
3255
|
* @name getApplicationFilterValues
|
|
3256
|
-
* @summary:
|
|
3257
|
-
* @description:
|
|
3256
|
+
* @summary: List product filters
|
|
3257
|
+
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
3258
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
3258
3259
|
*/
|
|
3259
3260
|
async getApplicationFilterValues(
|
|
3260
3261
|
{ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -3353,7 +3354,7 @@ class Catalog {
|
|
|
3353
3354
|
* Success response
|
|
3354
3355
|
* @name getAutocompleteConfig
|
|
3355
3356
|
* @summary: Get autocomplete configuration
|
|
3356
|
-
* @description:
|
|
3357
|
+
* @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
|
|
3357
3358
|
*/
|
|
3358
3359
|
async getAutocompleteConfig(
|
|
3359
3360
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3430,8 +3431,8 @@ class Catalog {
|
|
|
3430
3431
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
3431
3432
|
* Success response
|
|
3432
3433
|
* @name getAutocompleteKeywordDetail
|
|
3433
|
-
* @summary: Get autocomplete keyword
|
|
3434
|
-
* @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
3434
|
+
* @summary: Get autocomplete keyword
|
|
3435
|
+
* @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
3435
3436
|
*/
|
|
3436
3437
|
async getAutocompleteKeywordDetail(
|
|
3437
3438
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3513,8 +3514,8 @@ class Catalog {
|
|
|
3513
3514
|
* - Success response
|
|
3514
3515
|
*
|
|
3515
3516
|
* @name getCatalogConfiguration
|
|
3516
|
-
* @summary:
|
|
3517
|
-
* @description: Retrieve configuration meta
|
|
3517
|
+
* @summary: Get catalog configuration meta data
|
|
3518
|
+
* @description: Retrieve configuration meta data for the catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
|
|
3518
3519
|
*/
|
|
3519
3520
|
async getCatalogConfiguration(
|
|
3520
3521
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3590,8 +3591,8 @@ class Catalog {
|
|
|
3590
3591
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3591
3592
|
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
3592
3593
|
* @name getCatalogInsights
|
|
3593
|
-
* @summary: Get catalog
|
|
3594
|
-
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the
|
|
3594
|
+
* @summary: Get catalog counts
|
|
3595
|
+
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
|
|
3595
3596
|
*/
|
|
3596
3597
|
async getCatalogInsights(
|
|
3597
3598
|
{ brand, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3670,8 +3671,8 @@ class Catalog {
|
|
|
3670
3671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3671
3672
|
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
3672
3673
|
* @name getCategories
|
|
3673
|
-
* @summary:
|
|
3674
|
-
* @description: Retrieve a list of categories
|
|
3674
|
+
* @summary: List categories
|
|
3675
|
+
* @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
|
|
3675
3676
|
*/
|
|
3676
3677
|
async getCategories(
|
|
3677
3678
|
{ department, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3753,7 +3754,7 @@ class Catalog {
|
|
|
3753
3754
|
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
3754
3755
|
* Success response
|
|
3755
3756
|
* @name getCollectionDetail
|
|
3756
|
-
* @summary: Get collection
|
|
3757
|
+
* @summary: Get a collection
|
|
3757
3758
|
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
3758
3759
|
*/
|
|
3759
3760
|
async getCollectionDetail(
|
|
@@ -3835,8 +3836,8 @@ class Catalog {
|
|
|
3835
3836
|
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
|
|
3836
3837
|
* Success response
|
|
3837
3838
|
* @name getCollectionItems
|
|
3838
|
-
* @summary:
|
|
3839
|
-
* @description: Get items from a collection specified by its
|
|
3839
|
+
* @summary: List items of collection
|
|
3840
|
+
* @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
3840
3841
|
*/
|
|
3841
3842
|
async getCollectionItems(
|
|
3842
3843
|
{ id, sortOn, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3927,8 +3928,8 @@ class Catalog {
|
|
|
3927
3928
|
* - Success response
|
|
3928
3929
|
*
|
|
3929
3930
|
* @name getConfigurationByType
|
|
3930
|
-
* @summary:
|
|
3931
|
-
* @description: Retrieve configuration details based on a specific type in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
|
|
3931
|
+
* @summary: Get configuration
|
|
3932
|
+
* @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
|
|
3932
3933
|
*/
|
|
3933
3934
|
async getConfigurationByType(
|
|
3934
3935
|
{ type, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4009,8 +4010,8 @@ class Catalog {
|
|
|
4009
4010
|
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
4010
4011
|
* Success response
|
|
4011
4012
|
* @name getConfigurationMetadata
|
|
4012
|
-
* @summary:
|
|
4013
|
-
* @description: Retrieve the configuraion metadata details for
|
|
4013
|
+
* @summary: Get configuration metadata
|
|
4014
|
+
* @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
4014
4015
|
*/
|
|
4015
4016
|
async getConfigurationMetadata(
|
|
4016
4017
|
{ configType, templateSlug, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -4105,8 +4106,8 @@ class Catalog {
|
|
|
4105
4106
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
4106
4107
|
* Success response
|
|
4107
4108
|
* @name getConfigurations
|
|
4108
|
-
* @summary:
|
|
4109
|
-
* @description: Retrieve a
|
|
4109
|
+
* @summary: Get product configurations
|
|
4110
|
+
* @description: Retrieve a detailed configurations for product catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
4110
4111
|
*/
|
|
4111
4112
|
async getConfigurations(
|
|
4112
4113
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4180,8 +4181,8 @@ class Catalog {
|
|
|
4180
4181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4181
4182
|
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
4182
4183
|
* @name getDepartments
|
|
4183
|
-
* @summary:
|
|
4184
|
-
* @description: Retrieve a list of departments
|
|
4184
|
+
* @summary: List departments
|
|
4185
|
+
* @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
|
|
4185
4186
|
*/
|
|
4186
4187
|
async getDepartments(
|
|
4187
4188
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4259,7 +4260,7 @@ class Catalog {
|
|
|
4259
4260
|
* - Success response
|
|
4260
4261
|
*
|
|
4261
4262
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
4262
|
-
* @summary: Get discounted inventory
|
|
4263
|
+
* @summary: Get discounted inventory
|
|
4263
4264
|
* @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/getDiscountedInventoryBySizeIdentifier/).
|
|
4264
4265
|
*/
|
|
4265
4266
|
async getDiscountedInventoryBySizeIdentifier(
|
|
@@ -4367,7 +4368,7 @@ class Catalog {
|
|
|
4367
4368
|
* @param {string} [arg.q] - Search with help of store code.
|
|
4368
4369
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
4369
4370
|
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
4370
|
-
* @summary: Get discounted inventory
|
|
4371
|
+
* @summary: Get discounted inventory
|
|
4371
4372
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
4372
4373
|
*/
|
|
4373
4374
|
getDiscountedInventoryBySizeIdentifierPaginator({
|
|
@@ -4412,8 +4413,8 @@ class Catalog {
|
|
|
4412
4413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4413
4414
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4414
4415
|
* @name getGroupConfigurations
|
|
4415
|
-
* @summary:
|
|
4416
|
-
* @description: Retrieve the details of
|
|
4416
|
+
* @summary: Get group configurations
|
|
4417
|
+
* @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
|
|
4417
4418
|
*/
|
|
4418
4419
|
async getGroupConfigurations(
|
|
4419
4420
|
{ configType, pageNo, pageSize, search, templateSlug, requestHeaders } = {
|
|
@@ -4507,8 +4508,8 @@ class Catalog {
|
|
|
4507
4508
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4508
4509
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4509
4510
|
* @name getListingConfigurations
|
|
4510
|
-
* @summary:
|
|
4511
|
-
* @description: Retrieve
|
|
4511
|
+
* @summary: Get listing configurations
|
|
4512
|
+
* @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
|
|
4512
4513
|
*/
|
|
4513
4514
|
async getListingConfigurations(
|
|
4514
4515
|
{ configType, pageNo, pageSize, search, requestHeaders } = {
|
|
@@ -4599,8 +4600,8 @@ class Catalog {
|
|
|
4599
4600
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4600
4601
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
4601
4602
|
* @name getProductDetailBySlug
|
|
4602
|
-
* @summary: Get product details
|
|
4603
|
-
* @description: Retrieve detailed product information using a product slug.
|
|
4603
|
+
* @summary: Get product details
|
|
4604
|
+
* @description: Retrieve detailed product information using a product slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
|
|
4604
4605
|
*/
|
|
4605
4606
|
async getProductDetailBySlug(
|
|
4606
4607
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4678,8 +4679,8 @@ class Catalog {
|
|
|
4678
4679
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4679
4680
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
4680
4681
|
* @name getQueryFilters
|
|
4681
|
-
* @summary:
|
|
4682
|
-
* @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
4682
|
+
* @summary: Get collection query filters
|
|
4683
|
+
* @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
4683
4684
|
*/
|
|
4684
4685
|
async getQueryFilters(
|
|
4685
4686
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4757,8 +4758,8 @@ class Catalog {
|
|
|
4757
4758
|
* - Success response
|
|
4758
4759
|
*
|
|
4759
4760
|
* @name getSearchConfiguration
|
|
4760
|
-
* @summary: Get Search
|
|
4761
|
-
* @description: Get search configuration
|
|
4761
|
+
* @summary: Get Search configuration
|
|
4762
|
+
* @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
|
|
4762
4763
|
*/
|
|
4763
4764
|
async getSearchConfiguration(
|
|
4764
4765
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4835,8 +4836,8 @@ class Catalog {
|
|
|
4835
4836
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
4836
4837
|
* Success response
|
|
4837
4838
|
* @name getSearchKeywords
|
|
4838
|
-
* @summary:
|
|
4839
|
-
* @description: Retrieve a list of
|
|
4839
|
+
* @summary: Get search keywords
|
|
4840
|
+
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
4840
4841
|
*/
|
|
4841
4842
|
async getSearchKeywords(
|
|
4842
4843
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4917,7 +4918,7 @@ class Catalog {
|
|
|
4917
4918
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
4918
4919
|
* @name updateAllowSingle
|
|
4919
4920
|
* @summary: Update 'Allow Single' setting
|
|
4920
|
-
* @description: Modify allow single flag for filters of the
|
|
4921
|
+
* @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
4921
4922
|
*/
|
|
4922
4923
|
async updateAllowSingle(
|
|
4923
4924
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4995,8 +4996,8 @@ class Catalog {
|
|
|
4995
4996
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4996
4997
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
4997
4998
|
* @name updateAppBrand
|
|
4998
|
-
* @summary: Update
|
|
4999
|
-
* @description: Modify data associated to
|
|
4999
|
+
* @summary: Update sales channel brand
|
|
5000
|
+
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
5000
5001
|
*/
|
|
5001
5002
|
async updateAppBrand(
|
|
5002
5003
|
{ brandUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5078,8 +5079,8 @@ class Catalog {
|
|
|
5078
5079
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5079
5080
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5080
5081
|
* @name updateAppCategory
|
|
5081
|
-
* @summary: Update
|
|
5082
|
-
* @description: Modify category data related to the
|
|
5082
|
+
* @summary: Update sales channel category
|
|
5083
|
+
* @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
5083
5084
|
*/
|
|
5084
5085
|
async updateAppCategory(
|
|
5085
5086
|
{ categoryUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5161,8 +5162,8 @@ class Catalog {
|
|
|
5161
5162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5162
5163
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
5163
5164
|
* @name updateAppCategoryReturnConfiguration
|
|
5164
|
-
* @summary: Update
|
|
5165
|
-
* @description: Update Category level
|
|
5165
|
+
* @summary: Update return Configuration
|
|
5166
|
+
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
5166
5167
|
*/
|
|
5167
5168
|
async updateAppCategoryReturnConfiguration(
|
|
5168
5169
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5242,8 +5243,8 @@ class Catalog {
|
|
|
5242
5243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5243
5244
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5244
5245
|
* @name updateAppDepartment
|
|
5245
|
-
* @summary: Update
|
|
5246
|
-
* @description: Modify department data
|
|
5246
|
+
* @summary: Update sales channel department
|
|
5247
|
+
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
5247
5248
|
*/
|
|
5248
5249
|
async updateAppDepartment(
|
|
5249
5250
|
{ departmentUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5325,8 +5326,8 @@ class Catalog {
|
|
|
5325
5326
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5326
5327
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5327
5328
|
* @name updateAppLocation
|
|
5328
|
-
* @summary: Update
|
|
5329
|
-
* @description: Modify location data related to the
|
|
5329
|
+
* @summary: Update sales channel location
|
|
5330
|
+
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
5330
5331
|
*/
|
|
5331
5332
|
async updateAppLocation(
|
|
5332
5333
|
{ storeUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5406,8 +5407,8 @@ class Catalog {
|
|
|
5406
5407
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5407
5408
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5408
5409
|
* @name updateAppProduct
|
|
5409
|
-
* @summary: Update
|
|
5410
|
-
* @description: Allows to update data associated to a item
|
|
5410
|
+
* @summary: Update sales channel product
|
|
5411
|
+
* @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
5411
5412
|
*/
|
|
5412
5413
|
async updateAppProduct(
|
|
5413
5414
|
{ itemId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5489,8 +5490,8 @@ class Catalog {
|
|
|
5489
5490
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5490
5491
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5491
5492
|
* @name updateAppReturnConfiguration
|
|
5492
|
-
* @summary: Update
|
|
5493
|
-
* @description: Update Return configuration level set for an
|
|
5493
|
+
* @summary: Update product return configuration
|
|
5494
|
+
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
5494
5495
|
*/
|
|
5495
5496
|
async updateAppReturnConfiguration(
|
|
5496
5497
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5571,8 +5572,8 @@ class Catalog {
|
|
|
5571
5572
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
5572
5573
|
* Success response
|
|
5573
5574
|
* @name updateAutocompleteKeyword
|
|
5574
|
-
* @summary: Update autocomplete
|
|
5575
|
-
* @description: Update a
|
|
5575
|
+
* @summary: Update autocomplete keyword
|
|
5576
|
+
* @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
5576
5577
|
*/
|
|
5577
5578
|
async updateAutocompleteKeyword(
|
|
5578
5579
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5736,7 +5737,7 @@ class Catalog {
|
|
|
5736
5737
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
5737
5738
|
* @name updateDefaultSort
|
|
5738
5739
|
* @summary: Update default sorting
|
|
5739
|
-
* @description: Modify the default sort key configuration for
|
|
5740
|
+
* @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
5740
5741
|
*/
|
|
5741
5742
|
async updateDefaultSort(
|
|
5742
5743
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5817,7 +5818,7 @@ class Catalog {
|
|
|
5817
5818
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
5818
5819
|
* @name updateGroupConfiguration
|
|
5819
5820
|
* @summary: Update group configuration
|
|
5820
|
-
* @description: Modify
|
|
5821
|
+
* @description: Modify group configurations by its slug for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
|
|
5821
5822
|
*/
|
|
5822
5823
|
async updateGroupConfiguration(
|
|
5823
5824
|
{ configType, groupSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5902,7 +5903,7 @@ class Catalog {
|
|
|
5902
5903
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
5903
5904
|
* @name updateListingConfiguration
|
|
5904
5905
|
* @summary: Update listing configuration
|
|
5905
|
-
* @description: Modify
|
|
5906
|
+
* @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
|
|
5906
5907
|
*/
|
|
5907
5908
|
async updateListingConfiguration(
|
|
5908
5909
|
{ configType, configId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5988,8 +5989,8 @@ class Catalog {
|
|
|
5988
5989
|
* - Success response
|
|
5989
5990
|
*
|
|
5990
5991
|
* @name updateSearchConfiguration
|
|
5991
|
-
* @summary: Update search configuration
|
|
5992
|
-
* @description:
|
|
5992
|
+
* @summary: Update search configuration
|
|
5993
|
+
* @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
|
|
5993
5994
|
*/
|
|
5994
5995
|
async updateSearchConfiguration(
|
|
5995
5996
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6070,7 +6071,7 @@ class Catalog {
|
|
|
6070
6071
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
6071
6072
|
* @name updateSearchKeywords
|
|
6072
6073
|
* @summary: Update search keywords
|
|
6073
|
-
* @description: Update
|
|
6074
|
+
* @description: Update a specific search keyword by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
|
|
6074
6075
|
*/
|
|
6075
6076
|
async updateSearchKeywords(
|
|
6076
6077
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|