@gofynd/fdk-client-javascript 3.4.4 → 3.6.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/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.js +210 -0
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +2 -2
- package/sdk/platform/Cart/CartPlatformModel.d.ts +11 -0
- package/sdk/platform/Cart/CartPlatformModel.js +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +125 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1075 -95
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1017 -46
- package/sdk/platform/Catalog/CatalogPlatformModel.js +681 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +200 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +174 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +9 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformModel.d.ts +49 -1
- package/sdk/platform/Order/OrderPlatformModel.js +28 -0
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +13 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +89 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +25 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +17 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +36 -4
- package/sdk/public/PublicAPIClient.d.ts +1 -1
|
@@ -1276,6 +1276,7 @@ export = CatalogPlatformModel;
|
|
|
1276
1276
|
* the product.
|
|
1277
1277
|
* @property {string} [description] - Detailed description of the product.
|
|
1278
1278
|
* @property {string[]} [highlights] - List of highlights for the product.
|
|
1279
|
+
* @property {string} [hs_code] - HSN code associated with the product for tax purposes.
|
|
1279
1280
|
* @property {string} [hsn_code] - HSN code associated with the product for tax purposes.
|
|
1280
1281
|
* @property {string} [id] - Unique identifier of the product.
|
|
1281
1282
|
* @property {string} [image_nature] - Nature or type of product images.
|
|
@@ -1948,6 +1949,7 @@ export = CatalogPlatformModel;
|
|
|
1948
1949
|
* @property {string} [created_on] - Date and time when the HSN data was created.
|
|
1949
1950
|
* @property {string} description - Description of the HSN data.
|
|
1950
1951
|
* @property {string} hsn_code
|
|
1952
|
+
* @property {string} [tax_rule_id] - Unique identifier of the tax rule.
|
|
1951
1953
|
* @property {string} [hsn_code_id] - Unique identifier of the HSN code.
|
|
1952
1954
|
* @property {string} [modified_on] - Date and time when the HSN data was last modified.
|
|
1953
1955
|
* @property {Object} reporting_hsn - HSN code.
|
|
@@ -2794,6 +2796,8 @@ export = CatalogPlatformModel;
|
|
|
2794
2796
|
* @property {number[]} [departments] - List of department IDs related to the product.
|
|
2795
2797
|
* @property {string} [description] - Full description of the product.
|
|
2796
2798
|
* @property {string[]} [highlights] - List of key highlights of the product.
|
|
2799
|
+
* @property {string} [hs_code] - HSN (Harmonized System Nomenclature) code for
|
|
2800
|
+
* tax classification.
|
|
2797
2801
|
* @property {string} [hsn_code] - HSN (Harmonized System Nomenclature) code for
|
|
2798
2802
|
* tax classification.
|
|
2799
2803
|
* @property {string} [id] - Unique identifier for the product in the system.
|
|
@@ -3008,6 +3012,7 @@ export = CatalogPlatformModel;
|
|
|
3008
3012
|
* @property {string} slug - URL-friendly identifier for the product.
|
|
3009
3013
|
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3010
3014
|
* @property {TaxIdentifier} tax_identifier
|
|
3015
|
+
* @property {string} [hs_code] - HS Code for the product.
|
|
3011
3016
|
* @property {TeaserTag} [teaser_tag]
|
|
3012
3017
|
* @property {string} template_tag - Template tag for the product, used for
|
|
3013
3018
|
* classification.
|
|
@@ -3073,6 +3078,123 @@ export = CatalogPlatformModel;
|
|
|
3073
3078
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3074
3079
|
* @property {Object} [variants] - Variants information for the product.
|
|
3075
3080
|
*/
|
|
3081
|
+
/**
|
|
3082
|
+
* @typedef ProductCreateSchemaV3
|
|
3083
|
+
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3084
|
+
* additional product properties.
|
|
3085
|
+
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3086
|
+
* upsert, update, delete).
|
|
3087
|
+
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3088
|
+
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3089
|
+
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3090
|
+
* @property {string} category_slug - The category to which the product belongs.
|
|
3091
|
+
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3092
|
+
* @property {number} company_id - Unique identifier for the company associated
|
|
3093
|
+
* with the product.
|
|
3094
|
+
* @property {string} country_of_origin - The country where the product was
|
|
3095
|
+
* manufactured or sourced.
|
|
3096
|
+
* @property {string} currency - The currency in which the product's price is listed.
|
|
3097
|
+
* @property {CustomOrder} [custom_order]
|
|
3098
|
+
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3099
|
+
* @property {string} [description] - A detailed description of the product.
|
|
3100
|
+
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3101
|
+
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3102
|
+
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3103
|
+
* dependent on other products.
|
|
3104
|
+
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3105
|
+
* does not have associated images.
|
|
3106
|
+
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3107
|
+
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3108
|
+
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3109
|
+
* composite, digital).
|
|
3110
|
+
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3111
|
+
* with the product.
|
|
3112
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3113
|
+
* @property {string} name - The name of the product.
|
|
3114
|
+
* @property {NetQuantity} [net_quantity]
|
|
3115
|
+
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3116
|
+
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3117
|
+
* for classification.
|
|
3118
|
+
* @property {ProductPublish} [product_publish]
|
|
3119
|
+
* @property {string} [requester] - The role requesting the product operation
|
|
3120
|
+
* (admin or user).
|
|
3121
|
+
* @property {ReturnConfig} return_config
|
|
3122
|
+
* @property {string} [short_description] - A short description of the product,
|
|
3123
|
+
* up to 50 characters.
|
|
3124
|
+
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3125
|
+
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3126
|
+
* @property {string} slug - URL-friendly identifier for the product.
|
|
3127
|
+
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3128
|
+
* @property {TaxIdentifierV3} tax_identifier
|
|
3129
|
+
* @property {TeaserTag} [teaser_tag]
|
|
3130
|
+
* @property {string} template_tag - Template tag for the product, used for
|
|
3131
|
+
* classification.
|
|
3132
|
+
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3133
|
+
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3134
|
+
* @property {Object} [variant_media] - Media related to product variants.
|
|
3135
|
+
* @property {Object} [variants] - Variants information for the product.
|
|
3136
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3137
|
+
* indian companies.
|
|
3138
|
+
*/
|
|
3139
|
+
/**
|
|
3140
|
+
* @typedef ProductUpdateSchemaV3
|
|
3141
|
+
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3142
|
+
* additional product properties.
|
|
3143
|
+
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3144
|
+
* upsert, update, delete).
|
|
3145
|
+
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3146
|
+
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3147
|
+
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3148
|
+
* @property {string} category_slug - The category to which the product belongs.
|
|
3149
|
+
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3150
|
+
* @property {number} company_id - Unique identifier for the company associated
|
|
3151
|
+
* with the product.
|
|
3152
|
+
* @property {string} country_of_origin - The country where the product was
|
|
3153
|
+
* manufactured or sourced.
|
|
3154
|
+
* @property {string} currency - The currency in which the product's price is listed.
|
|
3155
|
+
* @property {CustomOrder} [custom_order]
|
|
3156
|
+
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3157
|
+
* @property {string} [description] - A detailed description of the product.
|
|
3158
|
+
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3159
|
+
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3160
|
+
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3161
|
+
* dependent on other products.
|
|
3162
|
+
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3163
|
+
* does not have associated images.
|
|
3164
|
+
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3165
|
+
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3166
|
+
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3167
|
+
* composite, digital).
|
|
3168
|
+
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3169
|
+
* with the product.
|
|
3170
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3171
|
+
* @property {string} name - The name of the product.
|
|
3172
|
+
* @property {NetQuantity} [net_quantity]
|
|
3173
|
+
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3174
|
+
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3175
|
+
* for classification.
|
|
3176
|
+
* @property {ProductPublish} [product_publish]
|
|
3177
|
+
* @property {string} [requester] - The role requesting the product operation
|
|
3178
|
+
* (admin or user).
|
|
3179
|
+
* @property {ReturnConfig} return_config
|
|
3180
|
+
* @property {string} [short_description] - A short description of the product,
|
|
3181
|
+
* up to 50 characters.
|
|
3182
|
+
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3183
|
+
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3184
|
+
* @property {string} slug - URL-friendly identifier for the product.
|
|
3185
|
+
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3186
|
+
* @property {TaxIdentifierV3} tax_identifier
|
|
3187
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3188
|
+
* indian companies.
|
|
3189
|
+
* @property {TeaserTag} [teaser_tag]
|
|
3190
|
+
* @property {string} template_tag - Template tag for the product, used for
|
|
3191
|
+
* classification.
|
|
3192
|
+
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3193
|
+
* @property {number} [uid] - Unique identifier for the product.
|
|
3194
|
+
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3195
|
+
* @property {Object} [variant_media] - Media related to product variants.
|
|
3196
|
+
* @property {Object} [variants] - Variants information for the product.
|
|
3197
|
+
*/
|
|
3076
3198
|
/**
|
|
3077
3199
|
* @typedef ProductDetail
|
|
3078
3200
|
* @property {Object} [attributes] - Key-value pairs representing various
|
|
@@ -3489,8 +3611,12 @@ export = CatalogPlatformModel;
|
|
|
3489
3611
|
* the product.
|
|
3490
3612
|
* @property {string} [description] - Long description of the product.
|
|
3491
3613
|
* @property {string[]} [highlights] - Key features or highlights of the product.
|
|
3492
|
-
* @property {string} [
|
|
3493
|
-
* taxation purposes.
|
|
3614
|
+
* @property {string} [hs_code] - Harmonized System Nomenclature (HSN) code for
|
|
3615
|
+
* taxation purposes. This is required for indian products.
|
|
3616
|
+
* @property {string} [hsn_code] - **Deprecated**: Harmonized System
|
|
3617
|
+
* Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
|
|
3618
|
+
* field instead.\
|
|
3619
|
+
* _Deprecated_*
|
|
3494
3620
|
* @property {string} [id] - Unique identifier of the product in the database.
|
|
3495
3621
|
* @property {string} [image_nature] - Describes the nature of the product
|
|
3496
3622
|
* images (e.g., "standard").
|
|
@@ -3636,6 +3762,8 @@ export = CatalogPlatformModel;
|
|
|
3636
3762
|
/**
|
|
3637
3763
|
* @typedef ProductTemplateExportFilterRequestSchema
|
|
3638
3764
|
* @property {string[]} [brands] - The list of the brands that needs to be exported.
|
|
3765
|
+
* @property {string[]} [tax_rule_ids] - The list of the tax rule ids that needs
|
|
3766
|
+
* to be exported.
|
|
3639
3767
|
* @property {string[]} catalogue_types - The list of the type of the catalog
|
|
3640
3768
|
* such as set, standard and composite.
|
|
3641
3769
|
* @property {string} [from_date] - The modified on date from which the data
|
|
@@ -3686,6 +3814,7 @@ export = CatalogPlatformModel;
|
|
|
3686
3814
|
* @property {Object} [custom_order]
|
|
3687
3815
|
* @property {Object} [description]
|
|
3688
3816
|
* @property {Object} [highlights]
|
|
3817
|
+
* @property {Object} [hs_code]
|
|
3689
3818
|
* @property {Object} [hsn_code]
|
|
3690
3819
|
* @property {Object} [is_active]
|
|
3691
3820
|
* @property {Object} [is_dependent]
|
|
@@ -3999,9 +4128,14 @@ export = CatalogPlatformModel;
|
|
|
3999
4128
|
*/
|
|
4000
4129
|
/**
|
|
4001
4130
|
* @typedef TaxIdentifier
|
|
4002
|
-
* @property {string} [
|
|
4003
|
-
* @property {string} [
|
|
4004
|
-
* @property {string} [
|
|
4131
|
+
* @property {string} [tax_rule_id] - The unique identifier of the tax rule.
|
|
4132
|
+
* @property {string} [hsn_code] _Deprecated_*
|
|
4133
|
+
* @property {string} [hsn_code_id] _Deprecated_*
|
|
4134
|
+
* @property {string} [reporting_hsn] _Deprecated_*
|
|
4135
|
+
*/
|
|
4136
|
+
/**
|
|
4137
|
+
* @typedef TaxIdentifierV3
|
|
4138
|
+
* @property {string} tax_rule_id - The unique identifier of the tax rule.
|
|
4005
4139
|
*/
|
|
4006
4140
|
/**
|
|
4007
4141
|
* @typedef TaxSlab
|
|
@@ -4324,6 +4458,154 @@ export = CatalogPlatformModel;
|
|
|
4324
4458
|
* @property {string} [message] - A message indicating the result of the follow
|
|
4325
4459
|
* or unfollow operation.
|
|
4326
4460
|
*/
|
|
4461
|
+
/**
|
|
4462
|
+
* @typedef TaxReqBodyRule
|
|
4463
|
+
* @property {string} name - Tax rule name
|
|
4464
|
+
* @property {string} [description] - Tax rule description
|
|
4465
|
+
*/
|
|
4466
|
+
/**
|
|
4467
|
+
* @typedef TaxThreshold
|
|
4468
|
+
* @property {number} value - Tax rate is applied to products above or equal to
|
|
4469
|
+
* this price.
|
|
4470
|
+
* @property {number} rate - Tax rate ranging from 0 to 1.
|
|
4471
|
+
*/
|
|
4472
|
+
/**
|
|
4473
|
+
* @typedef TaxComponent
|
|
4474
|
+
* @property {string} name - Name of the component.
|
|
4475
|
+
* @property {TaxThreshold[]} slabs - List of thresholds.
|
|
4476
|
+
*/
|
|
4477
|
+
/**
|
|
4478
|
+
* @typedef TaxComponentRes
|
|
4479
|
+
* @property {string} name - Name of the component.
|
|
4480
|
+
* @property {string} [description] - Description of the tax component.
|
|
4481
|
+
* @property {TaxThreshold[]} slabs - List of thresholds.
|
|
4482
|
+
* @property {string} _id - Unique identifier of the tax component. This _id is
|
|
4483
|
+
* required for updating any tax component; If _id field is not in "update tax
|
|
4484
|
+
* version" request then that component will be created.
|
|
4485
|
+
*/
|
|
4486
|
+
/**
|
|
4487
|
+
* @typedef TaxReqBodyVersion
|
|
4488
|
+
* @property {TaxComponent[]} components - List of tax components with their
|
|
4489
|
+
* respective slabs and rates.
|
|
4490
|
+
*/
|
|
4491
|
+
/**
|
|
4492
|
+
* @typedef CreateTaxRequestBody
|
|
4493
|
+
* @property {TaxReqBodyRule} rule
|
|
4494
|
+
* @property {TaxReqBodyVersion[]} versions - List of tax versions for the tax rule.
|
|
4495
|
+
*/
|
|
4496
|
+
/**
|
|
4497
|
+
* @typedef TaxVersion
|
|
4498
|
+
* @property {string} [_id]
|
|
4499
|
+
* @property {string} [rule_id] - Tax Rule ID.
|
|
4500
|
+
* @property {string} [applicable_date] - It is the date from when this rule
|
|
4501
|
+
* will come in effect.
|
|
4502
|
+
* @property {string} [created_on]
|
|
4503
|
+
* @property {string} [modified_on]
|
|
4504
|
+
* @property {number} [company_id] - Company ID.
|
|
4505
|
+
* @property {TaxStatusEnum} [status]
|
|
4506
|
+
* @property {TaxComponentRes[]} [components] - List of tax components.
|
|
4507
|
+
*/
|
|
4508
|
+
/**
|
|
4509
|
+
* @typedef UpdateTaxVersionRequestBody
|
|
4510
|
+
* @property {TaxComponentRes[]} components - List of tax components.
|
|
4511
|
+
* @property {string} applicable_date - It is the date from when this rule will
|
|
4512
|
+
* come in effect. It should be atleast one minute in the future from the current time.
|
|
4513
|
+
*/
|
|
4514
|
+
/**
|
|
4515
|
+
* @typedef CreateTaxVersionRequestBody
|
|
4516
|
+
* @property {TaxComponent[]} components - List of tax components.
|
|
4517
|
+
* @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 current time.
|
|
4519
|
+
*/
|
|
4520
|
+
/**
|
|
4521
|
+
* @typedef TaxRule
|
|
4522
|
+
* @property {string} [_id]
|
|
4523
|
+
* @property {string} [name]
|
|
4524
|
+
* @property {string} [description] - Description of the tax rule.
|
|
4525
|
+
* @property {boolean} [is_default] - Flag to set any tax rule as default, in
|
|
4526
|
+
* case any tax rule is inactive on a product then default tax rule gets applied
|
|
4527
|
+
* @property {number} [company_id]
|
|
4528
|
+
* @property {TaxStatusEnum} [status]
|
|
4529
|
+
* @property {string} [created_on]
|
|
4530
|
+
* @property {string} [modified_on]
|
|
4531
|
+
*/
|
|
4532
|
+
/**
|
|
4533
|
+
* @typedef TaxVersionDetail
|
|
4534
|
+
* @property {string} _id
|
|
4535
|
+
* @property {string} rule_id
|
|
4536
|
+
* @property {string} applicable_date
|
|
4537
|
+
* @property {string} created_on
|
|
4538
|
+
* @property {string} modified_on
|
|
4539
|
+
* @property {number} company_id
|
|
4540
|
+
* @property {TaxStatusEnum} [status]
|
|
4541
|
+
* @property {TaxComponent[]} components - List of components.
|
|
4542
|
+
* @property {string} version_status - Specifies the type of tax version.
|
|
4543
|
+
*/
|
|
4544
|
+
/**
|
|
4545
|
+
* @typedef CreateTax
|
|
4546
|
+
* @property {TaxRule} [rule]
|
|
4547
|
+
* @property {TaxVersion} [versions]
|
|
4548
|
+
*/
|
|
4549
|
+
/**
|
|
4550
|
+
* @typedef UpdateTaxVersion
|
|
4551
|
+
* @property {TaxComponent[]} components - List of components.
|
|
4552
|
+
* @property {string} applicable_date
|
|
4553
|
+
*/
|
|
4554
|
+
/**
|
|
4555
|
+
* @typedef UpdateTaxRequestBody
|
|
4556
|
+
* @property {TaxStatusEnum} status
|
|
4557
|
+
* @property {boolean} is_default - Flag to set any tax rule as default, in case
|
|
4558
|
+
* any tax rule is inactive or not available on a product then default tax
|
|
4559
|
+
* rule gets applied.
|
|
4560
|
+
* @property {string} name - New name of the tax rule.
|
|
4561
|
+
*/
|
|
4562
|
+
/**
|
|
4563
|
+
* @typedef TaxRuleItem
|
|
4564
|
+
* @property {TaxVersionDetail[]} versions
|
|
4565
|
+
* @property {TaxRule} rule
|
|
4566
|
+
*/
|
|
4567
|
+
/**
|
|
4568
|
+
* @typedef TaxRules
|
|
4569
|
+
* @property {TaxRuleItem[]} items - List of tax rules with their versions.
|
|
4570
|
+
* @property {Page} page
|
|
4571
|
+
*/
|
|
4572
|
+
/**
|
|
4573
|
+
* @typedef TaxVersionPastData
|
|
4574
|
+
* @property {TaxVersion[]} [data]
|
|
4575
|
+
* @property {Page} [pagination]
|
|
4576
|
+
*/
|
|
4577
|
+
/**
|
|
4578
|
+
* @typedef TaxRuleVersion
|
|
4579
|
+
* @property {TaxVersionDetail[]} items - List of tax versions.
|
|
4580
|
+
* @property {TaxRule} rule
|
|
4581
|
+
* @property {Page} page
|
|
4582
|
+
*/
|
|
4583
|
+
/**
|
|
4584
|
+
* @typedef HSCodeItem
|
|
4585
|
+
* @property {string} [created_on] - Timestamp of when the HS code was created.
|
|
4586
|
+
* @property {string} [modified_on] - Timestamp of when the HS code was last modified.
|
|
4587
|
+
* @property {HsTypeEnum} type
|
|
4588
|
+
* @property {number} [company_id] - Company ID associated with this HS code.
|
|
4589
|
+
* @property {string} [description] - Description of the HS code.
|
|
4590
|
+
* @property {string} hs_code - The HS code of the product.
|
|
4591
|
+
* @property {string} [_id] - Unique identifier for the HS code entry.
|
|
4592
|
+
* @property {string} [country_iso] - ISO 2-digit country code. Will be set by
|
|
4593
|
+
* default according to company's country.
|
|
4594
|
+
*/
|
|
4595
|
+
/**
|
|
4596
|
+
* @typedef HSCodes
|
|
4597
|
+
* @property {HSCodeItem[]} items - Array of HS code responses.
|
|
4598
|
+
* @property {Page} page
|
|
4599
|
+
*/
|
|
4600
|
+
/**
|
|
4601
|
+
* @typedef CreateTaxComponentName
|
|
4602
|
+
* @property {string} name - Name of a tax component
|
|
4603
|
+
*/
|
|
4604
|
+
/**
|
|
4605
|
+
* @typedef GetTaxComponents
|
|
4606
|
+
* @property {TaxComponentRes[]} items
|
|
4607
|
+
* @property {Page} page
|
|
4608
|
+
*/
|
|
4327
4609
|
/**
|
|
4328
4610
|
* @typedef ActionPage
|
|
4329
4611
|
* @property {Object} [params] - Parameters that should be considered in path.
|
|
@@ -4366,6 +4648,8 @@ export = CatalogPlatformModel;
|
|
|
4366
4648
|
* @property {string} value - The value of the metadata. Should be a non-empty
|
|
4367
4649
|
* string and length should not exceed 100 characters.
|
|
4368
4650
|
*/
|
|
4651
|
+
/** @typedef {"ACTIVE" | "INACTIVE" | "DELETED"} TaxStatusEnum */
|
|
4652
|
+
/** @typedef {"HS" | "SAC"} HsTypeEnum */
|
|
4369
4653
|
/**
|
|
4370
4654
|
* @typedef {| "about-us"
|
|
4371
4655
|
* | "addresses"
|
|
@@ -4419,7 +4703,7 @@ export = CatalogPlatformModel;
|
|
|
4419
4703
|
declare class CatalogPlatformModel {
|
|
4420
4704
|
}
|
|
4421
4705
|
declare namespace CatalogPlatformModel {
|
|
4422
|
-
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, 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, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
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 };
|
|
4423
4707
|
}
|
|
4424
4708
|
/** @returns {Action} */
|
|
4425
4709
|
declare function Action(): Action;
|
|
@@ -7001,6 +7285,10 @@ type RawProduct = {
|
|
|
7001
7285
|
* - List of highlights for the product.
|
|
7002
7286
|
*/
|
|
7003
7287
|
highlights?: string[];
|
|
7288
|
+
/**
|
|
7289
|
+
* - HSN code associated with the product for tax purposes.
|
|
7290
|
+
*/
|
|
7291
|
+
hs_code?: string;
|
|
7004
7292
|
/**
|
|
7005
7293
|
* - HSN code associated with the product for tax purposes.
|
|
7006
7294
|
*/
|
|
@@ -8479,6 +8767,10 @@ type HSNDataInsertV2 = {
|
|
|
8479
8767
|
*/
|
|
8480
8768
|
description: string;
|
|
8481
8769
|
hsn_code: string;
|
|
8770
|
+
/**
|
|
8771
|
+
* - Unique identifier of the tax rule.
|
|
8772
|
+
*/
|
|
8773
|
+
tax_rule_id?: string;
|
|
8482
8774
|
/**
|
|
8483
8775
|
* - Unique identifier of the HSN code.
|
|
8484
8776
|
*/
|
|
@@ -10393,6 +10685,11 @@ type Product = {
|
|
|
10393
10685
|
* - List of key highlights of the product.
|
|
10394
10686
|
*/
|
|
10395
10687
|
highlights?: string[];
|
|
10688
|
+
/**
|
|
10689
|
+
* - HSN (Harmonized System Nomenclature) code for
|
|
10690
|
+
* tax classification.
|
|
10691
|
+
*/
|
|
10692
|
+
hs_code?: string;
|
|
10396
10693
|
/**
|
|
10397
10694
|
* - HSN (Harmonized System Nomenclature) code for
|
|
10398
10695
|
* tax classification.
|
|
@@ -10899,6 +11196,10 @@ type ProductUpdateSchemaV2 = {
|
|
|
10899
11196
|
*/
|
|
10900
11197
|
tags?: string[];
|
|
10901
11198
|
tax_identifier: TaxIdentifier;
|
|
11199
|
+
/**
|
|
11200
|
+
* - HS Code for the product.
|
|
11201
|
+
*/
|
|
11202
|
+
hs_code?: string;
|
|
10902
11203
|
teaser_tag?: TeaserTag;
|
|
10903
11204
|
/**
|
|
10904
11205
|
* - Template tag for the product, used for
|
|
@@ -11088,76 +11389,414 @@ type ProductCreateSchemaV2 = {
|
|
|
11088
11389
|
*/
|
|
11089
11390
|
variants?: any;
|
|
11090
11391
|
};
|
|
11091
|
-
/** @returns {
|
|
11092
|
-
declare function
|
|
11093
|
-
type
|
|
11392
|
+
/** @returns {ProductCreateSchemaV3} */
|
|
11393
|
+
declare function ProductCreateSchemaV3(): ProductCreateSchemaV3;
|
|
11394
|
+
type ProductCreateSchemaV3 = {
|
|
11094
11395
|
/**
|
|
11095
|
-
* -
|
|
11096
|
-
* product
|
|
11396
|
+
* - Custom JSON data that can be used for
|
|
11397
|
+
* additional product properties.
|
|
11097
11398
|
*/
|
|
11098
|
-
|
|
11099
|
-
brand?: ProductBrand;
|
|
11399
|
+
_custom_json?: any;
|
|
11100
11400
|
/**
|
|
11101
|
-
* -
|
|
11401
|
+
* - The action to perform wrt to the product (e.g.,
|
|
11402
|
+
* upsert, update, delete).
|
|
11102
11403
|
*/
|
|
11103
|
-
|
|
11404
|
+
action?: string;
|
|
11104
11405
|
/**
|
|
11105
|
-
* -
|
|
11106
|
-
* attributes of the product, such as product details and specifications.
|
|
11406
|
+
* - Additional attributes related to the product.
|
|
11107
11407
|
*/
|
|
11108
|
-
|
|
11408
|
+
attributes?: any;
|
|
11109
11409
|
/**
|
|
11110
|
-
* -
|
|
11410
|
+
* - Unique identifier for the product's brand.
|
|
11111
11411
|
*/
|
|
11112
|
-
|
|
11412
|
+
brand_uid: number;
|
|
11113
11413
|
/**
|
|
11114
|
-
* -
|
|
11414
|
+
* - Job ID associated with bulk operations.
|
|
11115
11415
|
*/
|
|
11116
|
-
|
|
11416
|
+
bulk_job_id?: string;
|
|
11117
11417
|
/**
|
|
11118
|
-
* - The
|
|
11418
|
+
* - The category to which the product belongs.
|
|
11119
11419
|
*/
|
|
11120
|
-
|
|
11420
|
+
category_slug: string;
|
|
11121
11421
|
/**
|
|
11122
|
-
* -
|
|
11422
|
+
* - Change request identifier for product updates.
|
|
11123
11423
|
*/
|
|
11124
|
-
|
|
11424
|
+
change_request_id?: string;
|
|
11125
11425
|
/**
|
|
11126
|
-
* -
|
|
11426
|
+
* - Unique identifier for the company associated
|
|
11427
|
+
* with the product.
|
|
11127
11428
|
*/
|
|
11128
|
-
|
|
11429
|
+
company_id: number;
|
|
11129
11430
|
/**
|
|
11130
|
-
* -
|
|
11131
|
-
*
|
|
11431
|
+
* - The country where the product was
|
|
11432
|
+
* manufactured or sourced.
|
|
11132
11433
|
*/
|
|
11133
|
-
|
|
11434
|
+
country_of_origin: string;
|
|
11134
11435
|
/**
|
|
11135
|
-
* -
|
|
11436
|
+
* - The currency in which the product's price is listed.
|
|
11136
11437
|
*/
|
|
11137
|
-
|
|
11438
|
+
currency: string;
|
|
11439
|
+
custom_order?: CustomOrder;
|
|
11138
11440
|
/**
|
|
11139
|
-
* -
|
|
11140
|
-
* available online.
|
|
11441
|
+
* - List of department IDs associated with the product.
|
|
11141
11442
|
*/
|
|
11142
|
-
|
|
11443
|
+
departments: number[];
|
|
11143
11444
|
/**
|
|
11144
|
-
* -
|
|
11445
|
+
* - A detailed description of the product.
|
|
11145
11446
|
*/
|
|
11146
|
-
|
|
11447
|
+
description?: string;
|
|
11147
11448
|
/**
|
|
11148
|
-
* -
|
|
11449
|
+
* - Product highlights or key features.
|
|
11149
11450
|
*/
|
|
11150
|
-
|
|
11451
|
+
highlights?: string[];
|
|
11151
11452
|
/**
|
|
11152
|
-
* -
|
|
11453
|
+
* - Flag to indicate if the product is active.
|
|
11153
11454
|
*/
|
|
11154
|
-
|
|
11455
|
+
is_active?: boolean;
|
|
11155
11456
|
/**
|
|
11156
|
-
* -
|
|
11457
|
+
* - Flag to indicate if the product is
|
|
11458
|
+
* dependent on other products.
|
|
11157
11459
|
*/
|
|
11158
|
-
|
|
11460
|
+
is_dependent?: boolean;
|
|
11159
11461
|
/**
|
|
11160
|
-
* -
|
|
11462
|
+
* - Flag to indicate if the product
|
|
11463
|
+
* does not have associated images.
|
|
11464
|
+
*/
|
|
11465
|
+
is_image_less_product?: boolean;
|
|
11466
|
+
/**
|
|
11467
|
+
* - Flag to indicate if the product is part of a set.
|
|
11468
|
+
*/
|
|
11469
|
+
is_set?: boolean;
|
|
11470
|
+
/**
|
|
11471
|
+
* - Unique item code or SKU of the product.
|
|
11472
|
+
*/
|
|
11473
|
+
item_code: string;
|
|
11474
|
+
/**
|
|
11475
|
+
* - Type of the product (e.g., standard, set,
|
|
11476
|
+
* composite, digital).
|
|
11477
|
+
*/
|
|
11478
|
+
item_type: string;
|
|
11479
|
+
/**
|
|
11480
|
+
* - List of media URLs (images, videos) associated
|
|
11481
|
+
* with the product.
|
|
11482
|
+
*/
|
|
11483
|
+
media?: Media[];
|
|
11484
|
+
/**
|
|
11485
|
+
* - Indicates if the product supports multiple sizes.
|
|
11486
|
+
*/
|
|
11487
|
+
multi_size?: boolean;
|
|
11488
|
+
/**
|
|
11489
|
+
* - The name of the product.
|
|
11490
|
+
*/
|
|
11491
|
+
name: string;
|
|
11492
|
+
net_quantity?: NetQuantity;
|
|
11493
|
+
/**
|
|
11494
|
+
* - Number of boxes required to package the product.
|
|
11495
|
+
*/
|
|
11496
|
+
no_of_boxes?: number;
|
|
11497
|
+
/**
|
|
11498
|
+
* - Tags to group products together
|
|
11499
|
+
* for classification.
|
|
11500
|
+
*/
|
|
11501
|
+
product_group_tag?: string[];
|
|
11502
|
+
product_publish?: ProductPublish;
|
|
11503
|
+
/**
|
|
11504
|
+
* - The role requesting the product operation
|
|
11505
|
+
* (admin or user).
|
|
11506
|
+
*/
|
|
11507
|
+
requester?: string;
|
|
11508
|
+
return_config: ReturnConfig;
|
|
11509
|
+
/**
|
|
11510
|
+
* - A short description of the product,
|
|
11511
|
+
* up to 50 characters.
|
|
11512
|
+
*/
|
|
11513
|
+
short_description?: string;
|
|
11514
|
+
/**
|
|
11515
|
+
* - Identifier for the product's size guide.
|
|
11516
|
+
*/
|
|
11517
|
+
size_guide?: string;
|
|
11518
|
+
/**
|
|
11519
|
+
* - List of sizes available for the product.
|
|
11520
|
+
*/
|
|
11521
|
+
sizes: any[];
|
|
11522
|
+
/**
|
|
11523
|
+
* - URL-friendly identifier for the product.
|
|
11524
|
+
*/
|
|
11525
|
+
slug: string;
|
|
11526
|
+
/**
|
|
11527
|
+
* - List of tags associated with the product.
|
|
11528
|
+
*/
|
|
11529
|
+
tags?: string[];
|
|
11530
|
+
tax_identifier: TaxIdentifierV3;
|
|
11531
|
+
teaser_tag?: TeaserTag;
|
|
11532
|
+
/**
|
|
11533
|
+
* - Template tag for the product, used for
|
|
11534
|
+
* classification.
|
|
11535
|
+
*/
|
|
11536
|
+
template_tag: string;
|
|
11537
|
+
/**
|
|
11538
|
+
* - List of traders associated with the product.
|
|
11539
|
+
*/
|
|
11540
|
+
trader: Trader[];
|
|
11541
|
+
/**
|
|
11542
|
+
* - Variant group information for the product.
|
|
11543
|
+
*/
|
|
11544
|
+
variant_group?: any;
|
|
11545
|
+
/**
|
|
11546
|
+
* - Media related to product variants.
|
|
11547
|
+
*/
|
|
11548
|
+
variant_media?: any;
|
|
11549
|
+
/**
|
|
11550
|
+
* - Variants information for the product.
|
|
11551
|
+
*/
|
|
11552
|
+
variants?: any;
|
|
11553
|
+
/**
|
|
11554
|
+
* - HS Code for the product. This is required for
|
|
11555
|
+
* indian companies.
|
|
11556
|
+
*/
|
|
11557
|
+
hs_code?: string;
|
|
11558
|
+
};
|
|
11559
|
+
/** @returns {ProductUpdateSchemaV3} */
|
|
11560
|
+
declare function ProductUpdateSchemaV3(): ProductUpdateSchemaV3;
|
|
11561
|
+
type ProductUpdateSchemaV3 = {
|
|
11562
|
+
/**
|
|
11563
|
+
* - Custom JSON data that can be used for
|
|
11564
|
+
* additional product properties.
|
|
11565
|
+
*/
|
|
11566
|
+
_custom_json?: any;
|
|
11567
|
+
/**
|
|
11568
|
+
* - The action to perform wrt to the product (e.g.,
|
|
11569
|
+
* upsert, update, delete).
|
|
11570
|
+
*/
|
|
11571
|
+
action?: string;
|
|
11572
|
+
/**
|
|
11573
|
+
* - Additional attributes related to the product.
|
|
11574
|
+
*/
|
|
11575
|
+
attributes?: any;
|
|
11576
|
+
/**
|
|
11577
|
+
* - Unique identifier for the product's brand.
|
|
11578
|
+
*/
|
|
11579
|
+
brand_uid: number;
|
|
11580
|
+
/**
|
|
11581
|
+
* - Job ID associated with bulk operations.
|
|
11582
|
+
*/
|
|
11583
|
+
bulk_job_id?: string;
|
|
11584
|
+
/**
|
|
11585
|
+
* - The category to which the product belongs.
|
|
11586
|
+
*/
|
|
11587
|
+
category_slug: string;
|
|
11588
|
+
/**
|
|
11589
|
+
* - Change request identifier for product updates.
|
|
11590
|
+
*/
|
|
11591
|
+
change_request_id?: string;
|
|
11592
|
+
/**
|
|
11593
|
+
* - Unique identifier for the company associated
|
|
11594
|
+
* with the product.
|
|
11595
|
+
*/
|
|
11596
|
+
company_id: number;
|
|
11597
|
+
/**
|
|
11598
|
+
* - The country where the product was
|
|
11599
|
+
* manufactured or sourced.
|
|
11600
|
+
*/
|
|
11601
|
+
country_of_origin: string;
|
|
11602
|
+
/**
|
|
11603
|
+
* - The currency in which the product's price is listed.
|
|
11604
|
+
*/
|
|
11605
|
+
currency: string;
|
|
11606
|
+
custom_order?: CustomOrder;
|
|
11607
|
+
/**
|
|
11608
|
+
* - List of department IDs associated with the product.
|
|
11609
|
+
*/
|
|
11610
|
+
departments: number[];
|
|
11611
|
+
/**
|
|
11612
|
+
* - A detailed description of the product.
|
|
11613
|
+
*/
|
|
11614
|
+
description?: string;
|
|
11615
|
+
/**
|
|
11616
|
+
* - Product highlights or key features.
|
|
11617
|
+
*/
|
|
11618
|
+
highlights?: string[];
|
|
11619
|
+
/**
|
|
11620
|
+
* - Flag to indicate if the product is active.
|
|
11621
|
+
*/
|
|
11622
|
+
is_active?: boolean;
|
|
11623
|
+
/**
|
|
11624
|
+
* - Flag to indicate if the product is
|
|
11625
|
+
* dependent on other products.
|
|
11626
|
+
*/
|
|
11627
|
+
is_dependent?: boolean;
|
|
11628
|
+
/**
|
|
11629
|
+
* - Flag to indicate if the product
|
|
11630
|
+
* does not have associated images.
|
|
11631
|
+
*/
|
|
11632
|
+
is_image_less_product?: boolean;
|
|
11633
|
+
/**
|
|
11634
|
+
* - Flag to indicate if the product is part of a set.
|
|
11635
|
+
*/
|
|
11636
|
+
is_set?: boolean;
|
|
11637
|
+
/**
|
|
11638
|
+
* - Unique item code or SKU of the product.
|
|
11639
|
+
*/
|
|
11640
|
+
item_code: string;
|
|
11641
|
+
/**
|
|
11642
|
+
* - Type of the product (e.g., standard, set,
|
|
11643
|
+
* composite, digital).
|
|
11644
|
+
*/
|
|
11645
|
+
item_type: string;
|
|
11646
|
+
/**
|
|
11647
|
+
* - List of media URLs (images, videos) associated
|
|
11648
|
+
* with the product.
|
|
11649
|
+
*/
|
|
11650
|
+
media?: Media[];
|
|
11651
|
+
/**
|
|
11652
|
+
* - Indicates if the product supports multiple sizes.
|
|
11653
|
+
*/
|
|
11654
|
+
multi_size?: boolean;
|
|
11655
|
+
/**
|
|
11656
|
+
* - The name of the product.
|
|
11657
|
+
*/
|
|
11658
|
+
name: string;
|
|
11659
|
+
net_quantity?: NetQuantity;
|
|
11660
|
+
/**
|
|
11661
|
+
* - Number of boxes required to package the product.
|
|
11662
|
+
*/
|
|
11663
|
+
no_of_boxes?: number;
|
|
11664
|
+
/**
|
|
11665
|
+
* - Tags to group products together
|
|
11666
|
+
* for classification.
|
|
11667
|
+
*/
|
|
11668
|
+
product_group_tag?: string[];
|
|
11669
|
+
product_publish?: ProductPublish;
|
|
11670
|
+
/**
|
|
11671
|
+
* - The role requesting the product operation
|
|
11672
|
+
* (admin or user).
|
|
11673
|
+
*/
|
|
11674
|
+
requester?: string;
|
|
11675
|
+
return_config: ReturnConfig;
|
|
11676
|
+
/**
|
|
11677
|
+
* - A short description of the product,
|
|
11678
|
+
* up to 50 characters.
|
|
11679
|
+
*/
|
|
11680
|
+
short_description?: string;
|
|
11681
|
+
/**
|
|
11682
|
+
* - Identifier for the product's size guide.
|
|
11683
|
+
*/
|
|
11684
|
+
size_guide?: string;
|
|
11685
|
+
/**
|
|
11686
|
+
* - List of sizes available for the product.
|
|
11687
|
+
*/
|
|
11688
|
+
sizes: any[];
|
|
11689
|
+
/**
|
|
11690
|
+
* - URL-friendly identifier for the product.
|
|
11691
|
+
*/
|
|
11692
|
+
slug: string;
|
|
11693
|
+
/**
|
|
11694
|
+
* - List of tags associated with the product.
|
|
11695
|
+
*/
|
|
11696
|
+
tags?: string[];
|
|
11697
|
+
tax_identifier: TaxIdentifierV3;
|
|
11698
|
+
/**
|
|
11699
|
+
* - HS Code for the product. This is required for
|
|
11700
|
+
* indian companies.
|
|
11701
|
+
*/
|
|
11702
|
+
hs_code?: string;
|
|
11703
|
+
teaser_tag?: TeaserTag;
|
|
11704
|
+
/**
|
|
11705
|
+
* - Template tag for the product, used for
|
|
11706
|
+
* classification.
|
|
11707
|
+
*/
|
|
11708
|
+
template_tag: string;
|
|
11709
|
+
/**
|
|
11710
|
+
* - List of traders associated with the product.
|
|
11711
|
+
*/
|
|
11712
|
+
trader: Trader[];
|
|
11713
|
+
/**
|
|
11714
|
+
* - Unique identifier for the product.
|
|
11715
|
+
*/
|
|
11716
|
+
uid?: number;
|
|
11717
|
+
/**
|
|
11718
|
+
* - Variant group information for the product.
|
|
11719
|
+
*/
|
|
11720
|
+
variant_group?: any;
|
|
11721
|
+
/**
|
|
11722
|
+
* - Media related to product variants.
|
|
11723
|
+
*/
|
|
11724
|
+
variant_media?: any;
|
|
11725
|
+
/**
|
|
11726
|
+
* - Variants information for the product.
|
|
11727
|
+
*/
|
|
11728
|
+
variants?: any;
|
|
11729
|
+
};
|
|
11730
|
+
/** @returns {ProductDetail} */
|
|
11731
|
+
declare function ProductDetail(): ProductDetail;
|
|
11732
|
+
type ProductDetail = {
|
|
11733
|
+
/**
|
|
11734
|
+
* - Key-value pairs representing various
|
|
11735
|
+
* product attributes.
|
|
11736
|
+
*/
|
|
11737
|
+
attributes?: any;
|
|
11738
|
+
brand?: ProductBrand;
|
|
11739
|
+
/**
|
|
11740
|
+
* - Detailed description of the product.
|
|
11741
|
+
*/
|
|
11742
|
+
description?: string;
|
|
11743
|
+
/**
|
|
11744
|
+
* - Grouped
|
|
11745
|
+
* attributes of the product, such as product details and specifications.
|
|
11746
|
+
*/
|
|
11747
|
+
grouped_attributes?: ProductDetailGroupedAttribute[];
|
|
11748
|
+
/**
|
|
11749
|
+
* - Indicates whether the product has variants.
|
|
11750
|
+
*/
|
|
11751
|
+
has_variant?: boolean;
|
|
11752
|
+
/**
|
|
11753
|
+
* - Array of highlight features for the product.
|
|
11754
|
+
*/
|
|
11755
|
+
highlights?: string[];
|
|
11756
|
+
/**
|
|
11757
|
+
* - The nature of the product's images.
|
|
11758
|
+
*/
|
|
11759
|
+
image_nature?: string;
|
|
11760
|
+
/**
|
|
11761
|
+
* - Unique item code for the product.
|
|
11762
|
+
*/
|
|
11763
|
+
item_code?: string;
|
|
11764
|
+
/**
|
|
11765
|
+
* - Type of the item.
|
|
11766
|
+
*/
|
|
11767
|
+
item_type?: string;
|
|
11768
|
+
/**
|
|
11769
|
+
* - Array of media objects such as images and
|
|
11770
|
+
* videos for the product.
|
|
11771
|
+
*/
|
|
11772
|
+
medias?: Media[];
|
|
11773
|
+
/**
|
|
11774
|
+
* - Name of the product.
|
|
11775
|
+
*/
|
|
11776
|
+
name?: string;
|
|
11777
|
+
/**
|
|
11778
|
+
* - Date when the product was made
|
|
11779
|
+
* available online.
|
|
11780
|
+
*/
|
|
11781
|
+
product_online_date?: string;
|
|
11782
|
+
/**
|
|
11783
|
+
* - Promotional metadata associated with the product.
|
|
11784
|
+
*/
|
|
11785
|
+
promo_meta?: any;
|
|
11786
|
+
/**
|
|
11787
|
+
* - Average rating of the product.
|
|
11788
|
+
*/
|
|
11789
|
+
rating?: number;
|
|
11790
|
+
/**
|
|
11791
|
+
* - Total number of ratings for the product.
|
|
11792
|
+
*/
|
|
11793
|
+
rating_count?: number;
|
|
11794
|
+
/**
|
|
11795
|
+
* - A brief description of the product.
|
|
11796
|
+
*/
|
|
11797
|
+
short_description?: string;
|
|
11798
|
+
/**
|
|
11799
|
+
* - Array of similar products.
|
|
11161
11800
|
*/
|
|
11162
11801
|
similars?: string[];
|
|
11163
11802
|
/**
|
|
@@ -12167,7 +12806,14 @@ type ProductSchemaV2 = {
|
|
|
12167
12806
|
highlights?: string[];
|
|
12168
12807
|
/**
|
|
12169
12808
|
* - Harmonized System Nomenclature (HSN) code for
|
|
12170
|
-
* taxation purposes.
|
|
12809
|
+
* taxation purposes. This is required for indian products.
|
|
12810
|
+
*/
|
|
12811
|
+
hs_code?: string;
|
|
12812
|
+
/**
|
|
12813
|
+
* - **Deprecated**: Harmonized System
|
|
12814
|
+
* Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
|
|
12815
|
+
* field instead.\
|
|
12816
|
+
* _Deprecated_*
|
|
12171
12817
|
*/
|
|
12172
12818
|
hsn_code?: string;
|
|
12173
12819
|
/**
|
|
@@ -12533,6 +13179,11 @@ type ProductTemplateExportFilterRequestSchema = {
|
|
|
12533
13179
|
* - The list of the brands that needs to be exported.
|
|
12534
13180
|
*/
|
|
12535
13181
|
brands?: string[];
|
|
13182
|
+
/**
|
|
13183
|
+
* - The list of the tax rule ids that needs
|
|
13184
|
+
* to be exported.
|
|
13185
|
+
*/
|
|
13186
|
+
tax_rule_ids?: string[];
|
|
12536
13187
|
/**
|
|
12537
13188
|
* - The list of the type of the catalog
|
|
12538
13189
|
* such as set, standard and composite.
|
|
@@ -12647,6 +13298,7 @@ type Properties = {
|
|
|
12647
13298
|
custom_order?: any;
|
|
12648
13299
|
description?: any;
|
|
12649
13300
|
highlights?: any;
|
|
13301
|
+
hs_code?: any;
|
|
12650
13302
|
hsn_code?: any;
|
|
12651
13303
|
is_active?: any;
|
|
12652
13304
|
is_dependent?: any;
|
|
@@ -13181,10 +13833,31 @@ type SuccessResponseObject = {
|
|
|
13181
13833
|
/** @returns {TaxIdentifier} */
|
|
13182
13834
|
declare function TaxIdentifier(): TaxIdentifier;
|
|
13183
13835
|
type TaxIdentifier = {
|
|
13836
|
+
/**
|
|
13837
|
+
* - The unique identifier of the tax rule.
|
|
13838
|
+
*/
|
|
13839
|
+
tax_rule_id?: string;
|
|
13840
|
+
/**
|
|
13841
|
+
* _Deprecated_*
|
|
13842
|
+
*/
|
|
13184
13843
|
hsn_code?: string;
|
|
13844
|
+
/**
|
|
13845
|
+
* _Deprecated_*
|
|
13846
|
+
*/
|
|
13185
13847
|
hsn_code_id?: string;
|
|
13848
|
+
/**
|
|
13849
|
+
* _Deprecated_*
|
|
13850
|
+
*/
|
|
13186
13851
|
reporting_hsn?: string;
|
|
13187
13852
|
};
|
|
13853
|
+
/** @returns {TaxIdentifierV3} */
|
|
13854
|
+
declare function TaxIdentifierV3(): TaxIdentifierV3;
|
|
13855
|
+
type TaxIdentifierV3 = {
|
|
13856
|
+
/**
|
|
13857
|
+
* - The unique identifier of the tax rule.
|
|
13858
|
+
*/
|
|
13859
|
+
tax_rule_id: string;
|
|
13860
|
+
};
|
|
13188
13861
|
/** @returns {TaxSlab} */
|
|
13189
13862
|
declare function TaxSlab(): TaxSlab;
|
|
13190
13863
|
type TaxSlab = {
|
|
@@ -13788,6 +14461,290 @@ type FollowProduct = {
|
|
|
13788
14461
|
*/
|
|
13789
14462
|
message?: string;
|
|
13790
14463
|
};
|
|
14464
|
+
/** @returns {TaxReqBodyRule} */
|
|
14465
|
+
declare function TaxReqBodyRule(): TaxReqBodyRule;
|
|
14466
|
+
type TaxReqBodyRule = {
|
|
14467
|
+
/**
|
|
14468
|
+
* - Tax rule name
|
|
14469
|
+
*/
|
|
14470
|
+
name: string;
|
|
14471
|
+
/**
|
|
14472
|
+
* - Tax rule description
|
|
14473
|
+
*/
|
|
14474
|
+
description?: string;
|
|
14475
|
+
};
|
|
14476
|
+
/** @returns {TaxThreshold} */
|
|
14477
|
+
declare function TaxThreshold(): TaxThreshold;
|
|
14478
|
+
type TaxThreshold = {
|
|
14479
|
+
/**
|
|
14480
|
+
* - Tax rate is applied to products above or equal to
|
|
14481
|
+
* this price.
|
|
14482
|
+
*/
|
|
14483
|
+
value: number;
|
|
14484
|
+
/**
|
|
14485
|
+
* - Tax rate ranging from 0 to 1.
|
|
14486
|
+
*/
|
|
14487
|
+
rate: number;
|
|
14488
|
+
};
|
|
14489
|
+
/** @returns {TaxComponent} */
|
|
14490
|
+
declare function TaxComponent(): TaxComponent;
|
|
14491
|
+
type TaxComponent = {
|
|
14492
|
+
/**
|
|
14493
|
+
* - Name of the component.
|
|
14494
|
+
*/
|
|
14495
|
+
name: string;
|
|
14496
|
+
/**
|
|
14497
|
+
* - List of thresholds.
|
|
14498
|
+
*/
|
|
14499
|
+
slabs: TaxThreshold[];
|
|
14500
|
+
};
|
|
14501
|
+
/** @returns {TaxComponentRes} */
|
|
14502
|
+
declare function TaxComponentRes(): TaxComponentRes;
|
|
14503
|
+
type TaxComponentRes = {
|
|
14504
|
+
/**
|
|
14505
|
+
* - Name of the component.
|
|
14506
|
+
*/
|
|
14507
|
+
name: string;
|
|
14508
|
+
/**
|
|
14509
|
+
* - Description of the tax component.
|
|
14510
|
+
*/
|
|
14511
|
+
description?: string;
|
|
14512
|
+
/**
|
|
14513
|
+
* - List of thresholds.
|
|
14514
|
+
*/
|
|
14515
|
+
slabs: TaxThreshold[];
|
|
14516
|
+
/**
|
|
14517
|
+
* - Unique identifier of the tax component. This _id is
|
|
14518
|
+
* required for updating any tax component; If _id field is not in "update tax
|
|
14519
|
+
* version" request then that component will be created.
|
|
14520
|
+
*/
|
|
14521
|
+
_id: string;
|
|
14522
|
+
};
|
|
14523
|
+
/** @returns {TaxReqBodyVersion} */
|
|
14524
|
+
declare function TaxReqBodyVersion(): TaxReqBodyVersion;
|
|
14525
|
+
type TaxReqBodyVersion = {
|
|
14526
|
+
/**
|
|
14527
|
+
* - List of tax components with their
|
|
14528
|
+
* respective slabs and rates.
|
|
14529
|
+
*/
|
|
14530
|
+
components: TaxComponent[];
|
|
14531
|
+
};
|
|
14532
|
+
/** @returns {CreateTaxRequestBody} */
|
|
14533
|
+
declare function CreateTaxRequestBody(): CreateTaxRequestBody;
|
|
14534
|
+
type CreateTaxRequestBody = {
|
|
14535
|
+
rule: TaxReqBodyRule;
|
|
14536
|
+
/**
|
|
14537
|
+
* - List of tax versions for the tax rule.
|
|
14538
|
+
*/
|
|
14539
|
+
versions: TaxReqBodyVersion[];
|
|
14540
|
+
};
|
|
14541
|
+
/** @returns {TaxVersion} */
|
|
14542
|
+
declare function TaxVersion(): TaxVersion;
|
|
14543
|
+
type TaxVersion = {
|
|
14544
|
+
_id?: string;
|
|
14545
|
+
/**
|
|
14546
|
+
* - Tax Rule ID.
|
|
14547
|
+
*/
|
|
14548
|
+
rule_id?: string;
|
|
14549
|
+
/**
|
|
14550
|
+
* - It is the date from when this rule
|
|
14551
|
+
* will come in effect.
|
|
14552
|
+
*/
|
|
14553
|
+
applicable_date?: string;
|
|
14554
|
+
created_on?: string;
|
|
14555
|
+
modified_on?: string;
|
|
14556
|
+
/**
|
|
14557
|
+
* - Company ID.
|
|
14558
|
+
*/
|
|
14559
|
+
company_id?: number;
|
|
14560
|
+
status?: TaxStatusEnum;
|
|
14561
|
+
/**
|
|
14562
|
+
* - List of tax components.
|
|
14563
|
+
*/
|
|
14564
|
+
components?: TaxComponentRes[];
|
|
14565
|
+
};
|
|
14566
|
+
/** @returns {UpdateTaxVersionRequestBody} */
|
|
14567
|
+
declare function UpdateTaxVersionRequestBody(): UpdateTaxVersionRequestBody;
|
|
14568
|
+
type UpdateTaxVersionRequestBody = {
|
|
14569
|
+
/**
|
|
14570
|
+
* - List of tax components.
|
|
14571
|
+
*/
|
|
14572
|
+
components: TaxComponentRes[];
|
|
14573
|
+
/**
|
|
14574
|
+
* - It is the date from when this rule will
|
|
14575
|
+
* come in effect. It should be atleast one minute in the future from the current time.
|
|
14576
|
+
*/
|
|
14577
|
+
applicable_date: string;
|
|
14578
|
+
};
|
|
14579
|
+
/** @returns {CreateTaxVersionRequestBody} */
|
|
14580
|
+
declare function CreateTaxVersionRequestBody(): CreateTaxVersionRequestBody;
|
|
14581
|
+
type CreateTaxVersionRequestBody = {
|
|
14582
|
+
/**
|
|
14583
|
+
* - List of tax components.
|
|
14584
|
+
*/
|
|
14585
|
+
components: TaxComponent[];
|
|
14586
|
+
/**
|
|
14587
|
+
* - It is the date from when this rule will
|
|
14588
|
+
* come in effect. It should be atleast one minute in the future from the current time.
|
|
14589
|
+
*/
|
|
14590
|
+
applicable_date: string;
|
|
14591
|
+
};
|
|
14592
|
+
/** @returns {TaxRule} */
|
|
14593
|
+
declare function TaxRule(): TaxRule;
|
|
14594
|
+
type TaxRule = {
|
|
14595
|
+
_id?: string;
|
|
14596
|
+
name?: string;
|
|
14597
|
+
/**
|
|
14598
|
+
* - Description of the tax rule.
|
|
14599
|
+
*/
|
|
14600
|
+
description?: string;
|
|
14601
|
+
/**
|
|
14602
|
+
* - Flag to set any tax rule as default, in
|
|
14603
|
+
* case any tax rule is inactive on a product then default tax rule gets applied
|
|
14604
|
+
*/
|
|
14605
|
+
is_default?: boolean;
|
|
14606
|
+
company_id?: number;
|
|
14607
|
+
status?: TaxStatusEnum;
|
|
14608
|
+
created_on?: string;
|
|
14609
|
+
modified_on?: string;
|
|
14610
|
+
};
|
|
14611
|
+
/** @returns {TaxVersionDetail} */
|
|
14612
|
+
declare function TaxVersionDetail(): TaxVersionDetail;
|
|
14613
|
+
type TaxVersionDetail = {
|
|
14614
|
+
_id: string;
|
|
14615
|
+
rule_id: string;
|
|
14616
|
+
applicable_date: string;
|
|
14617
|
+
created_on: string;
|
|
14618
|
+
modified_on: string;
|
|
14619
|
+
company_id: number;
|
|
14620
|
+
status?: TaxStatusEnum;
|
|
14621
|
+
/**
|
|
14622
|
+
* - List of components.
|
|
14623
|
+
*/
|
|
14624
|
+
components: TaxComponent[];
|
|
14625
|
+
/**
|
|
14626
|
+
* - Specifies the type of tax version.
|
|
14627
|
+
*/
|
|
14628
|
+
version_status: string;
|
|
14629
|
+
};
|
|
14630
|
+
/** @returns {CreateTax} */
|
|
14631
|
+
declare function CreateTax(): CreateTax;
|
|
14632
|
+
type CreateTax = {
|
|
14633
|
+
rule?: TaxRule;
|
|
14634
|
+
versions?: TaxVersion;
|
|
14635
|
+
};
|
|
14636
|
+
/** @returns {UpdateTaxVersion} */
|
|
14637
|
+
declare function UpdateTaxVersion(): UpdateTaxVersion;
|
|
14638
|
+
type UpdateTaxVersion = {
|
|
14639
|
+
/**
|
|
14640
|
+
* - List of components.
|
|
14641
|
+
*/
|
|
14642
|
+
components: TaxComponent[];
|
|
14643
|
+
applicable_date: string;
|
|
14644
|
+
};
|
|
14645
|
+
/** @returns {UpdateTaxRequestBody} */
|
|
14646
|
+
declare function UpdateTaxRequestBody(): UpdateTaxRequestBody;
|
|
14647
|
+
type UpdateTaxRequestBody = {
|
|
14648
|
+
status: TaxStatusEnum;
|
|
14649
|
+
/**
|
|
14650
|
+
* - Flag to set any tax rule as default, in case
|
|
14651
|
+
* any tax rule is inactive or not available on a product then default tax
|
|
14652
|
+
* rule gets applied.
|
|
14653
|
+
*/
|
|
14654
|
+
is_default: boolean;
|
|
14655
|
+
/**
|
|
14656
|
+
* - New name of the tax rule.
|
|
14657
|
+
*/
|
|
14658
|
+
name: string;
|
|
14659
|
+
};
|
|
14660
|
+
/** @returns {TaxRuleItem} */
|
|
14661
|
+
declare function TaxRuleItem(): TaxRuleItem;
|
|
14662
|
+
type TaxRuleItem = {
|
|
14663
|
+
versions: TaxVersionDetail[];
|
|
14664
|
+
rule: TaxRule;
|
|
14665
|
+
};
|
|
14666
|
+
/** @returns {TaxRules} */
|
|
14667
|
+
declare function TaxRules(): TaxRules;
|
|
14668
|
+
type TaxRules = {
|
|
14669
|
+
/**
|
|
14670
|
+
* - List of tax rules with their versions.
|
|
14671
|
+
*/
|
|
14672
|
+
items: TaxRuleItem[];
|
|
14673
|
+
page: Page;
|
|
14674
|
+
};
|
|
14675
|
+
/** @returns {TaxVersionPastData} */
|
|
14676
|
+
declare function TaxVersionPastData(): TaxVersionPastData;
|
|
14677
|
+
type TaxVersionPastData = {
|
|
14678
|
+
data?: TaxVersion[];
|
|
14679
|
+
pagination?: Page;
|
|
14680
|
+
};
|
|
14681
|
+
/** @returns {TaxRuleVersion} */
|
|
14682
|
+
declare function TaxRuleVersion(): TaxRuleVersion;
|
|
14683
|
+
type TaxRuleVersion = {
|
|
14684
|
+
/**
|
|
14685
|
+
* - List of tax versions.
|
|
14686
|
+
*/
|
|
14687
|
+
items: TaxVersionDetail[];
|
|
14688
|
+
rule: TaxRule;
|
|
14689
|
+
page: Page;
|
|
14690
|
+
};
|
|
14691
|
+
/** @returns {HSCodeItem} */
|
|
14692
|
+
declare function HSCodeItem(): HSCodeItem;
|
|
14693
|
+
type HSCodeItem = {
|
|
14694
|
+
/**
|
|
14695
|
+
* - Timestamp of when the HS code was created.
|
|
14696
|
+
*/
|
|
14697
|
+
created_on?: string;
|
|
14698
|
+
/**
|
|
14699
|
+
* - Timestamp of when the HS code was last modified.
|
|
14700
|
+
*/
|
|
14701
|
+
modified_on?: string;
|
|
14702
|
+
type: HsTypeEnum;
|
|
14703
|
+
/**
|
|
14704
|
+
* - Company ID associated with this HS code.
|
|
14705
|
+
*/
|
|
14706
|
+
company_id?: number;
|
|
14707
|
+
/**
|
|
14708
|
+
* - Description of the HS code.
|
|
14709
|
+
*/
|
|
14710
|
+
description?: string;
|
|
14711
|
+
/**
|
|
14712
|
+
* - The HS code of the product.
|
|
14713
|
+
*/
|
|
14714
|
+
hs_code: string;
|
|
14715
|
+
/**
|
|
14716
|
+
* - Unique identifier for the HS code entry.
|
|
14717
|
+
*/
|
|
14718
|
+
_id?: string;
|
|
14719
|
+
/**
|
|
14720
|
+
* - ISO 2-digit country code. Will be set by
|
|
14721
|
+
* default according to company's country.
|
|
14722
|
+
*/
|
|
14723
|
+
country_iso?: string;
|
|
14724
|
+
};
|
|
14725
|
+
/** @returns {HSCodes} */
|
|
14726
|
+
declare function HSCodes(): HSCodes;
|
|
14727
|
+
type HSCodes = {
|
|
14728
|
+
/**
|
|
14729
|
+
* - Array of HS code responses.
|
|
14730
|
+
*/
|
|
14731
|
+
items: HSCodeItem[];
|
|
14732
|
+
page: Page;
|
|
14733
|
+
};
|
|
14734
|
+
/** @returns {CreateTaxComponentName} */
|
|
14735
|
+
declare function CreateTaxComponentName(): CreateTaxComponentName;
|
|
14736
|
+
type CreateTaxComponentName = {
|
|
14737
|
+
/**
|
|
14738
|
+
* - Name of a tax component
|
|
14739
|
+
*/
|
|
14740
|
+
name: string;
|
|
14741
|
+
};
|
|
14742
|
+
/** @returns {GetTaxComponents} */
|
|
14743
|
+
declare function GetTaxComponents(): GetTaxComponents;
|
|
14744
|
+
type GetTaxComponents = {
|
|
14745
|
+
items: TaxComponentRes[];
|
|
14746
|
+
page: Page;
|
|
14747
|
+
};
|
|
13791
14748
|
/** @returns {ActionPage} */
|
|
13792
14749
|
declare function ActionPage(): ActionPage;
|
|
13793
14750
|
type ActionPage = {
|
|
@@ -13881,6 +14838,20 @@ type CustomMeta = {
|
|
|
13881
14838
|
*/
|
|
13882
14839
|
value: string;
|
|
13883
14840
|
};
|
|
14841
|
+
/**
|
|
14842
|
+
* Enum: TaxStatusEnum Used By: Catalog
|
|
14843
|
+
*
|
|
14844
|
+
* @returns {TaxStatusEnum}
|
|
14845
|
+
*/
|
|
14846
|
+
declare function TaxStatusEnum(): TaxStatusEnum;
|
|
14847
|
+
type TaxStatusEnum = "ACTIVE" | "INACTIVE" | "DELETED";
|
|
14848
|
+
/**
|
|
14849
|
+
* Enum: HsTypeEnum Used By: Catalog
|
|
14850
|
+
*
|
|
14851
|
+
* @returns {HsTypeEnum}
|
|
14852
|
+
*/
|
|
14853
|
+
declare function HsTypeEnum(): HsTypeEnum;
|
|
14854
|
+
type HsTypeEnum = "HS" | "SAC";
|
|
13884
14855
|
/**
|
|
13885
14856
|
* Enum: PageType Used By: Catalog
|
|
13886
14857
|
*
|