@wix/stores 1.0.315 → 1.0.317

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/stores",
3
- "version": "1.0.315",
3
+ "version": "1.0.317",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -29,7 +29,7 @@
29
29
  "@wix/stores_inventory": "1.0.68",
30
30
  "@wix/stores_inventory-items-v-3": "1.0.37",
31
31
  "@wix/stores_products": "1.0.93",
32
- "@wix/stores_products-v-3": "1.0.80",
32
+ "@wix/stores_products-v-3": "1.0.82",
33
33
  "@wix/stores_ribbons-v-3": "1.0.26",
34
34
  "@wix/stores_stores-locations-v-3": "1.0.32",
35
35
  "@wix/stores_subscription-options": "1.0.50",
@@ -58,5 +58,5 @@
58
58
  "fqdn": ""
59
59
  }
60
60
  },
61
- "falconPackageHash": "8b112c57f93f8f07f1823a101d7d4d8656a886b846a74c6dfaf6e327"
61
+ "falconPackageHash": "7ea49d204527ef31e94edf61abfb92eb6912ce3f88ea6e9c24d3db9e"
62
62
  }
@@ -10473,11 +10473,17 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
10473
10473
  /**
10474
10474
  * Product base price range - minimum and maximum prices of all product variants.
10475
10475
  * @readonly
10476
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
10477
+ * @replacedBy compare_at_price_range
10478
+ * @targetRemovalDate 2024-12-31
10476
10479
  */
10477
10480
  basePriceRange?: PriceRange;
10478
10481
  /**
10479
10482
  * Product sale price range - minimum and maximum sale prices of all product variants.
10480
10483
  * @readonly
10484
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
10485
+ * @replacedBy actual_price_range
10486
+ * @targetRemovalDate 2024-12-31
10481
10487
  */
10482
10488
  salePriceRange?: PriceRange;
10483
10489
  /**
@@ -10520,6 +10526,16 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
10520
10526
  * @readonly
10521
10527
  */
10522
10528
  breadcrumbsInfo?: BreadcrumbsInfo;
10529
+ /**
10530
+ * Product actual price range - minimum and maximum prices of all product variants.
10531
+ * @readonly
10532
+ */
10533
+ actualPriceRange?: PriceRange;
10534
+ /**
10535
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
10536
+ * @readonly
10537
+ */
10538
+ compareAtPriceRange?: PriceRange;
10523
10539
  /** Product variants. */
10524
10540
  variantsInfo?: VariantsInfo;
10525
10541
  /**
@@ -12374,7 +12390,7 @@ interface Variant extends VariantTypedPropertiesOneOf {
12374
12390
  */
12375
12391
  media?: ProductMedia;
12376
12392
  /**
12377
- * Subscription prices calculated by applying subscription discount to the variant `price.salePrice`.
12393
+ * Subscription prices calculated by applying subscription discount to the variant `price.actual_price`.
12378
12394
  * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
12379
12395
  * @readonly
12380
12396
  */
@@ -12416,10 +12432,24 @@ interface OptionChoiceNames {
12416
12432
  renderType?: ProductOptionRenderType;
12417
12433
  }
12418
12434
  interface PriceInfo {
12419
- /** Variant price. Must be greater or equal to 0. */
12435
+ /**
12436
+ * Variant price. Must be greater or equal to 0.
12437
+ * @deprecated Variant price. Must be greater or equal to 0.
12438
+ * @replacedBy compare_at_price
12439
+ * @targetRemovalDate 2024-12-31
12440
+ */
12420
12441
  basePrice?: FixedMonetaryAmount;
12421
- /** Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`. */
12442
+ /**
12443
+ * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12444
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12445
+ * @replacedBy actual_price
12446
+ * @targetRemovalDate 2024-12-31
12447
+ */
12422
12448
  salePrice?: FixedMonetaryAmount;
12449
+ /** Variant price. Must be greater or equal to 0. */
12450
+ actualPrice?: FixedMonetaryAmount;
12451
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
12452
+ compareAtPrice?: FixedMonetaryAmount;
12423
12453
  }
12424
12454
  interface RevenueDetails {
12425
12455
  /** Item cost. */
@@ -12513,7 +12543,7 @@ interface SubscriptionPrice {
12513
12543
  */
12514
12544
  subscriptionId?: string;
12515
12545
  /**
12516
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
12546
+ * Subscription price calculated by applying subscription discount to the variant `price.actual_price`
12517
12547
  * @readonly
12518
12548
  */
12519
12549
  price?: FixedMonetaryAmount;
@@ -12641,15 +12671,21 @@ interface MinVariantPriceInfo {
12641
12671
  /**
12642
12672
  * Variant price. Must be greater or equal to 0.
12643
12673
  * @readonly
12674
+ * @deprecated Variant price. Must be greater or equal to 0.
12675
+ * @replacedBy compare_at_price
12676
+ * @targetRemovalDate 2024-12-31
12644
12677
  */
12645
12678
  basePrice?: FixedMonetaryAmount;
12646
12679
  /**
12647
12680
  * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12648
12681
  * @readonly
12682
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12683
+ * @replacedBy actual_price
12684
+ * @targetRemovalDate 2024-12-31
12649
12685
  */
12650
12686
  salePrice?: FixedMonetaryAmount;
12651
12687
  /**
12652
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
12688
+ * Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
12653
12689
  * @readonly
12654
12690
  */
12655
12691
  minSubscriptionPrice?: FixedMonetaryAmount;
@@ -12683,6 +12719,10 @@ interface MinVariantPriceInfo {
12683
12719
  * @readonly
12684
12720
  */
12685
12721
  revenueDetails?: RevenueDetails;
12722
+ /** Variant price. Must be greater or equal to 0. */
12723
+ actualPrice?: FixedMonetaryAmount;
12724
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
12725
+ compareAtPrice?: FixedMonetaryAmount;
12686
12726
  }
12687
12727
  interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
12688
12728
  /** insert/update documents */
@@ -14168,15 +14208,29 @@ interface BulkUpdateProductVariantsByFilterResponse {
14168
14208
  interface V3BulkAdjustProductVariantsByFilterRequest {
14169
14209
  /** Filter object. */
14170
14210
  filter: Record<string, any> | null;
14171
- /** Base price adjustment. */
14211
+ /**
14212
+ * Base price adjustment.
14213
+ * @deprecated Base price adjustment.
14214
+ * @replacedBy compare_at_price
14215
+ * @targetRemovalDate 2024-12-31
14216
+ */
14172
14217
  basePrice?: V3AdjustValue;
14173
- /** Sale price adjustment. */
14218
+ /**
14219
+ * Sale price adjustment.
14220
+ * @deprecated Sale price adjustment.
14221
+ * @replacedBy actual_price
14222
+ * @targetRemovalDate 2024-12-31
14223
+ */
14174
14224
  salePrice?: V3AdjustValue;
14175
14225
  /** Cost adjustment. */
14176
14226
  cost?: V3AdjustValue;
14177
14227
  /**
14178
14228
  * Set variant sale price from base price by applying provided discount to it.
14179
14229
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14230
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
14231
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14232
+ * @replacedBy actual_price_from_compare_at_price
14233
+ * @targetRemovalDate 2024-12-31
14180
14234
  */
14181
14235
  salePriceFromBasePrice?: V3UnsignedAdjustValue;
14182
14236
  /**
@@ -14189,6 +14243,16 @@ interface V3BulkAdjustProductVariantsByFilterRequest {
14189
14243
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy;
14190
14244
  /** Free text to match in searchable fields. */
14191
14245
  search?: WixCommonSearchDetails;
14246
+ /** Actual price adjustment. */
14247
+ actualPrice?: V3AdjustValue;
14248
+ /** Compare at price adjustment. */
14249
+ compareAtPrice?: V3AdjustValue;
14250
+ /**
14251
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
14252
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
14253
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
14254
+ */
14255
+ compareAtPriceDiscount?: V3UnsignedAdjustValue;
14192
14256
  }
14193
14257
  interface V3AdjustValue extends V3AdjustValueAdjustValueOneOf {
14194
14258
  /** A decimal value to increase or reduce from the original value, can be negative. */
@@ -15441,7 +15505,7 @@ interface BulkDeleteProductsByFilterRequest {
15441
15505
  /**
15442
15506
  * Filter object in the following format:
15443
15507
  * `"filter" : {
15444
- * "basePriceRange.minValue": {"$lte": 5.99}
15508
+ * "actualPriceRange.minValue": {"$lte": 5.99}
15445
15509
  * }`
15446
15510
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
15447
15511
  */
@@ -15475,7 +15539,7 @@ interface BulkAddInfoSectionsToProductsByFilterRequest {
15475
15539
  /**
15476
15540
  * Filter object in the following format:
15477
15541
  * `"filter" : {
15478
- * "basePriceRange.minValue": {"$lte": 5.99}
15542
+ * "actualPriceRange.minValue": {"$lte": 5.99}
15479
15543
  * }`
15480
15544
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
15481
15545
  */
@@ -16070,6 +16134,8 @@ interface OptionChoiceNonNullableFields {
16070
16134
  interface PriceInfoNonNullableFields {
16071
16135
  basePrice?: FixedMonetaryAmountNonNullableFields;
16072
16136
  salePrice?: FixedMonetaryAmountNonNullableFields;
16137
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
16138
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
16073
16139
  }
16074
16140
  interface RevenueDetailsNonNullableFields {
16075
16141
  cost?: FixedMonetaryAmountNonNullableFields;
@@ -16128,6 +16194,8 @@ interface MinVariantPriceInfoNonNullableFields {
16128
16194
  minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
16129
16195
  pricePerUnitData?: PricePerUnitNonNullableFields;
16130
16196
  revenueDetails?: RevenueDetailsNonNullableFields;
16197
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
16198
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
16131
16199
  }
16132
16200
  interface V3ProductNonNullableFields {
16133
16201
  physicalProperties?: PhysicalPropertiesNonNullableFields;
@@ -16148,6 +16216,8 @@ interface V3ProductNonNullableFields {
16148
16216
  inventory?: InventoryNonNullableFields;
16149
16217
  productType: ProductType;
16150
16218
  breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
16219
+ actualPriceRange?: PriceRangeNonNullableFields;
16220
+ compareAtPriceRange?: PriceRangeNonNullableFields;
16151
16221
  variantsInfo?: VariantsInfoNonNullableFields;
16152
16222
  subscriptionDetails?: SubscriptionDetailsNonNullableFields;
16153
16223
  flattenOptions: string[];
@@ -16550,11 +16620,17 @@ interface UpdateProduct {
16550
16620
  /**
16551
16621
  * Product base price range - minimum and maximum prices of all product variants.
16552
16622
  * @readonly
16623
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
16624
+ * @replacedBy compare_at_price_range
16625
+ * @targetRemovalDate 2024-12-31
16553
16626
  */
16554
16627
  basePriceRange?: PriceRange;
16555
16628
  /**
16556
16629
  * Product sale price range - minimum and maximum sale prices of all product variants.
16557
16630
  * @readonly
16631
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
16632
+ * @replacedBy actual_price_range
16633
+ * @targetRemovalDate 2024-12-31
16558
16634
  */
16559
16635
  salePriceRange?: PriceRange;
16560
16636
  /**
@@ -16597,6 +16673,16 @@ interface UpdateProduct {
16597
16673
  * @readonly
16598
16674
  */
16599
16675
  breadcrumbsInfo?: BreadcrumbsInfo;
16676
+ /**
16677
+ * Product actual price range - minimum and maximum prices of all product variants.
16678
+ * @readonly
16679
+ */
16680
+ actualPriceRange?: PriceRange;
16681
+ /**
16682
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
16683
+ * @readonly
16684
+ */
16685
+ compareAtPriceRange?: PriceRange;
16600
16686
  /** Product variants. */
16601
16687
  variantsInfo?: VariantsInfo;
16602
16688
  /**
@@ -16917,15 +17003,29 @@ interface BulkUpdateProductVariantsByFilterOptions {
16917
17003
  search?: WixCommonSearchDetails;
16918
17004
  }
16919
17005
  interface BulkAdjustProductVariantsByFilterOptions {
16920
- /** Base price adjustment. */
17006
+ /**
17007
+ * Base price adjustment.
17008
+ * @deprecated Base price adjustment.
17009
+ * @replacedBy compare_at_price
17010
+ * @targetRemovalDate 2024-12-31
17011
+ */
16921
17012
  basePrice?: V3AdjustValue;
16922
- /** Sale price adjustment. */
17013
+ /**
17014
+ * Sale price adjustment.
17015
+ * @deprecated Sale price adjustment.
17016
+ * @replacedBy actual_price
17017
+ * @targetRemovalDate 2024-12-31
17018
+ */
16923
17019
  salePrice?: V3AdjustValue;
16924
17020
  /** Cost adjustment. */
16925
17021
  cost?: V3AdjustValue;
16926
17022
  /**
16927
17023
  * Set variant sale price from base price by applying provided discount to it.
16928
17024
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
17025
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
17026
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
17027
+ * @replacedBy actual_price_from_compare_at_price
17028
+ * @targetRemovalDate 2024-12-31
16929
17029
  */
16930
17030
  salePriceFromBasePrice?: V3UnsignedAdjustValue;
16931
17031
  /**
@@ -16938,6 +17038,16 @@ interface BulkAdjustProductVariantsByFilterOptions {
16938
17038
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy;
16939
17039
  /** Free text to match in searchable fields. */
16940
17040
  search?: WixCommonSearchDetails;
17041
+ /** Actual price adjustment. */
17042
+ actualPrice?: V3AdjustValue;
17043
+ /** Compare at price adjustment. */
17044
+ compareAtPrice?: V3AdjustValue;
17045
+ /**
17046
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
17047
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
17048
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
17049
+ */
17050
+ compareAtPriceDiscount?: V3UnsignedAdjustValue;
16941
17051
  }
16942
17052
  interface BulkAddInfoSectionsToProductsByFilterOptions {
16943
17053
  /** IDs of the info sections to add. */
@@ -10473,11 +10473,17 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
10473
10473
  /**
10474
10474
  * Product base price range - minimum and maximum prices of all product variants.
10475
10475
  * @readonly
10476
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
10477
+ * @replacedBy compare_at_price_range
10478
+ * @targetRemovalDate 2024-12-31
10476
10479
  */
10477
10480
  basePriceRange?: PriceRange;
10478
10481
  /**
10479
10482
  * Product sale price range - minimum and maximum sale prices of all product variants.
10480
10483
  * @readonly
10484
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
10485
+ * @replacedBy actual_price_range
10486
+ * @targetRemovalDate 2024-12-31
10481
10487
  */
10482
10488
  salePriceRange?: PriceRange;
10483
10489
  /**
@@ -10520,6 +10526,16 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
10520
10526
  * @readonly
10521
10527
  */
10522
10528
  breadcrumbsInfo?: BreadcrumbsInfo;
10529
+ /**
10530
+ * Product actual price range - minimum and maximum prices of all product variants.
10531
+ * @readonly
10532
+ */
10533
+ actualPriceRange?: PriceRange;
10534
+ /**
10535
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
10536
+ * @readonly
10537
+ */
10538
+ compareAtPriceRange?: PriceRange;
10523
10539
  /** Product variants. */
10524
10540
  variantsInfo?: VariantsInfo;
10525
10541
  /**
@@ -12374,7 +12390,7 @@ interface Variant extends VariantTypedPropertiesOneOf {
12374
12390
  */
12375
12391
  media?: ProductMedia;
12376
12392
  /**
12377
- * Subscription prices calculated by applying subscription discount to the variant `price.salePrice`.
12393
+ * Subscription prices calculated by applying subscription discount to the variant `price.actual_price`.
12378
12394
  * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
12379
12395
  * @readonly
12380
12396
  */
@@ -12416,10 +12432,24 @@ interface OptionChoiceNames {
12416
12432
  renderType?: ProductOptionRenderType;
12417
12433
  }
12418
12434
  interface PriceInfo {
12419
- /** Variant price. Must be greater or equal to 0. */
12435
+ /**
12436
+ * Variant price. Must be greater or equal to 0.
12437
+ * @deprecated Variant price. Must be greater or equal to 0.
12438
+ * @replacedBy compare_at_price
12439
+ * @targetRemovalDate 2024-12-31
12440
+ */
12420
12441
  basePrice?: FixedMonetaryAmount;
12421
- /** Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`. */
12442
+ /**
12443
+ * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12444
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12445
+ * @replacedBy actual_price
12446
+ * @targetRemovalDate 2024-12-31
12447
+ */
12422
12448
  salePrice?: FixedMonetaryAmount;
12449
+ /** Variant price. Must be greater or equal to 0. */
12450
+ actualPrice?: FixedMonetaryAmount;
12451
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
12452
+ compareAtPrice?: FixedMonetaryAmount;
12423
12453
  }
12424
12454
  interface RevenueDetails {
12425
12455
  /** Item cost. */
@@ -12513,7 +12543,7 @@ interface SubscriptionPrice {
12513
12543
  */
12514
12544
  subscriptionId?: string;
12515
12545
  /**
12516
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
12546
+ * Subscription price calculated by applying subscription discount to the variant `price.actual_price`
12517
12547
  * @readonly
12518
12548
  */
12519
12549
  price?: FixedMonetaryAmount;
@@ -12641,15 +12671,21 @@ interface MinVariantPriceInfo {
12641
12671
  /**
12642
12672
  * Variant price. Must be greater or equal to 0.
12643
12673
  * @readonly
12674
+ * @deprecated Variant price. Must be greater or equal to 0.
12675
+ * @replacedBy compare_at_price
12676
+ * @targetRemovalDate 2024-12-31
12644
12677
  */
12645
12678
  basePrice?: FixedMonetaryAmount;
12646
12679
  /**
12647
12680
  * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12648
12681
  * @readonly
12682
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
12683
+ * @replacedBy actual_price
12684
+ * @targetRemovalDate 2024-12-31
12649
12685
  */
12650
12686
  salePrice?: FixedMonetaryAmount;
12651
12687
  /**
12652
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
12688
+ * Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
12653
12689
  * @readonly
12654
12690
  */
12655
12691
  minSubscriptionPrice?: FixedMonetaryAmount;
@@ -12683,6 +12719,10 @@ interface MinVariantPriceInfo {
12683
12719
  * @readonly
12684
12720
  */
12685
12721
  revenueDetails?: RevenueDetails;
12722
+ /** Variant price. Must be greater or equal to 0. */
12723
+ actualPrice?: FixedMonetaryAmount;
12724
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
12725
+ compareAtPrice?: FixedMonetaryAmount;
12686
12726
  }
12687
12727
  interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
12688
12728
  /** insert/update documents */
@@ -14168,15 +14208,29 @@ interface BulkUpdateProductVariantsByFilterResponse {
14168
14208
  interface V3BulkAdjustProductVariantsByFilterRequest {
14169
14209
  /** Filter object. */
14170
14210
  filter: Record<string, any> | null;
14171
- /** Base price adjustment. */
14211
+ /**
14212
+ * Base price adjustment.
14213
+ * @deprecated Base price adjustment.
14214
+ * @replacedBy compare_at_price
14215
+ * @targetRemovalDate 2024-12-31
14216
+ */
14172
14217
  basePrice?: V3AdjustValue;
14173
- /** Sale price adjustment. */
14218
+ /**
14219
+ * Sale price adjustment.
14220
+ * @deprecated Sale price adjustment.
14221
+ * @replacedBy actual_price
14222
+ * @targetRemovalDate 2024-12-31
14223
+ */
14174
14224
  salePrice?: V3AdjustValue;
14175
14225
  /** Cost adjustment. */
14176
14226
  cost?: V3AdjustValue;
14177
14227
  /**
14178
14228
  * Set variant sale price from base price by applying provided discount to it.
14179
14229
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14230
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
14231
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14232
+ * @replacedBy actual_price_from_compare_at_price
14233
+ * @targetRemovalDate 2024-12-31
14180
14234
  */
14181
14235
  salePriceFromBasePrice?: V3UnsignedAdjustValue;
14182
14236
  /**
@@ -14189,6 +14243,16 @@ interface V3BulkAdjustProductVariantsByFilterRequest {
14189
14243
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy;
14190
14244
  /** Free text to match in searchable fields. */
14191
14245
  search?: WixCommonSearchDetails;
14246
+ /** Actual price adjustment. */
14247
+ actualPrice?: V3AdjustValue;
14248
+ /** Compare at price adjustment. */
14249
+ compareAtPrice?: V3AdjustValue;
14250
+ /**
14251
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
14252
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
14253
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
14254
+ */
14255
+ compareAtPriceDiscount?: V3UnsignedAdjustValue;
14192
14256
  }
14193
14257
  interface V3AdjustValue extends V3AdjustValueAdjustValueOneOf {
14194
14258
  /** A decimal value to increase or reduce from the original value, can be negative. */
@@ -15441,7 +15505,7 @@ interface BulkDeleteProductsByFilterRequest {
15441
15505
  /**
15442
15506
  * Filter object in the following format:
15443
15507
  * `"filter" : {
15444
- * "basePriceRange.minValue": {"$lte": 5.99}
15508
+ * "actualPriceRange.minValue": {"$lte": 5.99}
15445
15509
  * }`
15446
15510
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
15447
15511
  */
@@ -15475,7 +15539,7 @@ interface BulkAddInfoSectionsToProductsByFilterRequest {
15475
15539
  /**
15476
15540
  * Filter object in the following format:
15477
15541
  * `"filter" : {
15478
- * "basePriceRange.minValue": {"$lte": 5.99}
15542
+ * "actualPriceRange.minValue": {"$lte": 5.99}
15479
15543
  * }`
15480
15544
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
15481
15545
  */
@@ -16070,6 +16134,8 @@ interface OptionChoiceNonNullableFields {
16070
16134
  interface PriceInfoNonNullableFields {
16071
16135
  basePrice?: FixedMonetaryAmountNonNullableFields;
16072
16136
  salePrice?: FixedMonetaryAmountNonNullableFields;
16137
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
16138
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
16073
16139
  }
16074
16140
  interface RevenueDetailsNonNullableFields {
16075
16141
  cost?: FixedMonetaryAmountNonNullableFields;
@@ -16128,6 +16194,8 @@ interface MinVariantPriceInfoNonNullableFields {
16128
16194
  minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
16129
16195
  pricePerUnitData?: PricePerUnitNonNullableFields;
16130
16196
  revenueDetails?: RevenueDetailsNonNullableFields;
16197
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
16198
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
16131
16199
  }
16132
16200
  interface V3ProductNonNullableFields {
16133
16201
  physicalProperties?: PhysicalPropertiesNonNullableFields;
@@ -16148,6 +16216,8 @@ interface V3ProductNonNullableFields {
16148
16216
  inventory?: InventoryNonNullableFields;
16149
16217
  productType: ProductType;
16150
16218
  breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
16219
+ actualPriceRange?: PriceRangeNonNullableFields;
16220
+ compareAtPriceRange?: PriceRangeNonNullableFields;
16151
16221
  variantsInfo?: VariantsInfoNonNullableFields;
16152
16222
  subscriptionDetails?: SubscriptionDetailsNonNullableFields;
16153
16223
  flattenOptions: string[];
@@ -16550,11 +16620,17 @@ interface UpdateProduct {
16550
16620
  /**
16551
16621
  * Product base price range - minimum and maximum prices of all product variants.
16552
16622
  * @readonly
16623
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
16624
+ * @replacedBy compare_at_price_range
16625
+ * @targetRemovalDate 2024-12-31
16553
16626
  */
16554
16627
  basePriceRange?: PriceRange;
16555
16628
  /**
16556
16629
  * Product sale price range - minimum and maximum sale prices of all product variants.
16557
16630
  * @readonly
16631
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
16632
+ * @replacedBy actual_price_range
16633
+ * @targetRemovalDate 2024-12-31
16558
16634
  */
16559
16635
  salePriceRange?: PriceRange;
16560
16636
  /**
@@ -16597,6 +16673,16 @@ interface UpdateProduct {
16597
16673
  * @readonly
16598
16674
  */
16599
16675
  breadcrumbsInfo?: BreadcrumbsInfo;
16676
+ /**
16677
+ * Product actual price range - minimum and maximum prices of all product variants.
16678
+ * @readonly
16679
+ */
16680
+ actualPriceRange?: PriceRange;
16681
+ /**
16682
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
16683
+ * @readonly
16684
+ */
16685
+ compareAtPriceRange?: PriceRange;
16600
16686
  /** Product variants. */
16601
16687
  variantsInfo?: VariantsInfo;
16602
16688
  /**
@@ -16917,15 +17003,29 @@ interface BulkUpdateProductVariantsByFilterOptions {
16917
17003
  search?: WixCommonSearchDetails;
16918
17004
  }
16919
17005
  interface BulkAdjustProductVariantsByFilterOptions {
16920
- /** Base price adjustment. */
17006
+ /**
17007
+ * Base price adjustment.
17008
+ * @deprecated Base price adjustment.
17009
+ * @replacedBy compare_at_price
17010
+ * @targetRemovalDate 2024-12-31
17011
+ */
16921
17012
  basePrice?: V3AdjustValue;
16922
- /** Sale price adjustment. */
17013
+ /**
17014
+ * Sale price adjustment.
17015
+ * @deprecated Sale price adjustment.
17016
+ * @replacedBy actual_price
17017
+ * @targetRemovalDate 2024-12-31
17018
+ */
16923
17019
  salePrice?: V3AdjustValue;
16924
17020
  /** Cost adjustment. */
16925
17021
  cost?: V3AdjustValue;
16926
17022
  /**
16927
17023
  * Set variant sale price from base price by applying provided discount to it.
16928
17024
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
17025
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
17026
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
17027
+ * @replacedBy actual_price_from_compare_at_price
17028
+ * @targetRemovalDate 2024-12-31
16929
17029
  */
16930
17030
  salePriceFromBasePrice?: V3UnsignedAdjustValue;
16931
17031
  /**
@@ -16938,6 +17038,16 @@ interface BulkAdjustProductVariantsByFilterOptions {
16938
17038
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy;
16939
17039
  /** Free text to match in searchable fields. */
16940
17040
  search?: WixCommonSearchDetails;
17041
+ /** Actual price adjustment. */
17042
+ actualPrice?: V3AdjustValue;
17043
+ /** Compare at price adjustment. */
17044
+ compareAtPrice?: V3AdjustValue;
17045
+ /**
17046
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
17047
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
17048
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
17049
+ */
17050
+ compareAtPriceDiscount?: V3UnsignedAdjustValue;
16941
17051
  }
16942
17052
  interface BulkAddInfoSectionsToProductsByFilterOptions {
16943
17053
  /** IDs of the info sections to add. */
@@ -11380,11 +11380,17 @@ interface V3Product$1 extends V3ProductTypedPropertiesOneOf$1 {
11380
11380
  /**
11381
11381
  * Product base price range - minimum and maximum prices of all product variants.
11382
11382
  * @readonly
11383
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
11384
+ * @replacedBy compare_at_price_range
11385
+ * @targetRemovalDate 2024-12-31
11383
11386
  */
11384
11387
  basePriceRange?: PriceRange$1;
11385
11388
  /**
11386
11389
  * Product sale price range - minimum and maximum sale prices of all product variants.
11387
11390
  * @readonly
11391
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
11392
+ * @replacedBy actual_price_range
11393
+ * @targetRemovalDate 2024-12-31
11388
11394
  */
11389
11395
  salePriceRange?: PriceRange$1;
11390
11396
  /**
@@ -11427,6 +11433,16 @@ interface V3Product$1 extends V3ProductTypedPropertiesOneOf$1 {
11427
11433
  * @readonly
11428
11434
  */
11429
11435
  breadcrumbsInfo?: BreadcrumbsInfo$1;
11436
+ /**
11437
+ * Product actual price range - minimum and maximum prices of all product variants.
11438
+ * @readonly
11439
+ */
11440
+ actualPriceRange?: PriceRange$1;
11441
+ /**
11442
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
11443
+ * @readonly
11444
+ */
11445
+ compareAtPriceRange?: PriceRange$1;
11430
11446
  /** Product variants. */
11431
11447
  variantsInfo?: VariantsInfo$1;
11432
11448
  /**
@@ -13294,7 +13310,7 @@ interface Variant$1 extends VariantTypedPropertiesOneOf$1 {
13294
13310
  */
13295
13311
  media?: ProductMedia$1;
13296
13312
  /**
13297
- * Subscription prices calculated by applying subscription discount to the variant `price.salePrice`.
13313
+ * Subscription prices calculated by applying subscription discount to the variant `price.actual_price`.
13298
13314
  * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
13299
13315
  * @readonly
13300
13316
  */
@@ -13336,10 +13352,24 @@ interface OptionChoiceNames$1 {
13336
13352
  renderType?: ProductOptionRenderType$1;
13337
13353
  }
13338
13354
  interface PriceInfo$1 {
13339
- /** Variant price. Must be greater or equal to 0. */
13355
+ /**
13356
+ * Variant price. Must be greater or equal to 0.
13357
+ * @deprecated Variant price. Must be greater or equal to 0.
13358
+ * @replacedBy compare_at_price
13359
+ * @targetRemovalDate 2024-12-31
13360
+ */
13340
13361
  basePrice?: FixedMonetaryAmount$1;
13341
- /** Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`. */
13362
+ /**
13363
+ * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
13364
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
13365
+ * @replacedBy actual_price
13366
+ * @targetRemovalDate 2024-12-31
13367
+ */
13342
13368
  salePrice?: FixedMonetaryAmount$1;
13369
+ /** Variant price. Must be greater or equal to 0. */
13370
+ actualPrice?: FixedMonetaryAmount$1;
13371
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
13372
+ compareAtPrice?: FixedMonetaryAmount$1;
13343
13373
  }
13344
13374
  interface RevenueDetails$1 {
13345
13375
  /** Item cost. */
@@ -13433,7 +13463,7 @@ interface SubscriptionPrice$1 {
13433
13463
  */
13434
13464
  subscriptionId?: string;
13435
13465
  /**
13436
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
13466
+ * Subscription price calculated by applying subscription discount to the variant `price.actual_price`
13437
13467
  * @readonly
13438
13468
  */
13439
13469
  price?: FixedMonetaryAmount$1;
@@ -14800,15 +14830,29 @@ interface BulkUpdateProductVariantsByFilterResponse$1 {
14800
14830
  interface V3BulkAdjustProductVariantsByFilterRequest$1 {
14801
14831
  /** Filter object. */
14802
14832
  filter: Record<string, any> | null;
14803
- /** Base price adjustment. */
14833
+ /**
14834
+ * Base price adjustment.
14835
+ * @deprecated Base price adjustment.
14836
+ * @replacedBy compare_at_price
14837
+ * @targetRemovalDate 2024-12-31
14838
+ */
14804
14839
  basePrice?: V3AdjustValue$1;
14805
- /** Sale price adjustment. */
14840
+ /**
14841
+ * Sale price adjustment.
14842
+ * @deprecated Sale price adjustment.
14843
+ * @replacedBy actual_price
14844
+ * @targetRemovalDate 2024-12-31
14845
+ */
14806
14846
  salePrice?: V3AdjustValue$1;
14807
14847
  /** Cost adjustment. */
14808
14848
  cost?: V3AdjustValue$1;
14809
14849
  /**
14810
14850
  * Set variant sale price from base price by applying provided discount to it.
14811
14851
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14852
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
14853
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
14854
+ * @replacedBy actual_price_from_compare_at_price
14855
+ * @targetRemovalDate 2024-12-31
14812
14856
  */
14813
14857
  salePriceFromBasePrice?: V3UnsignedAdjustValue$1;
14814
14858
  /**
@@ -14821,6 +14865,16 @@ interface V3BulkAdjustProductVariantsByFilterRequest$1 {
14821
14865
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy$1;
14822
14866
  /** Free text to match in searchable fields. */
14823
14867
  search?: WixCommonSearchDetails$1;
14868
+ /** Actual price adjustment. */
14869
+ actualPrice?: V3AdjustValue$1;
14870
+ /** Compare at price adjustment. */
14871
+ compareAtPrice?: V3AdjustValue$1;
14872
+ /**
14873
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
14874
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
14875
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
14876
+ */
14877
+ compareAtPriceDiscount?: V3UnsignedAdjustValue$1;
14824
14878
  }
14825
14879
  interface V3AdjustValue$1 extends V3AdjustValueAdjustValueOneOf$1 {
14826
14880
  /** A decimal value to increase or reduce from the original value, can be negative. */
@@ -15428,6 +15482,8 @@ interface OptionChoiceNonNullableFields$1 {
15428
15482
  interface PriceInfoNonNullableFields$1 {
15429
15483
  basePrice?: FixedMonetaryAmountNonNullableFields$1;
15430
15484
  salePrice?: FixedMonetaryAmountNonNullableFields$1;
15485
+ actualPrice?: FixedMonetaryAmountNonNullableFields$1;
15486
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields$1;
15431
15487
  }
15432
15488
  interface RevenueDetailsNonNullableFields$1 {
15433
15489
  cost?: FixedMonetaryAmountNonNullableFields$1;
@@ -15486,6 +15542,8 @@ interface MinVariantPriceInfoNonNullableFields$1 {
15486
15542
  minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields$1;
15487
15543
  pricePerUnitData?: PricePerUnitNonNullableFields$1;
15488
15544
  revenueDetails?: RevenueDetailsNonNullableFields$1;
15545
+ actualPrice?: FixedMonetaryAmountNonNullableFields$1;
15546
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields$1;
15489
15547
  }
15490
15548
  interface V3ProductNonNullableFields$1 {
15491
15549
  physicalProperties?: PhysicalPropertiesNonNullableFields$1;
@@ -15506,6 +15564,8 @@ interface V3ProductNonNullableFields$1 {
15506
15564
  inventory?: InventoryNonNullableFields$1;
15507
15565
  productType: ProductType$1;
15508
15566
  breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields$1;
15567
+ actualPriceRange?: PriceRangeNonNullableFields$1;
15568
+ compareAtPriceRange?: PriceRangeNonNullableFields$1;
15509
15569
  variantsInfo?: VariantsInfoNonNullableFields$1;
15510
15570
  subscriptionDetails?: SubscriptionDetailsNonNullableFields$1;
15511
15571
  flattenOptions: string[];
@@ -15837,11 +15897,17 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
15837
15897
  /**
15838
15898
  * Product base price range - minimum and maximum prices of all product variants.
15839
15899
  * @readonly
15900
+ * @deprecated Product base price range - minimum and maximum prices of all product variants.
15901
+ * @replacedBy compare_at_price_range
15902
+ * @targetRemovalDate 2024-12-31
15840
15903
  */
15841
15904
  basePriceRange?: PriceRange;
15842
15905
  /**
15843
15906
  * Product sale price range - minimum and maximum sale prices of all product variants.
15844
15907
  * @readonly
15908
+ * @deprecated Product sale price range - minimum and maximum sale prices of all product variants.
15909
+ * @replacedBy actual_price_range
15910
+ * @targetRemovalDate 2024-12-31
15845
15911
  */
15846
15912
  salePriceRange?: PriceRange;
15847
15913
  /**
@@ -15884,6 +15950,16 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
15884
15950
  * @readonly
15885
15951
  */
15886
15952
  breadcrumbsInfo?: BreadcrumbsInfo;
15953
+ /**
15954
+ * Product actual price range - minimum and maximum prices of all product variants.
15955
+ * @readonly
15956
+ */
15957
+ actualPriceRange?: PriceRange;
15958
+ /**
15959
+ * Product compare at price range - minimum and maximum compare at price prices of all product variants.
15960
+ * @readonly
15961
+ */
15962
+ compareAtPriceRange?: PriceRange;
15887
15963
  /** Product variants. */
15888
15964
  variantsInfo?: VariantsInfo;
15889
15965
  /**
@@ -17698,7 +17774,7 @@ interface Variant extends VariantTypedPropertiesOneOf {
17698
17774
  */
17699
17775
  media?: ProductMedia;
17700
17776
  /**
17701
- * Subscription prices calculated by applying subscription discount to the variant `price.salePrice`.
17777
+ * Subscription prices calculated by applying subscription discount to the variant `price.actual_price`.
17702
17778
  * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
17703
17779
  * @readonly
17704
17780
  */
@@ -17740,10 +17816,24 @@ interface OptionChoiceNames {
17740
17816
  renderType?: ProductOptionRenderType;
17741
17817
  }
17742
17818
  interface PriceInfo {
17743
- /** Variant price. Must be greater or equal to 0. */
17819
+ /**
17820
+ * Variant price. Must be greater or equal to 0.
17821
+ * @deprecated Variant price. Must be greater or equal to 0.
17822
+ * @replacedBy compare_at_price
17823
+ * @targetRemovalDate 2024-12-31
17824
+ */
17744
17825
  basePrice?: FixedMonetaryAmount;
17745
- /** Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`. */
17826
+ /**
17827
+ * Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
17828
+ * @deprecated Variant sale price. If not provided, sale price will be equal to `basePrice`. When provided, value must be greater or equal to 0, and less than or equal to `basePrice`.
17829
+ * @replacedBy actual_price
17830
+ * @targetRemovalDate 2024-12-31
17831
+ */
17746
17832
  salePrice?: FixedMonetaryAmount;
17833
+ /** Variant price. Must be greater or equal to 0. */
17834
+ actualPrice?: FixedMonetaryAmount;
17835
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
17836
+ compareAtPrice?: FixedMonetaryAmount;
17747
17837
  }
17748
17838
  interface RevenueDetails {
17749
17839
  /** Item cost. */
@@ -17837,7 +17927,7 @@ interface SubscriptionPrice {
17837
17927
  */
17838
17928
  subscriptionId?: string;
17839
17929
  /**
17840
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
17930
+ * Subscription price calculated by applying subscription discount to the variant `price.actual_price`
17841
17931
  * @readonly
17842
17932
  */
17843
17933
  price?: FixedMonetaryAmount;
@@ -19204,15 +19294,29 @@ interface BulkUpdateProductVariantsByFilterResponse {
19204
19294
  interface V3BulkAdjustProductVariantsByFilterRequest {
19205
19295
  /** Filter object. */
19206
19296
  filter: Record<string, any> | null;
19207
- /** Base price adjustment. */
19297
+ /**
19298
+ * Base price adjustment.
19299
+ * @deprecated Base price adjustment.
19300
+ * @replacedBy compare_at_price
19301
+ * @targetRemovalDate 2024-12-31
19302
+ */
19208
19303
  basePrice?: V3AdjustValue;
19209
- /** Sale price adjustment. */
19304
+ /**
19305
+ * Sale price adjustment.
19306
+ * @deprecated Sale price adjustment.
19307
+ * @replacedBy actual_price
19308
+ * @targetRemovalDate 2024-12-31
19309
+ */
19210
19310
  salePrice?: V3AdjustValue;
19211
19311
  /** Cost adjustment. */
19212
19312
  cost?: V3AdjustValue;
19213
19313
  /**
19214
19314
  * Set variant sale price from base price by applying provided discount to it.
19215
19315
  * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
19316
+ * @deprecated Set variant sale price from base price by applying provided discount to it.
19317
+ * For example variant base price 100$, variant sale price 95$, requested `salePriceFromBasePrice.percentage` is 10, then old sale price ignored and new sale price set to 90 (100$ - 10%).
19318
+ * @replacedBy actual_price_from_compare_at_price
19319
+ * @targetRemovalDate 2024-12-31
19216
19320
  */
19217
19321
  salePriceFromBasePrice?: V3UnsignedAdjustValue;
19218
19322
  /**
@@ -19225,6 +19329,16 @@ interface V3BulkAdjustProductVariantsByFilterRequest {
19225
19329
  rounding?: BulkAdjustProductVariantsByFilterRequestRoundingStrategy;
19226
19330
  /** Free text to match in searchable fields. */
19227
19331
  search?: WixCommonSearchDetails;
19332
+ /** Actual price adjustment. */
19333
+ actualPrice?: V3AdjustValue;
19334
+ /** Compare at price adjustment. */
19335
+ compareAtPrice?: V3AdjustValue;
19336
+ /**
19337
+ * Set variant actual_price from compare_at_price by applying provided discount to it.
19338
+ * if compare-at-price doesn't exist, actual_price will be set to compare_at_price and the discount will be calculated from it.
19339
+ * For example variant compare at price 100$, variant actual price is 95$, requested `salePriceFromBasePrice.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
19340
+ */
19341
+ compareAtPriceDiscount?: V3UnsignedAdjustValue;
19228
19342
  }
19229
19343
  interface V3AdjustValue extends V3AdjustValueAdjustValueOneOf {
19230
19344
  /** A decimal value to increase or reduce from the original value, can be negative. */
@@ -19810,6 +19924,8 @@ interface OptionChoiceNonNullableFields {
19810
19924
  interface PriceInfoNonNullableFields {
19811
19925
  basePrice?: FixedMonetaryAmountNonNullableFields;
19812
19926
  salePrice?: FixedMonetaryAmountNonNullableFields;
19927
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
19928
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
19813
19929
  }
19814
19930
  interface RevenueDetailsNonNullableFields {
19815
19931
  cost?: FixedMonetaryAmountNonNullableFields;
@@ -19868,6 +19984,8 @@ interface MinVariantPriceInfoNonNullableFields {
19868
19984
  minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
19869
19985
  pricePerUnitData?: PricePerUnitNonNullableFields;
19870
19986
  revenueDetails?: RevenueDetailsNonNullableFields;
19987
+ actualPrice?: FixedMonetaryAmountNonNullableFields;
19988
+ compareAtPrice?: FixedMonetaryAmountNonNullableFields;
19871
19989
  }
19872
19990
  interface V3ProductNonNullableFields {
19873
19991
  physicalProperties?: PhysicalPropertiesNonNullableFields;
@@ -19888,6 +20006,8 @@ interface V3ProductNonNullableFields {
19888
20006
  inventory?: InventoryNonNullableFields;
19889
20007
  productType: ProductType;
19890
20008
  breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
20009
+ actualPriceRange?: PriceRangeNonNullableFields;
20010
+ compareAtPriceRange?: PriceRangeNonNullableFields;
19891
20011
  variantsInfo?: VariantsInfoNonNullableFields;
19892
20012
  subscriptionDetails?: SubscriptionDetailsNonNullableFields;
19893
20013
  flattenOptions: string[];