@wix/ecom 1.0.702 → 1.0.704

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.
@@ -4151,6 +4151,8 @@ interface AdditionalFee$9 {
4151
4151
  providerAppId?: string | null;
4152
4152
  /** Additional fee's price before tax. */
4153
4153
  priceBeforeTax?: MultiCurrencyPrice$7;
4154
+ /** Additional fee's price after tax. */
4155
+ priceAfterTax?: MultiCurrencyPrice$7;
4154
4156
  /**
4155
4157
  * Optional - Line items associated with this additional fee.
4156
4158
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -4744,6 +4746,7 @@ interface AdditionalFeeNonNullableFields$9 {
4744
4746
  price?: MultiCurrencyPriceNonNullableFields$7;
4745
4747
  taxDetails?: ItemTaxFullDetailsNonNullableFields$b;
4746
4748
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$7;
4749
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$7;
4747
4750
  lineItemIds: string[];
4748
4751
  }
4749
4752
  interface OtherNonNullableFields$5 {
@@ -6002,6 +6005,8 @@ interface AdditionalFee$8 {
6002
6005
  providerAppId?: string | null;
6003
6006
  /** Additional fee's price before tax. */
6004
6007
  priceBeforeTax?: MultiCurrencyPrice$6;
6008
+ /** Additional fee's price after tax. */
6009
+ priceAfterTax?: MultiCurrencyPrice$6;
6005
6010
  /**
6006
6011
  * Optional - Line items associated with this additional fee.
6007
6012
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -6581,6 +6586,7 @@ interface AdditionalFeeNonNullableFields$8 {
6581
6586
  price?: MultiCurrencyPriceNonNullableFields$6;
6582
6587
  taxDetails?: ItemTaxFullDetailsNonNullableFields$a;
6583
6588
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$6;
6589
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$6;
6584
6590
  lineItemIds: string[];
6585
6591
  }
6586
6592
  interface OtherNonNullableFields$4 {
@@ -7963,6 +7969,8 @@ interface AdditionalFee$7 {
7963
7969
  providerAppId?: string | null;
7964
7970
  /** Additional fee's price before tax. */
7965
7971
  priceBeforeTax?: MultiCurrencyPrice$5;
7972
+ /** Additional fee's price after tax. */
7973
+ priceAfterTax?: MultiCurrencyPrice$5;
7966
7974
  /**
7967
7975
  * Optional - Line items associated with this additional fee.
7968
7976
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -8515,6 +8523,7 @@ interface AdditionalFeeNonNullableFields$7 {
8515
8523
  price?: MultiCurrencyPriceNonNullableFields$5;
8516
8524
  taxDetails?: ItemTaxFullDetailsNonNullableFields$9;
8517
8525
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$5;
8526
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$5;
8518
8527
  lineItemIds: string[];
8519
8528
  }
8520
8529
  interface OtherNonNullableFields$3 {
@@ -9779,6 +9788,8 @@ interface AdditionalFee$6 {
9779
9788
  providerAppId?: string | null;
9780
9789
  /** Additional fee's price before tax. */
9781
9790
  priceBeforeTax?: MultiCurrencyPrice$4;
9791
+ /** Additional fee's price after tax. */
9792
+ priceAfterTax?: MultiCurrencyPrice$4;
9782
9793
  /**
9783
9794
  * Optional - Line items associated with this additional fee.
9784
9795
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -10317,6 +10328,7 @@ interface AdditionalFeeNonNullableFields$6 {
10317
10328
  price?: MultiCurrencyPriceNonNullableFields$4;
10318
10329
  taxDetails?: ItemTaxFullDetailsNonNullableFields$8;
10319
10330
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$4;
10331
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$4;
10320
10332
  lineItemIds: string[];
10321
10333
  }
10322
10334
  interface OtherNonNullableFields$2 {
@@ -11619,6 +11631,8 @@ interface AdditionalFee$5 {
11619
11631
  providerAppId?: string | null;
11620
11632
  /** Additional fee's price before tax. */
11621
11633
  priceBeforeTax?: MultiCurrencyPrice$3;
11634
+ /** Additional fee's price after tax. */
11635
+ priceAfterTax?: MultiCurrencyPrice$3;
11622
11636
  /**
11623
11637
  * Optional - Line items associated with this additional fee.
11624
11638
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -12369,6 +12383,7 @@ interface AdditionalFeeNonNullableFields$5 {
12369
12383
  price?: MultiCurrencyPriceNonNullableFields$3;
12370
12384
  taxDetails?: ItemTaxFullDetailsNonNullableFields$7;
12371
12385
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$3;
12386
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$3;
12372
12387
  lineItemIds: string[];
12373
12388
  }
12374
12389
  interface ConversionInfoNonNullableFields$1 {
@@ -13657,6 +13672,8 @@ interface AdditionalFee$4 {
13657
13672
  providerAppId?: string | null;
13658
13673
  /** Additional fee's price before tax. */
13659
13674
  priceBeforeTax?: MultiCurrencyPrice$2;
13675
+ /** Additional fee's price after tax. */
13676
+ priceAfterTax?: MultiCurrencyPrice$2;
13660
13677
  /**
13661
13678
  * Optional - Line items associated with this additional fee.
13662
13679
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -14375,6 +14392,7 @@ interface AdditionalFeeNonNullableFields$4 {
14375
14392
  price?: MultiCurrencyPriceNonNullableFields$2;
14376
14393
  taxDetails?: ItemTaxFullDetailsNonNullableFields$6;
14377
14394
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$2;
14395
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$2;
14378
14396
  lineItemIds: string[];
14379
14397
  }
14380
14398
  interface ConversionInfoNonNullableFields {
@@ -18029,6 +18047,8 @@ interface AdditionalFee$3 {
18029
18047
  providerAppId?: string | null;
18030
18048
  /** Additional fee's price before tax. */
18031
18049
  priceBeforeTax?: Price$7;
18050
+ /** Additional fee's price after tax. */
18051
+ priceAfterTax?: Price$7;
18032
18052
  /** Additional fee's id. */
18033
18053
  id?: string;
18034
18054
  /**
@@ -19368,6 +19388,7 @@ interface AdditionalFeeNonNullableFields$3 {
19368
19388
  price?: PriceNonNullableFields$7;
19369
19389
  taxDetails?: ItemTaxFullDetailsNonNullableFields$5;
19370
19390
  priceBeforeTax?: PriceNonNullableFields$7;
19391
+ priceAfterTax?: PriceNonNullableFields$7;
19371
19392
  id: string;
19372
19393
  lineItemIds: string[];
19373
19394
  }
@@ -20484,6 +20505,8 @@ interface AdditionalFee$2 {
20484
20505
  providerAppId?: string | null;
20485
20506
  /** Additional fee's price before tax. */
20486
20507
  priceBeforeTax?: Price$6;
20508
+ /** Additional fee's price after tax. */
20509
+ priceAfterTax?: Price$6;
20487
20510
  /** Additional fee's id. */
20488
20511
  _id?: string;
20489
20512
  /**
@@ -21811,6 +21834,7 @@ interface AdditionalFeeNonNullableFields$2 {
21811
21834
  price?: PriceNonNullableFields$6;
21812
21835
  taxDetails?: ItemTaxFullDetailsNonNullableFields$4;
21813
21836
  priceBeforeTax?: PriceNonNullableFields$6;
21837
+ priceAfterTax?: PriceNonNullableFields$6;
21814
21838
  _id: string;
21815
21839
  lineItemIds: string[];
21816
21840
  }
@@ -24503,6 +24527,8 @@ interface AdditionalFee$1 {
24503
24527
  providerAppId?: string | null;
24504
24528
  /** Additional fee's price before tax. */
24505
24529
  priceBeforeTax?: Price$5;
24530
+ /** Additional fee's price after tax. */
24531
+ priceAfterTax?: Price$5;
24506
24532
  /** Additional fee's id. */
24507
24533
  id?: string;
24508
24534
  /**
@@ -24549,6 +24575,23 @@ interface Cursors$9 {
24549
24575
  /** Cursor pointing to the previous page in the list of results. */
24550
24576
  prev?: string | null;
24551
24577
  }
24578
+ interface GetPaymentCollectabilityStatusRequest$1 {
24579
+ /** Ecom order ID. */
24580
+ ecomOrderId: string;
24581
+ }
24582
+ interface GetPaymentCollectabilityStatusResponse$1 {
24583
+ /** Payment collectability status */
24584
+ status?: PaymentCollectabilityStatus$1;
24585
+ /** Collectable order amount */
24586
+ amount?: Price$5;
24587
+ }
24588
+ declare enum PaymentCollectabilityStatus$1 {
24589
+ UNKNOWN = "UNKNOWN",
24590
+ COLLECTABLE = "COLLECTABLE",
24591
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
24592
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
24593
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
24594
+ }
24552
24595
  interface BulkOrderResult$1 {
24553
24596
  /** Item metadata. */
24554
24597
  itemMetadata?: ItemMetadata$3;
@@ -24701,6 +24744,15 @@ interface CancelOrderResponse$1 {
24701
24744
  /** Canceled order. */
24702
24745
  order?: Order$1;
24703
24746
  }
24747
+ interface PriceNonNullableFields$5 {
24748
+ amount: string;
24749
+ formattedAmount: string;
24750
+ }
24751
+ interface GetPaymentCollectabilityStatusResponseNonNullableFields$1 {
24752
+ status: PaymentCollectabilityStatus$1;
24753
+ amount?: PriceNonNullableFields$5;
24754
+ authorizationSupported: boolean;
24755
+ }
24704
24756
  interface ProductNameNonNullableFields$1 {
24705
24757
  original: string;
24706
24758
  }
@@ -24708,10 +24760,6 @@ interface CatalogReferenceNonNullableFields$1 {
24708
24760
  catalogItemId: string;
24709
24761
  appId: string;
24710
24762
  }
24711
- interface PriceNonNullableFields$5 {
24712
- amount: string;
24713
- formattedAmount: string;
24714
- }
24715
24763
  interface PlainTextValueNonNullableFields$1 {
24716
24764
  original: string;
24717
24765
  }
@@ -25051,6 +25099,7 @@ interface AdditionalFeeNonNullableFields$1 {
25051
25099
  price?: PriceNonNullableFields$5;
25052
25100
  taxDetails?: ItemTaxFullDetailsNonNullableFields$3;
25053
25101
  priceBeforeTax?: PriceNonNullableFields$5;
25102
+ priceAfterTax?: PriceNonNullableFields$5;
25054
25103
  id: string;
25055
25104
  lineItemIds: string[];
25056
25105
  }
@@ -26176,6 +26225,8 @@ interface AdditionalFee {
26176
26225
  providerAppId?: string | null;
26177
26226
  /** Additional fee's price before tax. */
26178
26227
  priceBeforeTax?: Price$4;
26228
+ /** Additional fee's price after tax. */
26229
+ priceAfterTax?: Price$4;
26179
26230
  /** Additional fee's id. */
26180
26231
  _id?: string;
26181
26232
  /**
@@ -26222,6 +26273,23 @@ interface Cursors$8 {
26222
26273
  /** Cursor pointing to the previous page in the list of results. */
26223
26274
  prev?: string | null;
26224
26275
  }
26276
+ interface GetPaymentCollectabilityStatusRequest {
26277
+ /** Ecom order ID. */
26278
+ ecomOrderId: string;
26279
+ }
26280
+ interface GetPaymentCollectabilityStatusResponse {
26281
+ /** Payment collectability status */
26282
+ status?: PaymentCollectabilityStatus;
26283
+ /** Collectable order amount */
26284
+ amount?: Price$4;
26285
+ }
26286
+ declare enum PaymentCollectabilityStatus {
26287
+ UNKNOWN = "UNKNOWN",
26288
+ COLLECTABLE = "COLLECTABLE",
26289
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
26290
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
26291
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
26292
+ }
26225
26293
  interface BulkOrderResult {
26226
26294
  /** Item metadata. */
26227
26295
  itemMetadata?: ItemMetadata$2;
@@ -26374,6 +26442,15 @@ interface CancelOrderResponse {
26374
26442
  /** Canceled order. */
26375
26443
  order?: Order;
26376
26444
  }
26445
+ interface PriceNonNullableFields$4 {
26446
+ amount: string;
26447
+ formattedAmount: string;
26448
+ }
26449
+ interface GetPaymentCollectabilityStatusResponseNonNullableFields {
26450
+ status: PaymentCollectabilityStatus;
26451
+ amount?: PriceNonNullableFields$4;
26452
+ authorizationSupported: boolean;
26453
+ }
26377
26454
  interface ProductNameNonNullableFields {
26378
26455
  original: string;
26379
26456
  }
@@ -26381,10 +26458,6 @@ interface CatalogReferenceNonNullableFields {
26381
26458
  catalogItemId: string;
26382
26459
  appId: string;
26383
26460
  }
26384
- interface PriceNonNullableFields$4 {
26385
- amount: string;
26386
- formattedAmount: string;
26387
- }
26388
26461
  interface PlainTextValueNonNullableFields {
26389
26462
  original: string;
26390
26463
  }
@@ -26718,6 +26791,7 @@ interface AdditionalFeeNonNullableFields {
26718
26791
  price?: PriceNonNullableFields$4;
26719
26792
  taxDetails?: ItemTaxFullDetailsNonNullableFields$2;
26720
26793
  priceBeforeTax?: PriceNonNullableFields$4;
26794
+ priceAfterTax?: PriceNonNullableFields$4;
26721
26795
  _id: string;
26722
26796
  lineItemIds: string[];
26723
26797
  }
@@ -26803,6 +26877,9 @@ type __PublicMethodMetaInfo$8<K = string, M = unknown, T = unknown, S = unknown,
26803
26877
  __responseType: Q;
26804
26878
  __originalResponseType: R;
26805
26879
  };
26880
+ declare function getPaymentCollectabilityStatus(): __PublicMethodMetaInfo$8<'GET', {
26881
+ ecomOrderId: string;
26882
+ }, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusRequest$1, GetPaymentCollectabilityStatusResponse & GetPaymentCollectabilityStatusResponseNonNullableFields, GetPaymentCollectabilityStatusResponse$1 & GetPaymentCollectabilityStatusResponseNonNullableFields$1>;
26806
26883
  declare function getOrder(): __PublicMethodMetaInfo$8<'GET', {
26807
26884
  id: string;
26808
26885
  }, GetOrderRequest, GetOrderRequest$1, GetOrderResponse & GetOrderResponseNonNullableFields, GetOrderResponse$1 & GetOrderResponseNonNullableFields$1>;
@@ -26820,10 +26897,11 @@ declare const meta$8_bulkUpdateOrders: typeof bulkUpdateOrders;
26820
26897
  declare const meta$8_cancelOrder: typeof cancelOrder;
26821
26898
  declare const meta$8_createOrder: typeof createOrder;
26822
26899
  declare const meta$8_getOrder: typeof getOrder;
26900
+ declare const meta$8_getPaymentCollectabilityStatus: typeof getPaymentCollectabilityStatus;
26823
26901
  declare const meta$8_searchOrders: typeof searchOrders;
26824
26902
  declare const meta$8_updateOrder: typeof updateOrder;
26825
26903
  declare namespace meta$8 {
26826
- export { type __PublicMethodMetaInfo$8 as __PublicMethodMetaInfo, meta$8_bulkUpdateOrders as bulkUpdateOrders, meta$8_cancelOrder as cancelOrder, meta$8_createOrder as createOrder, meta$8_getOrder as getOrder, meta$8_searchOrders as searchOrders, meta$8_updateOrder as updateOrder };
26904
+ export { type __PublicMethodMetaInfo$8 as __PublicMethodMetaInfo, meta$8_bulkUpdateOrders as bulkUpdateOrders, meta$8_cancelOrder as cancelOrder, meta$8_createOrder as createOrder, meta$8_getOrder as getOrder, meta$8_getPaymentCollectabilityStatus as getPaymentCollectabilityStatus, meta$8_searchOrders as searchOrders, meta$8_updateOrder as updateOrder };
26827
26905
  }
26828
26906
 
26829
26907
  interface OrderPaymentRequest$1 {
@@ -27552,10 +27630,20 @@ interface RefundTransaction$1 {
27552
27630
  /** Whether refund was made externally and manually on the payment provider's side. */
27553
27631
  externalRefund?: boolean;
27554
27632
  }
27633
+ /**
27634
+ * Refund transaction status.
27635
+ * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
27636
+ * + `SUCCEEDED`: Refund transaction succeeded.
27637
+ * + `FAILED`: Refund transaction failed.
27638
+ * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
27639
+ * + `STARTED`: Refund was initiated on payment provider side.
27640
+ */
27555
27641
  declare enum RefundStatus$1 {
27556
27642
  PENDING = "PENDING",
27557
27643
  SUCCEEDED = "SUCCEEDED",
27558
- FAILED = "FAILED"
27644
+ FAILED = "FAILED",
27645
+ SCHEDULED = "SCHEDULED",
27646
+ STARTED = "STARTED"
27559
27647
  }
27560
27648
  /** Business model of a refund request */
27561
27649
  interface RefundDetails$1 {
@@ -27971,10 +28059,20 @@ interface RefundTransaction {
27971
28059
  /** Whether refund was made externally and manually on the payment provider's side. */
27972
28060
  externalRefund?: boolean;
27973
28061
  }
28062
+ /**
28063
+ * Refund transaction status.
28064
+ * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
28065
+ * + `SUCCEEDED`: Refund transaction succeeded.
28066
+ * + `FAILED`: Refund transaction failed.
28067
+ * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
28068
+ * + `STARTED`: Refund was initiated on payment provider side.
28069
+ */
27974
28070
  declare enum RefundStatus {
27975
28071
  PENDING = "PENDING",
27976
28072
  SUCCEEDED = "SUCCEEDED",
27977
- FAILED = "FAILED"
28073
+ FAILED = "FAILED",
28074
+ SCHEDULED = "SCHEDULED",
28075
+ STARTED = "STARTED"
27978
28076
  }
27979
28077
  /** Business model of a refund request */
27980
28078
  interface RefundDetails {
@@ -31045,6 +31143,8 @@ interface V1AdditionalFee$1 {
31045
31143
  providerAppId?: string | null;
31046
31144
  /** Additional fee's price before tax. */
31047
31145
  priceBeforeTax?: MultiCurrencyPrice$1;
31146
+ /** Additional fee's price after tax. */
31147
+ priceAfterTax?: MultiCurrencyPrice$1;
31048
31148
  /**
31049
31149
  * Optional - Line items associated with this additional fee.
31050
31150
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -31292,6 +31392,7 @@ interface V1AdditionalFeeNonNullableFields$1 {
31292
31392
  price?: MultiCurrencyPriceNonNullableFields$1;
31293
31393
  taxDetails?: ItemTaxFullDetailsNonNullableFields$1;
31294
31394
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields$1;
31395
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields$1;
31295
31396
  lineItemIds: string[];
31296
31397
  }
31297
31398
  interface CalculateTotalsResponseNonNullableFields$1 {
@@ -32168,6 +32269,8 @@ interface V1AdditionalFee {
32168
32269
  providerAppId?: string | null;
32169
32270
  /** Additional fee's price before tax. */
32170
32271
  priceBeforeTax?: MultiCurrencyPrice;
32272
+ /** Additional fee's price after tax. */
32273
+ priceAfterTax?: MultiCurrencyPrice;
32171
32274
  /**
32172
32275
  * Optional - Line items associated with this additional fee.
32173
32276
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -32415,6 +32518,7 @@ interface V1AdditionalFeeNonNullableFields {
32415
32518
  price?: MultiCurrencyPriceNonNullableFields;
32416
32519
  taxDetails?: ItemTaxFullDetailsNonNullableFields;
32417
32520
  priceBeforeTax?: MultiCurrencyPriceNonNullableFields;
32521
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields;
32418
32522
  lineItemIds: string[];
32419
32523
  }
32420
32524
  interface CalculateTotalsResponseNonNullableFields {
@@ -424,11 +424,13 @@ interface IdentificationDataIdOneOf$4 {
424
424
  }
425
425
 
426
426
  /**
427
- * Postal Code was missing from request.
428
- This error should be returned when the postal code is missing from the request and it is impossible to calculate the shipping rates.
429
- If it is returned in cases where the postal code exists, it will be ignored and considered as a bug in the carrier's implementation.
430
- Error data is optional. If provided, it will appear in the monitoring system but will not be exposed to the user.
431
- Zipcode errors may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
427
+ * Missing postal code error.
428
+
429
+ Throw this error when a postal code is not provided in the request.
430
+ This error tells Wix that a valid postal code is required to calculate the shipping rate.
431
+ You can optionally provide error data to help debug the issue.
432
+ Error data you provide appears in the monitoring log but is not exposed to the user.
433
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
432
434
  */
433
435
  declare class MissingPostalCodeWixError extends Error {
434
436
  /** @hidden */
@@ -447,11 +449,13 @@ declare class MissingPostalCodeWixError extends Error {
447
449
  static readonly __type = "wix_spi_error";
448
450
  }
449
451
  /**
450
- * Postal Code was invalid.
451
- This error should be returned when the postal code is invalid and it is impossible to calculate the shipping rates.
452
- If it is returned in cases where the postal code is valid, it will be ignored and considered as a bug in the carrier's implementation.
453
- Error data is optional. If provided, it will appear in the monitoring system but will not be exposed to the user.
454
- Zipcode errors may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
452
+ * Invalid postal code error.
453
+
454
+ Throw this error when an invalid postal code is provided in the request.
455
+ This error tells Wix that a valid postal code is required to calculate the shipping rate.
456
+ You can optionally provide error data to help debug the issue.
457
+ Error data you provide appears in the monitoring log but is not exposed to the user.
458
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
455
459
  */
456
460
  declare class InvalidPostalCodeWixError extends Error {
457
461
  /** @hidden */
@@ -470,11 +474,12 @@ declare class InvalidPostalCodeWixError extends Error {
470
474
  static readonly __type = "wix_spi_error";
471
475
  }
472
476
  /**
473
- * The provided address was invalid.
474
- This error is to indicate the system that more detailed information is needed (such as subdivision) in order to provide shipping rates.
475
- This may happen in early stages of the purchase flow, where not all shipping address information has been collected yet.
476
- Client, such as cart page, that receive this error can use it to customise the flow to ask for more detailed address information in order to get valid shipping rates.
477
- Data is mandatory and should include the invalid fields in the address. for example: "ShippingDestination.subdivision".
477
+ * Invalid address error.
478
+
479
+ Throw this error when one or more fields in the address provided are invalid.
480
+ This error tells Wix that more address details are needed to calculate the shipping rate.
481
+ Wix may then prompt the user to provide more detailed address information.
482
+ The error data must include the invalid fields in the address. For example: `ShippingDestination.subdivision`.
478
483
  */
479
484
  declare class InvalidAddressWixError extends Error {
480
485
  /** @hidden */
@@ -493,11 +498,12 @@ declare class InvalidAddressWixError extends Error {
493
498
  static readonly __type = "wix_spi_error";
494
499
  }
495
500
  /**
496
- * Generic error for shipping rates calculation.
497
- This error should be returned when there is a generic error in the shipping rates calculation that is not covered by the other errors.
498
- Since this error is generic it is highly encouraged to provide error data that will help in debugging the issue.
499
- If error data is provided, it will appear in the monitoring system but will not be exposed to the user.
500
- This error may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
501
+ * Generic shipping rate calculation error.
502
+
503
+ Throw this error for cases the other errors don't cover.
504
+ You can optionally provide error data to help debug the issue.
505
+ Error data you provide appears in the monitoring log but is not exposed to the user.
506
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
501
507
  */
502
508
  declare class GenericShippingRatesWixError extends Error {
503
509
  /** @hidden */
@@ -2380,6 +2386,8 @@ interface AdditionalFee {
2380
2386
  providerAppId?: string | null;
2381
2387
  /** Additional fee's price before tax. */
2382
2388
  priceBeforeTax?: Price;
2389
+ /** Additional fee's price after tax. */
2390
+ priceAfterTax?: Price;
2383
2391
  /** Additional fee's id. */
2384
2392
  _id?: string;
2385
2393
  /**
@@ -460,11 +460,13 @@ declare const provideHandlers$4: ServicePluginDefinition<{
460
460
  }>;
461
461
 
462
462
  /**
463
- * Postal Code was missing from request.
464
- This error should be returned when the postal code is missing from the request and it is impossible to calculate the shipping rates.
465
- If it is returned in cases where the postal code exists, it will be ignored and considered as a bug in the carrier's implementation.
466
- Error data is optional. If provided, it will appear in the monitoring system but will not be exposed to the user.
467
- Zipcode errors may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
463
+ * Missing postal code error.
464
+
465
+ Throw this error when a postal code is not provided in the request.
466
+ This error tells Wix that a valid postal code is required to calculate the shipping rate.
467
+ You can optionally provide error data to help debug the issue.
468
+ Error data you provide appears in the monitoring log but is not exposed to the user.
469
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
468
470
  */
469
471
  declare class MissingPostalCodeWixError extends Error {
470
472
  /** @hidden */
@@ -483,11 +485,13 @@ declare class MissingPostalCodeWixError extends Error {
483
485
  static readonly __type = "wix_spi_error";
484
486
  }
485
487
  /**
486
- * Postal Code was invalid.
487
- This error should be returned when the postal code is invalid and it is impossible to calculate the shipping rates.
488
- If it is returned in cases where the postal code is valid, it will be ignored and considered as a bug in the carrier's implementation.
489
- Error data is optional. If provided, it will appear in the monitoring system but will not be exposed to the user.
490
- Zipcode errors may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
488
+ * Invalid postal code error.
489
+
490
+ Throw this error when an invalid postal code is provided in the request.
491
+ This error tells Wix that a valid postal code is required to calculate the shipping rate.
492
+ You can optionally provide error data to help debug the issue.
493
+ Error data you provide appears in the monitoring log but is not exposed to the user.
494
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
491
495
  */
492
496
  declare class InvalidPostalCodeWixError extends Error {
493
497
  /** @hidden */
@@ -506,11 +510,12 @@ declare class InvalidPostalCodeWixError extends Error {
506
510
  static readonly __type = "wix_spi_error";
507
511
  }
508
512
  /**
509
- * The provided address was invalid.
510
- This error is to indicate the system that more detailed information is needed (such as subdivision) in order to provide shipping rates.
511
- This may happen in early stages of the purchase flow, where not all shipping address information has been collected yet.
512
- Client, such as cart page, that receive this error can use it to customise the flow to ask for more detailed address information in order to get valid shipping rates.
513
- Data is mandatory and should include the invalid fields in the address. for example: "ShippingDestination.subdivision".
513
+ * Invalid address error.
514
+
515
+ Throw this error when one or more fields in the address provided are invalid.
516
+ This error tells Wix that more address details are needed to calculate the shipping rate.
517
+ Wix may then prompt the user to provide more detailed address information.
518
+ The error data must include the invalid fields in the address. For example: `ShippingDestination.subdivision`.
514
519
  */
515
520
  declare class InvalidAddressWixError extends Error {
516
521
  /** @hidden */
@@ -529,11 +534,12 @@ declare class InvalidAddressWixError extends Error {
529
534
  static readonly __type = "wix_spi_error";
530
535
  }
531
536
  /**
532
- * Generic error for shipping rates calculation.
533
- This error should be returned when there is a generic error in the shipping rates calculation that is not covered by the other errors.
534
- Since this error is generic it is highly encouraged to provide error data that will help in debugging the issue.
535
- If error data is provided, it will appear in the monitoring system but will not be exposed to the user.
536
- This error may block the user from proceeding to checkout, thus it is important to use it only if there is no other way to proceed.
537
+ * Generic shipping rate calculation error.
538
+
539
+ Throw this error for cases the other errors don't cover.
540
+ You can optionally provide error data to help debug the issue.
541
+ Error data you provide appears in the monitoring log but is not exposed to the user.
542
+ This error may block the site visitor from proceeding to checkout, so throw it only if there is no other way to proceed.
537
543
  */
538
544
  declare class GenericShippingRatesWixError extends Error {
539
545
  /** @hidden */
@@ -2400,6 +2406,8 @@ interface AdditionalFee {
2400
2406
  providerAppId?: string | null;
2401
2407
  /** Additional fee's price before tax. */
2402
2408
  priceBeforeTax?: Price;
2409
+ /** Additional fee's price after tax. */
2410
+ priceAfterTax?: Price;
2403
2411
  /** Additional fee's id. */
2404
2412
  _id?: string;
2405
2413
  /**