@gofynd/fdk-client-javascript 3.18.0 → 3.20.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/Cart/CartApplicationClient.d.ts +2 -2
- package/sdk/application/Cart/CartApplicationClient.js +12 -4
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
- package/sdk/application/Order/OrderApplicationClient.js +49 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +2 -0
- package/sdk/common/utils.d.ts +1 -1
- package/sdk/common/utils.js +1 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +11 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +1 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +46 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +334 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +222 -1
- package/sdk/partner/Webhook/WebhookPartnerModel.js +165 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +4 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +30 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +50 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +69 -10
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +30 -5
- package/sdk/platform/Cart/CartPlatformModel.d.ts +97 -72
- package/sdk/platform/Cart/CartPlatformModel.js +54 -35
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +17 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.js +18 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +353 -156
- package/sdk/platform/Catalog/CatalogPlatformModel.js +176 -87
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -38
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +22 -21
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1 -1
- package/sdk/platform/Content/ContentPlatformModel.d.ts +7 -7
- package/sdk/platform/Content/ContentPlatformModel.js +5 -5
- package/sdk/platform/Order/OrderPlatformModel.d.ts +6 -6
- package/sdk/platform/Order/OrderPlatformModel.js +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +5 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/User/UserPlatformApplicationClient.js +9 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +43 -3
- package/sdk/platform/User/UserPlatformModel.js +27 -3
|
@@ -734,10 +734,24 @@ export = CatalogPlatformModel;
|
|
|
734
734
|
* @property {BulkInventoryGetItems[]} [items]
|
|
735
735
|
* @property {Page} [page]
|
|
736
736
|
*/
|
|
737
|
+
/**
|
|
738
|
+
* @typedef InventoryRecord
|
|
739
|
+
* @property {string} [command] - The command associated with the data entry.
|
|
740
|
+
* @property {string} [currency] - The currency code, e.g., INR, USD.
|
|
741
|
+
* @property {string} [inventory_bucket] - Inventory bucket identifier.
|
|
742
|
+
* @property {number} [price_effective] - The effective price of the item.
|
|
743
|
+
* @property {number} [price_marked] - The marked price of the item.
|
|
744
|
+
* @property {string} [seller_identifier] - Identifier for the seller.
|
|
745
|
+
* @property {string} [store_code] - Code identifying the store.
|
|
746
|
+
* @property {number} [total_quantity] - The total quantity for the item.
|
|
747
|
+
* @property {string} [trace_id] - Trace identifier for tracking.
|
|
748
|
+
*/
|
|
737
749
|
/**
|
|
738
750
|
* @typedef FailedRecord
|
|
739
751
|
* @property {string} [identifiers]
|
|
740
752
|
* @property {string} [message]
|
|
753
|
+
* @property {InventoryRecord[]} [data] - List of data items representing the
|
|
754
|
+
* bulk inventory get response.
|
|
741
755
|
*/
|
|
742
756
|
/**
|
|
743
757
|
* @typedef BulkInventoryGetItems
|
|
@@ -757,6 +771,7 @@ export = CatalogPlatformModel;
|
|
|
757
771
|
* @property {number} [succeed]
|
|
758
772
|
* @property {number} [total]
|
|
759
773
|
* @property {string[]} [tags]
|
|
774
|
+
* @property {string} [error_file_url]
|
|
760
775
|
* @property {BulkMeta} [meta]
|
|
761
776
|
*/
|
|
762
777
|
/**
|
|
@@ -765,6 +780,8 @@ export = CatalogPlatformModel;
|
|
|
765
780
|
* context or reason for the bulk inventory action.
|
|
766
781
|
* @property {string[]} [image_urls] - A list of image URLs providing visual
|
|
767
782
|
* evidence or supporting context for the comment.
|
|
783
|
+
* @property {number} [total] - The total count, if provided.
|
|
784
|
+
* @property {Object} [meta] - Metadata as a key-value map.
|
|
768
785
|
*/
|
|
769
786
|
/**
|
|
770
787
|
* @typedef BulkProductJob
|
|
@@ -799,6 +816,8 @@ export = CatalogPlatformModel;
|
|
|
799
816
|
* @property {string} [template_tag]
|
|
800
817
|
* @property {number} [total]
|
|
801
818
|
* @property {string} [tracking_url]
|
|
819
|
+
* @property {string[]} [tags]
|
|
820
|
+
* @property {Object} [meta]
|
|
802
821
|
*/
|
|
803
822
|
/**
|
|
804
823
|
* @typedef BulkProductRequestSchema
|
|
@@ -1816,7 +1835,7 @@ export = CatalogPlatformModel;
|
|
|
1816
1835
|
* @property {string} name - Name of the store location.
|
|
1817
1836
|
* @property {string[]} [notification_emails] - Email addresses for sending
|
|
1818
1837
|
* notifications related to this store.
|
|
1819
|
-
* @property {string} phone_number - Primary phone number for contacting the store.
|
|
1838
|
+
* @property {string} [phone_number] - Primary phone number for contacting the store.
|
|
1820
1839
|
* @property {ProductReturnConfigSchema} [product_return_config]
|
|
1821
1840
|
* @property {string} [stage] - Current operational stage of the store.
|
|
1822
1841
|
* @property {string} [store_type] - Type of store.
|
|
@@ -2218,8 +2237,8 @@ export = CatalogPlatformModel;
|
|
|
2218
2237
|
*/
|
|
2219
2238
|
/**
|
|
2220
2239
|
* @typedef InventoryExportJobListResponseSchema
|
|
2221
|
-
* @property {InventoryJobDetailResponseSchema} items - This is the
|
|
2222
|
-
* of all the jobs.
|
|
2240
|
+
* @property {InventoryJobDetailResponseSchema[]} [items] - This is the
|
|
2241
|
+
* list/history of all the jobs.
|
|
2223
2242
|
* @property {Page} [page]
|
|
2224
2243
|
*/
|
|
2225
2244
|
/**
|
|
@@ -2262,9 +2281,9 @@ export = CatalogPlatformModel;
|
|
|
2262
2281
|
* @property {UserDetail} [created_by] - This is the user detail of the user who
|
|
2263
2282
|
* cancelled the job.
|
|
2264
2283
|
* @property {string} [created_on] - This is the timestamp of the creation for this job.
|
|
2265
|
-
* @property {InventoryJobFilters} filters - This is the filter criteria
|
|
2266
|
-
* for the export job.
|
|
2267
|
-
* @property {string} id - This is the ID of the job.
|
|
2284
|
+
* @property {InventoryJobFilters} [filters] - This is the filter criteria
|
|
2285
|
+
* applied for the export job.
|
|
2286
|
+
* @property {string} [id] - This is the ID of the job.
|
|
2268
2287
|
* @property {string} [modified_on] - This is the timestamp of the modification
|
|
2269
2288
|
* for this job.
|
|
2270
2289
|
* @property {string[]} [notification_emails] - User email to get notification
|
|
@@ -2272,9 +2291,9 @@ export = CatalogPlatformModel;
|
|
|
2272
2291
|
* @property {number} seller_id - This ID of the company.
|
|
2273
2292
|
* @property {string} [status] - This tells you the current status of the export job.
|
|
2274
2293
|
* @property {Object} [stats] - Provides count of total/success/failed
|
|
2275
|
-
* @property {string} task_id - This is the task id of the jobs that is used for search.
|
|
2294
|
+
* @property {string} [task_id] - This is the task id of the jobs that is used for search.
|
|
2276
2295
|
* @property {string} [type] - This is the file type of the export.
|
|
2277
|
-
* @property {string} url - This is the url to download the export.
|
|
2296
|
+
* @property {string} [url] - This is the url to download the export.
|
|
2278
2297
|
*/
|
|
2279
2298
|
/**
|
|
2280
2299
|
* @typedef InventoryJobFilters
|
|
@@ -2334,6 +2353,7 @@ export = CatalogPlatformModel;
|
|
|
2334
2353
|
* @property {number} [not_available_quantity] - The not available quantity of
|
|
2335
2354
|
* the inventory item.
|
|
2336
2355
|
* @property {string} [trace_id] - The trace ID of the inventory payload.
|
|
2356
|
+
* @property {Object} [meta]
|
|
2337
2357
|
*/
|
|
2338
2358
|
/**
|
|
2339
2359
|
* @typedef InventoryRequestSchema
|
|
@@ -3607,6 +3627,11 @@ export = CatalogPlatformModel;
|
|
|
3607
3627
|
/**
|
|
3608
3628
|
* @typedef SizeDetails
|
|
3609
3629
|
* @property {string} [size] - Size identifier for the product (e.g., "S", "M", "L").
|
|
3630
|
+
* @property {number} [item_width] - Item width for the size.
|
|
3631
|
+
* @property {number} [item_length] - Item length for the size.
|
|
3632
|
+
* @property {number} [item_height] - Item height for the size.
|
|
3633
|
+
* @property {number} [price_effective] - Effective price for the size.
|
|
3634
|
+
* @property {number} [item_weight] - Item weight for the size.
|
|
3610
3635
|
* @property {number} [store_count] - The number of stores that have this size available.
|
|
3611
3636
|
* @property {number} [sellable_quantity] - Quantity of the product that is
|
|
3612
3637
|
* sellable in this size.
|
|
@@ -4419,6 +4444,8 @@ export = CatalogPlatformModel;
|
|
|
4419
4444
|
* @property {string} file_path - URL of the uploaded file containing inventory
|
|
4420
4445
|
* update data.
|
|
4421
4446
|
* @property {string[]} [tags] - Tags associated with the inventory update job.
|
|
4447
|
+
* @property {string} [created_on] - The date and time when the bulk inventory
|
|
4448
|
+
* job was created.
|
|
4422
4449
|
* @property {BulkMeta} [meta]
|
|
4423
4450
|
*/
|
|
4424
4451
|
/**
|
|
@@ -4485,39 +4512,45 @@ export = CatalogPlatformModel;
|
|
|
4485
4512
|
*/
|
|
4486
4513
|
/**
|
|
4487
4514
|
* @typedef TaxReqBodyRule
|
|
4488
|
-
* @property {string} name -
|
|
4489
|
-
* @property {string} [description] -
|
|
4515
|
+
* @property {string} name - Unique name of the tax rule
|
|
4516
|
+
* @property {string} [description] - A detailed description of the tax rule.
|
|
4517
|
+
* Helps provide context about its purpose and scope.
|
|
4490
4518
|
*/
|
|
4491
4519
|
/**
|
|
4492
4520
|
* @typedef TaxThreshold
|
|
4493
4521
|
* @property {number} value - Tax rate is applied to products above or equal to
|
|
4494
4522
|
* this price.
|
|
4495
|
-
* @property {number} rate - Tax rate ranging from 0 to 1
|
|
4523
|
+
* @property {number} rate - Tax rate ranging from 0 to 1
|
|
4496
4524
|
*/
|
|
4497
4525
|
/**
|
|
4498
4526
|
* @typedef TaxComponent
|
|
4499
|
-
* @property {string} name -
|
|
4500
|
-
*
|
|
4501
|
-
* (VAT), goods and services tax, consumption
|
|
4502
|
-
*
|
|
4503
|
-
*
|
|
4504
|
-
*
|
|
4527
|
+
* @property {string} name - The name of the tax component. This field
|
|
4528
|
+
* identifies the specific type of tax that the component represents, such as
|
|
4529
|
+
* sales tax, value-added tax (VAT), goods and services tax (GST), consumption
|
|
4530
|
+
* tax, or any other tax applicable at a regional or national level. This
|
|
4531
|
+
* enables classification and clear distinction between multiple tax types
|
|
4532
|
+
* applied to products or transactions.
|
|
4533
|
+
* @property {TaxThreshold[]} slabs - An array of tax rate slabs that define the
|
|
4534
|
+
* thresholds and corresponding rates for this component. Each slab specifies
|
|
4535
|
+
* a minimum value at which the tax rate applies and the rate itself, allowing
|
|
4536
|
+
* for tiered tax calculations based on price ranges or thresholds.
|
|
4505
4537
|
*/
|
|
4506
4538
|
/**
|
|
4507
4539
|
* @typedef TaxComponentResponseSchema
|
|
4508
|
-
* @property {string} name - Name of the component
|
|
4509
|
-
* @property {string} [description] - Description of the tax component
|
|
4510
|
-
* @property {TaxThreshold[]} slabs -
|
|
4511
|
-
* and
|
|
4512
|
-
*
|
|
4513
|
-
*
|
|
4514
|
-
*
|
|
4540
|
+
* @property {string} name - Name of the component
|
|
4541
|
+
* @property {string} [description] - Description of the tax component
|
|
4542
|
+
* @property {TaxThreshold[]} slabs - An array of tax rate slabs, each
|
|
4543
|
+
* specifying the applicable tax rate and its corresponding threshold for this
|
|
4544
|
+
* component.
|
|
4545
|
+
* @property {string} _id - Unique identifier of the tax component. It is
|
|
4546
|
+
* required for updating any tax component; If _id field is not in
|
|
4547
|
+
* "updateTaxVersion" request then that component will be created.
|
|
4515
4548
|
*/
|
|
4516
4549
|
/**
|
|
4517
4550
|
* @typedef TaxComponentName
|
|
4518
4551
|
* @property {string} _id - Unique identifier for the tax component name
|
|
4519
|
-
* @property {number} company_id -
|
|
4520
|
-
*
|
|
4552
|
+
* @property {number} company_id - Unique identifier of the company to which
|
|
4553
|
+
* this tax component name is associated.
|
|
4521
4554
|
* @property {string} name - Name of the tax component
|
|
4522
4555
|
* @property {string} [description] - Description of the tax component name
|
|
4523
4556
|
* @property {string} [created_on] - Timestamp when the component name was created
|
|
@@ -4526,18 +4559,22 @@ export = CatalogPlatformModel;
|
|
|
4526
4559
|
/**
|
|
4527
4560
|
* @typedef CreateTaxComponentNameRequestSchema
|
|
4528
4561
|
* @property {string} name - Name of the tax component
|
|
4529
|
-
* @property {string} [description] - Description of the tax component name
|
|
4530
4562
|
*/
|
|
4531
4563
|
/**
|
|
4532
4564
|
* @typedef TaxReqBodyVersion
|
|
4533
|
-
* @property {
|
|
4534
|
-
*
|
|
4535
|
-
*
|
|
4536
|
-
*
|
|
4537
|
-
*
|
|
4538
|
-
*
|
|
4565
|
+
* @property {string} [scope] - Scope of the tax version
|
|
4566
|
+
* @property {TaxComponent[]} components - Array of tax components included in
|
|
4567
|
+
* this version that will apply within the scope of this tax version.
|
|
4568
|
+
* @property {string} [applicable_date] - The date and time (in ISO 8601 format)
|
|
4569
|
+
* when this tax version becomes effective. If provided, it must be at least
|
|
4570
|
+
* one minute later than the current time, allowing scheduling of future tax
|
|
4571
|
+
* rule activation.
|
|
4572
|
+
* @property {string} [region_type] - Specifies the level (like state, city, or
|
|
4573
|
+
* pincode) for this tax version when the 'areas' field is used. Use values
|
|
4574
|
+
* allowed for the country, which you can get from the Servicability
|
|
4575
|
+
* country-hierarchy API. This field is needed if 'areas' are provided.
|
|
4539
4576
|
* @property {TaxGeoArea} [areas]
|
|
4540
|
-
* @property {number[]} [store_ids] -
|
|
4577
|
+
* @property {number[]} [store_ids] - List of store identifiers for store-level taxation.
|
|
4541
4578
|
*/
|
|
4542
4579
|
/**
|
|
4543
4580
|
* @typedef TaxGeoArea
|
|
@@ -4571,69 +4608,88 @@ export = CatalogPlatformModel;
|
|
|
4571
4608
|
/**
|
|
4572
4609
|
* @typedef CreateTaxRequestBody
|
|
4573
4610
|
* @property {TaxReqBodyRule} rule
|
|
4574
|
-
* @property {TaxReqBodyVersion
|
|
4611
|
+
* @property {TaxReqBodyVersion} versions
|
|
4575
4612
|
*/
|
|
4576
4613
|
/**
|
|
4577
4614
|
* @typedef TaxVersion
|
|
4578
|
-
* @property {string} [_id]
|
|
4579
|
-
* @property {string} [rule_id] -
|
|
4580
|
-
*
|
|
4581
|
-
*
|
|
4582
|
-
*
|
|
4583
|
-
*
|
|
4584
|
-
*
|
|
4615
|
+
* @property {string} [_id] - Unique identifier of the tax version
|
|
4616
|
+
* @property {string} [rule_id] - Unique identifier of the tax rule to which
|
|
4617
|
+
* this version belongs. This identifier links the tax version to its parent rule.
|
|
4618
|
+
* @property {string} [applicable_date] - The date and time when this version
|
|
4619
|
+
* becomes effective and is used for taxation purposes. This field must be at
|
|
4620
|
+
* least one minute in the future relative to the current system time to
|
|
4621
|
+
* ensure future scheduling of tax versions.
|
|
4622
|
+
* @property {string} [created_on] - ISO 8601 timestamp indicating when this tax
|
|
4623
|
+
* version was created in the system. Used for audit trails and version history.
|
|
4624
|
+
* @property {string} [modified_on] - ISO 8601 timestamp of the latest update to
|
|
4625
|
+
* this tax version. Every modification or update to the version record
|
|
4626
|
+
* updates this field, ensuring accurate audit and traceability.
|
|
4627
|
+
* @property {number} [company_id] - Unique identifier of the company for which
|
|
4628
|
+
* this tax version is defined.
|
|
4585
4629
|
* @property {TaxStatusEnum} [status]
|
|
4586
|
-
* @property {string} [region_type] -
|
|
4587
|
-
*
|
|
4630
|
+
* @property {string} [region_type] - Specifies the geographical region at which
|
|
4631
|
+
* the tax rule version applies. Required and present when the version targets
|
|
4632
|
+
* a specific region rather than the default country-level rule.
|
|
4588
4633
|
* @property {TaxGeoArea} [areas]
|
|
4589
|
-
* @property {number[]} [store_ids] -
|
|
4634
|
+
* @property {number[]} [store_ids] - Array of store identifiers to which this
|
|
4635
|
+
* tax version is scoped. Enables store-level tax configuration, allowing
|
|
4636
|
+
* companies to specify tax applicability at individual store granularity.
|
|
4590
4637
|
* @property {TaxVersionScopeEnum} [scope]
|
|
4591
|
-
* @property {TaxComponentResponseSchema[]} [components]
|
|
4638
|
+
* @property {TaxComponentResponseSchema[]} [components]
|
|
4592
4639
|
*/
|
|
4593
4640
|
/**
|
|
4594
4641
|
* @typedef UpdateTaxVersionRequestBody
|
|
4595
|
-
* @property {TaxComponentResponseSchema[]} components
|
|
4642
|
+
* @property {TaxComponentResponseSchema[]} components
|
|
4596
4643
|
* @property {string} applicable_date - It is the date from when this rule will
|
|
4597
4644
|
* come in effect. It should be at least one minute in the future from the
|
|
4598
4645
|
* current time.
|
|
4599
4646
|
* @property {string} [region_type] - Required when areas are present to denote
|
|
4600
|
-
* the level (city/state/pincode) at which the version applies.
|
|
4647
|
+
* the level (city/state/pincode) at which the version applies. Supported
|
|
4648
|
+
* region types are derived from Servicability's country hierarchy (e.g.,
|
|
4649
|
+
* India: state, city; UAE: sector, city). Use the Servicability
|
|
4650
|
+
* country-hierarchy API to read the allowed levels.
|
|
4601
4651
|
* @property {TaxGeoArea} [areas]
|
|
4602
4652
|
* @property {number[]} [store_ids] - Store identifiers for store-level taxation.
|
|
4603
4653
|
*/
|
|
4604
4654
|
/**
|
|
4605
4655
|
* @typedef CreateTaxVersionRequestBody
|
|
4606
|
-
* @property {
|
|
4656
|
+
* @property {string} [scope] - Scope of the tax version
|
|
4657
|
+
* @property {TaxComponent[]} components - List of tax components
|
|
4607
4658
|
* @property {string} [applicable_date] - Optional scheduled date from when this
|
|
4608
4659
|
* rule will come in effect. It should be at least one minute in the future
|
|
4609
|
-
* from the current time.
|
|
4660
|
+
* from the current time.
|
|
4610
4661
|
* @property {string} [region_type] - Required when areas are present to denote
|
|
4611
|
-
* the level (city/state/pincode) at which the version applies.
|
|
4662
|
+
* the level (city/state/pincode) at which the version applies. Supported
|
|
4663
|
+
* values follow Servicability's country hierarchy (e.g., India: state, city;
|
|
4664
|
+
* UAE: sector, city); consult Servicability country-hierarchy APIs to
|
|
4665
|
+
* retrieve valid levels.
|
|
4612
4666
|
* @property {TaxGeoArea} [areas]
|
|
4613
4667
|
* @property {number[]} [store_ids] - Store identifiers for store-level taxation.
|
|
4614
4668
|
*/
|
|
4615
4669
|
/**
|
|
4616
4670
|
* @typedef TaxRule
|
|
4617
|
-
* @property {string} [_id]
|
|
4618
|
-
* @property {string} [name]
|
|
4619
|
-
* @property {string} [description] - Description of the tax rule
|
|
4620
|
-
* @property {boolean} [is_default] - Flag to set any tax rule as default
|
|
4621
|
-
*
|
|
4622
|
-
* @property {number} [company_id]
|
|
4671
|
+
* @property {string} [_id] - Unique identifier of the tax rule
|
|
4672
|
+
* @property {string} [name] - Name of the tax rule
|
|
4673
|
+
* @property {string} [description] - Description of the tax rule
|
|
4674
|
+
* @property {boolean} [is_default] - Flag to set any tax rule as default. If
|
|
4675
|
+
* any tax rule is inactive on a product then default tax rule gets applied.
|
|
4676
|
+
* @property {number} [company_id] - Unique identifier of the company which the
|
|
4677
|
+
* tax rule created
|
|
4623
4678
|
* @property {TaxStatusEnum} [status]
|
|
4624
4679
|
* @property {string} [created_on]
|
|
4625
4680
|
* @property {string} [modified_on]
|
|
4626
4681
|
*/
|
|
4627
4682
|
/**
|
|
4628
4683
|
* @typedef TaxVersionDetail
|
|
4629
|
-
* @property {string} _id
|
|
4630
|
-
* @property {string} rule_id
|
|
4684
|
+
* @property {string} _id - Unique identifier for the tax version
|
|
4685
|
+
* @property {string} rule_id - Unique identifier for the rule ID
|
|
4631
4686
|
* @property {string} applicable_date - It is the date from when this rule comes
|
|
4632
4687
|
* in effect. Always present and should be at least one minute in the future
|
|
4633
4688
|
* when scheduled.
|
|
4634
4689
|
* @property {string} created_on
|
|
4635
4690
|
* @property {string} modified_on
|
|
4636
|
-
* @property {number} company_id
|
|
4691
|
+
* @property {number} company_id - Unique identifier of the company which the
|
|
4692
|
+
* tax rule created
|
|
4637
4693
|
* @property {TaxStatusEnum} [status]
|
|
4638
4694
|
* @property {string} [region_code] - Region code for areas sent when adding a
|
|
4639
4695
|
* region override.
|
|
@@ -4651,10 +4707,10 @@ export = CatalogPlatformModel;
|
|
|
4651
4707
|
/**
|
|
4652
4708
|
* @typedef UpdateTaxRequestBody
|
|
4653
4709
|
* @property {TaxStatusEnum} status
|
|
4654
|
-
* @property {boolean} is_default - Flag to set
|
|
4655
|
-
*
|
|
4656
|
-
*
|
|
4657
|
-
* @property {string} name - New name of the tax rule
|
|
4710
|
+
* @property {boolean} is_default - Flag to set tax rule as the default. If a
|
|
4711
|
+
* tax rule is inactive or not available for a product, the default tax rule
|
|
4712
|
+
* will be applied.
|
|
4713
|
+
* @property {string} name - New name of the tax rule
|
|
4658
4714
|
*/
|
|
4659
4715
|
/**
|
|
4660
4716
|
* @typedef TaxRuleItem
|
|
@@ -4663,7 +4719,7 @@ export = CatalogPlatformModel;
|
|
|
4663
4719
|
*/
|
|
4664
4720
|
/**
|
|
4665
4721
|
* @typedef TaxRules
|
|
4666
|
-
* @property {TaxRuleItem[]} items - List of tax rules with their versions
|
|
4722
|
+
* @property {TaxRuleItem[]} items - List of tax rules with their versions
|
|
4667
4723
|
* @property {Page} page
|
|
4668
4724
|
*/
|
|
4669
4725
|
/**
|
|
@@ -4673,25 +4729,28 @@ export = CatalogPlatformModel;
|
|
|
4673
4729
|
*/
|
|
4674
4730
|
/**
|
|
4675
4731
|
* @typedef TaxRuleVersion
|
|
4676
|
-
* @property {TaxVersionDetail[]} items - List of tax versions
|
|
4732
|
+
* @property {TaxVersionDetail[]} items - List of tax versions
|
|
4677
4733
|
* @property {TaxRule} rule
|
|
4678
4734
|
* @property {Page} page
|
|
4679
4735
|
*/
|
|
4680
4736
|
/**
|
|
4681
4737
|
* @typedef HSCodeItem
|
|
4682
|
-
* @property {string} [created_on] - Timestamp
|
|
4683
|
-
* @property {string} [modified_on] - Timestamp of
|
|
4684
|
-
*
|
|
4685
|
-
* @property {
|
|
4686
|
-
* @property {
|
|
4687
|
-
*
|
|
4688
|
-
* @property {string} [
|
|
4689
|
-
*
|
|
4690
|
-
*
|
|
4738
|
+
* @property {string} [created_on] - Timestamp when the HS/SAC code entry was created.
|
|
4739
|
+
* @property {string} [modified_on] - Timestamp of the most recent modification
|
|
4740
|
+
* to this HS/SAC code entry.
|
|
4741
|
+
* @property {string} type - Type of the code for services
|
|
4742
|
+
* @property {number} [company_id] - Unique identifier of the company to which
|
|
4743
|
+
* this HS/SAC code is associated.
|
|
4744
|
+
* @property {string} [description] - Description providing details about the HS
|
|
4745
|
+
* or SAC code
|
|
4746
|
+
* @property {string} hs_code - The HS or SAC value being registered for the company.
|
|
4747
|
+
* @property {string} [_id] - Unique identifier for the HS/SAC code entry
|
|
4748
|
+
* @property {string} [country_iso] - ISO 3166-1 alpha-2 country code
|
|
4749
|
+
* representing the country for which this code is registered.
|
|
4691
4750
|
*/
|
|
4692
4751
|
/**
|
|
4693
4752
|
* @typedef HSCodes
|
|
4694
|
-
* @property {HSCodeItem[]} items - Array of HS code responses
|
|
4753
|
+
* @property {HSCodeItem[]} items - Array of HS code responses
|
|
4695
4754
|
* @property {Page} page
|
|
4696
4755
|
*/
|
|
4697
4756
|
/**
|
|
@@ -4936,7 +4995,7 @@ export = CatalogPlatformModel;
|
|
|
4936
4995
|
declare class CatalogPlatformModel {
|
|
4937
4996
|
}
|
|
4938
4997
|
declare namespace CatalogPlatformModel {
|
|
4939
|
-
export { Action, ValidationErrors, StandardError, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, SortWeights, CohortWeights, HighSpenderRepeatCustomerWeights, HyperactiveRepeatCustomerWeights, HighSpenderOccasionalCustomerWeights, StandardOccasionalCustomerWeights, DormantPremiumCustomerWeights, BudgetRegularCustomerWeights, HighSpenderRegularCustomerWeights, StandardCustomerAboutToChurnWeights, PremiumCustomerAboutToChurnWeights, HighSpenderCustomerAboutToChurnWeights, StandardDormantCustomerWeights, HighSpenderDormantCustomerWeights, PotentialCustomerWeights, NewCustomerWeights, BudgetRepeatCustomerWeights, AverageSpenderRepeatCustomerWeights, CohortSortingConfiguration, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleStoreResponseSchema, 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, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, PriceStrategySchema, PriceFactoryResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, 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, TaxGeoArea, AreaDetails, Country, Area, RegionReference, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, PriceFactoryListItemsSchema, PriceFactoryListResponseSchema, CreatePriceFactoryConfigSchema, UpdatePriceFactoryConfigSchema, PriceFactoryConfigSchema, CurrencyPriceSchema, UpsertPriceFactorySizesSchema, UpsertPriceFactoryProductSchema, PriceFactoryCurrencyPriceSchema, PriceFactorySizesSchema, PriceFactoryProductResponseSchema, PriceFactoryProductListResponseSchema, PriceRange, CurrencyPrice, ProductPrice, AppProductPricesSchema, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, TaxVersionScopeEnum, HsTypeEnum, PageType };
|
|
4998
|
+
export { Action, ValidationErrors, StandardError, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, SortWeights, CohortWeights, HighSpenderRepeatCustomerWeights, HyperactiveRepeatCustomerWeights, HighSpenderOccasionalCustomerWeights, StandardOccasionalCustomerWeights, DormantPremiumCustomerWeights, BudgetRegularCustomerWeights, HighSpenderRegularCustomerWeights, StandardCustomerAboutToChurnWeights, PremiumCustomerAboutToChurnWeights, HighSpenderCustomerAboutToChurnWeights, StandardDormantCustomerWeights, HighSpenderDormantCustomerWeights, PotentialCustomerWeights, NewCustomerWeights, BudgetRepeatCustomerWeights, AverageSpenderRepeatCustomerWeights, CohortSortingConfiguration, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleStoreResponseSchema, 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, InventoryRecord, 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, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, PriceStrategySchema, PriceFactoryResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, 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, TaxGeoArea, AreaDetails, Country, Area, RegionReference, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, PriceFactoryListItemsSchema, PriceFactoryListResponseSchema, CreatePriceFactoryConfigSchema, UpdatePriceFactoryConfigSchema, PriceFactoryConfigSchema, CurrencyPriceSchema, UpsertPriceFactorySizesSchema, UpsertPriceFactoryProductSchema, PriceFactoryCurrencyPriceSchema, PriceFactorySizesSchema, PriceFactoryProductResponseSchema, PriceFactoryProductListResponseSchema, PriceRange, CurrencyPrice, ProductPrice, AppProductPricesSchema, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, TaxVersionScopeEnum, HsTypeEnum, PageType };
|
|
4940
4999
|
}
|
|
4941
5000
|
/** @returns {Action} */
|
|
4942
5001
|
declare function Action(): Action;
|
|
@@ -6415,11 +6474,56 @@ type BulkInventoryGet = {
|
|
|
6415
6474
|
items?: BulkInventoryGetItems[];
|
|
6416
6475
|
page?: Page;
|
|
6417
6476
|
};
|
|
6477
|
+
/** @returns {InventoryRecord} */
|
|
6478
|
+
declare function InventoryRecord(): InventoryRecord;
|
|
6479
|
+
type InventoryRecord = {
|
|
6480
|
+
/**
|
|
6481
|
+
* - The command associated with the data entry.
|
|
6482
|
+
*/
|
|
6483
|
+
command?: string;
|
|
6484
|
+
/**
|
|
6485
|
+
* - The currency code, e.g., INR, USD.
|
|
6486
|
+
*/
|
|
6487
|
+
currency?: string;
|
|
6488
|
+
/**
|
|
6489
|
+
* - Inventory bucket identifier.
|
|
6490
|
+
*/
|
|
6491
|
+
inventory_bucket?: string;
|
|
6492
|
+
/**
|
|
6493
|
+
* - The effective price of the item.
|
|
6494
|
+
*/
|
|
6495
|
+
price_effective?: number;
|
|
6496
|
+
/**
|
|
6497
|
+
* - The marked price of the item.
|
|
6498
|
+
*/
|
|
6499
|
+
price_marked?: number;
|
|
6500
|
+
/**
|
|
6501
|
+
* - Identifier for the seller.
|
|
6502
|
+
*/
|
|
6503
|
+
seller_identifier?: string;
|
|
6504
|
+
/**
|
|
6505
|
+
* - Code identifying the store.
|
|
6506
|
+
*/
|
|
6507
|
+
store_code?: string;
|
|
6508
|
+
/**
|
|
6509
|
+
* - The total quantity for the item.
|
|
6510
|
+
*/
|
|
6511
|
+
total_quantity?: number;
|
|
6512
|
+
/**
|
|
6513
|
+
* - Trace identifier for tracking.
|
|
6514
|
+
*/
|
|
6515
|
+
trace_id?: string;
|
|
6516
|
+
};
|
|
6418
6517
|
/** @returns {FailedRecord} */
|
|
6419
6518
|
declare function FailedRecord(): FailedRecord;
|
|
6420
6519
|
type FailedRecord = {
|
|
6421
6520
|
identifiers?: string;
|
|
6422
6521
|
message?: string;
|
|
6522
|
+
/**
|
|
6523
|
+
* - List of data items representing the
|
|
6524
|
+
* bulk inventory get response.
|
|
6525
|
+
*/
|
|
6526
|
+
data?: InventoryRecord[];
|
|
6423
6527
|
};
|
|
6424
6528
|
/** @returns {BulkInventoryGetItems} */
|
|
6425
6529
|
declare function BulkInventoryGetItems(): BulkInventoryGetItems;
|
|
@@ -6440,6 +6544,7 @@ type BulkInventoryGetItems = {
|
|
|
6440
6544
|
succeed?: number;
|
|
6441
6545
|
total?: number;
|
|
6442
6546
|
tags?: string[];
|
|
6547
|
+
error_file_url?: string;
|
|
6443
6548
|
meta?: BulkMeta;
|
|
6444
6549
|
};
|
|
6445
6550
|
/** @returns {BulkMeta} */
|
|
@@ -6455,6 +6560,14 @@ type BulkMeta = {
|
|
|
6455
6560
|
* evidence or supporting context for the comment.
|
|
6456
6561
|
*/
|
|
6457
6562
|
image_urls?: string[];
|
|
6563
|
+
/**
|
|
6564
|
+
* - The total count, if provided.
|
|
6565
|
+
*/
|
|
6566
|
+
total?: number;
|
|
6567
|
+
/**
|
|
6568
|
+
* - Metadata as a key-value map.
|
|
6569
|
+
*/
|
|
6570
|
+
meta?: any;
|
|
6458
6571
|
};
|
|
6459
6572
|
/** @returns {BulkProductJob} */
|
|
6460
6573
|
declare function BulkProductJob(): BulkProductJob;
|
|
@@ -6524,6 +6637,8 @@ type BulkJob = {
|
|
|
6524
6637
|
template_tag?: string;
|
|
6525
6638
|
total?: number;
|
|
6526
6639
|
tracking_url?: string;
|
|
6640
|
+
tags?: string[];
|
|
6641
|
+
meta?: any;
|
|
6527
6642
|
};
|
|
6528
6643
|
/** @returns {BulkProductRequestSchema} */
|
|
6529
6644
|
declare function BulkProductRequestSchema(): BulkProductRequestSchema;
|
|
@@ -8609,7 +8724,7 @@ type GetLocationSchema = {
|
|
|
8609
8724
|
/**
|
|
8610
8725
|
* - Primary phone number for contacting the store.
|
|
8611
8726
|
*/
|
|
8612
|
-
phone_number
|
|
8727
|
+
phone_number?: string;
|
|
8613
8728
|
product_return_config?: ProductReturnConfigSchema;
|
|
8614
8729
|
/**
|
|
8615
8730
|
* - Current operational stage of the store.
|
|
@@ -9481,10 +9596,10 @@ type InventoryExportJob = {
|
|
|
9481
9596
|
declare function InventoryExportJobListResponseSchema(): InventoryExportJobListResponseSchema;
|
|
9482
9597
|
type InventoryExportJobListResponseSchema = {
|
|
9483
9598
|
/**
|
|
9484
|
-
* - This is the
|
|
9485
|
-
* of all the jobs.
|
|
9599
|
+
* - This is the
|
|
9600
|
+
* list/history of all the jobs.
|
|
9486
9601
|
*/
|
|
9487
|
-
items
|
|
9602
|
+
items?: InventoryJobDetailResponseSchema[];
|
|
9488
9603
|
page?: Page;
|
|
9489
9604
|
};
|
|
9490
9605
|
/** @returns {InventoryExportQuantityFilter} */
|
|
@@ -9587,14 +9702,14 @@ type InventoryJobDetailResponseSchema = {
|
|
|
9587
9702
|
*/
|
|
9588
9703
|
created_on?: string;
|
|
9589
9704
|
/**
|
|
9590
|
-
* - This is the filter criteria
|
|
9591
|
-
* for the export job.
|
|
9705
|
+
* - This is the filter criteria
|
|
9706
|
+
* applied for the export job.
|
|
9592
9707
|
*/
|
|
9593
|
-
filters
|
|
9708
|
+
filters?: InventoryJobFilters;
|
|
9594
9709
|
/**
|
|
9595
9710
|
* - This is the ID of the job.
|
|
9596
9711
|
*/
|
|
9597
|
-
id
|
|
9712
|
+
id?: string;
|
|
9598
9713
|
/**
|
|
9599
9714
|
* - This is the timestamp of the modification
|
|
9600
9715
|
* for this job.
|
|
@@ -9620,7 +9735,7 @@ type InventoryJobDetailResponseSchema = {
|
|
|
9620
9735
|
/**
|
|
9621
9736
|
* - This is the task id of the jobs that is used for search.
|
|
9622
9737
|
*/
|
|
9623
|
-
task_id
|
|
9738
|
+
task_id?: string;
|
|
9624
9739
|
/**
|
|
9625
9740
|
* - This is the file type of the export.
|
|
9626
9741
|
*/
|
|
@@ -9628,7 +9743,7 @@ type InventoryJobDetailResponseSchema = {
|
|
|
9628
9743
|
/**
|
|
9629
9744
|
* - This is the url to download the export.
|
|
9630
9745
|
*/
|
|
9631
|
-
url
|
|
9746
|
+
url?: string;
|
|
9632
9747
|
};
|
|
9633
9748
|
/** @returns {InventoryJobFilters} */
|
|
9634
9749
|
declare function InventoryJobFilters(): InventoryJobFilters;
|
|
@@ -9795,6 +9910,7 @@ type InventoryPayload = {
|
|
|
9795
9910
|
* - The trace ID of the inventory payload.
|
|
9796
9911
|
*/
|
|
9797
9912
|
trace_id?: string;
|
|
9913
|
+
meta?: any;
|
|
9798
9914
|
};
|
|
9799
9915
|
/** @returns {InventoryRequestSchema} */
|
|
9800
9916
|
declare function InventoryRequestSchema(): InventoryRequestSchema;
|
|
@@ -12814,6 +12930,26 @@ type SizeDetails = {
|
|
|
12814
12930
|
* - Size identifier for the product (e.g., "S", "M", "L").
|
|
12815
12931
|
*/
|
|
12816
12932
|
size?: string;
|
|
12933
|
+
/**
|
|
12934
|
+
* - Item width for the size.
|
|
12935
|
+
*/
|
|
12936
|
+
item_width?: number;
|
|
12937
|
+
/**
|
|
12938
|
+
* - Item length for the size.
|
|
12939
|
+
*/
|
|
12940
|
+
item_length?: number;
|
|
12941
|
+
/**
|
|
12942
|
+
* - Item height for the size.
|
|
12943
|
+
*/
|
|
12944
|
+
item_height?: number;
|
|
12945
|
+
/**
|
|
12946
|
+
* - Effective price for the size.
|
|
12947
|
+
*/
|
|
12948
|
+
price_effective?: number;
|
|
12949
|
+
/**
|
|
12950
|
+
* - Item weight for the size.
|
|
12951
|
+
*/
|
|
12952
|
+
item_weight?: number;
|
|
12817
12953
|
/**
|
|
12818
12954
|
* - The number of stores that have this size available.
|
|
12819
12955
|
*/
|
|
@@ -14483,6 +14619,11 @@ type BulkInventoryJob = {
|
|
|
14483
14619
|
* - Tags associated with the inventory update job.
|
|
14484
14620
|
*/
|
|
14485
14621
|
tags?: string[];
|
|
14622
|
+
/**
|
|
14623
|
+
* - The date and time when the bulk inventory
|
|
14624
|
+
* job was created.
|
|
14625
|
+
*/
|
|
14626
|
+
created_on?: string;
|
|
14486
14627
|
meta?: BulkMeta;
|
|
14487
14628
|
};
|
|
14488
14629
|
/** @returns {Marketplaces} */
|
|
@@ -14576,11 +14717,12 @@ type FollowProduct = {
|
|
|
14576
14717
|
declare function TaxReqBodyRule(): TaxReqBodyRule;
|
|
14577
14718
|
type TaxReqBodyRule = {
|
|
14578
14719
|
/**
|
|
14579
|
-
* -
|
|
14720
|
+
* - Unique name of the tax rule
|
|
14580
14721
|
*/
|
|
14581
14722
|
name: string;
|
|
14582
14723
|
/**
|
|
14583
|
-
* -
|
|
14724
|
+
* - A detailed description of the tax rule.
|
|
14725
|
+
* Helps provide context about its purpose and scope.
|
|
14584
14726
|
*/
|
|
14585
14727
|
description?: string;
|
|
14586
14728
|
};
|
|
@@ -14593,7 +14735,7 @@ type TaxThreshold = {
|
|
|
14593
14735
|
*/
|
|
14594
14736
|
value: number;
|
|
14595
14737
|
/**
|
|
14596
|
-
* - Tax rate ranging from 0 to 1
|
|
14738
|
+
* - Tax rate ranging from 0 to 1
|
|
14597
14739
|
*/
|
|
14598
14740
|
rate: number;
|
|
14599
14741
|
};
|
|
@@ -14601,15 +14743,19 @@ type TaxThreshold = {
|
|
|
14601
14743
|
declare function TaxComponent(): TaxComponent;
|
|
14602
14744
|
type TaxComponent = {
|
|
14603
14745
|
/**
|
|
14604
|
-
* -
|
|
14605
|
-
*
|
|
14606
|
-
* (VAT), goods and services tax, consumption
|
|
14607
|
-
*
|
|
14746
|
+
* - The name of the tax component. This field
|
|
14747
|
+
* identifies the specific type of tax that the component represents, such as
|
|
14748
|
+
* sales tax, value-added tax (VAT), goods and services tax (GST), consumption
|
|
14749
|
+
* tax, or any other tax applicable at a regional or national level. This
|
|
14750
|
+
* enables classification and clear distinction between multiple tax types
|
|
14751
|
+
* applied to products or transactions.
|
|
14608
14752
|
*/
|
|
14609
14753
|
name: string;
|
|
14610
14754
|
/**
|
|
14611
|
-
* -
|
|
14612
|
-
* and
|
|
14755
|
+
* - An array of tax rate slabs that define the
|
|
14756
|
+
* thresholds and corresponding rates for this component. Each slab specifies
|
|
14757
|
+
* a minimum value at which the tax rate applies and the rate itself, allowing
|
|
14758
|
+
* for tiered tax calculations based on price ranges or thresholds.
|
|
14613
14759
|
*/
|
|
14614
14760
|
slabs: TaxThreshold[];
|
|
14615
14761
|
};
|
|
@@ -14617,22 +14763,23 @@ type TaxComponent = {
|
|
|
14617
14763
|
declare function TaxComponentResponseSchema(): TaxComponentResponseSchema;
|
|
14618
14764
|
type TaxComponentResponseSchema = {
|
|
14619
14765
|
/**
|
|
14620
|
-
* - Name of the component
|
|
14766
|
+
* - Name of the component
|
|
14621
14767
|
*/
|
|
14622
14768
|
name: string;
|
|
14623
14769
|
/**
|
|
14624
|
-
* - Description of the tax component
|
|
14770
|
+
* - Description of the tax component
|
|
14625
14771
|
*/
|
|
14626
14772
|
description?: string;
|
|
14627
14773
|
/**
|
|
14628
|
-
* -
|
|
14629
|
-
* and
|
|
14774
|
+
* - An array of tax rate slabs, each
|
|
14775
|
+
* specifying the applicable tax rate and its corresponding threshold for this
|
|
14776
|
+
* component.
|
|
14630
14777
|
*/
|
|
14631
14778
|
slabs: TaxThreshold[];
|
|
14632
14779
|
/**
|
|
14633
|
-
* - Unique identifier of the tax component.
|
|
14634
|
-
* required for updating any tax component; If _id field is not in
|
|
14635
|
-
*
|
|
14780
|
+
* - Unique identifier of the tax component. It is
|
|
14781
|
+
* required for updating any tax component; If _id field is not in
|
|
14782
|
+
* "updateTaxVersion" request then that component will be created.
|
|
14636
14783
|
*/
|
|
14637
14784
|
_id: string;
|
|
14638
14785
|
};
|
|
@@ -14644,8 +14791,8 @@ type TaxComponentName = {
|
|
|
14644
14791
|
*/
|
|
14645
14792
|
_id: string;
|
|
14646
14793
|
/**
|
|
14647
|
-
* -
|
|
14648
|
-
*
|
|
14794
|
+
* - Unique identifier of the company to which
|
|
14795
|
+
* this tax component name is associated.
|
|
14649
14796
|
*/
|
|
14650
14797
|
company_id: number;
|
|
14651
14798
|
/**
|
|
@@ -14672,32 +14819,36 @@ type CreateTaxComponentNameRequestSchema = {
|
|
|
14672
14819
|
* - Name of the tax component
|
|
14673
14820
|
*/
|
|
14674
14821
|
name: string;
|
|
14675
|
-
/**
|
|
14676
|
-
* - Description of the tax component name
|
|
14677
|
-
*/
|
|
14678
|
-
description?: string;
|
|
14679
14822
|
};
|
|
14680
14823
|
/** @returns {TaxReqBodyVersion} */
|
|
14681
14824
|
declare function TaxReqBodyVersion(): TaxReqBodyVersion;
|
|
14682
14825
|
type TaxReqBodyVersion = {
|
|
14683
14826
|
/**
|
|
14684
|
-
* -
|
|
14685
|
-
|
|
14827
|
+
* - Scope of the tax version
|
|
14828
|
+
*/
|
|
14829
|
+
scope?: string;
|
|
14830
|
+
/**
|
|
14831
|
+
* - Array of tax components included in
|
|
14832
|
+
* this version that will apply within the scope of this tax version.
|
|
14686
14833
|
*/
|
|
14687
14834
|
components: TaxComponent[];
|
|
14688
14835
|
/**
|
|
14689
|
-
* -
|
|
14690
|
-
*
|
|
14836
|
+
* - The date and time (in ISO 8601 format)
|
|
14837
|
+
* when this tax version becomes effective. If provided, it must be at least
|
|
14838
|
+
* one minute later than the current time, allowing scheduling of future tax
|
|
14839
|
+
* rule activation.
|
|
14691
14840
|
*/
|
|
14692
14841
|
applicable_date?: string;
|
|
14693
14842
|
/**
|
|
14694
|
-
* -
|
|
14695
|
-
*
|
|
14843
|
+
* - Specifies the level (like state, city, or
|
|
14844
|
+
* pincode) for this tax version when the 'areas' field is used. Use values
|
|
14845
|
+
* allowed for the country, which you can get from the Servicability
|
|
14846
|
+
* country-hierarchy API. This field is needed if 'areas' are provided.
|
|
14696
14847
|
*/
|
|
14697
14848
|
region_type?: string;
|
|
14698
14849
|
areas?: TaxGeoArea;
|
|
14699
14850
|
/**
|
|
14700
|
-
* -
|
|
14851
|
+
* - List of store identifiers for store-level taxation.
|
|
14701
14852
|
*/
|
|
14702
14853
|
store_ids?: number[];
|
|
14703
14854
|
};
|
|
@@ -14745,53 +14896,63 @@ type RegionReference = {
|
|
|
14745
14896
|
declare function CreateTaxRequestBody(): CreateTaxRequestBody;
|
|
14746
14897
|
type CreateTaxRequestBody = {
|
|
14747
14898
|
rule: TaxReqBodyRule;
|
|
14748
|
-
|
|
14749
|
-
* - List of tax versions for the tax rule.
|
|
14750
|
-
*/
|
|
14751
|
-
versions: TaxReqBodyVersion[];
|
|
14899
|
+
versions: TaxReqBodyVersion;
|
|
14752
14900
|
};
|
|
14753
14901
|
/** @returns {TaxVersion} */
|
|
14754
14902
|
declare function TaxVersion(): TaxVersion;
|
|
14755
14903
|
type TaxVersion = {
|
|
14904
|
+
/**
|
|
14905
|
+
* - Unique identifier of the tax version
|
|
14906
|
+
*/
|
|
14756
14907
|
_id?: string;
|
|
14757
14908
|
/**
|
|
14758
|
-
* -
|
|
14909
|
+
* - Unique identifier of the tax rule to which
|
|
14910
|
+
* this version belongs. This identifier links the tax version to its parent rule.
|
|
14759
14911
|
*/
|
|
14760
14912
|
rule_id?: string;
|
|
14761
14913
|
/**
|
|
14762
|
-
* -
|
|
14763
|
-
*
|
|
14914
|
+
* - The date and time when this version
|
|
14915
|
+
* becomes effective and is used for taxation purposes. This field must be at
|
|
14916
|
+
* least one minute in the future relative to the current system time to
|
|
14917
|
+
* ensure future scheduling of tax versions.
|
|
14764
14918
|
*/
|
|
14765
14919
|
applicable_date?: string;
|
|
14920
|
+
/**
|
|
14921
|
+
* - ISO 8601 timestamp indicating when this tax
|
|
14922
|
+
* version was created in the system. Used for audit trails and version history.
|
|
14923
|
+
*/
|
|
14766
14924
|
created_on?: string;
|
|
14925
|
+
/**
|
|
14926
|
+
* - ISO 8601 timestamp of the latest update to
|
|
14927
|
+
* this tax version. Every modification or update to the version record
|
|
14928
|
+
* updates this field, ensuring accurate audit and traceability.
|
|
14929
|
+
*/
|
|
14767
14930
|
modified_on?: string;
|
|
14768
14931
|
/**
|
|
14769
|
-
* -
|
|
14932
|
+
* - Unique identifier of the company for which
|
|
14933
|
+
* this tax version is defined.
|
|
14770
14934
|
*/
|
|
14771
14935
|
company_id?: number;
|
|
14772
14936
|
status?: TaxStatusEnum;
|
|
14773
14937
|
/**
|
|
14774
|
-
* -
|
|
14775
|
-
*
|
|
14938
|
+
* - Specifies the geographical region at which
|
|
14939
|
+
* the tax rule version applies. Required and present when the version targets
|
|
14940
|
+
* a specific region rather than the default country-level rule.
|
|
14776
14941
|
*/
|
|
14777
14942
|
region_type?: string;
|
|
14778
14943
|
areas?: TaxGeoArea;
|
|
14779
14944
|
/**
|
|
14780
|
-
* -
|
|
14945
|
+
* - Array of store identifiers to which this
|
|
14946
|
+
* tax version is scoped. Enables store-level tax configuration, allowing
|
|
14947
|
+
* companies to specify tax applicability at individual store granularity.
|
|
14781
14948
|
*/
|
|
14782
14949
|
store_ids?: number[];
|
|
14783
14950
|
scope?: TaxVersionScopeEnum;
|
|
14784
|
-
/**
|
|
14785
|
-
* - List of tax components.
|
|
14786
|
-
*/
|
|
14787
14951
|
components?: TaxComponentResponseSchema[];
|
|
14788
14952
|
};
|
|
14789
14953
|
/** @returns {UpdateTaxVersionRequestBody} */
|
|
14790
14954
|
declare function UpdateTaxVersionRequestBody(): UpdateTaxVersionRequestBody;
|
|
14791
14955
|
type UpdateTaxVersionRequestBody = {
|
|
14792
|
-
/**
|
|
14793
|
-
* - List of tax components.
|
|
14794
|
-
*/
|
|
14795
14956
|
components: TaxComponentResponseSchema[];
|
|
14796
14957
|
/**
|
|
14797
14958
|
* - It is the date from when this rule will
|
|
@@ -14801,7 +14962,10 @@ type UpdateTaxVersionRequestBody = {
|
|
|
14801
14962
|
applicable_date: string;
|
|
14802
14963
|
/**
|
|
14803
14964
|
* - Required when areas are present to denote
|
|
14804
|
-
* the level (city/state/pincode) at which the version applies.
|
|
14965
|
+
* the level (city/state/pincode) at which the version applies. Supported
|
|
14966
|
+
* region types are derived from Servicability's country hierarchy (e.g.,
|
|
14967
|
+
* India: state, city; UAE: sector, city). Use the Servicability
|
|
14968
|
+
* country-hierarchy API to read the allowed levels.
|
|
14805
14969
|
*/
|
|
14806
14970
|
region_type?: string;
|
|
14807
14971
|
areas?: TaxGeoArea;
|
|
@@ -14814,18 +14978,25 @@ type UpdateTaxVersionRequestBody = {
|
|
|
14814
14978
|
declare function CreateTaxVersionRequestBody(): CreateTaxVersionRequestBody;
|
|
14815
14979
|
type CreateTaxVersionRequestBody = {
|
|
14816
14980
|
/**
|
|
14817
|
-
* -
|
|
14981
|
+
* - Scope of the tax version
|
|
14982
|
+
*/
|
|
14983
|
+
scope?: string;
|
|
14984
|
+
/**
|
|
14985
|
+
* - List of tax components
|
|
14818
14986
|
*/
|
|
14819
14987
|
components: TaxComponent[];
|
|
14820
14988
|
/**
|
|
14821
14989
|
* - Optional scheduled date from when this
|
|
14822
14990
|
* rule will come in effect. It should be at least one minute in the future
|
|
14823
|
-
* from the current time.
|
|
14991
|
+
* from the current time.
|
|
14824
14992
|
*/
|
|
14825
14993
|
applicable_date?: string;
|
|
14826
14994
|
/**
|
|
14827
14995
|
* - Required when areas are present to denote
|
|
14828
|
-
* the level (city/state/pincode) at which the version applies.
|
|
14996
|
+
* the level (city/state/pincode) at which the version applies. Supported
|
|
14997
|
+
* values follow Servicability's country hierarchy (e.g., India: state, city;
|
|
14998
|
+
* UAE: sector, city); consult Servicability country-hierarchy APIs to
|
|
14999
|
+
* retrieve valid levels.
|
|
14829
15000
|
*/
|
|
14830
15001
|
region_type?: string;
|
|
14831
15002
|
areas?: TaxGeoArea;
|
|
@@ -14837,17 +15008,27 @@ type CreateTaxVersionRequestBody = {
|
|
|
14837
15008
|
/** @returns {TaxRule} */
|
|
14838
15009
|
declare function TaxRule(): TaxRule;
|
|
14839
15010
|
type TaxRule = {
|
|
15011
|
+
/**
|
|
15012
|
+
* - Unique identifier of the tax rule
|
|
15013
|
+
*/
|
|
14840
15014
|
_id?: string;
|
|
15015
|
+
/**
|
|
15016
|
+
* - Name of the tax rule
|
|
15017
|
+
*/
|
|
14841
15018
|
name?: string;
|
|
14842
15019
|
/**
|
|
14843
|
-
* - Description of the tax rule
|
|
15020
|
+
* - Description of the tax rule
|
|
14844
15021
|
*/
|
|
14845
15022
|
description?: string;
|
|
14846
15023
|
/**
|
|
14847
|
-
* - Flag to set any tax rule as default
|
|
14848
|
-
*
|
|
15024
|
+
* - Flag to set any tax rule as default. If
|
|
15025
|
+
* any tax rule is inactive on a product then default tax rule gets applied.
|
|
14849
15026
|
*/
|
|
14850
15027
|
is_default?: boolean;
|
|
15028
|
+
/**
|
|
15029
|
+
* - Unique identifier of the company which the
|
|
15030
|
+
* tax rule created
|
|
15031
|
+
*/
|
|
14851
15032
|
company_id?: number;
|
|
14852
15033
|
status?: TaxStatusEnum;
|
|
14853
15034
|
created_on?: string;
|
|
@@ -14856,7 +15037,13 @@ type TaxRule = {
|
|
|
14856
15037
|
/** @returns {TaxVersionDetail} */
|
|
14857
15038
|
declare function TaxVersionDetail(): TaxVersionDetail;
|
|
14858
15039
|
type TaxVersionDetail = {
|
|
15040
|
+
/**
|
|
15041
|
+
* - Unique identifier for the tax version
|
|
15042
|
+
*/
|
|
14859
15043
|
_id: string;
|
|
15044
|
+
/**
|
|
15045
|
+
* - Unique identifier for the rule ID
|
|
15046
|
+
*/
|
|
14860
15047
|
rule_id: string;
|
|
14861
15048
|
/**
|
|
14862
15049
|
* - It is the date from when this rule comes
|
|
@@ -14866,6 +15053,10 @@ type TaxVersionDetail = {
|
|
|
14866
15053
|
applicable_date: string;
|
|
14867
15054
|
created_on: string;
|
|
14868
15055
|
modified_on: string;
|
|
15056
|
+
/**
|
|
15057
|
+
* - Unique identifier of the company which the
|
|
15058
|
+
* tax rule created
|
|
15059
|
+
*/
|
|
14869
15060
|
company_id: number;
|
|
14870
15061
|
status?: TaxStatusEnum;
|
|
14871
15062
|
/**
|
|
@@ -14899,13 +15090,13 @@ declare function UpdateTaxRequestBody(): UpdateTaxRequestBody;
|
|
|
14899
15090
|
type UpdateTaxRequestBody = {
|
|
14900
15091
|
status: TaxStatusEnum;
|
|
14901
15092
|
/**
|
|
14902
|
-
* - Flag to set
|
|
14903
|
-
*
|
|
14904
|
-
*
|
|
15093
|
+
* - Flag to set tax rule as the default. If a
|
|
15094
|
+
* tax rule is inactive or not available for a product, the default tax rule
|
|
15095
|
+
* will be applied.
|
|
14905
15096
|
*/
|
|
14906
15097
|
is_default: boolean;
|
|
14907
15098
|
/**
|
|
14908
|
-
* - New name of the tax rule
|
|
15099
|
+
* - New name of the tax rule
|
|
14909
15100
|
*/
|
|
14910
15101
|
name: string;
|
|
14911
15102
|
};
|
|
@@ -14919,7 +15110,7 @@ type TaxRuleItem = {
|
|
|
14919
15110
|
declare function TaxRules(): TaxRules;
|
|
14920
15111
|
type TaxRules = {
|
|
14921
15112
|
/**
|
|
14922
|
-
* - List of tax rules with their versions
|
|
15113
|
+
* - List of tax rules with their versions
|
|
14923
15114
|
*/
|
|
14924
15115
|
items: TaxRuleItem[];
|
|
14925
15116
|
page: Page;
|
|
@@ -14934,7 +15125,7 @@ type TaxVersionPastData = {
|
|
|
14934
15125
|
declare function TaxRuleVersion(): TaxRuleVersion;
|
|
14935
15126
|
type TaxRuleVersion = {
|
|
14936
15127
|
/**
|
|
14937
|
-
* - List of tax versions
|
|
15128
|
+
* - List of tax versions
|
|
14938
15129
|
*/
|
|
14939
15130
|
items: TaxVersionDetail[];
|
|
14940
15131
|
rule: TaxRule;
|
|
@@ -14944,33 +15135,39 @@ type TaxRuleVersion = {
|
|
|
14944
15135
|
declare function HSCodeItem(): HSCodeItem;
|
|
14945
15136
|
type HSCodeItem = {
|
|
14946
15137
|
/**
|
|
14947
|
-
* - Timestamp
|
|
15138
|
+
* - Timestamp when the HS/SAC code entry was created.
|
|
14948
15139
|
*/
|
|
14949
15140
|
created_on?: string;
|
|
14950
15141
|
/**
|
|
14951
|
-
* - Timestamp of
|
|
15142
|
+
* - Timestamp of the most recent modification
|
|
15143
|
+
* to this HS/SAC code entry.
|
|
14952
15144
|
*/
|
|
14953
15145
|
modified_on?: string;
|
|
14954
|
-
type: HsTypeEnum;
|
|
14955
15146
|
/**
|
|
14956
|
-
* -
|
|
15147
|
+
* - Type of the code for services
|
|
15148
|
+
*/
|
|
15149
|
+
type: string;
|
|
15150
|
+
/**
|
|
15151
|
+
* - Unique identifier of the company to which
|
|
15152
|
+
* this HS/SAC code is associated.
|
|
14957
15153
|
*/
|
|
14958
15154
|
company_id?: number;
|
|
14959
15155
|
/**
|
|
14960
|
-
* - Description
|
|
15156
|
+
* - Description providing details about the HS
|
|
15157
|
+
* or SAC code
|
|
14961
15158
|
*/
|
|
14962
15159
|
description?: string;
|
|
14963
15160
|
/**
|
|
14964
|
-
* - The HS
|
|
15161
|
+
* - The HS or SAC value being registered for the company.
|
|
14965
15162
|
*/
|
|
14966
15163
|
hs_code: string;
|
|
14967
15164
|
/**
|
|
14968
|
-
* - Unique identifier for the HS code entry
|
|
15165
|
+
* - Unique identifier for the HS/SAC code entry
|
|
14969
15166
|
*/
|
|
14970
15167
|
_id?: string;
|
|
14971
15168
|
/**
|
|
14972
|
-
* - ISO
|
|
14973
|
-
*
|
|
15169
|
+
* - ISO 3166-1 alpha-2 country code
|
|
15170
|
+
* representing the country for which this code is registered.
|
|
14974
15171
|
*/
|
|
14975
15172
|
country_iso?: string;
|
|
14976
15173
|
};
|
|
@@ -14978,7 +15175,7 @@ type HSCodeItem = {
|
|
|
14978
15175
|
declare function HSCodes(): HSCodes;
|
|
14979
15176
|
type HSCodes = {
|
|
14980
15177
|
/**
|
|
14981
|
-
* - Array of HS code responses
|
|
15178
|
+
* - Array of HS code responses
|
|
14982
15179
|
*/
|
|
14983
15180
|
items: HSCodeItem[];
|
|
14984
15181
|
page: Page;
|