@gofynd/fdk-client-javascript 3.7.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/application/Payment/PaymentApplicationClient.d.ts +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.js +210 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +124 -6
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1074 -175
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1072 -45
- package/sdk/platform/Catalog/CatalogPlatformModel.js +714 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +193 -19
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +167 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +9 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/Order/OrderPlatformModel.d.ts +49 -1
- package/sdk/platform/Order/OrderPlatformModel.js +28 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +0 -4
|
@@ -1354,6 +1354,7 @@ export = CatalogPlatformModel;
|
|
|
1354
1354
|
* the product.
|
|
1355
1355
|
* @property {string} [description] - Detailed description of the product.
|
|
1356
1356
|
* @property {string[]} [highlights] - List of highlights for the product.
|
|
1357
|
+
* @property {string} [hs_code] - HSN code associated with the product for tax purposes.
|
|
1357
1358
|
* @property {string} [hsn_code] - HSN code associated with the product for tax purposes.
|
|
1358
1359
|
* @property {string} [id] - Unique identifier of the product.
|
|
1359
1360
|
* @property {string} [image_nature] - Nature or type of product images.
|
|
@@ -2026,6 +2027,7 @@ export = CatalogPlatformModel;
|
|
|
2026
2027
|
* @property {string} [created_on] - Date and time when the HSN data was created.
|
|
2027
2028
|
* @property {string} description - Description of the HSN data.
|
|
2028
2029
|
* @property {string} hsn_code
|
|
2030
|
+
* @property {string} [tax_rule_id] - Unique identifier of the tax rule.
|
|
2029
2031
|
* @property {string} [hsn_code_id] - Unique identifier of the HSN code.
|
|
2030
2032
|
* @property {string} [modified_on] - Date and time when the HSN data was last modified.
|
|
2031
2033
|
* @property {Object} reporting_hsn - HSN code.
|
|
@@ -2872,6 +2874,8 @@ export = CatalogPlatformModel;
|
|
|
2872
2874
|
* @property {number[]} [departments] - List of department IDs related to the product.
|
|
2873
2875
|
* @property {string} [description] - Full description of the product.
|
|
2874
2876
|
* @property {string[]} [highlights] - List of key highlights of the product.
|
|
2877
|
+
* @property {string} [hs_code] - HSN (Harmonized System Nomenclature) code for
|
|
2878
|
+
* tax classification.
|
|
2875
2879
|
* @property {string} [hsn_code] - HSN (Harmonized System Nomenclature) code for
|
|
2876
2880
|
* tax classification.
|
|
2877
2881
|
* @property {string} [id] - Unique identifier for the product in the system.
|
|
@@ -3086,6 +3090,7 @@ export = CatalogPlatformModel;
|
|
|
3086
3090
|
* @property {string} slug - URL-friendly identifier for the product.
|
|
3087
3091
|
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3088
3092
|
* @property {TaxIdentifier} tax_identifier
|
|
3093
|
+
* @property {string} [hs_code] - HS Code for the product.
|
|
3089
3094
|
* @property {TeaserTag} [teaser_tag]
|
|
3090
3095
|
* @property {string} template_tag - Template tag for the product, used for
|
|
3091
3096
|
* classification.
|
|
@@ -3151,6 +3156,123 @@ export = CatalogPlatformModel;
|
|
|
3151
3156
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3152
3157
|
* @property {Object} [variants] - Variants information for the product.
|
|
3153
3158
|
*/
|
|
3159
|
+
/**
|
|
3160
|
+
* @typedef ProductCreateSchemaV3
|
|
3161
|
+
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3162
|
+
* additional product properties.
|
|
3163
|
+
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3164
|
+
* upsert, update, delete).
|
|
3165
|
+
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3166
|
+
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3167
|
+
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3168
|
+
* @property {string} category_slug - The category to which the product belongs.
|
|
3169
|
+
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3170
|
+
* @property {number} company_id - Unique identifier for the company associated
|
|
3171
|
+
* with the product.
|
|
3172
|
+
* @property {string} country_of_origin - The country where the product was
|
|
3173
|
+
* manufactured or sourced.
|
|
3174
|
+
* @property {string} currency - The currency in which the product's price is listed.
|
|
3175
|
+
* @property {CustomOrder} [custom_order]
|
|
3176
|
+
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3177
|
+
* @property {string} [description] - A detailed description of the product.
|
|
3178
|
+
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3179
|
+
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3180
|
+
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3181
|
+
* dependent on other products.
|
|
3182
|
+
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3183
|
+
* does not have associated images.
|
|
3184
|
+
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3185
|
+
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3186
|
+
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3187
|
+
* composite, digital).
|
|
3188
|
+
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3189
|
+
* with the product.
|
|
3190
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3191
|
+
* @property {string} name - The name of the product.
|
|
3192
|
+
* @property {NetQuantity} [net_quantity]
|
|
3193
|
+
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3194
|
+
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3195
|
+
* for classification.
|
|
3196
|
+
* @property {ProductPublish} [product_publish]
|
|
3197
|
+
* @property {string} [requester] - The role requesting the product operation
|
|
3198
|
+
* (admin or user).
|
|
3199
|
+
* @property {ReturnConfig} return_config
|
|
3200
|
+
* @property {string} [short_description] - A short description of the product,
|
|
3201
|
+
* up to 50 characters.
|
|
3202
|
+
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3203
|
+
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3204
|
+
* @property {string} slug - URL-friendly identifier for the product.
|
|
3205
|
+
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3206
|
+
* @property {TaxIdentifierV3} tax_identifier
|
|
3207
|
+
* @property {TeaserTag} [teaser_tag]
|
|
3208
|
+
* @property {string} template_tag - Template tag for the product, used for
|
|
3209
|
+
* classification.
|
|
3210
|
+
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3211
|
+
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3212
|
+
* @property {Object} [variant_media] - Media related to product variants.
|
|
3213
|
+
* @property {Object} [variants] - Variants information for the product.
|
|
3214
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3215
|
+
* indian companies.
|
|
3216
|
+
*/
|
|
3217
|
+
/**
|
|
3218
|
+
* @typedef ProductUpdateSchemaV3
|
|
3219
|
+
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3220
|
+
* additional product properties.
|
|
3221
|
+
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3222
|
+
* upsert, update, delete).
|
|
3223
|
+
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3224
|
+
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3225
|
+
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3226
|
+
* @property {string} category_slug - The category to which the product belongs.
|
|
3227
|
+
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3228
|
+
* @property {number} company_id - Unique identifier for the company associated
|
|
3229
|
+
* with the product.
|
|
3230
|
+
* @property {string} country_of_origin - The country where the product was
|
|
3231
|
+
* manufactured or sourced.
|
|
3232
|
+
* @property {string} currency - The currency in which the product's price is listed.
|
|
3233
|
+
* @property {CustomOrder} [custom_order]
|
|
3234
|
+
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3235
|
+
* @property {string} [description] - A detailed description of the product.
|
|
3236
|
+
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3237
|
+
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3238
|
+
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3239
|
+
* dependent on other products.
|
|
3240
|
+
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3241
|
+
* does not have associated images.
|
|
3242
|
+
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3243
|
+
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3244
|
+
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3245
|
+
* composite, digital).
|
|
3246
|
+
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3247
|
+
* with the product.
|
|
3248
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3249
|
+
* @property {string} name - The name of the product.
|
|
3250
|
+
* @property {NetQuantity} [net_quantity]
|
|
3251
|
+
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3252
|
+
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3253
|
+
* for classification.
|
|
3254
|
+
* @property {ProductPublish} [product_publish]
|
|
3255
|
+
* @property {string} [requester] - The role requesting the product operation
|
|
3256
|
+
* (admin or user).
|
|
3257
|
+
* @property {ReturnConfig} return_config
|
|
3258
|
+
* @property {string} [short_description] - A short description of the product,
|
|
3259
|
+
* up to 50 characters.
|
|
3260
|
+
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3261
|
+
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3262
|
+
* @property {string} slug - URL-friendly identifier for the product.
|
|
3263
|
+
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3264
|
+
* @property {TaxIdentifierV3} tax_identifier
|
|
3265
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3266
|
+
* indian companies.
|
|
3267
|
+
* @property {TeaserTag} [teaser_tag]
|
|
3268
|
+
* @property {string} template_tag - Template tag for the product, used for
|
|
3269
|
+
* classification.
|
|
3270
|
+
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3271
|
+
* @property {number} [uid] - Unique identifier for the product.
|
|
3272
|
+
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3273
|
+
* @property {Object} [variant_media] - Media related to product variants.
|
|
3274
|
+
* @property {Object} [variants] - Variants information for the product.
|
|
3275
|
+
*/
|
|
3154
3276
|
/**
|
|
3155
3277
|
* @typedef ProductDetail
|
|
3156
3278
|
* @property {Object} [attributes] - Key-value pairs representing various
|
|
@@ -3567,8 +3689,12 @@ export = CatalogPlatformModel;
|
|
|
3567
3689
|
* the product.
|
|
3568
3690
|
* @property {string} [description] - Long description of the product.
|
|
3569
3691
|
* @property {string[]} [highlights] - Key features or highlights of the product.
|
|
3570
|
-
* @property {string} [
|
|
3571
|
-
* taxation purposes.
|
|
3692
|
+
* @property {string} [hs_code] - Harmonized System Nomenclature (HSN) code for
|
|
3693
|
+
* taxation purposes. This is required for indian products.
|
|
3694
|
+
* @property {string} [hsn_code] - **Deprecated**: Harmonized System
|
|
3695
|
+
* Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
|
|
3696
|
+
* field instead.\
|
|
3697
|
+
* _Deprecated_*
|
|
3572
3698
|
* @property {string} [id] - Unique identifier of the product in the database.
|
|
3573
3699
|
* @property {string} [image_nature] - Describes the nature of the product
|
|
3574
3700
|
* images (e.g., "standard").
|
|
@@ -3714,6 +3840,8 @@ export = CatalogPlatformModel;
|
|
|
3714
3840
|
/**
|
|
3715
3841
|
* @typedef ProductTemplateExportFilterRequestSchema
|
|
3716
3842
|
* @property {string[]} [brands] - The list of the brands that needs to be exported.
|
|
3843
|
+
* @property {string[]} [tax_rule_ids] - The list of the tax rule ids that needs
|
|
3844
|
+
* to be exported.
|
|
3717
3845
|
* @property {string[]} catalogue_types - The list of the type of the catalog
|
|
3718
3846
|
* such as set, standard and composite.
|
|
3719
3847
|
* @property {string} [from_date] - The modified on date from which the data
|
|
@@ -3764,6 +3892,7 @@ export = CatalogPlatformModel;
|
|
|
3764
3892
|
* @property {Object} [custom_order]
|
|
3765
3893
|
* @property {Object} [description]
|
|
3766
3894
|
* @property {Object} [highlights]
|
|
3895
|
+
* @property {Object} [hs_code]
|
|
3767
3896
|
* @property {Object} [hsn_code]
|
|
3768
3897
|
* @property {Object} [is_active]
|
|
3769
3898
|
* @property {Object} [is_dependent]
|
|
@@ -4077,9 +4206,14 @@ export = CatalogPlatformModel;
|
|
|
4077
4206
|
*/
|
|
4078
4207
|
/**
|
|
4079
4208
|
* @typedef TaxIdentifier
|
|
4080
|
-
* @property {string} [
|
|
4081
|
-
* @property {string} [
|
|
4082
|
-
* @property {string} [
|
|
4209
|
+
* @property {string} [tax_rule_id] - The unique identifier of the tax rule.
|
|
4210
|
+
* @property {string} [hsn_code] _Deprecated_*
|
|
4211
|
+
* @property {string} [hsn_code_id] _Deprecated_*
|
|
4212
|
+
* @property {string} [reporting_hsn] _Deprecated_*
|
|
4213
|
+
*/
|
|
4214
|
+
/**
|
|
4215
|
+
* @typedef TaxIdentifierV3
|
|
4216
|
+
* @property {string} tax_rule_id - The unique identifier of the tax rule.
|
|
4083
4217
|
*/
|
|
4084
4218
|
/**
|
|
4085
4219
|
* @typedef TaxSlab
|
|
@@ -4402,6 +4536,171 @@ export = CatalogPlatformModel;
|
|
|
4402
4536
|
* @property {string} [message] - A message indicating the result of the follow
|
|
4403
4537
|
* or unfollow operation.
|
|
4404
4538
|
*/
|
|
4539
|
+
/**
|
|
4540
|
+
* @typedef TaxReqBodyRule
|
|
4541
|
+
* @property {string} name - Tax rule name
|
|
4542
|
+
* @property {string} [description] - Tax rule description
|
|
4543
|
+
*/
|
|
4544
|
+
/**
|
|
4545
|
+
* @typedef TaxThreshold
|
|
4546
|
+
* @property {number} value - Tax rate is applied to products above or equal to
|
|
4547
|
+
* this price.
|
|
4548
|
+
* @property {number} rate - Tax rate ranging from 0 to 1.
|
|
4549
|
+
*/
|
|
4550
|
+
/**
|
|
4551
|
+
* @typedef TaxComponent
|
|
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
|
|
4558
|
+
*/
|
|
4559
|
+
/**
|
|
4560
|
+
* @typedef TaxComponentResponseSchema
|
|
4561
|
+
* @property {string} name - Name of the component.
|
|
4562
|
+
* @property {string} [description] - Description of the tax component.
|
|
4563
|
+
* @property {TaxThreshold[]} slabs - List of slabs that comprises of tax rate
|
|
4564
|
+
* and their respective threshold.
|
|
4565
|
+
* @property {string} _id - Unique identifier of the tax component. This _id is
|
|
4566
|
+
* required for updating any tax component; If _id field is not in "update tax
|
|
4567
|
+
* version" request then that component will be created.
|
|
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
|
+
*/
|
|
4584
|
+
/**
|
|
4585
|
+
* @typedef TaxReqBodyVersion
|
|
4586
|
+
* @property {TaxComponent[]} components - List of tax components with their
|
|
4587
|
+
* respective slabs and rates.
|
|
4588
|
+
*/
|
|
4589
|
+
/**
|
|
4590
|
+
* @typedef CreateTaxRequestBody
|
|
4591
|
+
* @property {TaxReqBodyRule} rule
|
|
4592
|
+
* @property {TaxReqBodyVersion[]} versions - List of tax versions for the tax rule.
|
|
4593
|
+
*/
|
|
4594
|
+
/**
|
|
4595
|
+
* @typedef TaxVersion
|
|
4596
|
+
* @property {string} [_id]
|
|
4597
|
+
* @property {string} [rule_id] - Tax Rule ID.
|
|
4598
|
+
* @property {string} [applicable_date] - It is the date from when this rule
|
|
4599
|
+
* will come in effect.
|
|
4600
|
+
* @property {string} [created_on]
|
|
4601
|
+
* @property {string} [modified_on]
|
|
4602
|
+
* @property {number} [company_id] - Company ID.
|
|
4603
|
+
* @property {TaxStatusEnum} [status]
|
|
4604
|
+
* @property {TaxComponentResponseSchema[]} [components] - List of tax components.
|
|
4605
|
+
*/
|
|
4606
|
+
/**
|
|
4607
|
+
* @typedef UpdateTaxVersionRequestBody
|
|
4608
|
+
* @property {TaxComponentResponseSchema[]} components - List of tax components.
|
|
4609
|
+
* @property {string} applicable_date - It is the date from when this rule will
|
|
4610
|
+
* come in effect. It should be atleast one minute in the future from the current time.
|
|
4611
|
+
*/
|
|
4612
|
+
/**
|
|
4613
|
+
* @typedef CreateTaxVersionRequestBody
|
|
4614
|
+
* @property {TaxComponent[]} components - List of tax components.
|
|
4615
|
+
* @property {string} applicable_date - It is the date from when this rule will
|
|
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.
|
|
4618
|
+
*/
|
|
4619
|
+
/**
|
|
4620
|
+
* @typedef TaxRule
|
|
4621
|
+
* @property {string} [_id]
|
|
4622
|
+
* @property {string} [name]
|
|
4623
|
+
* @property {string} [description] - Description of the tax rule.
|
|
4624
|
+
* @property {boolean} [is_default] - Flag to set any tax rule as default, in
|
|
4625
|
+
* case any tax rule is inactive on a product then default tax rule gets applied
|
|
4626
|
+
* @property {number} [company_id]
|
|
4627
|
+
* @property {TaxStatusEnum} [status]
|
|
4628
|
+
* @property {string} [created_on]
|
|
4629
|
+
* @property {string} [modified_on]
|
|
4630
|
+
*/
|
|
4631
|
+
/**
|
|
4632
|
+
* @typedef TaxVersionDetail
|
|
4633
|
+
* @property {string} _id
|
|
4634
|
+
* @property {string} rule_id
|
|
4635
|
+
* @property {string} applicable_date
|
|
4636
|
+
* @property {string} created_on
|
|
4637
|
+
* @property {string} modified_on
|
|
4638
|
+
* @property {number} company_id
|
|
4639
|
+
* @property {TaxStatusEnum} [status]
|
|
4640
|
+
* @property {TaxComponent[]} components - List of components.
|
|
4641
|
+
* @property {string} version_status - Specifies the type of tax version.
|
|
4642
|
+
*/
|
|
4643
|
+
/**
|
|
4644
|
+
* @typedef CreateTax
|
|
4645
|
+
* @property {TaxRule} [rule]
|
|
4646
|
+
* @property {TaxVersion} [versions]
|
|
4647
|
+
*/
|
|
4648
|
+
/**
|
|
4649
|
+
* @typedef UpdateTaxVersion
|
|
4650
|
+
* @property {TaxComponent[]} components - List of components.
|
|
4651
|
+
* @property {string} applicable_date
|
|
4652
|
+
*/
|
|
4653
|
+
/**
|
|
4654
|
+
* @typedef UpdateTaxRequestBody
|
|
4655
|
+
* @property {TaxStatusEnum} status
|
|
4656
|
+
* @property {boolean} is_default - Flag to set any tax rule as default, in case
|
|
4657
|
+
* any tax rule is inactive or not available on a product then default tax
|
|
4658
|
+
* rule gets applied.
|
|
4659
|
+
* @property {string} name - New name of the tax rule.
|
|
4660
|
+
*/
|
|
4661
|
+
/**
|
|
4662
|
+
* @typedef TaxRuleItem
|
|
4663
|
+
* @property {TaxVersionDetail[]} versions
|
|
4664
|
+
* @property {TaxRule} rule
|
|
4665
|
+
*/
|
|
4666
|
+
/**
|
|
4667
|
+
* @typedef TaxRules
|
|
4668
|
+
* @property {TaxRuleItem[]} items - List of tax rules with their versions.
|
|
4669
|
+
* @property {Page} page
|
|
4670
|
+
*/
|
|
4671
|
+
/**
|
|
4672
|
+
* @typedef TaxVersionPastData
|
|
4673
|
+
* @property {TaxVersion[]} [data]
|
|
4674
|
+
* @property {Page} [pagination]
|
|
4675
|
+
*/
|
|
4676
|
+
/**
|
|
4677
|
+
* @typedef TaxRuleVersion
|
|
4678
|
+
* @property {TaxVersionDetail[]} items - List of tax versions.
|
|
4679
|
+
* @property {TaxRule} rule
|
|
4680
|
+
* @property {Page} page
|
|
4681
|
+
*/
|
|
4682
|
+
/**
|
|
4683
|
+
* @typedef HSCodeItem
|
|
4684
|
+
* @property {string} [created_on] - Timestamp of when the HS code was created.
|
|
4685
|
+
* @property {string} [modified_on] - Timestamp of when the HS code was last modified.
|
|
4686
|
+
* @property {HsTypeEnum} type
|
|
4687
|
+
* @property {number} [company_id] - Company ID associated with this HS code.
|
|
4688
|
+
* @property {string} [description] - Description of the HS code.
|
|
4689
|
+
* @property {string} hs_code - The HS code of the product.
|
|
4690
|
+
* @property {string} [_id] - Unique identifier for the HS code entry.
|
|
4691
|
+
* @property {string} [country_iso] - ISO 2-digit country code. Will be set by
|
|
4692
|
+
* default according to company's country.
|
|
4693
|
+
*/
|
|
4694
|
+
/**
|
|
4695
|
+
* @typedef HSCodes
|
|
4696
|
+
* @property {HSCodeItem[]} items - Array of HS code responses.
|
|
4697
|
+
* @property {Page} page
|
|
4698
|
+
*/
|
|
4699
|
+
/**
|
|
4700
|
+
* @typedef GetTaxComponents
|
|
4701
|
+
* @property {TaxComponentResponseSchema[]} items
|
|
4702
|
+
* @property {Page} page
|
|
4703
|
+
*/
|
|
4405
4704
|
/**
|
|
4406
4705
|
* @typedef ActionPage
|
|
4407
4706
|
* @property {Object} [params] - Parameters that should be considered in path.
|
|
@@ -4444,6 +4743,8 @@ export = CatalogPlatformModel;
|
|
|
4444
4743
|
* @property {string} value - The value of the metadata. Should be a non-empty
|
|
4445
4744
|
* string and length should not exceed 100 characters.
|
|
4446
4745
|
*/
|
|
4746
|
+
/** @typedef {"ACTIVE" | "INACTIVE" | "DELETED"} TaxStatusEnum */
|
|
4747
|
+
/** @typedef {"HS" | "SAC"} HsTypeEnum */
|
|
4447
4748
|
/**
|
|
4448
4749
|
* @typedef {| "about-us"
|
|
4449
4750
|
* | "addresses"
|
|
@@ -4497,7 +4798,7 @@ export = CatalogPlatformModel;
|
|
|
4497
4798
|
declare class CatalogPlatformModel {
|
|
4498
4799
|
}
|
|
4499
4800
|
declare namespace CatalogPlatformModel {
|
|
4500
|
-
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, 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 };
|
|
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 };
|
|
4501
4802
|
}
|
|
4502
4803
|
/** @returns {Action} */
|
|
4503
4804
|
declare function Action(): Action;
|
|
@@ -7191,6 +7492,10 @@ type RawProduct = {
|
|
|
7191
7492
|
* - List of highlights for the product.
|
|
7192
7493
|
*/
|
|
7193
7494
|
highlights?: string[];
|
|
7495
|
+
/**
|
|
7496
|
+
* - HSN code associated with the product for tax purposes.
|
|
7497
|
+
*/
|
|
7498
|
+
hs_code?: string;
|
|
7194
7499
|
/**
|
|
7195
7500
|
* - HSN code associated with the product for tax purposes.
|
|
7196
7501
|
*/
|
|
@@ -8669,6 +8974,10 @@ type HSNDataInsertV2 = {
|
|
|
8669
8974
|
*/
|
|
8670
8975
|
description: string;
|
|
8671
8976
|
hsn_code: string;
|
|
8977
|
+
/**
|
|
8978
|
+
* - Unique identifier of the tax rule.
|
|
8979
|
+
*/
|
|
8980
|
+
tax_rule_id?: string;
|
|
8672
8981
|
/**
|
|
8673
8982
|
* - Unique identifier of the HSN code.
|
|
8674
8983
|
*/
|
|
@@ -10583,6 +10892,11 @@ type Product = {
|
|
|
10583
10892
|
* - List of key highlights of the product.
|
|
10584
10893
|
*/
|
|
10585
10894
|
highlights?: string[];
|
|
10895
|
+
/**
|
|
10896
|
+
* - HSN (Harmonized System Nomenclature) code for
|
|
10897
|
+
* tax classification.
|
|
10898
|
+
*/
|
|
10899
|
+
hs_code?: string;
|
|
10586
10900
|
/**
|
|
10587
10901
|
* - HSN (Harmonized System Nomenclature) code for
|
|
10588
10902
|
* tax classification.
|
|
@@ -11089,6 +11403,10 @@ type ProductUpdateSchemaV2 = {
|
|
|
11089
11403
|
*/
|
|
11090
11404
|
tags?: string[];
|
|
11091
11405
|
tax_identifier: TaxIdentifier;
|
|
11406
|
+
/**
|
|
11407
|
+
* - HS Code for the product.
|
|
11408
|
+
*/
|
|
11409
|
+
hs_code?: string;
|
|
11092
11410
|
teaser_tag?: TeaserTag;
|
|
11093
11411
|
/**
|
|
11094
11412
|
* - Template tag for the product, used for
|
|
@@ -11278,74 +11596,412 @@ type ProductCreateSchemaV2 = {
|
|
|
11278
11596
|
*/
|
|
11279
11597
|
variants?: any;
|
|
11280
11598
|
};
|
|
11281
|
-
/** @returns {
|
|
11282
|
-
declare function
|
|
11283
|
-
type
|
|
11599
|
+
/** @returns {ProductCreateSchemaV3} */
|
|
11600
|
+
declare function ProductCreateSchemaV3(): ProductCreateSchemaV3;
|
|
11601
|
+
type ProductCreateSchemaV3 = {
|
|
11284
11602
|
/**
|
|
11285
|
-
* -
|
|
11286
|
-
* product
|
|
11603
|
+
* - Custom JSON data that can be used for
|
|
11604
|
+
* additional product properties.
|
|
11287
11605
|
*/
|
|
11288
|
-
|
|
11289
|
-
brand?: ProductBrand;
|
|
11606
|
+
_custom_json?: any;
|
|
11290
11607
|
/**
|
|
11291
|
-
* -
|
|
11608
|
+
* - The action to perform wrt to the product (e.g.,
|
|
11609
|
+
* upsert, update, delete).
|
|
11292
11610
|
*/
|
|
11293
|
-
|
|
11611
|
+
action?: string;
|
|
11294
11612
|
/**
|
|
11295
|
-
* -
|
|
11296
|
-
* attributes of the product, such as product details and specifications.
|
|
11613
|
+
* - Additional attributes related to the product.
|
|
11297
11614
|
*/
|
|
11298
|
-
|
|
11615
|
+
attributes?: any;
|
|
11299
11616
|
/**
|
|
11300
|
-
* -
|
|
11617
|
+
* - Unique identifier for the product's brand.
|
|
11301
11618
|
*/
|
|
11302
|
-
|
|
11619
|
+
brand_uid: number;
|
|
11303
11620
|
/**
|
|
11304
|
-
* -
|
|
11621
|
+
* - Job ID associated with bulk operations.
|
|
11305
11622
|
*/
|
|
11306
|
-
|
|
11623
|
+
bulk_job_id?: string;
|
|
11307
11624
|
/**
|
|
11308
|
-
* - The
|
|
11625
|
+
* - The category to which the product belongs.
|
|
11309
11626
|
*/
|
|
11310
|
-
|
|
11627
|
+
category_slug: string;
|
|
11311
11628
|
/**
|
|
11312
|
-
* -
|
|
11629
|
+
* - Change request identifier for product updates.
|
|
11313
11630
|
*/
|
|
11314
|
-
|
|
11631
|
+
change_request_id?: string;
|
|
11315
11632
|
/**
|
|
11316
|
-
* -
|
|
11633
|
+
* - Unique identifier for the company associated
|
|
11634
|
+
* with the product.
|
|
11317
11635
|
*/
|
|
11318
|
-
|
|
11636
|
+
company_id: number;
|
|
11319
11637
|
/**
|
|
11320
|
-
* -
|
|
11321
|
-
*
|
|
11638
|
+
* - The country where the product was
|
|
11639
|
+
* manufactured or sourced.
|
|
11322
11640
|
*/
|
|
11323
|
-
|
|
11641
|
+
country_of_origin: string;
|
|
11324
11642
|
/**
|
|
11325
|
-
* -
|
|
11643
|
+
* - The currency in which the product's price is listed.
|
|
11326
11644
|
*/
|
|
11327
|
-
|
|
11645
|
+
currency: string;
|
|
11646
|
+
custom_order?: CustomOrder;
|
|
11328
11647
|
/**
|
|
11329
|
-
* -
|
|
11330
|
-
* available online.
|
|
11648
|
+
* - List of department IDs associated with the product.
|
|
11331
11649
|
*/
|
|
11332
|
-
|
|
11650
|
+
departments: number[];
|
|
11333
11651
|
/**
|
|
11334
|
-
* -
|
|
11652
|
+
* - A detailed description of the product.
|
|
11335
11653
|
*/
|
|
11336
|
-
|
|
11654
|
+
description?: string;
|
|
11337
11655
|
/**
|
|
11338
|
-
* -
|
|
11656
|
+
* - Product highlights or key features.
|
|
11339
11657
|
*/
|
|
11340
|
-
|
|
11658
|
+
highlights?: string[];
|
|
11341
11659
|
/**
|
|
11342
|
-
* -
|
|
11660
|
+
* - Flag to indicate if the product is active.
|
|
11343
11661
|
*/
|
|
11344
|
-
|
|
11662
|
+
is_active?: boolean;
|
|
11345
11663
|
/**
|
|
11346
|
-
* -
|
|
11664
|
+
* - Flag to indicate if the product is
|
|
11665
|
+
* dependent on other products.
|
|
11347
11666
|
*/
|
|
11348
|
-
|
|
11667
|
+
is_dependent?: boolean;
|
|
11668
|
+
/**
|
|
11669
|
+
* - Flag to indicate if the product
|
|
11670
|
+
* does not have associated images.
|
|
11671
|
+
*/
|
|
11672
|
+
is_image_less_product?: boolean;
|
|
11673
|
+
/**
|
|
11674
|
+
* - Flag to indicate if the product is part of a set.
|
|
11675
|
+
*/
|
|
11676
|
+
is_set?: boolean;
|
|
11677
|
+
/**
|
|
11678
|
+
* - Unique item code or SKU of the product.
|
|
11679
|
+
*/
|
|
11680
|
+
item_code: string;
|
|
11681
|
+
/**
|
|
11682
|
+
* - Type of the product (e.g., standard, set,
|
|
11683
|
+
* composite, digital).
|
|
11684
|
+
*/
|
|
11685
|
+
item_type: string;
|
|
11686
|
+
/**
|
|
11687
|
+
* - List of media URLs (images, videos) associated
|
|
11688
|
+
* with the product.
|
|
11689
|
+
*/
|
|
11690
|
+
media?: Media[];
|
|
11691
|
+
/**
|
|
11692
|
+
* - Indicates if the product supports multiple sizes.
|
|
11693
|
+
*/
|
|
11694
|
+
multi_size?: boolean;
|
|
11695
|
+
/**
|
|
11696
|
+
* - The name of the product.
|
|
11697
|
+
*/
|
|
11698
|
+
name: string;
|
|
11699
|
+
net_quantity?: NetQuantity;
|
|
11700
|
+
/**
|
|
11701
|
+
* - Number of boxes required to package the product.
|
|
11702
|
+
*/
|
|
11703
|
+
no_of_boxes?: number;
|
|
11704
|
+
/**
|
|
11705
|
+
* - Tags to group products together
|
|
11706
|
+
* for classification.
|
|
11707
|
+
*/
|
|
11708
|
+
product_group_tag?: string[];
|
|
11709
|
+
product_publish?: ProductPublish;
|
|
11710
|
+
/**
|
|
11711
|
+
* - The role requesting the product operation
|
|
11712
|
+
* (admin or user).
|
|
11713
|
+
*/
|
|
11714
|
+
requester?: string;
|
|
11715
|
+
return_config: ReturnConfig;
|
|
11716
|
+
/**
|
|
11717
|
+
* - A short description of the product,
|
|
11718
|
+
* up to 50 characters.
|
|
11719
|
+
*/
|
|
11720
|
+
short_description?: string;
|
|
11721
|
+
/**
|
|
11722
|
+
* - Identifier for the product's size guide.
|
|
11723
|
+
*/
|
|
11724
|
+
size_guide?: string;
|
|
11725
|
+
/**
|
|
11726
|
+
* - List of sizes available for the product.
|
|
11727
|
+
*/
|
|
11728
|
+
sizes: any[];
|
|
11729
|
+
/**
|
|
11730
|
+
* - URL-friendly identifier for the product.
|
|
11731
|
+
*/
|
|
11732
|
+
slug: string;
|
|
11733
|
+
/**
|
|
11734
|
+
* - List of tags associated with the product.
|
|
11735
|
+
*/
|
|
11736
|
+
tags?: string[];
|
|
11737
|
+
tax_identifier: TaxIdentifierV3;
|
|
11738
|
+
teaser_tag?: TeaserTag;
|
|
11739
|
+
/**
|
|
11740
|
+
* - Template tag for the product, used for
|
|
11741
|
+
* classification.
|
|
11742
|
+
*/
|
|
11743
|
+
template_tag: string;
|
|
11744
|
+
/**
|
|
11745
|
+
* - List of traders associated with the product.
|
|
11746
|
+
*/
|
|
11747
|
+
trader: Trader[];
|
|
11748
|
+
/**
|
|
11749
|
+
* - Variant group information for the product.
|
|
11750
|
+
*/
|
|
11751
|
+
variant_group?: any;
|
|
11752
|
+
/**
|
|
11753
|
+
* - Media related to product variants.
|
|
11754
|
+
*/
|
|
11755
|
+
variant_media?: any;
|
|
11756
|
+
/**
|
|
11757
|
+
* - Variants information for the product.
|
|
11758
|
+
*/
|
|
11759
|
+
variants?: any;
|
|
11760
|
+
/**
|
|
11761
|
+
* - HS Code for the product. This is required for
|
|
11762
|
+
* indian companies.
|
|
11763
|
+
*/
|
|
11764
|
+
hs_code?: string;
|
|
11765
|
+
};
|
|
11766
|
+
/** @returns {ProductUpdateSchemaV3} */
|
|
11767
|
+
declare function ProductUpdateSchemaV3(): ProductUpdateSchemaV3;
|
|
11768
|
+
type ProductUpdateSchemaV3 = {
|
|
11769
|
+
/**
|
|
11770
|
+
* - Custom JSON data that can be used for
|
|
11771
|
+
* additional product properties.
|
|
11772
|
+
*/
|
|
11773
|
+
_custom_json?: any;
|
|
11774
|
+
/**
|
|
11775
|
+
* - The action to perform wrt to the product (e.g.,
|
|
11776
|
+
* upsert, update, delete).
|
|
11777
|
+
*/
|
|
11778
|
+
action?: string;
|
|
11779
|
+
/**
|
|
11780
|
+
* - Additional attributes related to the product.
|
|
11781
|
+
*/
|
|
11782
|
+
attributes?: any;
|
|
11783
|
+
/**
|
|
11784
|
+
* - Unique identifier for the product's brand.
|
|
11785
|
+
*/
|
|
11786
|
+
brand_uid: number;
|
|
11787
|
+
/**
|
|
11788
|
+
* - Job ID associated with bulk operations.
|
|
11789
|
+
*/
|
|
11790
|
+
bulk_job_id?: string;
|
|
11791
|
+
/**
|
|
11792
|
+
* - The category to which the product belongs.
|
|
11793
|
+
*/
|
|
11794
|
+
category_slug: string;
|
|
11795
|
+
/**
|
|
11796
|
+
* - Change request identifier for product updates.
|
|
11797
|
+
*/
|
|
11798
|
+
change_request_id?: string;
|
|
11799
|
+
/**
|
|
11800
|
+
* - Unique identifier for the company associated
|
|
11801
|
+
* with the product.
|
|
11802
|
+
*/
|
|
11803
|
+
company_id: number;
|
|
11804
|
+
/**
|
|
11805
|
+
* - The country where the product was
|
|
11806
|
+
* manufactured or sourced.
|
|
11807
|
+
*/
|
|
11808
|
+
country_of_origin: string;
|
|
11809
|
+
/**
|
|
11810
|
+
* - The currency in which the product's price is listed.
|
|
11811
|
+
*/
|
|
11812
|
+
currency: string;
|
|
11813
|
+
custom_order?: CustomOrder;
|
|
11814
|
+
/**
|
|
11815
|
+
* - List of department IDs associated with the product.
|
|
11816
|
+
*/
|
|
11817
|
+
departments: number[];
|
|
11818
|
+
/**
|
|
11819
|
+
* - A detailed description of the product.
|
|
11820
|
+
*/
|
|
11821
|
+
description?: string;
|
|
11822
|
+
/**
|
|
11823
|
+
* - Product highlights or key features.
|
|
11824
|
+
*/
|
|
11825
|
+
highlights?: string[];
|
|
11826
|
+
/**
|
|
11827
|
+
* - Flag to indicate if the product is active.
|
|
11828
|
+
*/
|
|
11829
|
+
is_active?: boolean;
|
|
11830
|
+
/**
|
|
11831
|
+
* - Flag to indicate if the product is
|
|
11832
|
+
* dependent on other products.
|
|
11833
|
+
*/
|
|
11834
|
+
is_dependent?: boolean;
|
|
11835
|
+
/**
|
|
11836
|
+
* - Flag to indicate if the product
|
|
11837
|
+
* does not have associated images.
|
|
11838
|
+
*/
|
|
11839
|
+
is_image_less_product?: boolean;
|
|
11840
|
+
/**
|
|
11841
|
+
* - Flag to indicate if the product is part of a set.
|
|
11842
|
+
*/
|
|
11843
|
+
is_set?: boolean;
|
|
11844
|
+
/**
|
|
11845
|
+
* - Unique item code or SKU of the product.
|
|
11846
|
+
*/
|
|
11847
|
+
item_code: string;
|
|
11848
|
+
/**
|
|
11849
|
+
* - Type of the product (e.g., standard, set,
|
|
11850
|
+
* composite, digital).
|
|
11851
|
+
*/
|
|
11852
|
+
item_type: string;
|
|
11853
|
+
/**
|
|
11854
|
+
* - List of media URLs (images, videos) associated
|
|
11855
|
+
* with the product.
|
|
11856
|
+
*/
|
|
11857
|
+
media?: Media[];
|
|
11858
|
+
/**
|
|
11859
|
+
* - Indicates if the product supports multiple sizes.
|
|
11860
|
+
*/
|
|
11861
|
+
multi_size?: boolean;
|
|
11862
|
+
/**
|
|
11863
|
+
* - The name of the product.
|
|
11864
|
+
*/
|
|
11865
|
+
name: string;
|
|
11866
|
+
net_quantity?: NetQuantity;
|
|
11867
|
+
/**
|
|
11868
|
+
* - Number of boxes required to package the product.
|
|
11869
|
+
*/
|
|
11870
|
+
no_of_boxes?: number;
|
|
11871
|
+
/**
|
|
11872
|
+
* - Tags to group products together
|
|
11873
|
+
* for classification.
|
|
11874
|
+
*/
|
|
11875
|
+
product_group_tag?: string[];
|
|
11876
|
+
product_publish?: ProductPublish;
|
|
11877
|
+
/**
|
|
11878
|
+
* - The role requesting the product operation
|
|
11879
|
+
* (admin or user).
|
|
11880
|
+
*/
|
|
11881
|
+
requester?: string;
|
|
11882
|
+
return_config: ReturnConfig;
|
|
11883
|
+
/**
|
|
11884
|
+
* - A short description of the product,
|
|
11885
|
+
* up to 50 characters.
|
|
11886
|
+
*/
|
|
11887
|
+
short_description?: string;
|
|
11888
|
+
/**
|
|
11889
|
+
* - Identifier for the product's size guide.
|
|
11890
|
+
*/
|
|
11891
|
+
size_guide?: string;
|
|
11892
|
+
/**
|
|
11893
|
+
* - List of sizes available for the product.
|
|
11894
|
+
*/
|
|
11895
|
+
sizes: any[];
|
|
11896
|
+
/**
|
|
11897
|
+
* - URL-friendly identifier for the product.
|
|
11898
|
+
*/
|
|
11899
|
+
slug: string;
|
|
11900
|
+
/**
|
|
11901
|
+
* - List of tags associated with the product.
|
|
11902
|
+
*/
|
|
11903
|
+
tags?: string[];
|
|
11904
|
+
tax_identifier: TaxIdentifierV3;
|
|
11905
|
+
/**
|
|
11906
|
+
* - HS Code for the product. This is required for
|
|
11907
|
+
* indian companies.
|
|
11908
|
+
*/
|
|
11909
|
+
hs_code?: string;
|
|
11910
|
+
teaser_tag?: TeaserTag;
|
|
11911
|
+
/**
|
|
11912
|
+
* - Template tag for the product, used for
|
|
11913
|
+
* classification.
|
|
11914
|
+
*/
|
|
11915
|
+
template_tag: string;
|
|
11916
|
+
/**
|
|
11917
|
+
* - List of traders associated with the product.
|
|
11918
|
+
*/
|
|
11919
|
+
trader: Trader[];
|
|
11920
|
+
/**
|
|
11921
|
+
* - Unique identifier for the product.
|
|
11922
|
+
*/
|
|
11923
|
+
uid?: number;
|
|
11924
|
+
/**
|
|
11925
|
+
* - Variant group information for the product.
|
|
11926
|
+
*/
|
|
11927
|
+
variant_group?: any;
|
|
11928
|
+
/**
|
|
11929
|
+
* - Media related to product variants.
|
|
11930
|
+
*/
|
|
11931
|
+
variant_media?: any;
|
|
11932
|
+
/**
|
|
11933
|
+
* - Variants information for the product.
|
|
11934
|
+
*/
|
|
11935
|
+
variants?: any;
|
|
11936
|
+
};
|
|
11937
|
+
/** @returns {ProductDetail} */
|
|
11938
|
+
declare function ProductDetail(): ProductDetail;
|
|
11939
|
+
type ProductDetail = {
|
|
11940
|
+
/**
|
|
11941
|
+
* - Key-value pairs representing various
|
|
11942
|
+
* product attributes.
|
|
11943
|
+
*/
|
|
11944
|
+
attributes?: any;
|
|
11945
|
+
brand?: ProductBrand;
|
|
11946
|
+
/**
|
|
11947
|
+
* - Detailed description of the product.
|
|
11948
|
+
*/
|
|
11949
|
+
description?: string;
|
|
11950
|
+
/**
|
|
11951
|
+
* - Grouped
|
|
11952
|
+
* attributes of the product, such as product details and specifications.
|
|
11953
|
+
*/
|
|
11954
|
+
grouped_attributes?: ProductDetailGroupedAttribute[];
|
|
11955
|
+
/**
|
|
11956
|
+
* - Indicates whether the product has variants.
|
|
11957
|
+
*/
|
|
11958
|
+
has_variant?: boolean;
|
|
11959
|
+
/**
|
|
11960
|
+
* - Array of highlight features for the product.
|
|
11961
|
+
*/
|
|
11962
|
+
highlights?: string[];
|
|
11963
|
+
/**
|
|
11964
|
+
* - The nature of the product's images.
|
|
11965
|
+
*/
|
|
11966
|
+
image_nature?: string;
|
|
11967
|
+
/**
|
|
11968
|
+
* - Unique item code for the product.
|
|
11969
|
+
*/
|
|
11970
|
+
item_code?: string;
|
|
11971
|
+
/**
|
|
11972
|
+
* - Type of the item.
|
|
11973
|
+
*/
|
|
11974
|
+
item_type?: string;
|
|
11975
|
+
/**
|
|
11976
|
+
* - Array of media objects such as images and
|
|
11977
|
+
* videos for the product.
|
|
11978
|
+
*/
|
|
11979
|
+
medias?: Media[];
|
|
11980
|
+
/**
|
|
11981
|
+
* - Name of the product.
|
|
11982
|
+
*/
|
|
11983
|
+
name?: string;
|
|
11984
|
+
/**
|
|
11985
|
+
* - Date when the product was made
|
|
11986
|
+
* available online.
|
|
11987
|
+
*/
|
|
11988
|
+
product_online_date?: string;
|
|
11989
|
+
/**
|
|
11990
|
+
* - Promotional metadata associated with the product.
|
|
11991
|
+
*/
|
|
11992
|
+
promo_meta?: any;
|
|
11993
|
+
/**
|
|
11994
|
+
* - Average rating of the product.
|
|
11995
|
+
*/
|
|
11996
|
+
rating?: number;
|
|
11997
|
+
/**
|
|
11998
|
+
* - Total number of ratings for the product.
|
|
11999
|
+
*/
|
|
12000
|
+
rating_count?: number;
|
|
12001
|
+
/**
|
|
12002
|
+
* - A brief description of the product.
|
|
12003
|
+
*/
|
|
12004
|
+
short_description?: string;
|
|
11349
12005
|
/**
|
|
11350
12006
|
* - Array of similar products.
|
|
11351
12007
|
*/
|
|
@@ -12357,7 +13013,14 @@ type ProductSchemaV2 = {
|
|
|
12357
13013
|
highlights?: string[];
|
|
12358
13014
|
/**
|
|
12359
13015
|
* - Harmonized System Nomenclature (HSN) code for
|
|
12360
|
-
* taxation purposes.
|
|
13016
|
+
* taxation purposes. This is required for indian products.
|
|
13017
|
+
*/
|
|
13018
|
+
hs_code?: string;
|
|
13019
|
+
/**
|
|
13020
|
+
* - **Deprecated**: Harmonized System
|
|
13021
|
+
* Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
|
|
13022
|
+
* field instead.\
|
|
13023
|
+
* _Deprecated_*
|
|
12361
13024
|
*/
|
|
12362
13025
|
hsn_code?: string;
|
|
12363
13026
|
/**
|
|
@@ -12723,6 +13386,11 @@ type ProductTemplateExportFilterRequestSchema = {
|
|
|
12723
13386
|
* - The list of the brands that needs to be exported.
|
|
12724
13387
|
*/
|
|
12725
13388
|
brands?: string[];
|
|
13389
|
+
/**
|
|
13390
|
+
* - The list of the tax rule ids that needs
|
|
13391
|
+
* to be exported.
|
|
13392
|
+
*/
|
|
13393
|
+
tax_rule_ids?: string[];
|
|
12726
13394
|
/**
|
|
12727
13395
|
* - The list of the type of the catalog
|
|
12728
13396
|
* such as set, standard and composite.
|
|
@@ -12837,6 +13505,7 @@ type Properties = {
|
|
|
12837
13505
|
custom_order?: any;
|
|
12838
13506
|
description?: any;
|
|
12839
13507
|
highlights?: any;
|
|
13508
|
+
hs_code?: any;
|
|
12840
13509
|
hsn_code?: any;
|
|
12841
13510
|
is_active?: any;
|
|
12842
13511
|
is_dependent?: any;
|
|
@@ -13371,10 +14040,31 @@ type SuccessResponseObject = {
|
|
|
13371
14040
|
/** @returns {TaxIdentifier} */
|
|
13372
14041
|
declare function TaxIdentifier(): TaxIdentifier;
|
|
13373
14042
|
type TaxIdentifier = {
|
|
14043
|
+
/**
|
|
14044
|
+
* - The unique identifier of the tax rule.
|
|
14045
|
+
*/
|
|
14046
|
+
tax_rule_id?: string;
|
|
14047
|
+
/**
|
|
14048
|
+
* _Deprecated_*
|
|
14049
|
+
*/
|
|
13374
14050
|
hsn_code?: string;
|
|
14051
|
+
/**
|
|
14052
|
+
* _Deprecated_*
|
|
14053
|
+
*/
|
|
13375
14054
|
hsn_code_id?: string;
|
|
14055
|
+
/**
|
|
14056
|
+
* _Deprecated_*
|
|
14057
|
+
*/
|
|
13376
14058
|
reporting_hsn?: string;
|
|
13377
14059
|
};
|
|
14060
|
+
/** @returns {TaxIdentifierV3} */
|
|
14061
|
+
declare function TaxIdentifierV3(): TaxIdentifierV3;
|
|
14062
|
+
type TaxIdentifierV3 = {
|
|
14063
|
+
/**
|
|
14064
|
+
* - The unique identifier of the tax rule.
|
|
14065
|
+
*/
|
|
14066
|
+
tax_rule_id: string;
|
|
14067
|
+
};
|
|
13378
14068
|
/** @returns {TaxSlab} */
|
|
13379
14069
|
declare function TaxSlab(): TaxSlab;
|
|
13380
14070
|
type TaxSlab = {
|
|
@@ -13978,6 +14668,329 @@ type FollowProduct = {
|
|
|
13978
14668
|
*/
|
|
13979
14669
|
message?: string;
|
|
13980
14670
|
};
|
|
14671
|
+
/** @returns {TaxReqBodyRule} */
|
|
14672
|
+
declare function TaxReqBodyRule(): TaxReqBodyRule;
|
|
14673
|
+
type TaxReqBodyRule = {
|
|
14674
|
+
/**
|
|
14675
|
+
* - Tax rule name
|
|
14676
|
+
*/
|
|
14677
|
+
name: string;
|
|
14678
|
+
/**
|
|
14679
|
+
* - Tax rule description
|
|
14680
|
+
*/
|
|
14681
|
+
description?: string;
|
|
14682
|
+
};
|
|
14683
|
+
/** @returns {TaxThreshold} */
|
|
14684
|
+
declare function TaxThreshold(): TaxThreshold;
|
|
14685
|
+
type TaxThreshold = {
|
|
14686
|
+
/**
|
|
14687
|
+
* - Tax rate is applied to products above or equal to
|
|
14688
|
+
* this price.
|
|
14689
|
+
*/
|
|
14690
|
+
value: number;
|
|
14691
|
+
/**
|
|
14692
|
+
* - Tax rate ranging from 0 to 1.
|
|
14693
|
+
*/
|
|
14694
|
+
rate: number;
|
|
14695
|
+
};
|
|
14696
|
+
/** @returns {TaxComponent} */
|
|
14697
|
+
declare function TaxComponent(): TaxComponent;
|
|
14698
|
+
type TaxComponent = {
|
|
14699
|
+
/**
|
|
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.
|
|
14704
|
+
*/
|
|
14705
|
+
name: string;
|
|
14706
|
+
/**
|
|
14707
|
+
* - List of slabs which comprises of tax rate
|
|
14708
|
+
* and their respective threshold value
|
|
14709
|
+
*/
|
|
14710
|
+
slabs: TaxThreshold[];
|
|
14711
|
+
};
|
|
14712
|
+
/** @returns {TaxComponentResponseSchema} */
|
|
14713
|
+
declare function TaxComponentResponseSchema(): TaxComponentResponseSchema;
|
|
14714
|
+
type TaxComponentResponseSchema = {
|
|
14715
|
+
/**
|
|
14716
|
+
* - Name of the component.
|
|
14717
|
+
*/
|
|
14718
|
+
name: string;
|
|
14719
|
+
/**
|
|
14720
|
+
* - Description of the tax component.
|
|
14721
|
+
*/
|
|
14722
|
+
description?: string;
|
|
14723
|
+
/**
|
|
14724
|
+
* - List of slabs that comprises of tax rate
|
|
14725
|
+
* and their respective threshold.
|
|
14726
|
+
*/
|
|
14727
|
+
slabs: TaxThreshold[];
|
|
14728
|
+
/**
|
|
14729
|
+
* - Unique identifier of the tax component. This _id is
|
|
14730
|
+
* required for updating any tax component; If _id field is not in "update tax
|
|
14731
|
+
* version" request then that component will be created.
|
|
14732
|
+
*/
|
|
14733
|
+
_id: string;
|
|
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
|
+
};
|
|
14776
|
+
/** @returns {TaxReqBodyVersion} */
|
|
14777
|
+
declare function TaxReqBodyVersion(): TaxReqBodyVersion;
|
|
14778
|
+
type TaxReqBodyVersion = {
|
|
14779
|
+
/**
|
|
14780
|
+
* - List of tax components with their
|
|
14781
|
+
* respective slabs and rates.
|
|
14782
|
+
*/
|
|
14783
|
+
components: TaxComponent[];
|
|
14784
|
+
};
|
|
14785
|
+
/** @returns {CreateTaxRequestBody} */
|
|
14786
|
+
declare function CreateTaxRequestBody(): CreateTaxRequestBody;
|
|
14787
|
+
type CreateTaxRequestBody = {
|
|
14788
|
+
rule: TaxReqBodyRule;
|
|
14789
|
+
/**
|
|
14790
|
+
* - List of tax versions for the tax rule.
|
|
14791
|
+
*/
|
|
14792
|
+
versions: TaxReqBodyVersion[];
|
|
14793
|
+
};
|
|
14794
|
+
/** @returns {TaxVersion} */
|
|
14795
|
+
declare function TaxVersion(): TaxVersion;
|
|
14796
|
+
type TaxVersion = {
|
|
14797
|
+
_id?: string;
|
|
14798
|
+
/**
|
|
14799
|
+
* - Tax Rule ID.
|
|
14800
|
+
*/
|
|
14801
|
+
rule_id?: string;
|
|
14802
|
+
/**
|
|
14803
|
+
* - It is the date from when this rule
|
|
14804
|
+
* will come in effect.
|
|
14805
|
+
*/
|
|
14806
|
+
applicable_date?: string;
|
|
14807
|
+
created_on?: string;
|
|
14808
|
+
modified_on?: string;
|
|
14809
|
+
/**
|
|
14810
|
+
* - Company ID.
|
|
14811
|
+
*/
|
|
14812
|
+
company_id?: number;
|
|
14813
|
+
status?: TaxStatusEnum;
|
|
14814
|
+
/**
|
|
14815
|
+
* - List of tax components.
|
|
14816
|
+
*/
|
|
14817
|
+
components?: TaxComponentResponseSchema[];
|
|
14818
|
+
};
|
|
14819
|
+
/** @returns {UpdateTaxVersionRequestBody} */
|
|
14820
|
+
declare function UpdateTaxVersionRequestBody(): UpdateTaxVersionRequestBody;
|
|
14821
|
+
type UpdateTaxVersionRequestBody = {
|
|
14822
|
+
/**
|
|
14823
|
+
* - List of tax components.
|
|
14824
|
+
*/
|
|
14825
|
+
components: TaxComponentResponseSchema[];
|
|
14826
|
+
/**
|
|
14827
|
+
* - It is the date from when this rule will
|
|
14828
|
+
* come in effect. It should be atleast one minute in the future from the current time.
|
|
14829
|
+
*/
|
|
14830
|
+
applicable_date: string;
|
|
14831
|
+
};
|
|
14832
|
+
/** @returns {CreateTaxVersionRequestBody} */
|
|
14833
|
+
declare function CreateTaxVersionRequestBody(): CreateTaxVersionRequestBody;
|
|
14834
|
+
type CreateTaxVersionRequestBody = {
|
|
14835
|
+
/**
|
|
14836
|
+
* - List of tax components.
|
|
14837
|
+
*/
|
|
14838
|
+
components: TaxComponent[];
|
|
14839
|
+
/**
|
|
14840
|
+
* - It is the date from when this rule will
|
|
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.
|
|
14843
|
+
*/
|
|
14844
|
+
applicable_date: string;
|
|
14845
|
+
};
|
|
14846
|
+
/** @returns {TaxRule} */
|
|
14847
|
+
declare function TaxRule(): TaxRule;
|
|
14848
|
+
type TaxRule = {
|
|
14849
|
+
_id?: string;
|
|
14850
|
+
name?: string;
|
|
14851
|
+
/**
|
|
14852
|
+
* - Description of the tax rule.
|
|
14853
|
+
*/
|
|
14854
|
+
description?: string;
|
|
14855
|
+
/**
|
|
14856
|
+
* - Flag to set any tax rule as default, in
|
|
14857
|
+
* case any tax rule is inactive on a product then default tax rule gets applied
|
|
14858
|
+
*/
|
|
14859
|
+
is_default?: boolean;
|
|
14860
|
+
company_id?: number;
|
|
14861
|
+
status?: TaxStatusEnum;
|
|
14862
|
+
created_on?: string;
|
|
14863
|
+
modified_on?: string;
|
|
14864
|
+
};
|
|
14865
|
+
/** @returns {TaxVersionDetail} */
|
|
14866
|
+
declare function TaxVersionDetail(): TaxVersionDetail;
|
|
14867
|
+
type TaxVersionDetail = {
|
|
14868
|
+
_id: string;
|
|
14869
|
+
rule_id: string;
|
|
14870
|
+
applicable_date: string;
|
|
14871
|
+
created_on: string;
|
|
14872
|
+
modified_on: string;
|
|
14873
|
+
company_id: number;
|
|
14874
|
+
status?: TaxStatusEnum;
|
|
14875
|
+
/**
|
|
14876
|
+
* - List of components.
|
|
14877
|
+
*/
|
|
14878
|
+
components: TaxComponent[];
|
|
14879
|
+
/**
|
|
14880
|
+
* - Specifies the type of tax version.
|
|
14881
|
+
*/
|
|
14882
|
+
version_status: string;
|
|
14883
|
+
};
|
|
14884
|
+
/** @returns {CreateTax} */
|
|
14885
|
+
declare function CreateTax(): CreateTax;
|
|
14886
|
+
type CreateTax = {
|
|
14887
|
+
rule?: TaxRule;
|
|
14888
|
+
versions?: TaxVersion;
|
|
14889
|
+
};
|
|
14890
|
+
/** @returns {UpdateTaxVersion} */
|
|
14891
|
+
declare function UpdateTaxVersion(): UpdateTaxVersion;
|
|
14892
|
+
type UpdateTaxVersion = {
|
|
14893
|
+
/**
|
|
14894
|
+
* - List of components.
|
|
14895
|
+
*/
|
|
14896
|
+
components: TaxComponent[];
|
|
14897
|
+
applicable_date: string;
|
|
14898
|
+
};
|
|
14899
|
+
/** @returns {UpdateTaxRequestBody} */
|
|
14900
|
+
declare function UpdateTaxRequestBody(): UpdateTaxRequestBody;
|
|
14901
|
+
type UpdateTaxRequestBody = {
|
|
14902
|
+
status: TaxStatusEnum;
|
|
14903
|
+
/**
|
|
14904
|
+
* - Flag to set any tax rule as default, in case
|
|
14905
|
+
* any tax rule is inactive or not available on a product then default tax
|
|
14906
|
+
* rule gets applied.
|
|
14907
|
+
*/
|
|
14908
|
+
is_default: boolean;
|
|
14909
|
+
/**
|
|
14910
|
+
* - New name of the tax rule.
|
|
14911
|
+
*/
|
|
14912
|
+
name: string;
|
|
14913
|
+
};
|
|
14914
|
+
/** @returns {TaxRuleItem} */
|
|
14915
|
+
declare function TaxRuleItem(): TaxRuleItem;
|
|
14916
|
+
type TaxRuleItem = {
|
|
14917
|
+
versions: TaxVersionDetail[];
|
|
14918
|
+
rule: TaxRule;
|
|
14919
|
+
};
|
|
14920
|
+
/** @returns {TaxRules} */
|
|
14921
|
+
declare function TaxRules(): TaxRules;
|
|
14922
|
+
type TaxRules = {
|
|
14923
|
+
/**
|
|
14924
|
+
* - List of tax rules with their versions.
|
|
14925
|
+
*/
|
|
14926
|
+
items: TaxRuleItem[];
|
|
14927
|
+
page: Page;
|
|
14928
|
+
};
|
|
14929
|
+
/** @returns {TaxVersionPastData} */
|
|
14930
|
+
declare function TaxVersionPastData(): TaxVersionPastData;
|
|
14931
|
+
type TaxVersionPastData = {
|
|
14932
|
+
data?: TaxVersion[];
|
|
14933
|
+
pagination?: Page;
|
|
14934
|
+
};
|
|
14935
|
+
/** @returns {TaxRuleVersion} */
|
|
14936
|
+
declare function TaxRuleVersion(): TaxRuleVersion;
|
|
14937
|
+
type TaxRuleVersion = {
|
|
14938
|
+
/**
|
|
14939
|
+
* - List of tax versions.
|
|
14940
|
+
*/
|
|
14941
|
+
items: TaxVersionDetail[];
|
|
14942
|
+
rule: TaxRule;
|
|
14943
|
+
page: Page;
|
|
14944
|
+
};
|
|
14945
|
+
/** @returns {HSCodeItem} */
|
|
14946
|
+
declare function HSCodeItem(): HSCodeItem;
|
|
14947
|
+
type HSCodeItem = {
|
|
14948
|
+
/**
|
|
14949
|
+
* - Timestamp of when the HS code was created.
|
|
14950
|
+
*/
|
|
14951
|
+
created_on?: string;
|
|
14952
|
+
/**
|
|
14953
|
+
* - Timestamp of when the HS code was last modified.
|
|
14954
|
+
*/
|
|
14955
|
+
modified_on?: string;
|
|
14956
|
+
type: HsTypeEnum;
|
|
14957
|
+
/**
|
|
14958
|
+
* - Company ID associated with this HS code.
|
|
14959
|
+
*/
|
|
14960
|
+
company_id?: number;
|
|
14961
|
+
/**
|
|
14962
|
+
* - Description of the HS code.
|
|
14963
|
+
*/
|
|
14964
|
+
description?: string;
|
|
14965
|
+
/**
|
|
14966
|
+
* - The HS code of the product.
|
|
14967
|
+
*/
|
|
14968
|
+
hs_code: string;
|
|
14969
|
+
/**
|
|
14970
|
+
* - Unique identifier for the HS code entry.
|
|
14971
|
+
*/
|
|
14972
|
+
_id?: string;
|
|
14973
|
+
/**
|
|
14974
|
+
* - ISO 2-digit country code. Will be set by
|
|
14975
|
+
* default according to company's country.
|
|
14976
|
+
*/
|
|
14977
|
+
country_iso?: string;
|
|
14978
|
+
};
|
|
14979
|
+
/** @returns {HSCodes} */
|
|
14980
|
+
declare function HSCodes(): HSCodes;
|
|
14981
|
+
type HSCodes = {
|
|
14982
|
+
/**
|
|
14983
|
+
* - Array of HS code responses.
|
|
14984
|
+
*/
|
|
14985
|
+
items: HSCodeItem[];
|
|
14986
|
+
page: Page;
|
|
14987
|
+
};
|
|
14988
|
+
/** @returns {GetTaxComponents} */
|
|
14989
|
+
declare function GetTaxComponents(): GetTaxComponents;
|
|
14990
|
+
type GetTaxComponents = {
|
|
14991
|
+
items: TaxComponentResponseSchema[];
|
|
14992
|
+
page: Page;
|
|
14993
|
+
};
|
|
13981
14994
|
/** @returns {ActionPage} */
|
|
13982
14995
|
declare function ActionPage(): ActionPage;
|
|
13983
14996
|
type ActionPage = {
|
|
@@ -14071,6 +15084,20 @@ type CustomMeta = {
|
|
|
14071
15084
|
*/
|
|
14072
15085
|
value: string;
|
|
14073
15086
|
};
|
|
15087
|
+
/**
|
|
15088
|
+
* Enum: TaxStatusEnum Used By: Catalog
|
|
15089
|
+
*
|
|
15090
|
+
* @returns {TaxStatusEnum}
|
|
15091
|
+
*/
|
|
15092
|
+
declare function TaxStatusEnum(): TaxStatusEnum;
|
|
15093
|
+
type TaxStatusEnum = "ACTIVE" | "INACTIVE" | "DELETED";
|
|
15094
|
+
/**
|
|
15095
|
+
* Enum: HsTypeEnum Used By: Catalog
|
|
15096
|
+
*
|
|
15097
|
+
* @returns {HsTypeEnum}
|
|
15098
|
+
*/
|
|
15099
|
+
declare function HsTypeEnum(): HsTypeEnum;
|
|
15100
|
+
type HsTypeEnum = "HS" | "SAC";
|
|
14074
15101
|
/**
|
|
14075
15102
|
* Enum: PageType Used By: Catalog
|
|
14076
15103
|
*
|