@gofynd/fdk-client-javascript 2.0.2 → 3.0.0
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/partner/Logistics/LogisticsPartnerModel.d.ts +4 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -4
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +227 -35
- package/sdk/platform/Catalog/CatalogPlatformModel.js +110 -23
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +6 -8
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +5 -7
- package/sdk/platform/Common/CommonPlatformModel.d.ts +10 -16
- package/sdk/platform/Common/CommonPlatformModel.js +5 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +62 -99
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +30 -50
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +9 -6
- package/sdk/platform/Content/ContentPlatformClient.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformClient.js +14 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +22 -17
- package/sdk/platform/Content/ContentPlatformModel.js +19 -17
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +2 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +2 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +4 -1
- package/sdk/public/Catalog/CatalogPublicModel.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +6 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +3 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +4 -8
- package/sdk/public/Content/ContentPublicModel.js +2 -4
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version:
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.0.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -464,7 +464,7 @@ export = LogisticsPartnerModel;
|
|
|
464
464
|
*/
|
|
465
465
|
/**
|
|
466
466
|
* @typedef ValidationErrors
|
|
467
|
-
* @property {ValidationError[]} errors
|
|
467
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
468
468
|
*/
|
|
469
469
|
/**
|
|
470
470
|
* @typedef CreatedBy
|
|
@@ -1706,6 +1706,9 @@ type StandardError = {
|
|
|
1706
1706
|
/** @returns {ValidationErrors} */
|
|
1707
1707
|
declare function ValidationErrors(): ValidationErrors;
|
|
1708
1708
|
type ValidationErrors = {
|
|
1709
|
+
/**
|
|
1710
|
+
* - A list of validation errors in the request.
|
|
1711
|
+
*/
|
|
1709
1712
|
errors: ValidationError[];
|
|
1710
1713
|
};
|
|
1711
1714
|
/** @returns {CreatedBy} */
|
|
@@ -546,7 +546,7 @@ class Theme {
|
|
|
546
546
|
const response = await PartnerAPIClient.execute(
|
|
547
547
|
this.config,
|
|
548
548
|
"get",
|
|
549
|
-
`/service/partner/theme/
|
|
549
|
+
`/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/themes`,
|
|
550
550
|
query_params,
|
|
551
551
|
undefined,
|
|
552
552
|
requestHeaders,
|
|
@@ -620,7 +620,7 @@ class Theme {
|
|
|
620
620
|
const response = await PartnerAPIClient.execute(
|
|
621
621
|
this.config,
|
|
622
622
|
"get",
|
|
623
|
-
`/service/partner/theme/
|
|
623
|
+
`/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
|
|
624
624
|
query_params,
|
|
625
625
|
undefined,
|
|
626
626
|
requestHeaders,
|
|
@@ -704,7 +704,7 @@ class Theme {
|
|
|
704
704
|
const response = await PartnerAPIClient.execute(
|
|
705
705
|
this.config,
|
|
706
706
|
"put",
|
|
707
|
-
`/service/partner/theme/
|
|
707
|
+
`/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
|
|
708
708
|
query_params,
|
|
709
709
|
body,
|
|
710
710
|
requestHeaders,
|
|
@@ -781,7 +781,7 @@ class Theme {
|
|
|
781
781
|
const response = await PartnerAPIClient.execute(
|
|
782
782
|
this.config,
|
|
783
783
|
"delete",
|
|
784
|
-
`/service/partner/theme/
|
|
784
|
+
`/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
|
|
785
785
|
query_params,
|
|
786
786
|
undefined,
|
|
787
787
|
requestHeaders,
|
|
@@ -22,7 +22,7 @@ export = WebhookPartnerModel;
|
|
|
22
22
|
/**
|
|
23
23
|
* @typedef AuthMeta
|
|
24
24
|
* @property {string} [type] - Specifies the type of authentication used.
|
|
25
|
-
* @property {string} [secret] - Contains the
|
|
25
|
+
* @property {string} [secret] - Contains the key or token used for authentication.
|
|
26
26
|
*/
|
|
27
27
|
/**
|
|
28
28
|
* @typedef BroadcasterConfig
|
|
@@ -373,7 +373,7 @@ type AuthMeta = {
|
|
|
373
373
|
*/
|
|
374
374
|
type?: string;
|
|
375
375
|
/**
|
|
376
|
-
* - Contains the
|
|
376
|
+
* - Contains the key or token used for authentication.
|
|
377
377
|
*/
|
|
378
378
|
secret?: string;
|
|
379
379
|
};
|
|
@@ -26,7 +26,7 @@ const Joi = require("joi");
|
|
|
26
26
|
/**
|
|
27
27
|
* @typedef AuthMeta
|
|
28
28
|
* @property {string} [type] - Specifies the type of authentication used.
|
|
29
|
-
* @property {string} [secret] - Contains the
|
|
29
|
+
* @property {string} [secret] - Contains the key or token used for authentication.
|
|
30
30
|
*/
|
|
31
31
|
|
|
32
32
|
/**
|
|
@@ -179,7 +179,7 @@ declare class Catalog {
|
|
|
179
179
|
* @summary: Delete product
|
|
180
180
|
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
181
181
|
*/
|
|
182
|
-
deleteProduct({ itemId,
|
|
182
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
183
183
|
/**
|
|
184
184
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
185
185
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1316,13 +1316,12 @@ class Catalog {
|
|
|
1316
1316
|
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
1317
1317
|
*/
|
|
1318
1318
|
async deleteProduct(
|
|
1319
|
-
{ itemId,
|
|
1319
|
+
{ itemId, requestHeaders } = { requestHeaders: {} },
|
|
1320
1320
|
{ responseHeaders } = { responseHeaders: false }
|
|
1321
1321
|
) {
|
|
1322
1322
|
const { error } = CatalogPlatformValidator.deleteProduct().validate(
|
|
1323
1323
|
{
|
|
1324
1324
|
itemId,
|
|
1325
|
-
body,
|
|
1326
1325
|
},
|
|
1327
1326
|
{ abortEarly: false, allowUnknown: true }
|
|
1328
1327
|
);
|
|
@@ -1336,7 +1335,6 @@ class Catalog {
|
|
|
1336
1335
|
} = CatalogPlatformValidator.deleteProduct().validate(
|
|
1337
1336
|
{
|
|
1338
1337
|
itemId,
|
|
1339
|
-
body,
|
|
1340
1338
|
},
|
|
1341
1339
|
{ abortEarly: false, allowUnknown: false }
|
|
1342
1340
|
);
|
|
@@ -1356,7 +1354,7 @@ class Catalog {
|
|
|
1356
1354
|
"delete",
|
|
1357
1355
|
`/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/`,
|
|
1358
1356
|
query_params,
|
|
1359
|
-
|
|
1357
|
+
undefined,
|
|
1360
1358
|
{ ...xHeaders, ...requestHeaders },
|
|
1361
1359
|
{ responseHeaders }
|
|
1362
1360
|
);
|
|
@@ -7,7 +7,7 @@ export = CatalogPlatformModel;
|
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
9
|
* @typedef ValidationErrors
|
|
10
|
-
* @property {ValidationError[]} errors
|
|
10
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* @typedef AllSizes
|
|
@@ -1135,14 +1135,6 @@ export = CatalogPlatformModel;
|
|
|
1135
1135
|
* @typedef DeleteAppCategoryReturnConfig
|
|
1136
1136
|
* @property {number[]} category_ids - List of category_ids to be deleted.
|
|
1137
1137
|
*/
|
|
1138
|
-
/**
|
|
1139
|
-
* @typedef DeleteProductRequestBody
|
|
1140
|
-
* @property {number} [brand_uid] - The brand identifier for the product.
|
|
1141
|
-
* @property {string} [item_code] - The code of the item to be deleted.
|
|
1142
|
-
* @property {string} [company_id] - The ID of the company. (Optional if already
|
|
1143
|
-
* provided in the path)
|
|
1144
|
-
* @property {number} [item_id] - The ID of the product.
|
|
1145
|
-
*/
|
|
1146
1138
|
/**
|
|
1147
1139
|
* @typedef DeleteResponseSchema
|
|
1148
1140
|
* @property {string} [message]
|
|
@@ -2946,7 +2938,7 @@ export = CatalogPlatformModel;
|
|
|
2946
2938
|
* @property {boolean} [multivalue]
|
|
2947
2939
|
*/
|
|
2948
2940
|
/**
|
|
2949
|
-
* @typedef
|
|
2941
|
+
* @typedef ProductUpdateSchemaV2
|
|
2950
2942
|
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
2951
2943
|
* additional product properties.
|
|
2952
2944
|
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
@@ -3002,6 +2994,62 @@ export = CatalogPlatformModel;
|
|
|
3002
2994
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3003
2995
|
* @property {Object} [variants] - Variants information for the product.
|
|
3004
2996
|
*/
|
|
2997
|
+
/**
|
|
2998
|
+
* @typedef ProductCreateSchemaV2
|
|
2999
|
+
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3000
|
+
* additional product properties.
|
|
3001
|
+
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3002
|
+
* upsert, update, delete).
|
|
3003
|
+
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3004
|
+
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3005
|
+
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3006
|
+
* @property {string} category_slug - The category to which the product belongs.
|
|
3007
|
+
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3008
|
+
* @property {number} company_id - Unique identifier for the company associated
|
|
3009
|
+
* with the product.
|
|
3010
|
+
* @property {string} country_of_origin - The country where the product was
|
|
3011
|
+
* manufactured or sourced.
|
|
3012
|
+
* @property {string} currency - The currency in which the product's price is listed.
|
|
3013
|
+
* @property {CustomOrder} [custom_order]
|
|
3014
|
+
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3015
|
+
* @property {string} [description] - A detailed description of the product.
|
|
3016
|
+
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3017
|
+
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3018
|
+
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3019
|
+
* dependent on other products.
|
|
3020
|
+
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3021
|
+
* does not have associated images.
|
|
3022
|
+
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3023
|
+
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3024
|
+
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3025
|
+
* composite, digital).
|
|
3026
|
+
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3027
|
+
* with the product.
|
|
3028
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3029
|
+
* @property {string} name - The name of the product.
|
|
3030
|
+
* @property {NetQuantity} [net_quantity]
|
|
3031
|
+
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3032
|
+
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3033
|
+
* for classification.
|
|
3034
|
+
* @property {ProductPublish} [product_publish]
|
|
3035
|
+
* @property {string} [requester] - The role requesting the product operation
|
|
3036
|
+
* (admin or user).
|
|
3037
|
+
* @property {ReturnConfig} return_config
|
|
3038
|
+
* @property {string} [short_description] - A short description of the product,
|
|
3039
|
+
* up to 50 characters.
|
|
3040
|
+
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3041
|
+
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3042
|
+
* @property {string} slug - URL-friendly identifier for the product.
|
|
3043
|
+
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3044
|
+
* @property {TaxIdentifier} tax_identifier
|
|
3045
|
+
* @property {TeaserTag} [teaser_tag]
|
|
3046
|
+
* @property {string} template_tag - Template tag for the product, used for
|
|
3047
|
+
* classification.
|
|
3048
|
+
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3049
|
+
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3050
|
+
* @property {Object} [variant_media] - Media related to product variants.
|
|
3051
|
+
* @property {Object} [variants] - Variants information for the product.
|
|
3052
|
+
*/
|
|
3005
3053
|
/**
|
|
3006
3054
|
* @typedef ProductDetail
|
|
3007
3055
|
* @property {Object} [attributes] - Key-value pairs representing various
|
|
@@ -4328,7 +4376,7 @@ export = CatalogPlatformModel;
|
|
|
4328
4376
|
declare class CatalogPlatformModel {
|
|
4329
4377
|
}
|
|
4330
4378
|
declare namespace CatalogPlatformModel {
|
|
4331
|
-
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig,
|
|
4379
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType, CurrencyCodeEnum };
|
|
4332
4380
|
}
|
|
4333
4381
|
/** @returns {Action} */
|
|
4334
4382
|
declare function Action(): Action;
|
|
@@ -4343,6 +4391,9 @@ type Action = {
|
|
|
4343
4391
|
/** @returns {ValidationErrors} */
|
|
4344
4392
|
declare function ValidationErrors(): ValidationErrors;
|
|
4345
4393
|
type ValidationErrors = {
|
|
4394
|
+
/**
|
|
4395
|
+
* - A list of validation errors in the request.
|
|
4396
|
+
*/
|
|
4346
4397
|
errors: ValidationError[];
|
|
4347
4398
|
};
|
|
4348
4399
|
/** @returns {AllSizes} */
|
|
@@ -6597,27 +6648,6 @@ type DeleteAppCategoryReturnConfig = {
|
|
|
6597
6648
|
*/
|
|
6598
6649
|
category_ids: number[];
|
|
6599
6650
|
};
|
|
6600
|
-
/** @returns {DeleteProductRequestBody} */
|
|
6601
|
-
declare function DeleteProductRequestBody(): DeleteProductRequestBody;
|
|
6602
|
-
type DeleteProductRequestBody = {
|
|
6603
|
-
/**
|
|
6604
|
-
* - The brand identifier for the product.
|
|
6605
|
-
*/
|
|
6606
|
-
brand_uid?: number;
|
|
6607
|
-
/**
|
|
6608
|
-
* - The code of the item to be deleted.
|
|
6609
|
-
*/
|
|
6610
|
-
item_code?: string;
|
|
6611
|
-
/**
|
|
6612
|
-
* - The ID of the company. (Optional if already
|
|
6613
|
-
* provided in the path)
|
|
6614
|
-
*/
|
|
6615
|
-
company_id?: string;
|
|
6616
|
-
/**
|
|
6617
|
-
* - The ID of the product.
|
|
6618
|
-
*/
|
|
6619
|
-
item_id?: number;
|
|
6620
|
-
};
|
|
6621
6651
|
/** @returns {DeleteResponseSchema} */
|
|
6622
6652
|
declare function DeleteResponseSchema(): DeleteResponseSchema;
|
|
6623
6653
|
type DeleteResponseSchema = {
|
|
@@ -10636,9 +10666,9 @@ type ProductConfigurationDownloads = {
|
|
|
10636
10666
|
data?: any[];
|
|
10637
10667
|
multivalue?: boolean;
|
|
10638
10668
|
};
|
|
10639
|
-
/** @returns {
|
|
10640
|
-
declare function
|
|
10641
|
-
type
|
|
10669
|
+
/** @returns {ProductUpdateSchemaV2} */
|
|
10670
|
+
declare function ProductUpdateSchemaV2(): ProductUpdateSchemaV2;
|
|
10671
|
+
type ProductUpdateSchemaV2 = {
|
|
10642
10672
|
/**
|
|
10643
10673
|
* - Custom JSON data that can be used for
|
|
10644
10674
|
* additional product properties.
|
|
@@ -10802,6 +10832,168 @@ type ProductCreateUpdateSchemaV2 = {
|
|
|
10802
10832
|
*/
|
|
10803
10833
|
variants?: any;
|
|
10804
10834
|
};
|
|
10835
|
+
/** @returns {ProductCreateSchemaV2} */
|
|
10836
|
+
declare function ProductCreateSchemaV2(): ProductCreateSchemaV2;
|
|
10837
|
+
type ProductCreateSchemaV2 = {
|
|
10838
|
+
/**
|
|
10839
|
+
* - Custom JSON data that can be used for
|
|
10840
|
+
* additional product properties.
|
|
10841
|
+
*/
|
|
10842
|
+
_custom_json?: any;
|
|
10843
|
+
/**
|
|
10844
|
+
* - The action to perform wrt to the product (e.g.,
|
|
10845
|
+
* upsert, update, delete).
|
|
10846
|
+
*/
|
|
10847
|
+
action?: string;
|
|
10848
|
+
/**
|
|
10849
|
+
* - Additional attributes related to the product.
|
|
10850
|
+
*/
|
|
10851
|
+
attributes?: any;
|
|
10852
|
+
/**
|
|
10853
|
+
* - Unique identifier for the product's brand.
|
|
10854
|
+
*/
|
|
10855
|
+
brand_uid: number;
|
|
10856
|
+
/**
|
|
10857
|
+
* - Job ID associated with bulk operations.
|
|
10858
|
+
*/
|
|
10859
|
+
bulk_job_id?: string;
|
|
10860
|
+
/**
|
|
10861
|
+
* - The category to which the product belongs.
|
|
10862
|
+
*/
|
|
10863
|
+
category_slug: string;
|
|
10864
|
+
/**
|
|
10865
|
+
* - Change request identifier for product updates.
|
|
10866
|
+
*/
|
|
10867
|
+
change_request_id?: string;
|
|
10868
|
+
/**
|
|
10869
|
+
* - Unique identifier for the company associated
|
|
10870
|
+
* with the product.
|
|
10871
|
+
*/
|
|
10872
|
+
company_id: number;
|
|
10873
|
+
/**
|
|
10874
|
+
* - The country where the product was
|
|
10875
|
+
* manufactured or sourced.
|
|
10876
|
+
*/
|
|
10877
|
+
country_of_origin: string;
|
|
10878
|
+
/**
|
|
10879
|
+
* - The currency in which the product's price is listed.
|
|
10880
|
+
*/
|
|
10881
|
+
currency: string;
|
|
10882
|
+
custom_order?: CustomOrder;
|
|
10883
|
+
/**
|
|
10884
|
+
* - List of department IDs associated with the product.
|
|
10885
|
+
*/
|
|
10886
|
+
departments: number[];
|
|
10887
|
+
/**
|
|
10888
|
+
* - A detailed description of the product.
|
|
10889
|
+
*/
|
|
10890
|
+
description?: string;
|
|
10891
|
+
/**
|
|
10892
|
+
* - Product highlights or key features.
|
|
10893
|
+
*/
|
|
10894
|
+
highlights?: string[];
|
|
10895
|
+
/**
|
|
10896
|
+
* - Flag to indicate if the product is active.
|
|
10897
|
+
*/
|
|
10898
|
+
is_active?: boolean;
|
|
10899
|
+
/**
|
|
10900
|
+
* - Flag to indicate if the product is
|
|
10901
|
+
* dependent on other products.
|
|
10902
|
+
*/
|
|
10903
|
+
is_dependent?: boolean;
|
|
10904
|
+
/**
|
|
10905
|
+
* - Flag to indicate if the product
|
|
10906
|
+
* does not have associated images.
|
|
10907
|
+
*/
|
|
10908
|
+
is_image_less_product?: boolean;
|
|
10909
|
+
/**
|
|
10910
|
+
* - Flag to indicate if the product is part of a set.
|
|
10911
|
+
*/
|
|
10912
|
+
is_set?: boolean;
|
|
10913
|
+
/**
|
|
10914
|
+
* - Unique item code or SKU of the product.
|
|
10915
|
+
*/
|
|
10916
|
+
item_code: string;
|
|
10917
|
+
/**
|
|
10918
|
+
* - Type of the product (e.g., standard, set,
|
|
10919
|
+
* composite, digital).
|
|
10920
|
+
*/
|
|
10921
|
+
item_type: string;
|
|
10922
|
+
/**
|
|
10923
|
+
* - List of media URLs (images, videos) associated
|
|
10924
|
+
* with the product.
|
|
10925
|
+
*/
|
|
10926
|
+
media?: Media[];
|
|
10927
|
+
/**
|
|
10928
|
+
* - Indicates if the product supports multiple sizes.
|
|
10929
|
+
*/
|
|
10930
|
+
multi_size?: boolean;
|
|
10931
|
+
/**
|
|
10932
|
+
* - The name of the product.
|
|
10933
|
+
*/
|
|
10934
|
+
name: string;
|
|
10935
|
+
net_quantity?: NetQuantity;
|
|
10936
|
+
/**
|
|
10937
|
+
* - Number of boxes required to package the product.
|
|
10938
|
+
*/
|
|
10939
|
+
no_of_boxes?: number;
|
|
10940
|
+
/**
|
|
10941
|
+
* - Tags to group products together
|
|
10942
|
+
* for classification.
|
|
10943
|
+
*/
|
|
10944
|
+
product_group_tag?: string[];
|
|
10945
|
+
product_publish?: ProductPublish;
|
|
10946
|
+
/**
|
|
10947
|
+
* - The role requesting the product operation
|
|
10948
|
+
* (admin or user).
|
|
10949
|
+
*/
|
|
10950
|
+
requester?: string;
|
|
10951
|
+
return_config: ReturnConfig;
|
|
10952
|
+
/**
|
|
10953
|
+
* - A short description of the product,
|
|
10954
|
+
* up to 50 characters.
|
|
10955
|
+
*/
|
|
10956
|
+
short_description?: string;
|
|
10957
|
+
/**
|
|
10958
|
+
* - Identifier for the product's size guide.
|
|
10959
|
+
*/
|
|
10960
|
+
size_guide?: string;
|
|
10961
|
+
/**
|
|
10962
|
+
* - List of sizes available for the product.
|
|
10963
|
+
*/
|
|
10964
|
+
sizes: any[];
|
|
10965
|
+
/**
|
|
10966
|
+
* - URL-friendly identifier for the product.
|
|
10967
|
+
*/
|
|
10968
|
+
slug: string;
|
|
10969
|
+
/**
|
|
10970
|
+
* - List of tags associated with the product.
|
|
10971
|
+
*/
|
|
10972
|
+
tags?: string[];
|
|
10973
|
+
tax_identifier: TaxIdentifier;
|
|
10974
|
+
teaser_tag?: TeaserTag;
|
|
10975
|
+
/**
|
|
10976
|
+
* - Template tag for the product, used for
|
|
10977
|
+
* classification.
|
|
10978
|
+
*/
|
|
10979
|
+
template_tag: string;
|
|
10980
|
+
/**
|
|
10981
|
+
* - List of traders associated with the product.
|
|
10982
|
+
*/
|
|
10983
|
+
trader: Trader[];
|
|
10984
|
+
/**
|
|
10985
|
+
* - Variant group information for the product.
|
|
10986
|
+
*/
|
|
10987
|
+
variant_group?: any;
|
|
10988
|
+
/**
|
|
10989
|
+
* - Media related to product variants.
|
|
10990
|
+
*/
|
|
10991
|
+
variant_media?: any;
|
|
10992
|
+
/**
|
|
10993
|
+
* - Variants information for the product.
|
|
10994
|
+
*/
|
|
10995
|
+
variants?: any;
|
|
10996
|
+
};
|
|
10805
10997
|
/** @returns {ProductDetail} */
|
|
10806
10998
|
declare function ProductDetail(): ProductDetail;
|
|
10807
10999
|
type ProductDetail = {
|