@gofynd/fdk-client-javascript 3.6.0 → 3.8.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/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -16
- package/sdk/platform/Catalog/CatalogPlatformClient.js +10 -91
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +277 -31
- package/sdk/platform/Catalog/CatalogPlatformModel.js +155 -25
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +3 -24
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -19
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -11
- package/sdk/platform/Order/OrderPlatformModel.js +3 -5
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +10 -6
- package/sdk/platform/Partner/PartnerPlatformModel.js +5 -3
|
@@ -147,11 +147,89 @@ export = CatalogPlatformModel;
|
|
|
147
147
|
* @property {number} [maximum] - The maximum quantity allowed for purchase.
|
|
148
148
|
* @property {number} [minimum] - The minimum quantity required for purchase.
|
|
149
149
|
*/
|
|
150
|
+
/**
|
|
151
|
+
* @typedef Scores
|
|
152
|
+
* @property {number} [popularity] - This score captures how trending and
|
|
153
|
+
* popular a product is for a specific sales channel. It evaluates recent
|
|
154
|
+
* customer interactions such as views, wishlist adds, add-to-carts, and
|
|
155
|
+
* orders, applying time-based decay so newer activity matters more. The
|
|
156
|
+
* blended score is ranked within the channel to reflect relative popularity.
|
|
157
|
+
* A higher score means the product is currently engaging more customers,
|
|
158
|
+
* while a lower score shows limited or declining interest.
|
|
159
|
+
* @property {number} [availability] - This score measures how reliably a
|
|
160
|
+
* product is stocked for a specific sales channel. It compares the product’s
|
|
161
|
+
* current inventory with its highest observed inventory level, adjusted for
|
|
162
|
+
* how inventory is distributed across locations. A higher score means the
|
|
163
|
+
* product is readily available, while a lower score indicates limited stock
|
|
164
|
+
* or frequent stockouts. Products with no meaningful inventory history
|
|
165
|
+
* receive a default low score for interpretation.
|
|
166
|
+
* @property {number} [conversion] - This score measures how effectively a
|
|
167
|
+
* product converts customer interest into actual orders for a specific sales
|
|
168
|
+
* channel. It considers product views, wishlist adds, add-to-carts, and
|
|
169
|
+
* completed orders to calculate a conversion rate. The rate is then ranked
|
|
170
|
+
* within the channel to give a normalized score. A higher score means the
|
|
171
|
+
* product turns interest into purchases more successfully, while a lower
|
|
172
|
+
* score indicates weaker conversion performance.
|
|
173
|
+
* @property {number} [sold_quantity] - This score evaluates how many units of a
|
|
174
|
+
* product have been sold for a specific sales channel, compared to other
|
|
175
|
+
* products in the same channel. It calculates total quantities sold and
|
|
176
|
+
* converts them into a percentile rank. A higher score means the product
|
|
177
|
+
* sells in large volumes, while a lower score signals fewer units sold.
|
|
178
|
+
* Products without transactions are assigned a default low score.
|
|
179
|
+
* @property {number} [depth] - This score evaluates how well a product covers
|
|
180
|
+
* different size options for a specific sales channel within its category,
|
|
181
|
+
* while also factoring in the inventory available for each size. It compares
|
|
182
|
+
* the product’s size variety and stock depth against the maximum observed
|
|
183
|
+
* within that category and channel. A higher score means the product offers a
|
|
184
|
+
* broader and better-stocked size range, while a lower score reflects fewer
|
|
185
|
+
* options or limited inventory depth.
|
|
186
|
+
* @property {number} [discount] - This score reflects the level of discount a
|
|
187
|
+
* product offers for a specific sales channel, relative to others in the
|
|
188
|
+
* channel. It compares the product’s listed price (MRP) to its effective
|
|
189
|
+
* selling price (ESP) and ranks products by discount percentage. It also
|
|
190
|
+
* takes into account Discount Rules. A higher score indicates steeper
|
|
191
|
+
* discounts, while a lower score shows smaller or no discounts. Products
|
|
192
|
+
* without valid price data receive a default low score.
|
|
193
|
+
* @property {number} [revenue] - This score measures how much revenue a product
|
|
194
|
+
* generates for a specific sales channel, relative to other products in that
|
|
195
|
+
* channel. It looks at the total value of items sold and assigns a percentile
|
|
196
|
+
* rank. A higher score indicates the product drives stronger sales revenue,
|
|
197
|
+
* while a lower score means it contributes less revenue compared to peers.
|
|
198
|
+
* Products with no sales activity receive a default low score.
|
|
199
|
+
* @property {number} [cancelled] - This score measures the proportion of orders
|
|
200
|
+
* cancelled by the platform for a specific sales channel. A higher score
|
|
201
|
+
* indicates fewer cancellations, suggesting smoother fulfilment and better
|
|
202
|
+
* operational consistency. A lower score highlights products more prone to
|
|
203
|
+
* cancellations, which may result from inventory mismatches, processing
|
|
204
|
+
* issues, or operational inefficiencies.
|
|
205
|
+
* @property {number} [returns] - This score measures the proportion of orders
|
|
206
|
+
* that were returned for a specific sales channel. It is designed so that a
|
|
207
|
+
* higher score indicates fewer returns relative to total orders, reflecting
|
|
208
|
+
* better product reliability and customer satisfaction. A lower score means
|
|
209
|
+
* the product experiences more returns, which could signal quality issues,
|
|
210
|
+
* mismatched expectations, or customer dissatisfaction.
|
|
211
|
+
* @property {number} [catalogue] - This score evaluates the quality and
|
|
212
|
+
* completeness of a product’s catalogue content for a specific sales channel.
|
|
213
|
+
* It considers the presence of images, videos, and 3D models, along with the
|
|
214
|
+
* length of product descriptions. Balanced image counts, supportive media,
|
|
215
|
+
* and detailed descriptions contribute to a higher score. A higher score
|
|
216
|
+
* means the product is well-presented and informative, while a lower score
|
|
217
|
+
* indicates missing media or insufficient descriptions that may reduce
|
|
218
|
+
* customer confidence.
|
|
219
|
+
* @property {number} [listing] - This score reflects how recently a product was
|
|
220
|
+
* listed for a specific sales channel. It uses the product’s listing date to
|
|
221
|
+
* calculate how many days have passed since it became available, then
|
|
222
|
+
* normalizes this against other products in the same channel. A higher score
|
|
223
|
+
* means the product is relatively new and fresh on the channel, while a lower
|
|
224
|
+
* score indicates it has been listed for a longer time or lacks valid listing
|
|
225
|
+
* information.
|
|
226
|
+
*/
|
|
150
227
|
/**
|
|
151
228
|
* @typedef ApplicationItemMeta
|
|
152
229
|
* @property {Object} [_custom_json] - Custom JSON data for the item
|
|
153
230
|
* @property {MetaFields[]} [_custom_meta] - Custom meta fields for the item
|
|
154
231
|
* @property {Object} [alt_text] - Alternative text for the item's images
|
|
232
|
+
* @property {Scores} [scores]
|
|
155
233
|
* @property {boolean} [is_cod] - Whether the item is available for Cash on
|
|
156
234
|
* Delivery (COD) or not
|
|
157
235
|
* @property {boolean} [is_gift] - Whether the item is a gift or not
|
|
@@ -4471,18 +4549,38 @@ export = CatalogPlatformModel;
|
|
|
4471
4549
|
*/
|
|
4472
4550
|
/**
|
|
4473
4551
|
* @typedef TaxComponent
|
|
4474
|
-
* @property {string} name - Name of
|
|
4475
|
-
*
|
|
4552
|
+
* @property {string} name - Name represent different types of taxes that may be
|
|
4553
|
+
* applied to products or transactions, such as sales tax, value-added tax
|
|
4554
|
+
* (VAT), goods and services tax, consumption tax, or other region-specific
|
|
4555
|
+
* taxation systems.
|
|
4556
|
+
* @property {TaxThreshold[]} slabs - List of slabs which comprises of tax rate
|
|
4557
|
+
* and their respective threshold value
|
|
4476
4558
|
*/
|
|
4477
4559
|
/**
|
|
4478
|
-
* @typedef
|
|
4560
|
+
* @typedef TaxComponentResponseSchema
|
|
4479
4561
|
* @property {string} name - Name of the component.
|
|
4480
4562
|
* @property {string} [description] - Description of the tax component.
|
|
4481
|
-
* @property {TaxThreshold[]} slabs - List of
|
|
4563
|
+
* @property {TaxThreshold[]} slabs - List of slabs that comprises of tax rate
|
|
4564
|
+
* and their respective threshold.
|
|
4482
4565
|
* @property {string} _id - Unique identifier of the tax component. This _id is
|
|
4483
4566
|
* required for updating any tax component; If _id field is not in "update tax
|
|
4484
4567
|
* version" request then that component will be created.
|
|
4485
4568
|
*/
|
|
4569
|
+
/**
|
|
4570
|
+
* @typedef TaxComponentName
|
|
4571
|
+
* @property {string} _id - Unique identifier for the tax component name
|
|
4572
|
+
* @property {number} company_id - Identifier of the company this component name
|
|
4573
|
+
* belongs to
|
|
4574
|
+
* @property {string} name - Name of the tax component
|
|
4575
|
+
* @property {string} [description] - Description of the tax component name
|
|
4576
|
+
* @property {string} [created_on] - Timestamp when the component name was created
|
|
4577
|
+
* @property {string} [modified_on] - Timestamp when the component name was last modified
|
|
4578
|
+
*/
|
|
4579
|
+
/**
|
|
4580
|
+
* @typedef CreateTaxComponentNameRequestSchema
|
|
4581
|
+
* @property {string} name - Name of the tax component
|
|
4582
|
+
* @property {string} [description] - Description of the tax component name
|
|
4583
|
+
*/
|
|
4486
4584
|
/**
|
|
4487
4585
|
* @typedef TaxReqBodyVersion
|
|
4488
4586
|
* @property {TaxComponent[]} components - List of tax components with their
|
|
@@ -4503,11 +4601,11 @@ export = CatalogPlatformModel;
|
|
|
4503
4601
|
* @property {string} [modified_on]
|
|
4504
4602
|
* @property {number} [company_id] - Company ID.
|
|
4505
4603
|
* @property {TaxStatusEnum} [status]
|
|
4506
|
-
* @property {
|
|
4604
|
+
* @property {TaxComponentResponseSchema[]} [components] - List of tax components.
|
|
4507
4605
|
*/
|
|
4508
4606
|
/**
|
|
4509
4607
|
* @typedef UpdateTaxVersionRequestBody
|
|
4510
|
-
* @property {
|
|
4608
|
+
* @property {TaxComponentResponseSchema[]} components - List of tax components.
|
|
4511
4609
|
* @property {string} applicable_date - It is the date from when this rule will
|
|
4512
4610
|
* come in effect. It should be atleast one minute in the future from the current time.
|
|
4513
4611
|
*/
|
|
@@ -4515,7 +4613,8 @@ export = CatalogPlatformModel;
|
|
|
4515
4613
|
* @typedef CreateTaxVersionRequestBody
|
|
4516
4614
|
* @property {TaxComponent[]} components - List of tax components.
|
|
4517
4615
|
* @property {string} applicable_date - It is the date from when this rule will
|
|
4518
|
-
* come in effect. It should be atleast one minute in the future from the
|
|
4616
|
+
* come in effect. It should be atleast one minute in the future from the
|
|
4617
|
+
* current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
|
|
4519
4618
|
*/
|
|
4520
4619
|
/**
|
|
4521
4620
|
* @typedef TaxRule
|
|
@@ -4597,13 +4696,9 @@ export = CatalogPlatformModel;
|
|
|
4597
4696
|
* @property {HSCodeItem[]} items - Array of HS code responses.
|
|
4598
4697
|
* @property {Page} page
|
|
4599
4698
|
*/
|
|
4600
|
-
/**
|
|
4601
|
-
* @typedef CreateTaxComponentName
|
|
4602
|
-
* @property {string} name - Name of a tax component
|
|
4603
|
-
*/
|
|
4604
4699
|
/**
|
|
4605
4700
|
* @typedef GetTaxComponents
|
|
4606
|
-
* @property {
|
|
4701
|
+
* @property {TaxComponentResponseSchema[]} items
|
|
4607
4702
|
* @property {Page} page
|
|
4608
4703
|
*/
|
|
4609
4704
|
/**
|
|
@@ -4703,7 +4798,7 @@ export = CatalogPlatformModel;
|
|
|
4703
4798
|
declare class CatalogPlatformModel {
|
|
4704
4799
|
}
|
|
4705
4800
|
declare namespace CatalogPlatformModel {
|
|
4706
|
-
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, BulkMeta, 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, ProductCreateSchemaV3, ProductUpdateSchemaV3, 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, TaxIdentifierV3, 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, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentRes, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, CreateTaxComponentName, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
|
|
4801
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, 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, BulkMeta, 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, ProductCreateSchemaV3, ProductUpdateSchemaV3, 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, TaxIdentifierV3, 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, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
|
|
4707
4802
|
}
|
|
4708
4803
|
/** @returns {Action} */
|
|
4709
4804
|
declare function Action(): Action;
|
|
@@ -4998,6 +5093,117 @@ type ApplicationItemMOQ = {
|
|
|
4998
5093
|
*/
|
|
4999
5094
|
minimum?: number;
|
|
5000
5095
|
};
|
|
5096
|
+
/** @returns {Scores} */
|
|
5097
|
+
declare function Scores(): Scores;
|
|
5098
|
+
type Scores = {
|
|
5099
|
+
/**
|
|
5100
|
+
* - This score captures how trending and
|
|
5101
|
+
* popular a product is for a specific sales channel. It evaluates recent
|
|
5102
|
+
* customer interactions such as views, wishlist adds, add-to-carts, and
|
|
5103
|
+
* orders, applying time-based decay so newer activity matters more. The
|
|
5104
|
+
* blended score is ranked within the channel to reflect relative popularity.
|
|
5105
|
+
* A higher score means the product is currently engaging more customers,
|
|
5106
|
+
* while a lower score shows limited or declining interest.
|
|
5107
|
+
*/
|
|
5108
|
+
popularity?: number;
|
|
5109
|
+
/**
|
|
5110
|
+
* - This score measures how reliably a
|
|
5111
|
+
* product is stocked for a specific sales channel. It compares the product’s
|
|
5112
|
+
* current inventory with its highest observed inventory level, adjusted for
|
|
5113
|
+
* how inventory is distributed across locations. A higher score means the
|
|
5114
|
+
* product is readily available, while a lower score indicates limited stock
|
|
5115
|
+
* or frequent stockouts. Products with no meaningful inventory history
|
|
5116
|
+
* receive a default low score for interpretation.
|
|
5117
|
+
*/
|
|
5118
|
+
availability?: number;
|
|
5119
|
+
/**
|
|
5120
|
+
* - This score measures how effectively a
|
|
5121
|
+
* product converts customer interest into actual orders for a specific sales
|
|
5122
|
+
* channel. It considers product views, wishlist adds, add-to-carts, and
|
|
5123
|
+
* completed orders to calculate a conversion rate. The rate is then ranked
|
|
5124
|
+
* within the channel to give a normalized score. A higher score means the
|
|
5125
|
+
* product turns interest into purchases more successfully, while a lower
|
|
5126
|
+
* score indicates weaker conversion performance.
|
|
5127
|
+
*/
|
|
5128
|
+
conversion?: number;
|
|
5129
|
+
/**
|
|
5130
|
+
* - This score evaluates how many units of a
|
|
5131
|
+
* product have been sold for a specific sales channel, compared to other
|
|
5132
|
+
* products in the same channel. It calculates total quantities sold and
|
|
5133
|
+
* converts them into a percentile rank. A higher score means the product
|
|
5134
|
+
* sells in large volumes, while a lower score signals fewer units sold.
|
|
5135
|
+
* Products without transactions are assigned a default low score.
|
|
5136
|
+
*/
|
|
5137
|
+
sold_quantity?: number;
|
|
5138
|
+
/**
|
|
5139
|
+
* - This score evaluates how well a product covers
|
|
5140
|
+
* different size options for a specific sales channel within its category,
|
|
5141
|
+
* while also factoring in the inventory available for each size. It compares
|
|
5142
|
+
* the product’s size variety and stock depth against the maximum observed
|
|
5143
|
+
* within that category and channel. A higher score means the product offers a
|
|
5144
|
+
* broader and better-stocked size range, while a lower score reflects fewer
|
|
5145
|
+
* options or limited inventory depth.
|
|
5146
|
+
*/
|
|
5147
|
+
depth?: number;
|
|
5148
|
+
/**
|
|
5149
|
+
* - This score reflects the level of discount a
|
|
5150
|
+
* product offers for a specific sales channel, relative to others in the
|
|
5151
|
+
* channel. It compares the product’s listed price (MRP) to its effective
|
|
5152
|
+
* selling price (ESP) and ranks products by discount percentage. It also
|
|
5153
|
+
* takes into account Discount Rules. A higher score indicates steeper
|
|
5154
|
+
* discounts, while a lower score shows smaller or no discounts. Products
|
|
5155
|
+
* without valid price data receive a default low score.
|
|
5156
|
+
*/
|
|
5157
|
+
discount?: number;
|
|
5158
|
+
/**
|
|
5159
|
+
* - This score measures how much revenue a product
|
|
5160
|
+
* generates for a specific sales channel, relative to other products in that
|
|
5161
|
+
* channel. It looks at the total value of items sold and assigns a percentile
|
|
5162
|
+
* rank. A higher score indicates the product drives stronger sales revenue,
|
|
5163
|
+
* while a lower score means it contributes less revenue compared to peers.
|
|
5164
|
+
* Products with no sales activity receive a default low score.
|
|
5165
|
+
*/
|
|
5166
|
+
revenue?: number;
|
|
5167
|
+
/**
|
|
5168
|
+
* - This score measures the proportion of orders
|
|
5169
|
+
* cancelled by the platform for a specific sales channel. A higher score
|
|
5170
|
+
* indicates fewer cancellations, suggesting smoother fulfilment and better
|
|
5171
|
+
* operational consistency. A lower score highlights products more prone to
|
|
5172
|
+
* cancellations, which may result from inventory mismatches, processing
|
|
5173
|
+
* issues, or operational inefficiencies.
|
|
5174
|
+
*/
|
|
5175
|
+
cancelled?: number;
|
|
5176
|
+
/**
|
|
5177
|
+
* - This score measures the proportion of orders
|
|
5178
|
+
* that were returned for a specific sales channel. It is designed so that a
|
|
5179
|
+
* higher score indicates fewer returns relative to total orders, reflecting
|
|
5180
|
+
* better product reliability and customer satisfaction. A lower score means
|
|
5181
|
+
* the product experiences more returns, which could signal quality issues,
|
|
5182
|
+
* mismatched expectations, or customer dissatisfaction.
|
|
5183
|
+
*/
|
|
5184
|
+
returns?: number;
|
|
5185
|
+
/**
|
|
5186
|
+
* - This score evaluates the quality and
|
|
5187
|
+
* completeness of a product’s catalogue content for a specific sales channel.
|
|
5188
|
+
* It considers the presence of images, videos, and 3D models, along with the
|
|
5189
|
+
* length of product descriptions. Balanced image counts, supportive media,
|
|
5190
|
+
* and detailed descriptions contribute to a higher score. A higher score
|
|
5191
|
+
* means the product is well-presented and informative, while a lower score
|
|
5192
|
+
* indicates missing media or insufficient descriptions that may reduce
|
|
5193
|
+
* customer confidence.
|
|
5194
|
+
*/
|
|
5195
|
+
catalogue?: number;
|
|
5196
|
+
/**
|
|
5197
|
+
* - This score reflects how recently a product was
|
|
5198
|
+
* listed for a specific sales channel. It uses the product’s listing date to
|
|
5199
|
+
* calculate how many days have passed since it became available, then
|
|
5200
|
+
* normalizes this against other products in the same channel. A higher score
|
|
5201
|
+
* means the product is relatively new and fresh on the channel, while a lower
|
|
5202
|
+
* score indicates it has been listed for a longer time or lacks valid listing
|
|
5203
|
+
* information.
|
|
5204
|
+
*/
|
|
5205
|
+
listing?: number;
|
|
5206
|
+
};
|
|
5001
5207
|
/** @returns {ApplicationItemMeta} */
|
|
5002
5208
|
declare function ApplicationItemMeta(): ApplicationItemMeta;
|
|
5003
5209
|
type ApplicationItemMeta = {
|
|
@@ -5013,6 +5219,7 @@ type ApplicationItemMeta = {
|
|
|
5013
5219
|
* - Alternative text for the item's images
|
|
5014
5220
|
*/
|
|
5015
5221
|
alt_text?: any;
|
|
5222
|
+
scores?: Scores;
|
|
5016
5223
|
/**
|
|
5017
5224
|
* - Whether the item is available for Cash on
|
|
5018
5225
|
* Delivery (COD) or not
|
|
@@ -14490,17 +14697,21 @@ type TaxThreshold = {
|
|
|
14490
14697
|
declare function TaxComponent(): TaxComponent;
|
|
14491
14698
|
type TaxComponent = {
|
|
14492
14699
|
/**
|
|
14493
|
-
* - Name of
|
|
14700
|
+
* - Name represent different types of taxes that may be
|
|
14701
|
+
* applied to products or transactions, such as sales tax, value-added tax
|
|
14702
|
+
* (VAT), goods and services tax, consumption tax, or other region-specific
|
|
14703
|
+
* taxation systems.
|
|
14494
14704
|
*/
|
|
14495
14705
|
name: string;
|
|
14496
14706
|
/**
|
|
14497
|
-
* - List of
|
|
14707
|
+
* - List of slabs which comprises of tax rate
|
|
14708
|
+
* and their respective threshold value
|
|
14498
14709
|
*/
|
|
14499
14710
|
slabs: TaxThreshold[];
|
|
14500
14711
|
};
|
|
14501
|
-
/** @returns {
|
|
14502
|
-
declare function
|
|
14503
|
-
type
|
|
14712
|
+
/** @returns {TaxComponentResponseSchema} */
|
|
14713
|
+
declare function TaxComponentResponseSchema(): TaxComponentResponseSchema;
|
|
14714
|
+
type TaxComponentResponseSchema = {
|
|
14504
14715
|
/**
|
|
14505
14716
|
* - Name of the component.
|
|
14506
14717
|
*/
|
|
@@ -14510,7 +14721,8 @@ type TaxComponentRes = {
|
|
|
14510
14721
|
*/
|
|
14511
14722
|
description?: string;
|
|
14512
14723
|
/**
|
|
14513
|
-
* - List of
|
|
14724
|
+
* - List of slabs that comprises of tax rate
|
|
14725
|
+
* and their respective threshold.
|
|
14514
14726
|
*/
|
|
14515
14727
|
slabs: TaxThreshold[];
|
|
14516
14728
|
/**
|
|
@@ -14520,6 +14732,47 @@ type TaxComponentRes = {
|
|
|
14520
14732
|
*/
|
|
14521
14733
|
_id: string;
|
|
14522
14734
|
};
|
|
14735
|
+
/** @returns {TaxComponentName} */
|
|
14736
|
+
declare function TaxComponentName(): TaxComponentName;
|
|
14737
|
+
type TaxComponentName = {
|
|
14738
|
+
/**
|
|
14739
|
+
* - Unique identifier for the tax component name
|
|
14740
|
+
*/
|
|
14741
|
+
_id: string;
|
|
14742
|
+
/**
|
|
14743
|
+
* - Identifier of the company this component name
|
|
14744
|
+
* belongs to
|
|
14745
|
+
*/
|
|
14746
|
+
company_id: number;
|
|
14747
|
+
/**
|
|
14748
|
+
* - Name of the tax component
|
|
14749
|
+
*/
|
|
14750
|
+
name: string;
|
|
14751
|
+
/**
|
|
14752
|
+
* - Description of the tax component name
|
|
14753
|
+
*/
|
|
14754
|
+
description?: string;
|
|
14755
|
+
/**
|
|
14756
|
+
* - Timestamp when the component name was created
|
|
14757
|
+
*/
|
|
14758
|
+
created_on?: string;
|
|
14759
|
+
/**
|
|
14760
|
+
* - Timestamp when the component name was last modified
|
|
14761
|
+
*/
|
|
14762
|
+
modified_on?: string;
|
|
14763
|
+
};
|
|
14764
|
+
/** @returns {CreateTaxComponentNameRequestSchema} */
|
|
14765
|
+
declare function CreateTaxComponentNameRequestSchema(): CreateTaxComponentNameRequestSchema;
|
|
14766
|
+
type CreateTaxComponentNameRequestSchema = {
|
|
14767
|
+
/**
|
|
14768
|
+
* - Name of the tax component
|
|
14769
|
+
*/
|
|
14770
|
+
name: string;
|
|
14771
|
+
/**
|
|
14772
|
+
* - Description of the tax component name
|
|
14773
|
+
*/
|
|
14774
|
+
description?: string;
|
|
14775
|
+
};
|
|
14523
14776
|
/** @returns {TaxReqBodyVersion} */
|
|
14524
14777
|
declare function TaxReqBodyVersion(): TaxReqBodyVersion;
|
|
14525
14778
|
type TaxReqBodyVersion = {
|
|
@@ -14561,7 +14814,7 @@ type TaxVersion = {
|
|
|
14561
14814
|
/**
|
|
14562
14815
|
* - List of tax components.
|
|
14563
14816
|
*/
|
|
14564
|
-
components?:
|
|
14817
|
+
components?: TaxComponentResponseSchema[];
|
|
14565
14818
|
};
|
|
14566
14819
|
/** @returns {UpdateTaxVersionRequestBody} */
|
|
14567
14820
|
declare function UpdateTaxVersionRequestBody(): UpdateTaxVersionRequestBody;
|
|
@@ -14569,7 +14822,7 @@ type UpdateTaxVersionRequestBody = {
|
|
|
14569
14822
|
/**
|
|
14570
14823
|
* - List of tax components.
|
|
14571
14824
|
*/
|
|
14572
|
-
components:
|
|
14825
|
+
components: TaxComponentResponseSchema[];
|
|
14573
14826
|
/**
|
|
14574
14827
|
* - It is the date from when this rule will
|
|
14575
14828
|
* come in effect. It should be atleast one minute in the future from the current time.
|
|
@@ -14585,7 +14838,8 @@ type CreateTaxVersionRequestBody = {
|
|
|
14585
14838
|
components: TaxComponent[];
|
|
14586
14839
|
/**
|
|
14587
14840
|
* - It is the date from when this rule will
|
|
14588
|
-
* come in effect. It should be atleast one minute in the future from the
|
|
14841
|
+
* come in effect. It should be atleast one minute in the future from the
|
|
14842
|
+
* current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
|
|
14589
14843
|
*/
|
|
14590
14844
|
applicable_date: string;
|
|
14591
14845
|
};
|
|
@@ -14731,18 +14985,10 @@ type HSCodes = {
|
|
|
14731
14985
|
items: HSCodeItem[];
|
|
14732
14986
|
page: Page;
|
|
14733
14987
|
};
|
|
14734
|
-
/** @returns {CreateTaxComponentName} */
|
|
14735
|
-
declare function CreateTaxComponentName(): CreateTaxComponentName;
|
|
14736
|
-
type CreateTaxComponentName = {
|
|
14737
|
-
/**
|
|
14738
|
-
* - Name of a tax component
|
|
14739
|
-
*/
|
|
14740
|
-
name: string;
|
|
14741
|
-
};
|
|
14742
14988
|
/** @returns {GetTaxComponents} */
|
|
14743
14989
|
declare function GetTaxComponents(): GetTaxComponents;
|
|
14744
14990
|
type GetTaxComponents = {
|
|
14745
|
-
items:
|
|
14991
|
+
items: TaxComponentResponseSchema[];
|
|
14746
14992
|
page: Page;
|
|
14747
14993
|
};
|
|
14748
14994
|
/** @returns {ActionPage} */
|