@wix/auto_sdk_ecom_orders 1.0.316 → 1.0.318

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.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-DXcKuMZ8.d.ts → ecom-v1-order-orders.universal-cwJXByV0.d.ts} +1837 -1696
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +197 -86
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +154 -85
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1838 -1697
  9. package/build/cjs/meta.js +154 -85
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-DXcKuMZ8.d.mts → ecom-v1-order-orders.universal-cwJXByV0.d.mts} +1837 -1696
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +193 -86
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +150 -85
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1838 -1697
  19. package/build/es/meta.mjs +150 -85
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-BOZydR9Q.d.ts → ecom-v1-order-orders.universal-CaNCF4JV.d.ts} +1995 -1798
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1980 -1796
  25. package/build/internal/es/{ecom-v1-order-orders.universal-BOZydR9Q.d.mts → ecom-v1-order-orders.universal-CaNCF4JV.d.mts} +1995 -1798
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1980 -1796
  29. package/package.json +2 -2
@@ -70,6 +70,13 @@ interface Order {
70
70
  * @immutable
71
71
  */
72
72
  taxIncludedInPrices?: boolean;
73
+ /**
74
+ * Cross-border repricing marker of the order: whether repricing is in force for it and which base tax region it uses. Set once at creation; an edit never changes it. One per order, unlike the per-line `CrossBorderPriceAdjustment` record.
75
+ * @internal
76
+ * @readonly
77
+ * @immutable
78
+ */
79
+ crossBorderRepricing?: CrossBorderRepricing;
73
80
  /**
74
81
  * Site language in which original values are shown.
75
82
  * @readonly
@@ -478,6 +485,12 @@ interface OrderLineItem {
478
485
  * @readonly
479
486
  */
480
487
  serviceProperties?: ServiceProperties;
488
+ /**
489
+ * Cross-border repricing record of this line item on a site whose catalog prices include tax: the catalog price, the base region's tax removed from it and the rate used.
490
+ * @internal
491
+ * @readonly
492
+ */
493
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
481
494
  }
482
495
  interface ProductName {
483
496
  /**
@@ -1306,6 +1319,76 @@ interface ServiceProperties {
1306
1319
  */
1307
1320
  endDate?: Date | null;
1308
1321
  }
1322
+ /**
1323
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1324
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1325
+ *
1326
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1327
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1328
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1329
+ */
1330
+ interface CrossBorderPriceAdjustment {
1331
+ /**
1332
+ * ID of the tax region whose tax is built into the catalog prices.
1333
+ * @format GUID
1334
+ */
1335
+ baseTaxRegionId?: string;
1336
+ /**
1337
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1338
+ * @format GUID
1339
+ */
1340
+ destinationTaxRegionId?: string | null;
1341
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1342
+ catalogPrice?: Price;
1343
+ /** Base region's tax removed per unit. Zero when `status` is `KEPT`, `SAME_REGION`, `SAME_COUNTRY`, `NOT_APPLICABLE`, `NOT_APPLICABLE_MODIFIERS` or `CONVERTED_CURRENCY_SUBSCRIPTION`, where nothing was removed. */
1344
+ baseTaxAmount?: Price;
1345
+ /** Outcome of the repricing for this line. */
1346
+ status?: RepriceStatusWithLiterals;
1347
+ /** Where the base region's rate came from. Meaningful only when a rate was applied, that is when `status` is `APPLIED`, `STRIP_ONLY` or `NO_DESTINATION_REGION`. */
1348
+ baseRateSource?: BaseRateSourceWithLiterals;
1349
+ /**
1350
+ * Base region's rate used to remove the tax, as a decimal numeral between 0 and 1. For example, `"0.22"`. Absent when no rate was applied.
1351
+ * @format DECIMAL_VALUE
1352
+ * @decimalValue options { gte:0, maxScale:6 }
1353
+ */
1354
+ baseRate?: string | null;
1355
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1356
+ baseRateCapturedDate?: Date | null;
1357
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1358
+ destinationTaxIncluded?: boolean | null;
1359
+ }
1360
+ /** Outcome of the repricing for one line. */
1361
+ declare enum RepriceStatus {
1362
+ /** Base tax removed and the destination's tax applied. */
1363
+ APPLIED = "APPLIED",
1364
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1365
+ KEPT = "KEPT",
1366
+ /** Base tax removed and no destination tax applied, as in a tax-exempt calculation. This is the outcome; the mode that asks for it is `CrossBorderRepricingMode.STRIP_ONLY`. */
1367
+ STRIP_ONLY = "STRIP_ONLY",
1368
+ /** The destination is the base region. Nothing was removed. */
1369
+ SAME_REGION = "SAME_REGION",
1370
+ /** The destination is in the base region's country, outside the US and Canada, so the catalog price already carries the destination's tax. Nothing was removed. */
1371
+ SAME_COUNTRY = "SAME_COUNTRY",
1372
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1373
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1374
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1375
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1376
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1377
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1378
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1379
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1380
+ }
1381
+ /** @enumType */
1382
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1383
+ /** Where the base region's rate came from. */
1384
+ declare enum BaseRateSource {
1385
+ /** The manual tax calculator computed the base tax for this calculation. */
1386
+ MANUAL_SPI = "MANUAL_SPI",
1387
+ /** The rate captured from Avalara by the embedded-rate probe. */
1388
+ AVALARA_PROBE = "AVALARA_PROBE"
1389
+ }
1390
+ /** @enumType */
1391
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1309
1392
  /** Buyer information. */
1310
1393
  interface BuyerInfo extends BuyerInfoIdOneOf {
1311
1394
  /**
@@ -1429,6 +1512,25 @@ interface CurrencyConversionDetails {
1429
1512
  */
1430
1513
  conversionRate?: string | null;
1431
1514
  }
1515
+ /** Cross-border repricing marker of an order, one per order, set once by the calculation that placed it. Every later edit reads it to keep repricing the order at the same base region. The per-line record is `CrossBorderPriceAdjustment`; the outcome of the last calculation is `OrderTaxInfo.crossBorderCalculation`. */
1516
+ interface CrossBorderRepricing {
1517
+ /**
1518
+ * Whether cross-border repricing is in force for this order: `true` when the placing calculation repriced the lines for the destination's tax, so every later edit keeps repricing them. `false` when that calculation answered not applicable or failed; such an order keeps its prices when edited. Unlike `taxInfo.crossBorderCalculation.applied`, which describes the last calculation and changes on edit, this never changes after creation.
1519
+ *
1520
+ * Default: `false`
1521
+ */
1522
+ enabled?: boolean;
1523
+ /**
1524
+ * ID of the tax region whose tax is built into the catalog prices, as used for this order.
1525
+ * @format GUID
1526
+ */
1527
+ baseTaxRegionId?: string | null;
1528
+ /**
1529
+ * ID of the base region's tax calculator when the order was placed.
1530
+ * @format GUID
1531
+ */
1532
+ baseCalculatorId?: string | null;
1533
+ }
1432
1534
  interface PriceSummary {
1433
1535
  /** Subtotal of all line items, before discounts and before tax. */
1434
1536
  subtotal?: Price;
@@ -1732,6 +1834,12 @@ interface ShippingPrice {
1732
1834
  * @readonly
1733
1835
  */
1734
1836
  discount?: Price;
1837
+ /**
1838
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1839
+ * @internal
1840
+ * @readonly
1841
+ */
1842
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1735
1843
  }
1736
1844
  interface ShippingRegion {
1737
1845
  /**
@@ -1809,6 +1917,12 @@ interface OrderTaxInfo {
1809
1917
  * @readonly
1810
1918
  */
1811
1919
  totalExempt?: Price;
1920
+ /**
1921
+ * Cross-border repricing outcome of the last calculation that produced this tax: whether the lines were repriced for the destination's tax, in which mode, and when they weren't, why. Replaced on every edit, unlike the order's `crossBorderRepricing` marker.
1922
+ * @internal
1923
+ * @readonly
1924
+ */
1925
+ crossBorderCalculation?: CrossBorderCalculation;
1812
1926
  }
1813
1927
  /**
1814
1928
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
@@ -1851,6 +1965,56 @@ interface OrderTaxBreakdown {
1851
1965
  */
1852
1966
  aggregatedExemptAmount?: Price;
1853
1967
  }
1968
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1969
+ interface CrossBorderCalculation {
1970
+ /** Whether the calculation repriced the lines for the destination's tax. */
1971
+ applied?: boolean;
1972
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1973
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1974
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1975
+ mode?: CrossBorderRepricingModeWithLiterals;
1976
+ /**
1977
+ * Request ID of the calculation, for log correlation.
1978
+ * @maxLength 100
1979
+ */
1980
+ requestId?: string | null;
1981
+ }
1982
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1983
+ declare enum CrossBorderNotApplicableReason {
1984
+ /** The repricing feature toggle is off. */
1985
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1986
+ /** The site hasn't opted in to cross-border repricing. */
1987
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1988
+ /** The site's prices no longer include tax. */
1989
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1990
+ /** The base tax region doesn't exist on the site. */
1991
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1992
+ /** The base region uses the manual calculator and has no tax mapping. */
1993
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1994
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1995
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1996
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1997
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1998
+ /** The line items were repriced. Repricing the shipping option failed. */
1999
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
2000
+ /** The line items were repriced. Repricing the additional fees failed. */
2001
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
2002
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
2003
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
2004
+ }
2005
+ /** @enumType */
2006
+ type CrossBorderNotApplicableReasonWithLiterals = CrossBorderNotApplicableReason | 'FEATURE_DISABLED' | 'NOT_OPTED_IN' | 'TAX_INCLUSIVE_PRICING_OFF' | 'BASE_TAX_REGION_NOT_FOUND' | 'BASE_REGION_HAS_NO_MANUAL_MAPPING' | 'EMBEDDED_RATE_MISSING' | 'CROSS_BORDER_REPRICING_FAILED' | 'SHIPPING_REPRICING_FAILED' | 'FEES_REPRICING_FAILED' | 'SETTINGS_UNAVAILABLE';
2007
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
2008
+ declare enum CrossBorderRepricingMode {
2009
+ /** Nothing is repriced. */
2010
+ DISABLED = "DISABLED",
2011
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
2012
+ STRIP_ONLY = "STRIP_ONLY",
2013
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
2014
+ FULL = "FULL"
2015
+ }
2016
+ /** @enumType */
2017
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1854
2018
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1855
2019
  /** Coupon applied by the customer. */
1856
2020
  coupon?: Coupon;
@@ -3381,6 +3545,12 @@ interface AdditionalFee {
3381
3545
  source?: AdditionalFeeSourceWithLiterals;
3382
3546
  /** Address type tax was calculated against for this fee. */
3383
3547
  taxableAddress?: TaxableAddress;
3548
+ /**
3549
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
3550
+ * @internal
3551
+ * @readonly
3552
+ */
3553
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
3384
3554
  }
3385
3555
  declare enum AdditionalFeeSource {
3386
3556
  /** The additional fee was added by an additional fee service plugin. */
@@ -4162,6 +4332,13 @@ interface OrderLineItemChangedDetails {
4162
4332
  * @internal
4163
4333
  */
4164
4334
  decimalQuantityUpdate?: DecimalQuantityUpdate;
4335
+ /**
4336
+ * Cross-border repricing record of the line item after the change.
4337
+ *
4338
+ * Set empty to state that the line item no longer carries a record. When omitted, the stored record is kept.
4339
+ * @internal
4340
+ */
4341
+ crossBorderAdjustmentUpdate?: CrossBorderAdjustmentUpdate;
4165
4342
  }
4166
4343
  /** Type of selected payment option for catalog item */
4167
4344
  declare enum DeltaPaymentOptionType {
@@ -4185,6 +4362,13 @@ interface DecimalQuantityUpdate {
4185
4362
  */
4186
4363
  decimalQuantity?: DecimalQuantity;
4187
4364
  }
4365
+ interface CrossBorderAdjustmentUpdate {
4366
+ /**
4367
+ * Cross-border repricing record of the line item.
4368
+ * @internal
4369
+ */
4370
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
4371
+ }
4188
4372
  interface LineItemDelta extends LineItemDeltaDeltaOneOf {
4189
4373
  lineItemAdded?: boolean;
4190
4374
  changedDetails?: ItemChangedDetails;
@@ -4497,1552 +4681,1272 @@ interface BulkDeleteImportedOrdersResponse {
4497
4681
  */
4498
4682
  jobId?: string;
4499
4683
  }
4500
- interface SendBuyerConfirmationEmailRequest {
4684
+ interface V1TriggerReindexRequest {
4501
4685
  /** @format GUID */
4502
- orderId?: string;
4503
- }
4504
- interface SendBuyerConfirmationEmailResponse {
4505
- }
4506
- interface SendBuyerPaymentsReceivedEmailRequest {
4686
+ metasiteId?: string;
4507
4687
  /**
4508
4688
  * @minLength 1
4509
4689
  * @maxLength 100
4690
+ * @maxSize 100
4510
4691
  */
4511
- orderId?: string;
4692
+ orderIds?: string[];
4512
4693
  }
4513
- interface SendBuyerPaymentsReceivedEmailResponse {
4694
+ interface V1TriggerReindexResponse {
4514
4695
  }
4515
- interface SendBuyerPickupConfirmationEmailRequest {
4696
+ interface V1TriggerReindexOrderRequest {
4697
+ /** @format GUID */
4698
+ metasiteId?: string;
4516
4699
  /**
4517
4700
  * @minLength 1
4518
4701
  * @maxLength 100
4519
4702
  */
4520
4703
  orderId?: string;
4521
4704
  }
4522
- interface SendBuyerPickupConfirmationEmailResponse {
4523
- }
4524
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4525
- /**
4526
- * IDs of orders to send pickup emails for.
4527
- * @minSize 1
4528
- * @maxSize 300
4529
- */
4530
- orderIds?: string[];
4531
- }
4532
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4533
- }
4534
- interface SendBuyerShippingConfirmationEmailRequest {
4705
+ interface PreparePaymentCollectionRequest {
4535
4706
  /**
4707
+ * Ecom order ID.
4536
4708
  * @minLength 1
4537
4709
  * @maxLength 100
4538
4710
  */
4539
- orderId?: string;
4540
- }
4541
- interface SendBuyerShippingConfirmationEmailResponse {
4542
- }
4543
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4711
+ ecomOrderId: string;
4712
+ /** Amount to collect */
4713
+ amount: Price;
4544
4714
  /**
4545
- * IDs of orders to send pickup emails for.
4546
- * @minSize 1
4547
- * @maxSize 300
4715
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4716
+ * Existing payment gateway order will be updated with a new amount.
4717
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4548
4718
  */
4549
- orderIds?: string[];
4550
- }
4551
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4552
- }
4553
- interface SendMerchantOrderReceivedNotificationRequest {
4719
+ paymentGatewayOrderId?: string | null;
4554
4720
  /**
4555
- * @minLength 1
4556
- * @maxLength 100
4721
+ * Whether to delay capture of the payment.
4722
+ * Default: false
4723
+ * @deprecated Whether to delay capture of the payment.
4724
+ * Default: false
4725
+ * @replacedBy delayed_capture_settings.scheduled_action
4726
+ * @targetRemovalDate 2024-09-30
4557
4727
  */
4558
- orderId?: string;
4559
- }
4560
- interface SendMerchantOrderReceivedNotificationResponse {
4561
- }
4562
- interface SendCancelRefundEmailRequest {
4728
+ delayedCapture?: boolean;
4563
4729
  /**
4564
- * The ID of order that is canceled/refunded
4565
- * @minLength 1
4566
- * @maxLength 100
4730
+ * Specifies whether payment collection is initiated by Merchant or User of User
4731
+ * Default: `true`
4732
+ * @internal
4567
4733
  */
4568
- orderId?: string;
4734
+ merchantInitiated?: boolean | null;
4569
4735
  /**
4570
- * Personal note added to the email (optional)
4571
- * @minLength 1
4572
- * @maxLength 1000
4736
+ * Redirect urls which are used to return buyer to third party system.
4737
+ * @internal
4573
4738
  */
4574
- customMessage?: string | null;
4575
- /** Refund amount */
4576
- refundAmount?: Price;
4739
+ redirectUrls?: RedirectUrls;
4740
+ /** Delayed capture payment settings */
4741
+ delayedCaptureSettings?: DelayedCaptureSettings;
4742
+ }
4743
+ interface RedirectUrls {
4577
4744
  /**
4578
- * Refund ID. (Optional)
4579
- * @format GUID
4745
+ * URL to redirect buyer in case of approved (successful) transaction
4746
+ * @format WEB_URL
4580
4747
  */
4581
- refundId?: string | null;
4582
- }
4583
- interface SendCancelRefundEmailResponse {
4584
- }
4585
- interface SendRefundEmailRequest {
4748
+ successUrl?: string | null;
4586
4749
  /**
4587
- * The ID of order that is refunded
4588
- * @format GUID
4750
+ * URL to redirect buyer in case of buyer canceled the transaction
4751
+ * @format WEB_URL
4589
4752
  */
4590
- orderId?: string;
4753
+ cancelUrl?: string | null;
4591
4754
  /**
4592
- * Refund ID
4593
- * @format GUID
4755
+ * URL to redirect buyer in case of failed/rejected transaction
4756
+ * @format WEB_URL
4594
4757
  */
4595
- refundId?: string;
4758
+ errorUrl?: string | null;
4596
4759
  /**
4597
- * Personal note added to the email (optional)
4598
- * @minLength 1
4599
- * @maxLength 1000
4760
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4761
+ * @format WEB_URL
4600
4762
  */
4601
- customMessage?: string | null;
4602
- }
4603
- interface SendRefundEmailResponse {
4763
+ pendingUrl?: string | null;
4604
4764
  }
4605
- interface SendFulfillmentEmailRequest {
4606
- /** @format GUID */
4607
- orderId?: string;
4608
- /** @format GUID */
4609
- fulfillerId?: string;
4765
+ interface DelayedCaptureSettings {
4766
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4767
+ scheduledAction?: ScheduledActionWithLiterals;
4768
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4769
+ delayDuration?: Duration;
4610
4770
  }
4611
- interface SendFulfillmentEmailResponse {
4771
+ declare enum ScheduledAction {
4772
+ /** Whether payment will be auto-voided when duration passes */
4773
+ VOID = "VOID",
4774
+ /** Whether payment will be auto-captured when duration passes */
4775
+ CAPTURE = "CAPTURE"
4612
4776
  }
4613
- interface SendMerchantOrderReceivedPushRequest {
4777
+ /** @enumType */
4778
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4779
+ interface Duration {
4614
4780
  /**
4615
- * @minLength 1
4616
- * @maxLength 100
4781
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4782
+ * @min 1
4617
4783
  */
4618
- orderId?: string;
4619
- }
4620
- interface SendMerchantOrderReceivedPushResponse {
4621
- }
4622
- interface PreviewEmailByTypeRequest {
4623
- emailType?: PreviewEmailTypeWithLiterals;
4784
+ count?: number;
4785
+ /** Duration unit: MINUTES, HOURS and DAYS */
4786
+ unit?: DurationUnitWithLiterals;
4624
4787
  }
4625
- declare enum PreviewEmailType {
4626
- ORDER_PLACED = "ORDER_PLACED",
4627
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4628
- ORDER_SHIPPED = "ORDER_SHIPPED",
4629
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4788
+ declare enum DurationUnit {
4789
+ MINUTES = "MINUTES",
4790
+ HOURS = "HOURS",
4791
+ DAYS = "DAYS"
4630
4792
  }
4631
4793
  /** @enumType */
4632
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4633
- interface PreviewEmailByTypeResponse {
4634
- emailPreview?: string;
4794
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4795
+ interface PreparePaymentCollectionResponse {
4796
+ /** Payment gateway order id which is associated with given payment */
4797
+ paymentGatewayOrderId?: string;
4635
4798
  }
4636
- interface PreviewRefundEmailRequest {
4799
+ interface GetPaymentCollectabilityStatusRequest {
4637
4800
  /**
4801
+ * Ecom order ID.
4638
4802
  * @minLength 1
4639
4803
  * @maxLength 100
4640
4804
  */
4641
- orderId?: string;
4642
- /** Refund amount */
4643
- refundAmount?: Price;
4644
- /** Refund business details */
4645
- details?: RefundDetails;
4805
+ ecomOrderId: string;
4806
+ }
4807
+ interface GetPaymentCollectabilityStatusResponse {
4808
+ /** Payment collectability status */
4809
+ status?: PaymentCollectabilityStatusWithLiterals;
4810
+ /** Collectable order amount */
4811
+ amount?: Price;
4646
4812
  /**
4647
- * Personal note added to the email (optional)
4648
- * @minLength 1
4649
- * @maxLength 1000
4813
+ * Whether authorization supported
4814
+ * @internal
4650
4815
  */
4651
- customMessage?: string | null;
4816
+ authorizationSupported?: boolean;
4652
4817
  /**
4653
- * Refund ID. (Optional)
4654
- * @format GUID
4818
+ * Whether custom amount is supported for payment collection
4819
+ * @internal
4655
4820
  */
4656
- refundId?: string | null;
4821
+ customAmountSupported?: boolean;
4657
4822
  }
4658
- /** Business model of a refund request */
4659
- interface RefundDetails {
4660
- /**
4661
- * Order line item IDs and quantities that were refunded.
4662
- * @maxSize 300
4663
- */
4664
- items?: RefundItem[];
4665
- /** Whether the shipping fee was also refunded. */
4666
- shippingIncluded?: boolean;
4667
- /**
4668
- * Reason for the refund, provided by customer (optional).
4669
- * @maxLength 200
4670
- */
4671
- reason?: string | null;
4672
- /**
4673
- * Line items that were refunded.
4674
- * @maxSize 300
4675
- */
4676
- lineItems?: LineItemRefund[];
4677
- /**
4678
- * Additional fees that were refunded.
4679
- * @maxSize 100
4680
- */
4681
- additionalFees?: AdditionalFeeRefund[];
4682
- /** Shipping amount that was refunded. */
4683
- shipping?: ShippingRefund;
4823
+ declare enum PaymentCollectabilityStatus {
4824
+ UNKNOWN = "UNKNOWN",
4825
+ COLLECTABLE = "COLLECTABLE",
4826
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4827
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4828
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4829
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4830
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4831
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4832
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4833
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4834
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4835
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4836
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4684
4837
  }
4685
- interface RefundItem {
4838
+ /** @enumType */
4839
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4840
+ interface RecordManuallyCollectedPaymentRequest {
4686
4841
  /**
4687
- * Line item ID the refunded line item.
4688
- * @format GUID
4842
+ * Order ID.
4843
+ * @minLength 1
4844
+ * @maxLength 100
4689
4845
  */
4690
- lineItemId?: string;
4846
+ orderId: string;
4847
+ /** Amount to be recorded as approved manual payment for given order */
4848
+ amount: Price;
4691
4849
  /**
4692
- * Line item quantity refunded.
4693
- * @min 1
4694
- * @max 100000
4850
+ * Payment method name provided by user.
4851
+ *
4852
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4853
+ * @internal
4695
4854
  */
4696
- quantity?: number;
4855
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4697
4856
  }
4698
- interface LineItemRefund {
4699
- /**
4700
- * Line item ID.
4701
- * @format GUID
4702
- * @immutable
4703
- */
4704
- lineItemId?: string;
4857
+ /**
4858
+ * User-defined payment method name.
4859
+ * Allows specifying either a predefined type or a custom name.
4860
+ */
4861
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4862
+ /** Predefined payment method. */
4863
+ predefined?: PredefinedPaymentMethodWithLiterals;
4705
4864
  /**
4706
- * Refund quantity.
4707
- * @min 1
4708
- * @max 100000
4709
- * @immutable
4865
+ * Custom payment method name provided by user.
4866
+ *
4867
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4868
+ * @minLength 1
4869
+ * @maxLength 150
4710
4870
  */
4711
- quantity?: number;
4871
+ custom?: string | null;
4712
4872
  }
4713
- interface AdditionalFeeRefund {
4714
- /**
4715
- * Additional fee ID.
4716
- * @format GUID
4717
- * @immutable
4718
- */
4719
- additionalFeeId?: string;
4873
+ /** @oneof */
4874
+ interface UserDefinedPaymentMethodNameKindOneOf {
4875
+ /** Predefined payment method. */
4876
+ predefined?: PredefinedPaymentMethodWithLiterals;
4720
4877
  /**
4721
- * Refund amount.
4722
- * @immutable
4878
+ * Custom payment method name provided by user.
4879
+ *
4880
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4881
+ * @minLength 1
4882
+ * @maxLength 150
4723
4883
  */
4724
- amount?: Price;
4884
+ custom?: string | null;
4725
4885
  }
4726
- interface ShippingRefund {
4727
- /**
4728
- * Refund amount.
4729
- * @immutable
4730
- */
4731
- amount?: Price;
4886
+ /** Predefined payment method types for offline/manual payments. */
4887
+ declare enum PredefinedPaymentMethod {
4888
+ /** Cash payment. */
4889
+ CASH = "CASH",
4890
+ /** Bank transfer. */
4891
+ BANK_TRANSFER = "BANK_TRANSFER",
4892
+ /** Payment by check. */
4893
+ CHECK = "CHECK"
4732
4894
  }
4733
- interface PreviewRefundEmailResponse {
4734
- emailPreview?: string;
4895
+ /** @enumType */
4896
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4897
+ interface RecordManuallyCollectedPaymentResponse {
4735
4898
  }
4736
- interface PreviewCancelEmailRequest {
4899
+ interface MarkOrderAsPaidRequest {
4737
4900
  /**
4901
+ * Ecom order ID.
4738
4902
  * @minLength 1
4739
4903
  * @maxLength 100
4740
4904
  */
4741
- orderId?: string;
4905
+ ecomOrderId: string;
4742
4906
  /**
4743
- * Personal note added to the email (optional)
4744
- * @minLength 1
4745
- * @maxLength 1000
4907
+ * Payment method name provided by user.
4908
+ *
4909
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4910
+ * @internal
4746
4911
  */
4747
- customMessage?: string | null;
4912
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4748
4913
  }
4749
- interface PreviewCancelEmailResponse {
4750
- emailPreview?: string;
4914
+ interface MarkOrderAsPaidResponse {
4915
+ /** Updated order. */
4916
+ order?: Order;
4751
4917
  }
4752
- interface PreviewCancelRefundEmailRequest {
4918
+ interface BulkMarkOrdersAsPaidRequest {
4753
4919
  /**
4920
+ * IDs of orders to mark as paid.
4921
+ * @minSize 1
4922
+ * @maxSize 100
4754
4923
  * @minLength 1
4755
4924
  * @maxLength 100
4756
4925
  */
4757
- orderId?: string;
4926
+ ecomOrderIds: string[];
4927
+ }
4928
+ interface BulkMarkOrdersAsPaidResponse {
4758
4929
  /**
4759
- * Personal note added to the email (optional)
4760
- * @minLength 1
4761
- * @maxLength 1000
4930
+ * Items updated by the bulk action.
4931
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4762
4932
  */
4763
- customMessage?: string | null;
4764
- /** Refund amount */
4765
- refundAmount?: Price;
4933
+ results?: BulkOrderResult[];
4934
+ /** Bulk action metadata. */
4935
+ bulkActionMetadata?: BulkActionMetadata;
4936
+ }
4937
+ interface BulkOrderResult {
4938
+ /** Item metadata. */
4939
+ itemMetadata?: ItemMetadata;
4766
4940
  /**
4767
- * Refund ID. (Optional)
4768
- * @format GUID
4941
+ * Updated order.
4942
+ *
4943
+ * Returned when `returnFullEntity = true`.
4769
4944
  */
4770
- refundId?: string | null;
4945
+ item?: Order;
4771
4946
  }
4772
- interface PreviewCancelRefundEmailResponse {
4773
- emailPreview?: string;
4947
+ interface ItemMetadata {
4948
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4949
+ _id?: string | null;
4950
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4951
+ originalIndex?: number;
4952
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4953
+ success?: boolean;
4954
+ /** Details about the error in case of failure. */
4955
+ error?: ApplicationError;
4774
4956
  }
4775
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4957
+ interface ApplicationError {
4958
+ /** Error code. */
4959
+ code?: string;
4960
+ /** Description of the error. */
4961
+ description?: string;
4962
+ /** Data related to the error. */
4963
+ data?: Record<string, any> | null;
4776
4964
  }
4777
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4778
- emailPreview?: string;
4965
+ interface BulkActionMetadata {
4966
+ /** Number of items that were successfully processed. */
4967
+ totalSuccesses?: number;
4968
+ /** Number of items that couldn't be processed. */
4969
+ totalFailures?: number;
4970
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4971
+ undetailedFailures?: number;
4779
4972
  }
4780
- interface PreviewBuyerConfirmationEmailRequest {
4973
+ interface GetRefundabilityStatusRequest {
4974
+ /**
4975
+ * Order ID.
4976
+ * @minLength 1
4977
+ * @maxLength 100
4978
+ */
4979
+ ecomOrderId: string;
4781
4980
  }
4782
- interface PreviewBuyerConfirmationEmailResponse {
4783
- emailPreview?: string;
4981
+ interface GetRefundabilityStatusResponse {
4982
+ /**
4983
+ * Refundability details.
4984
+ * @maxSize 300
4985
+ */
4986
+ refundabilities?: Refundability[];
4987
+ /**
4988
+ * Whether the order supports refunding per item.
4989
+ * @deprecated
4990
+ */
4991
+ refundablePerItem?: boolean;
4784
4992
  }
4785
- interface PreviewBuyerPickupConfirmationEmailRequest {
4993
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4994
+ /** Reason why payment is not refundable. */
4995
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4996
+ /** Reason why payment is only refundable manually. */
4997
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4998
+ /** Payment ID. */
4999
+ paymentId?: string;
5000
+ /** Payment refundability status. */
5001
+ refundabilityStatus?: RefundableStatusWithLiterals;
5002
+ /** Link to payment provider dashboard. */
5003
+ providerLink?: string | null;
4786
5004
  }
4787
- interface PreviewBuyerPickupConfirmationEmailResponse {
4788
- emailPreview?: string;
5005
+ /** @oneof */
5006
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5007
+ /** Reason why payment is not refundable. */
5008
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5009
+ /** Reason why payment is only refundable manually. */
5010
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4789
5011
  }
4790
- interface PreviewShippingConfirmationEmailRequest {
5012
+ declare enum RefundableStatus {
5013
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5014
+ MANUAL = "MANUAL",
5015
+ REFUNDABLE = "REFUNDABLE"
4791
5016
  }
4792
- interface PreviewShippingConfirmationEmailResponse {
4793
- emailPreview?: string;
4794
- }
4795
- interface PreviewResendDownloadLinksEmailRequest {
5017
+ /** @enumType */
5018
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5019
+ declare enum NonRefundableReason {
5020
+ NONE = "NONE",
5021
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5022
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5023
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5024
+ NOT_PAID = "NOT_PAID",
5025
+ ACCESS_DENIED = "ACCESS_DENIED",
5026
+ ZERO_PRICE = "ZERO_PRICE",
5027
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5028
+ PENDING_REFUND = "PENDING_REFUND",
5029
+ FORBIDDEN = "FORBIDDEN",
5030
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5031
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5032
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4796
5033
  }
4797
- interface PreviewResendDownloadLinksEmailResponse {
4798
- emailPreview?: string;
5034
+ /** @enumType */
5035
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5036
+ declare enum ManuallyRefundableReason {
5037
+ EXPIRED = "EXPIRED",
5038
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5039
+ OFFLINE = "OFFLINE",
5040
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4799
5041
  }
4800
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4801
- /** Emitted on a meta site creation. */
4802
- siteCreated?: SiteCreated;
4803
- /** Emitted on a meta site transfer completion. */
4804
- siteTransferred?: SiteTransferred;
4805
- /** Emitted on a meta site deletion. */
4806
- siteDeleted?: SiteDeleted;
4807
- /** Emitted on a meta site restoration. */
4808
- siteUndeleted?: SiteUndeleted;
4809
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4810
- sitePublished?: SitePublished;
4811
- /** Emitted on a meta site unpublish. */
4812
- siteUnpublished?: SiteUnpublished;
4813
- /** Emitted when meta site is marked as template. */
4814
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4815
- /** Emitted when meta site is marked as a WixSite. */
4816
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4817
- /** Emitted when an application is provisioned (installed). */
4818
- serviceProvisioned?: ServiceProvisioned;
4819
- /** Emitted when an application is removed (uninstalled). */
4820
- serviceRemoved?: ServiceRemoved;
4821
- /** Emitted when meta site name (URL slug) is changed. */
4822
- siteRenamedPayload?: SiteRenamed;
4823
- /** Emitted when meta site was permanently deleted. */
4824
- hardDeleted?: SiteHardDeleted;
4825
- /** Emitted on a namespace change. */
4826
- namespaceChanged?: NamespaceChanged;
4827
- /** Emitted when Studio is attached. */
4828
- studioAssigned?: StudioAssigned;
4829
- /** Emitted when Studio is detached. */
4830
- studioUnassigned?: StudioUnassigned;
5042
+ /** @enumType */
5043
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5044
+ interface CreatePaymentGatewayOrderRequest {
4831
5045
  /**
4832
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4833
- * the actual URL.
5046
+ * Ecom order ID.
5047
+ * @minLength 1
5048
+ * @maxLength 100
5049
+ */
5050
+ ecomOrderId: string;
5051
+ /** Information about the user who initiated the payment. */
5052
+ chargedBy?: ChargedBy;
5053
+ /**
5054
+ * Whether to delay capture of the payment.
4834
5055
  *
4835
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4836
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5056
+ * Default: false
5057
+ * @internal
4837
5058
  */
4838
- urlChanged?: SiteUrlChanged;
4839
- /** Site is marked as PurgedExternally */
4840
- sitePurgedExternally?: SitePurgedExternally;
4841
- /** Emitted when Odeditor is attached. */
4842
- odeditorAssigned?: OdeditorAssigned;
4843
- /** Emitted when Odeditor is detached. */
4844
- odeditorUnassigned?: OdeditorUnassigned;
4845
- /** Emitted when Picasso is attached. */
4846
- picassoAssigned?: PicassoAssigned;
4847
- /** Emitted when Picasso is detached. */
4848
- picassoUnassigned?: PicassoUnassigned;
4849
- /** Emitted when Wixel is attached. */
4850
- wixelAssigned?: WixelAssigned;
4851
- /** Emitted when Wixel is detached. */
4852
- wixelUnassigned?: WixelUnassigned;
4853
- /** Emitted when StudioTwo is attached. */
4854
- studioTwoAssigned?: StudioTwoAssigned;
4855
- /** Emitted when StudioTwo is detached. */
4856
- studioTwoUnassigned?: StudioTwoUnassigned;
4857
- /** Emitted when media from user domain is enabled. */
4858
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4859
- /** Emitted when media from user domain is disabled. */
4860
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4861
- /** Emitted when Editorless is attached. */
4862
- editorlessAssigned?: EditorlessAssigned;
4863
- /** Emitted when Editorless is detached. */
4864
- editorlessUnassigned?: EditorlessUnassigned;
5059
+ delayedCapture?: boolean;
5060
+ }
5061
+ interface ChargedBy {
4865
5062
  /**
4866
- * A meta site id.
5063
+ * ID - id of the user who initiated the payment
4867
5064
  * @format GUID
4868
5065
  */
4869
- metaSiteId?: string;
4870
- /** A meta site version. Monotonically increasing. */
4871
- version?: string;
4872
- /** A timestamp of the event. */
4873
- timestamp?: string;
5066
+ _id?: string;
4874
5067
  /**
4875
- * TODO(meta-site): Change validation once validations are disabled for consumers
4876
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4877
- * @maxSize 4000
5068
+ * Full name - name of the user who initiated the payment
5069
+ * @minLength 1
5070
+ * @maxLength 200
4878
5071
  */
4879
- assets?: Asset[];
5072
+ fullName?: string | null;
4880
5073
  }
4881
- /** @oneof */
4882
- interface MetaSiteSpecialEventPayloadOneOf {
4883
- /** Emitted on a meta site creation. */
4884
- siteCreated?: SiteCreated;
4885
- /** Emitted on a meta site transfer completion. */
4886
- siteTransferred?: SiteTransferred;
4887
- /** Emitted on a meta site deletion. */
4888
- siteDeleted?: SiteDeleted;
4889
- /** Emitted on a meta site restoration. */
4890
- siteUndeleted?: SiteUndeleted;
4891
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4892
- sitePublished?: SitePublished;
4893
- /** Emitted on a meta site unpublish. */
4894
- siteUnpublished?: SiteUnpublished;
4895
- /** Emitted when meta site is marked as template. */
4896
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4897
- /** Emitted when meta site is marked as a WixSite. */
4898
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4899
- /** Emitted when an application is provisioned (installed). */
4900
- serviceProvisioned?: ServiceProvisioned;
4901
- /** Emitted when an application is removed (uninstalled). */
4902
- serviceRemoved?: ServiceRemoved;
4903
- /** Emitted when meta site name (URL slug) is changed. */
4904
- siteRenamedPayload?: SiteRenamed;
4905
- /** Emitted when meta site was permanently deleted. */
4906
- hardDeleted?: SiteHardDeleted;
4907
- /** Emitted on a namespace change. */
4908
- namespaceChanged?: NamespaceChanged;
4909
- /** Emitted when Studio is attached. */
4910
- studioAssigned?: StudioAssigned;
4911
- /** Emitted when Studio is detached. */
4912
- studioUnassigned?: StudioUnassigned;
5074
+ interface CreatePaymentGatewayOrderResponse {
5075
+ /** ID of the order created in the payment gateway */
5076
+ paymentGatewayOrderId?: string;
5077
+ }
5078
+ interface ChargeMembershipsRequest {
4913
5079
  /**
4914
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4915
- * the actual URL.
4916
- *
4917
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4918
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5080
+ * Order ID.
5081
+ * @minLength 1
5082
+ * @maxLength 100
4919
5083
  */
4920
- urlChanged?: SiteUrlChanged;
4921
- /** Site is marked as PurgedExternally */
4922
- sitePurgedExternally?: SitePurgedExternally;
4923
- /** Emitted when Odeditor is attached. */
4924
- odeditorAssigned?: OdeditorAssigned;
4925
- /** Emitted when Odeditor is detached. */
4926
- odeditorUnassigned?: OdeditorUnassigned;
4927
- /** Emitted when Picasso is attached. */
4928
- picassoAssigned?: PicassoAssigned;
4929
- /** Emitted when Picasso is detached. */
4930
- picassoUnassigned?: PicassoUnassigned;
4931
- /** Emitted when Wixel is attached. */
4932
- wixelAssigned?: WixelAssigned;
4933
- /** Emitted when Wixel is detached. */
4934
- wixelUnassigned?: WixelUnassigned;
4935
- /** Emitted when StudioTwo is attached. */
4936
- studioTwoAssigned?: StudioTwoAssigned;
4937
- /** Emitted when StudioTwo is detached. */
4938
- studioTwoUnassigned?: StudioTwoUnassigned;
4939
- /** Emitted when media from user domain is enabled. */
4940
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4941
- /** Emitted when media from user domain is disabled. */
4942
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4943
- /** Emitted when Editorless is attached. */
4944
- editorlessAssigned?: EditorlessAssigned;
4945
- /** Emitted when Editorless is detached. */
4946
- editorlessUnassigned?: EditorlessUnassigned;
4947
- }
4948
- interface Asset {
5084
+ ecomOrderId: string;
4949
5085
  /**
4950
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4951
- * @maxLength 36
5086
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5087
+ * but a user which is using the membership on behalf of the a member
5088
+ * @format GUID
4952
5089
  */
4953
- appDefId?: string;
5090
+ memberId: string;
4954
5091
  /**
4955
- * An instance id. For legacy reasons may be UUID or a string.
4956
- * @maxLength 200
5092
+ * List of items to be paid by memberships
5093
+ * @minSize 1
5094
+ * @maxSize 300
4957
5095
  */
4958
- instanceId?: string;
4959
- /** An application state. */
4960
- state?: StateWithLiterals;
4961
- }
4962
- declare enum State {
4963
- UNKNOWN = "UNKNOWN",
4964
- ENABLED = "ENABLED",
4965
- DISABLED = "DISABLED",
4966
- PENDING = "PENDING",
4967
- DEMO = "DEMO"
5096
+ membershipCharges?: MembershipChargeItem[];
4968
5097
  }
4969
- /** @enumType */
4970
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4971
- interface SiteCreated {
5098
+ interface MembershipChargeItem {
4972
5099
  /**
4973
- * A template identifier (empty if not created from a template).
4974
- * @maxLength 36
5100
+ * The id of used membership
5101
+ * @minLength 1
5102
+ * @maxLength 100
4975
5103
  */
4976
- originTemplateId?: string;
5104
+ membershipId?: string;
4977
5105
  /**
4978
- * An account id of the owner.
5106
+ * ID of the application providing this payment option
4979
5107
  * @format GUID
4980
5108
  */
4981
- ownerId?: string;
4982
- /** A context in which meta site was created. */
4983
- context?: SiteCreatedContextWithLiterals;
5109
+ appId?: string;
5110
+ /** The name of used membership */
5111
+ membershipName?: MembershipName;
5112
+ /** Additional data about this membership */
5113
+ membershipAdditionalData?: Record<string, any> | null;
5114
+ /** Catalog and item reference info. */
5115
+ catalogReference?: CatalogReference;
5116
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5117
+ serviceProperties?: ServiceProperties;
4984
5118
  /**
4985
- * A meta site id from which this site was created.
4986
- *
4987
- * In case of a creation from a template it's a template id.
4988
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4989
- * @format GUID
5119
+ * Usually would be the same as catalogReference.catalogItemId
5120
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5121
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5122
+ * @minLength 1
5123
+ * @maxLength 36
4990
5124
  */
4991
- originMetaSiteId?: string | null;
5125
+ rootCatalogItemId?: string | null;
4992
5126
  /**
4993
- * A meta site name (URL slug).
4994
- * @maxLength 20
5127
+ * line item id of Checkout/Order line item
5128
+ * @minLength 1
5129
+ * @maxLength 100
4995
5130
  */
4996
- siteName?: string;
4997
- /** A namespace. */
4998
- namespace?: NamespaceWithLiterals;
4999
- }
5000
- declare enum SiteCreatedContext {
5001
- /** A valid option, we don't expose all reasons why site might be created. */
5002
- OTHER = "OTHER",
5003
- /** A meta site was created from template. */
5004
- FROM_TEMPLATE = "FROM_TEMPLATE",
5005
- /** A meta site was created by copying of the transfferred meta site. */
5006
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5007
- /** A copy of existing meta site. */
5008
- DUPLICATE = "DUPLICATE",
5009
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5010
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5011
- /** deprecated A meta site was created for Flash editor. */
5012
- FLASH = "FLASH"
5131
+ lineItemId?: string;
5013
5132
  }
5014
- /** @enumType */
5015
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5016
- declare enum Namespace {
5017
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5018
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5019
- WIX = "WIX",
5020
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5021
- SHOUT_OUT = "SHOUT_OUT",
5022
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5023
- ALBUMS = "ALBUMS",
5024
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5025
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5026
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5027
- HOTELS = "HOTELS",
5028
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5029
- CLUBS = "CLUBS",
5030
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5031
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5133
+ interface MembershipName {
5032
5134
  /**
5033
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5034
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5135
+ * Membership name in the site's original language.
5136
+ * @maxLength 100
5035
5137
  */
5036
- DEV_SITE = "DEV_SITE",
5037
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5038
- LOGOS = "LOGOS",
5039
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5040
- VIDEO_MAKER = "VIDEO_MAKER",
5041
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5042
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5043
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5044
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5138
+ original?: string;
5045
5139
  /**
5046
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5140
+ * Membership name translated into the buyer's language.
5047
5141
  *
5048
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5142
+ * Default: The value of `original`
5143
+ * @maxLength 100
5049
5144
  */
5050
- HTML_DRAFT = "HTML_DRAFT",
5145
+ translated?: string | null;
5146
+ }
5147
+ interface ChargeMembershipsResponse {
5148
+ }
5149
+ interface TriggerRefundRequest {
5051
5150
  /**
5052
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5053
- * Will be accessible from Site List and will not have a website app.
5054
- * Once the user attaches a site, the site will become a regular wixsite.
5151
+ * The order this refund related to
5152
+ * @minLength 1
5153
+ * @maxLength 100
5055
5154
  */
5056
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5057
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5058
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5059
- /** It is to be used in the Business First efforts. */
5060
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5061
- /** Bookings business flow with no site. */
5062
- ANYWHERE = "ANYWHERE",
5063
- /** Namespace for Headless Backoffice with no editor */
5064
- HEADLESS = "HEADLESS",
5155
+ ecomOrderId: string;
5065
5156
  /**
5066
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5067
- * The site will be used for account level CSM feature for enterprise
5157
+ * Refund operations information
5158
+ * @minSize 1
5159
+ * @maxSize 1
5068
5160
  */
5069
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5070
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5071
- RISE = "RISE",
5161
+ payments: PaymentRefund[];
5162
+ /** Business model of a refund */
5163
+ details?: RefundDetails;
5164
+ /** Side effect details related to refund */
5165
+ sideEffects?: RefundSideEffects;
5166
+ }
5167
+ interface PaymentRefund {
5072
5168
  /**
5073
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5074
- * There's a blank site behind the scene but it's blank).
5075
- * The Mobile company will be the owner of this namespace.
5169
+ * Specific payment within the order to refund
5170
+ * @format GUID
5076
5171
  */
5077
- BRANDED_FIRST = "BRANDED_FIRST",
5078
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5079
- NOWNIA = "NOWNIA",
5172
+ paymentId?: string;
5173
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5174
+ amount?: Price;
5080
5175
  /**
5081
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5082
- * The Partners company owns this namespace.
5176
+ * Whether refund is made externally and manually (on the payment provider's side)
5177
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5178
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5083
5179
  */
5084
- UGC_TEMPLATE = "UGC_TEMPLATE",
5085
- /** Codux Headless Sites */
5086
- CODUX = "CODUX",
5087
- /** Bobb - AI Design Creator. */
5088
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5180
+ externalRefund?: boolean;
5089
5181
  /**
5090
- * Shared Blog Site is a unique single site across Enterprise account,
5091
- * This site will hold all Blog posts related to the Marketing product.
5182
+ * Gateway refund id. When param is present, new refund is not created.
5183
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5184
+ * and all side effects from request will be executed.
5185
+ * @internal
5186
+ * @minLength 1
5187
+ * @maxLength 100
5092
5188
  */
5093
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5094
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5095
- STANDALONE_FORMS = "STANDALONE_FORMS",
5096
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5097
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5098
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5099
- MIMIR = "MIMIR",
5100
- /** Wix Twins platform. */
5101
- TWINS = "TWINS",
5102
- /** Wix Nano. */
5103
- NANO = "NANO",
5104
- /** Base44 headless sites. */
5105
- BASE44 = "BASE44",
5106
- /** Wix Channels Sites */
5107
- CHANNELS = "CHANNELS",
5108
- /** Nautilus platform. */
5109
- NAUTILUS = "NAUTILUS",
5189
+ gatewayRefundId?: string | null;
5190
+ }
5191
+ /** Business model of a refund request */
5192
+ interface RefundDetails {
5110
5193
  /**
5111
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5112
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5194
+ * Order line item IDs and quantities that were refunded.
5195
+ * @maxSize 300
5113
5196
  */
5114
- SYMPHONY = "SYMPHONY",
5115
- /** Nautilus platform app. */
5116
- NAUTILUS_APPS = "NAUTILUS_APPS",
5197
+ items?: RefundItem[];
5198
+ /** Whether the shipping fee was also refunded. */
5199
+ shippingIncluded?: boolean;
5117
5200
  /**
5118
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5119
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5201
+ * Reason for the refund, provided by customer (optional).
5202
+ * @maxLength 200
5120
5203
  */
5121
- VIBU = "VIBU",
5204
+ reason?: string | null;
5122
5205
  /**
5123
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5124
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5125
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5126
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5206
+ * Line items that were refunded.
5207
+ * @maxSize 300
5127
5208
  */
5128
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5209
+ lineItems?: LineItemRefund[];
5129
5210
  /**
5130
- * Dev-center development sites (com.wixpress.devcenter.dsm).
5131
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5211
+ * Additional fees that were refunded.
5212
+ * @maxSize 100
5132
5213
  */
5133
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5214
+ additionalFees?: AdditionalFeeRefund[];
5215
+ /** Shipping amount that was refunded. */
5216
+ shipping?: ShippingRefund;
5134
5217
  }
5135
- /** @enumType */
5136
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
5137
- /** Site transferred to another user. */
5138
- interface SiteTransferred {
5218
+ interface RefundItem {
5139
5219
  /**
5140
- * A previous owner id (user that transfers meta site).
5220
+ * Line item ID the refunded line item.
5141
5221
  * @format GUID
5142
5222
  */
5143
- oldOwnerId?: string;
5223
+ lineItemId?: string;
5144
5224
  /**
5145
- * A new owner id (user that accepts meta site).
5146
- * @format GUID
5225
+ * Line item quantity refunded.
5226
+ * @min 1
5227
+ * @max 100000
5147
5228
  */
5148
- newOwnerId?: string;
5149
- }
5150
- /** Soft deletion of the meta site. Could be restored. */
5151
- interface SiteDeleted {
5152
- /** A deletion context. */
5153
- deleteContext?: DeleteContext;
5229
+ quantity?: number;
5154
5230
  }
5155
- interface DeleteContext {
5156
- /** When the meta site was deleted. */
5157
- dateDeleted?: Date | null;
5158
- /** A status. */
5159
- deleteStatus?: DeleteStatusWithLiterals;
5231
+ interface LineItemRefund {
5160
5232
  /**
5161
- * A reason (flow).
5162
- * @maxLength 255
5233
+ * Line item ID.
5234
+ * @format GUID
5235
+ * @immutable
5163
5236
  */
5164
- deleteOrigin?: string;
5237
+ lineItemId?: string;
5165
5238
  /**
5166
- * A service that deleted it.
5167
- * @maxLength 255
5239
+ * Refund quantity.
5240
+ * @min 1
5241
+ * @max 100000
5242
+ * @immutable
5168
5243
  */
5169
- initiatorId?: string | null;
5170
- }
5171
- declare enum DeleteStatus {
5172
- UNKNOWN = "UNKNOWN",
5173
- TRASH = "TRASH",
5174
- DELETED = "DELETED",
5175
- PENDING_PURGE = "PENDING_PURGE",
5176
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5177
- }
5178
- /** @enumType */
5179
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5180
- /** Restoration of the meta site. */
5181
- interface SiteUndeleted {
5182
- }
5183
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5184
- interface SitePublished {
5244
+ quantity?: number;
5185
5245
  }
5186
- interface SiteUnpublished {
5246
+ interface AdditionalFeeRefund {
5187
5247
  /**
5188
- * A list of URLs previously associated with the meta site.
5189
- * @maxLength 4000
5190
- * @maxSize 10000
5248
+ * Additional fee ID.
5249
+ * @format GUID
5250
+ * @immutable
5191
5251
  */
5192
- urls?: string[];
5193
- }
5194
- interface SiteMarkedAsTemplate {
5252
+ additionalFeeId?: string;
5253
+ /**
5254
+ * Refund amount.
5255
+ * @immutable
5256
+ */
5257
+ amount?: Price;
5195
5258
  }
5196
- interface SiteMarkedAsWixSite {
5197
- }
5198
- /**
5199
- * Represents a service provisioned a site.
5200
- *
5201
- * Note on `origin_instance_id`:
5202
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5203
- * This is because of the following scenario:
5204
- *
5205
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5206
- * such as a product catalog. When you create a site from this template, you inherit this
5207
- * default product catalog. However, if the template's product catalog is modified,
5208
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5209
- * your site remains consistent with what you initially received and does not include any
5210
- * changes made to the original template afterward.
5211
- * To ensure this, the TPA on the template gets a new instance_id.
5212
- */
5213
- interface ServiceProvisioned {
5214
- /**
5215
- * Either UUID or EmbeddedServiceType.
5216
- * @maxLength 36
5217
- */
5218
- appDefId?: string;
5219
- /**
5220
- * Not only UUID. Something here could be something weird.
5221
- * @maxLength 36
5222
- */
5223
- instanceId?: string;
5224
- /**
5225
- * An instance id from which this instance is originated.
5226
- * @maxLength 36
5227
- */
5228
- originInstanceId?: string;
5259
+ interface ShippingRefund {
5229
5260
  /**
5230
- * A version.
5231
- * @maxLength 500
5261
+ * Refund amount.
5262
+ * @immutable
5232
5263
  */
5233
- version?: string | null;
5264
+ amount?: Price;
5265
+ }
5266
+ interface RefundSideEffects {
5267
+ /** Inventory restock details as part of this refund. */
5268
+ restockInfo?: RestockInfo;
5269
+ /** Whether to send a refund confirmation email to the customer. */
5270
+ sendOrderRefundedEmail?: boolean;
5234
5271
  /**
5235
- * The origin meta site id
5236
- * @format GUID
5272
+ * Custom message added to the refund confirmation email.
5273
+ * @minLength 1
5274
+ * @maxLength 1000
5237
5275
  */
5238
- originMetaSiteId?: string | null;
5276
+ customMessage?: string | null;
5239
5277
  }
5240
- interface ServiceRemoved {
5278
+ interface RestockInfo {
5279
+ /** Restock type. */
5280
+ type?: RestockTypeWithLiterals;
5241
5281
  /**
5242
- * Either UUID or EmbeddedServiceType.
5243
- * @maxLength 36
5282
+ * Deprecated, use items instead
5283
+ * @internal
5284
+ * @maxSize 300
5285
+ * @deprecated
5244
5286
  */
5245
- appDefId?: string;
5287
+ lineItemIds?: string[];
5246
5288
  /**
5247
- * Not only UUID. Something here could be something weird.
5248
- * @maxLength 36
5289
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5290
+ * @maxSize 300
5249
5291
  */
5250
- instanceId?: string;
5292
+ items?: RestockItem[];
5293
+ }
5294
+ declare enum RestockType {
5295
+ NO_ITEMS = "NO_ITEMS",
5296
+ ALL_ITEMS = "ALL_ITEMS",
5297
+ SOME_ITEMS = "SOME_ITEMS"
5298
+ }
5299
+ /** @enumType */
5300
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5301
+ interface RestockItem {
5251
5302
  /**
5252
- * A version.
5253
- * @maxLength 500
5303
+ * ID of the line item being restocked.
5304
+ * @format GUID
5254
5305
  */
5255
- version?: string | null;
5256
- }
5257
- /** Rename of the site. Meaning, free public url has been changed as well. */
5258
- interface SiteRenamed {
5306
+ lineItemId?: string;
5259
5307
  /**
5260
- * A new meta site name (URL slug).
5261
- * @maxLength 20
5308
+ * Line item quantity being restocked.
5309
+ * @min 1
5310
+ * @max 100000
5262
5311
  */
5263
- newSiteName?: string;
5312
+ quantity?: number;
5264
5313
  /**
5265
- * A previous meta site name (URL slug).
5266
- * @maxLength 255
5314
+ * Per-location breakdown of restock quantities.
5315
+ * @internal
5316
+ * @maxSize 5
5267
5317
  */
5268
- oldSiteName?: string;
5269
- }
5270
- /**
5271
- * Hard deletion of the meta site.
5272
- *
5273
- * Could not be restored. Therefore it's desirable to cleanup data.
5274
- */
5275
- interface SiteHardDeleted {
5276
- /** A deletion context. */
5277
- deleteContext?: DeleteContext;
5278
- }
5279
- interface NamespaceChanged {
5280
- /** A previous namespace. */
5281
- oldNamespace?: NamespaceWithLiterals;
5282
- /** A new namespace. */
5283
- newNamespace?: NamespaceWithLiterals;
5284
- }
5285
- /** Assigned Studio editor */
5286
- interface StudioAssigned {
5318
+ restockLocations?: RestockLocation[];
5287
5319
  }
5288
- /** Unassigned Studio editor */
5289
- interface StudioUnassigned {
5320
+ interface TriggerRefundResponse {
5321
+ /** All order's transactions after the refunds were added */
5322
+ orderTransactions?: OrderTransactions;
5323
+ /** Created refund ID */
5324
+ refundId?: string | null;
5325
+ /** Payment ID's that the refund execution had failed for */
5326
+ failedPaymentIds?: ItemMetadata[];
5290
5327
  }
5291
5328
  /**
5292
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5293
- *
5294
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5295
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5329
+ * A record of all payments and refunds associated with an order.
5296
5330
  *
5297
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5298
- */
5299
- interface SiteUrlChanged {
5300
- }
5301
- /**
5302
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5303
- * Consumed by other teams to remove relevant data.
5331
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5304
5332
  */
5305
- interface SitePurgedExternally {
5306
- /**
5307
- * @maxLength 2048
5308
- * @maxSize 100
5309
- * @deprecated
5310
- * @targetRemovalDate 2025-04-15
5311
- */
5312
- appDefId?: string[];
5313
- }
5314
- /** Assigned Odeditor */
5315
- interface OdeditorAssigned {
5316
- }
5317
- /** Unassigned Odeditor */
5318
- interface OdeditorUnassigned {
5319
- }
5320
- /** Assigned Picasso editor */
5321
- interface PicassoAssigned {
5322
- }
5323
- /** Unassigned Picasso */
5324
- interface PicassoUnassigned {
5325
- }
5326
- /** Assigned Wixel */
5327
- interface WixelAssigned {
5328
- }
5329
- /** Unassigned Wixel */
5330
- interface WixelUnassigned {
5331
- }
5332
- /** Assigned StudioTwo */
5333
- interface StudioTwoAssigned {
5334
- }
5335
- /** Unassigned StudioTwo */
5336
- interface StudioTwoUnassigned {
5337
- }
5338
- /** Media from user domain is enabled. */
5339
- interface UserDomainMediaEnabled {
5340
- }
5341
- /** Media from user domain is disabled. */
5342
- interface UserDomainMediaDisabled {
5343
- }
5344
- /** Assigned Editorless */
5345
- interface EditorlessAssigned {
5346
- }
5347
- /** Unassigned Editorless */
5348
- interface EditorlessUnassigned {
5349
- }
5350
- interface HasCustomEmailConfigurationsRequest {
5351
- }
5352
- interface HasCustomEmailConfigurationsResponse {
5353
- hasCustomConfigurations?: boolean;
5354
- }
5355
- interface AddToAutomationMigrationPopulationRequest {
5356
- /** When true, sends custom email configurations to automation system via email */
5357
- sendCustomEmailConfigs?: boolean;
5358
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5359
- origin?: OriginWithLiterals;
5360
- }
5361
- declare enum Origin {
5362
- OPT_IN = "OPT_IN",
5363
- MIGRATION = "MIGRATION"
5364
- }
5365
- /** @enumType */
5366
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5367
- interface AddToAutomationMigrationPopulationResponse {
5368
- success?: boolean;
5369
- }
5370
- interface IsInAutomationMigrationPopulationRequest {
5371
- }
5372
- interface IsInAutomationMigrationPopulationResponse {
5373
- inPopulation?: boolean;
5374
- }
5375
- interface PreparePaymentCollectionRequest {
5333
+ interface OrderTransactions {
5376
5334
  /**
5377
- * Ecom order ID.
5378
- * @minLength 1
5379
- * @maxLength 100
5335
+ * Order ID.
5336
+ * @format GUID
5380
5337
  */
5381
- ecomOrderId: string;
5382
- /** Amount to collect */
5383
- amount: Price;
5338
+ orderId?: string;
5384
5339
  /**
5385
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5386
- * Existing payment gateway order will be updated with a new amount.
5387
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5340
+ * Record of payments made to the merchant.
5341
+ * @maxSize 100
5388
5342
  */
5389
- paymentGatewayOrderId?: string | null;
5343
+ payments?: Payment[];
5390
5344
  /**
5391
- * Whether to delay capture of the payment.
5392
- * Default: false
5393
- * @deprecated Whether to delay capture of the payment.
5394
- * Default: false
5395
- * @replacedBy delayed_capture_settings.scheduled_action
5396
- * @targetRemovalDate 2024-09-30
5345
+ * Record of refunds made to the buyer.
5346
+ * @maxSize 300
5397
5347
  */
5398
- delayedCapture?: boolean;
5348
+ refunds?: Refund[];
5349
+ }
5350
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5351
+ /** Regular payment details. */
5352
+ regularPaymentDetails?: RegularPaymentDetails;
5353
+ /** Gift card payment details. */
5354
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5355
+ /** Membership payment details. */
5356
+ membershipPaymentDetails?: MembershipPaymentDetails;
5399
5357
  /**
5400
- * Specifies whether payment collection is initiated by Merchant or User of User
5401
- * Default: `true`
5358
+ * Receipt created by Wix
5402
5359
  * @internal
5403
5360
  */
5404
- merchantInitiated?: boolean | null;
5361
+ wixReceipt?: WixReceiptInfo;
5405
5362
  /**
5406
- * Redirect urls which are used to return buyer to third party system.
5363
+ * Receipt created by an external system.
5407
5364
  * @internal
5408
5365
  */
5409
- redirectUrls?: RedirectUrls;
5410
- /** Delayed capture payment settings */
5411
- delayedCaptureSettings?: DelayedCaptureSettings;
5412
- }
5413
- interface RedirectUrls {
5366
+ externalReceipt?: ExternalReceiptInfo;
5367
+ /** @internal */
5368
+ canceled?: CanceledStatusDetails;
5369
+ /** @internal */
5370
+ declined?: DeclinedStatusDetails;
5371
+ /** @internal */
5372
+ voided?: VoidedStatusDetails;
5414
5373
  /**
5415
- * URL to redirect buyer in case of approved (successful) transaction
5416
- * @format WEB_URL
5374
+ * Payment ID.
5375
+ * @format GUID
5376
+ * @readonly
5417
5377
  */
5418
- successUrl?: string | null;
5378
+ _id?: string | null;
5379
+ /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
5380
+ _createdDate?: Date | null;
5419
5381
  /**
5420
- * URL to redirect buyer in case of buyer canceled the transaction
5421
- * @format WEB_URL
5382
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5383
+ * @readonly
5422
5384
  */
5423
- cancelUrl?: string | null;
5385
+ _updatedDate?: Date | null;
5386
+ /** Payment amount. */
5387
+ amount?: Price;
5424
5388
  /**
5425
- * URL to redirect buyer in case of failed/rejected transaction
5426
- * @format WEB_URL
5389
+ * Whether refunds for this payment are disabled.
5390
+ * + `true`: This payment is not refundable.
5391
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5427
5392
  */
5428
- errorUrl?: string | null;
5393
+ refundDisabled?: boolean;
5429
5394
  /**
5430
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5431
- * @format WEB_URL
5395
+ * Whether receipt generation is allowed for this payment.
5396
+ * + `true`: This payment supports receipt generation.
5397
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5398
+ * @readonly
5432
5399
  */
5433
- pendingUrl?: string | null;
5434
- }
5435
- interface DelayedCaptureSettings {
5436
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5437
- scheduledAction?: ScheduledActionWithLiterals;
5438
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5439
- delayDuration?: Duration;
5440
- }
5441
- declare enum ScheduledAction {
5442
- /** Whether payment will be auto-voided when duration passes */
5443
- VOID = "VOID",
5444
- /** Whether payment will be auto-captured when duration passes */
5445
- CAPTURE = "CAPTURE"
5446
- }
5447
- /** @enumType */
5448
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5449
- interface Duration {
5400
+ supportReceiptGeneration?: boolean;
5401
+ /** Details about cash rounding applied to this payment, when relevant. */
5402
+ cashRounding?: CashRoundingDetails;
5450
5403
  /**
5451
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5452
- * @min 1
5404
+ * Overall payment status.
5405
+ *
5406
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5453
5407
  */
5454
- count?: number;
5455
- /** Duration unit: MINUTES, HOURS and DAYS */
5456
- unit?: DurationUnitWithLiterals;
5457
- }
5458
- declare enum DurationUnit {
5459
- MINUTES = "MINUTES",
5460
- HOURS = "HOURS",
5461
- DAYS = "DAYS"
5462
- }
5463
- /** @enumType */
5464
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5465
- interface PreparePaymentCollectionResponse {
5466
- /** Payment gateway order id which is associated with given payment */
5467
- paymentGatewayOrderId?: string;
5468
- }
5469
- interface GetPaymentCollectabilityStatusRequest {
5408
+ status?: PaymentStatusWithLiterals;
5470
5409
  /**
5471
- * Ecom order ID.
5472
- * @minLength 1
5473
- * @maxLength 100
5410
+ * Detailed payment status information including gateway reason codes and status-specific details.
5411
+ * @internal
5474
5412
  */
5475
- ecomOrderId: string;
5476
- }
5477
- interface GetPaymentCollectabilityStatusResponse {
5478
- /** Payment collectability status */
5479
- status?: PaymentCollectabilityStatusWithLiterals;
5480
- /** Collectable order amount */
5481
- amount?: Price;
5413
+ paymentStatusDetails?: PaymentStatusDetails;
5482
5414
  /**
5483
- * Whether authorization supported
5415
+ * Location where the payment was processed.
5484
5416
  * @internal
5417
+ * @format GUID
5418
+ * @immutable
5485
5419
  */
5486
- authorizationSupported?: boolean;
5420
+ locationId?: string | null;
5487
5421
  /**
5488
- * Whether custom amount is supported for payment collection
5489
- * @internal
5422
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5423
+ * @format GUID
5490
5424
  */
5491
- customAmountSupported?: boolean;
5425
+ chargeCorrelationId?: string | null;
5492
5426
  }
5493
- declare enum PaymentCollectabilityStatus {
5494
- UNKNOWN = "UNKNOWN",
5495
- COLLECTABLE = "COLLECTABLE",
5496
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5497
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5498
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5499
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5500
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5501
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5502
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5503
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5504
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5505
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5506
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5427
+ /** @oneof */
5428
+ interface PaymentPaymentDetailsOneOf {
5429
+ /** Regular payment details. */
5430
+ regularPaymentDetails?: RegularPaymentDetails;
5431
+ /** Gift card payment details. */
5432
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5433
+ /** Membership payment details. */
5434
+ membershipPaymentDetails?: MembershipPaymentDetails;
5507
5435
  }
5508
- /** @enumType */
5509
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5510
- interface RecordManuallyCollectedPaymentRequest {
5511
- /**
5512
- * Order ID.
5513
- * @minLength 1
5514
- * @maxLength 100
5515
- */
5516
- orderId: string;
5517
- /** Amount to be recorded as approved manual payment for given order */
5518
- amount: Price;
5436
+ /** @oneof */
5437
+ interface PaymentReceiptInfoOneOf {
5519
5438
  /**
5520
- * Payment method name provided by user.
5521
- *
5522
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5439
+ * Receipt created by Wix
5523
5440
  * @internal
5524
5441
  */
5525
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5526
- }
5527
- /**
5528
- * User-defined payment method name.
5529
- * Allows specifying either a predefined type or a custom name.
5530
- */
5531
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5532
- /** Predefined payment method. */
5533
- predefined?: PredefinedPaymentMethodWithLiterals;
5442
+ wixReceipt?: WixReceiptInfo;
5534
5443
  /**
5535
- * Custom payment method name provided by user.
5536
- *
5537
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5538
- * @minLength 1
5539
- * @maxLength 150
5444
+ * Receipt created by an external system.
5445
+ * @internal
5540
5446
  */
5541
- custom?: string | null;
5447
+ externalReceipt?: ExternalReceiptInfo;
5542
5448
  }
5543
5449
  /** @oneof */
5544
- interface UserDefinedPaymentMethodNameKindOneOf {
5545
- /** Predefined payment method. */
5546
- predefined?: PredefinedPaymentMethodWithLiterals;
5450
+ interface PaymentStatusDetailsOneOf {
5451
+ /** @internal */
5452
+ canceled?: CanceledStatusDetails;
5453
+ /** @internal */
5454
+ declined?: DeclinedStatusDetails;
5455
+ /** @internal */
5456
+ voided?: VoidedStatusDetails;
5457
+ }
5458
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5459
+ /** Credit card details. */
5460
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5547
5461
  /**
5548
- * Custom payment method name provided by user.
5549
- *
5550
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5551
- * @minLength 1
5552
- * @maxLength 150
5462
+ * Wix Payments order ID.
5463
+ * @maxLength 100
5553
5464
  */
5554
- custom?: string | null;
5555
- }
5556
- /** Predefined payment method types for offline/manual payments. */
5557
- declare enum PredefinedPaymentMethod {
5558
- /** Cash payment. */
5559
- CASH = "CASH",
5560
- /** Bank transfer. */
5561
- BANK_TRANSFER = "BANK_TRANSFER",
5562
- /** Payment by check. */
5563
- CHECK = "CHECK"
5564
- }
5565
- /** @enumType */
5566
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5567
- interface RecordManuallyCollectedPaymentResponse {
5568
- }
5569
- interface MarkOrderAsPaidRequest {
5465
+ paymentOrderId?: string | null;
5570
5466
  /**
5571
- * Ecom order ID.
5572
- * @minLength 1
5467
+ * Payment gateway's transaction ID.
5468
+ * This field is only returned when the value of `offline_payment` is `false`.
5573
5469
  * @maxLength 100
5574
5470
  */
5575
- ecomOrderId: string;
5471
+ gatewayTransactionId?: string | null;
5576
5472
  /**
5577
- * Payment method name provided by user.
5578
- *
5579
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5580
- * @internal
5473
+ * Payment method.
5474
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5475
+ * Non-exhaustive list of supported values:
5476
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5477
+ * @maxLength 150
5478
+ * @deprecated Payment method.
5479
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5480
+ * Non-exhaustive list of supported values:
5481
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5482
+ * @replacedBy payment_method_name
5483
+ * @targetRemovalDate 2026-07-01
5581
5484
  */
5582
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5583
- }
5584
- interface MarkOrderAsPaidResponse {
5585
- /** Updated order. */
5586
- order?: Order;
5587
- }
5588
- interface BulkMarkOrdersAsPaidRequest {
5485
+ paymentMethod?: string | null;
5589
5486
  /**
5590
- * IDs of orders to mark as paid.
5591
- * @minSize 1
5592
- * @maxSize 100
5593
- * @minLength 1
5487
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5594
5488
  * @maxLength 100
5595
5489
  */
5596
- ecomOrderIds: string[];
5597
- }
5598
- interface BulkMarkOrdersAsPaidResponse {
5490
+ providerTransactionId?: string | null;
5491
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5492
+ offlinePayment?: boolean;
5599
5493
  /**
5600
- * Items updated by the bulk action.
5601
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5494
+ * Payment status.
5495
+ * @deprecated Payment status.
5496
+ * @replacedBy payment.status
5497
+ * @targetRemovalDate 2026-11-01
5602
5498
  */
5603
- results?: BulkOrderResult[];
5604
- /** Bulk action metadata. */
5605
- bulkActionMetadata?: BulkActionMetadata;
5606
- }
5607
- interface BulkOrderResult {
5608
- /** Item metadata. */
5609
- itemMetadata?: ItemMetadata;
5499
+ status?: TransactionStatusWithLiterals;
5500
+ /** Whether there is a payment agreement that allows for future charges. */
5501
+ savedPaymentMethod?: boolean;
5502
+ /** Authorization details. */
5503
+ authorizationDetails?: AuthorizationDetails;
5610
5504
  /**
5611
- * Updated order.
5612
- *
5613
- * Returned when `returnFullEntity = true`.
5505
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5506
+ * @internal
5507
+ * @maxLength 300
5614
5508
  */
5615
- item?: Order;
5616
- }
5617
- interface ItemMetadata {
5618
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5619
- _id?: string | null;
5620
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5621
- originalIndex?: number;
5622
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5623
- success?: boolean;
5624
- /** Details about the error in case of failure. */
5625
- error?: ApplicationError;
5626
- }
5627
- interface ApplicationError {
5628
- /** Error code. */
5629
- code?: string;
5630
- /** Description of the error. */
5631
- description?: string;
5632
- /** Data related to the error. */
5633
- data?: Record<string, any> | null;
5634
- }
5635
- interface BulkActionMetadata {
5636
- /** Number of items that were successfully processed. */
5637
- totalSuccesses?: number;
5638
- /** Number of items that couldn't be processed. */
5639
- totalFailures?: number;
5640
- /** Number of failures without details because detailed failure threshold was exceeded. */
5641
- undetailedFailures?: number;
5642
- }
5643
- interface GetRefundabilityStatusRequest {
5509
+ paymentProvider?: string | null;
5644
5510
  /**
5645
- * Order ID.
5646
- * @minLength 1
5647
- * @maxLength 100
5511
+ * Record of chargebacks made by the buyer.
5512
+ * @maxSize 6
5648
5513
  */
5649
- ecomOrderId: string;
5650
- }
5651
- interface GetRefundabilityStatusResponse {
5514
+ chargebacks?: Chargeback[];
5652
5515
  /**
5653
- * Refundability details.
5654
- * @maxSize 300
5516
+ * Payment method ID.
5517
+ * @internal
5518
+ * @maxLength 36
5655
5519
  */
5656
- refundabilities?: Refundability[];
5520
+ paymentMethodId?: string | null;
5521
+ /** Platform fee amount associated with this payment. */
5522
+ platformFee?: Price;
5657
5523
  /**
5658
- * Whether the order supports refunding per item.
5659
- * @deprecated
5524
+ * Payment method with buyer and optional owner translations.
5525
+ * Non-exhaustive list of supported values:
5526
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5660
5527
  */
5661
- refundablePerItem?: boolean;
5662
- }
5663
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5664
- /** Reason why payment is not refundable. */
5665
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5666
- /** Reason why payment is only refundable manually. */
5667
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5668
- /** Payment ID. */
5669
- paymentId?: string;
5670
- /** Payment refundability status. */
5671
- refundabilityStatus?: RefundableStatusWithLiterals;
5672
- /** Link to payment provider dashboard. */
5673
- providerLink?: string | null;
5528
+ paymentMethodName?: PaymentMethodName;
5674
5529
  }
5675
5530
  /** @oneof */
5676
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5677
- /** Reason why payment is not refundable. */
5678
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5679
- /** Reason why payment is only refundable manually. */
5680
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5681
- }
5682
- declare enum RefundableStatus {
5683
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5684
- MANUAL = "MANUAL",
5685
- REFUNDABLE = "REFUNDABLE"
5686
- }
5687
- /** @enumType */
5688
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5689
- declare enum NonRefundableReason {
5690
- NONE = "NONE",
5691
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5692
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5693
- INTERNAL_ERROR = "INTERNAL_ERROR",
5694
- NOT_PAID = "NOT_PAID",
5695
- ACCESS_DENIED = "ACCESS_DENIED",
5696
- ZERO_PRICE = "ZERO_PRICE",
5697
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5698
- PENDING_REFUND = "PENDING_REFUND",
5699
- FORBIDDEN = "FORBIDDEN",
5700
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5701
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5702
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5531
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5532
+ /** Credit card details. */
5533
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5703
5534
  }
5704
- /** @enumType */
5705
- type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5706
- declare enum ManuallyRefundableReason {
5707
- EXPIRED = "EXPIRED",
5708
- NOT_SUPPORTED = "NOT_SUPPORTED",
5709
- OFFLINE = "OFFLINE",
5710
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5535
+ declare enum TransactionStatus {
5536
+ UNDEFINED = "UNDEFINED",
5537
+ APPROVED = "APPROVED",
5538
+ PENDING = "PENDING",
5539
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5540
+ CANCELED = "CANCELED",
5541
+ DECLINED = "DECLINED",
5542
+ REFUNDED = "REFUNDED",
5543
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5544
+ AUTHORIZED = "AUTHORIZED",
5545
+ VOIDED = "VOIDED"
5711
5546
  }
5712
5547
  /** @enumType */
5713
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5714
- interface CreatePaymentGatewayOrderRequest {
5548
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5549
+ interface CreditCardPaymentMethodDetails {
5715
5550
  /**
5716
- * Ecom order ID.
5717
- * @minLength 1
5551
+ * The last 4 digits of the card number.
5552
+ * @maxLength 4
5553
+ */
5554
+ lastFourDigits?: string | null;
5555
+ /**
5556
+ * Card issuer's brand.
5718
5557
  * @maxLength 100
5719
5558
  */
5720
- ecomOrderId: string;
5721
- /** Information about the user who initiated the payment. */
5722
- chargedBy?: ChargedBy;
5559
+ brand?: string | null;
5560
+ }
5561
+ interface AuthorizationDetails {
5723
5562
  /**
5724
- * Whether to delay capture of the payment.
5725
- *
5726
- * Default: false
5727
- * @internal
5563
+ * Whether the authorized payment is of a delayed capture.
5564
+ * @readonly
5728
5565
  */
5729
5566
  delayedCapture?: boolean;
5567
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5568
+ authorizedDate?: Date | null;
5569
+ /**
5570
+ * List of captures associated with payment
5571
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5572
+ * @maxSize 1
5573
+ */
5574
+ captures?: AuthorizationCapture[];
5575
+ /** Void associated with payment */
5576
+ void?: AuthorizationVoid;
5577
+ /** Scheduled action for this transaction */
5578
+ scheduledAction?: V1ScheduledAction;
5730
5579
  }
5731
- interface ChargedBy {
5580
+ interface AuthorizationCapture {
5732
5581
  /**
5733
- * ID - id of the user who initiated the payment
5582
+ * Capture ID.
5734
5583
  * @format GUID
5584
+ * @readonly
5735
5585
  */
5736
- _id?: string;
5586
+ _id?: string | null;
5587
+ /** Status of this capture action */
5588
+ status?: AuthorizationCaptureStatusWithLiterals;
5737
5589
  /**
5738
- * Full name - name of the user who initiated the payment
5739
- * @minLength 1
5740
- * @maxLength 200
5590
+ * Amount of this capture
5591
+ * @immutable
5741
5592
  */
5742
- fullName?: string | null;
5593
+ amount?: Price;
5594
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5595
+ _createdDate?: Date | null;
5596
+ /** In case of status is FAILED may contain failure details */
5597
+ failureDetails?: AuthorizationActionFailureDetails;
5743
5598
  }
5744
- interface CreatePaymentGatewayOrderResponse {
5745
- /** ID of the order created in the payment gateway */
5746
- paymentGatewayOrderId?: string;
5599
+ declare enum AuthorizationCaptureStatus {
5600
+ /** Capture operation still in progress. */
5601
+ PENDING = "PENDING",
5602
+ /** Capture operation succeeded. */
5603
+ SUCCEEDED = "SUCCEEDED",
5604
+ /** Capture operation failed. */
5605
+ FAILED = "FAILED"
5747
5606
  }
5748
- interface ChargeMembershipsRequest {
5749
- /**
5750
- * Order ID.
5751
- * @minLength 1
5752
- * @maxLength 100
5753
- */
5754
- ecomOrderId: string;
5607
+ /** @enumType */
5608
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5609
+ interface AuthorizationActionFailureDetails {
5610
+ /** @maxLength 100 */
5611
+ failureCode?: string;
5612
+ }
5613
+ interface AuthorizationVoid {
5614
+ /** Status of this void action */
5615
+ status?: AuthorizationVoidStatusWithLiterals;
5616
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5617
+ voidedDate?: Date | null;
5618
+ /** In case of status is FAILED may contain failure details */
5619
+ failureDetails?: AuthorizationActionFailureDetails;
5620
+ /** Reason of void action */
5621
+ reason?: ReasonWithLiterals;
5622
+ }
5623
+ declare enum AuthorizationVoidStatus {
5624
+ /** Void operation still in progress. */
5625
+ PENDING = "PENDING",
5626
+ /** Void operation succeeded. */
5627
+ SUCCEEDED = "SUCCEEDED",
5628
+ /** Void operation failed. */
5629
+ FAILED = "FAILED"
5630
+ }
5631
+ /** @enumType */
5632
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5633
+ /** Reason the authorization was voided. */
5634
+ declare enum Reason {
5635
+ /** Authorization was voided by user. */
5636
+ MANUAL = "MANUAL",
5637
+ /** Authorization passed execution date. */
5638
+ SCHEDULED = "SCHEDULED"
5639
+ }
5640
+ /** @enumType */
5641
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5642
+ interface V1ScheduledAction {
5643
+ /** Type of the action. */
5644
+ actionType?: ActionTypeWithLiterals;
5645
+ /** The date and time of the action. */
5646
+ executionDate?: Date | null;
5647
+ }
5648
+ declare enum ActionType {
5649
+ VOID = "VOID",
5650
+ CAPTURE = "CAPTURE"
5651
+ }
5652
+ /** @enumType */
5653
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5654
+ interface Chargeback {
5755
5655
  /**
5756
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5757
- * but a user which is using the membership on behalf of the a member
5656
+ * Chargeback ID.
5758
5657
  * @format GUID
5658
+ * @readonly
5659
+ * @immutable
5759
5660
  */
5760
- memberId: string;
5661
+ _id?: string;
5761
5662
  /**
5762
- * List of items to be paid by memberships
5763
- * @minSize 1
5764
- * @maxSize 300
5663
+ * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5664
+ * @readonly
5665
+ * @immutable
5765
5666
  */
5766
- membershipCharges?: MembershipChargeItem[];
5767
- }
5768
- interface MembershipChargeItem {
5667
+ _createdDate?: Date | null;
5769
5668
  /**
5770
- * The id of used membership
5771
- * @minLength 1
5772
- * @maxLength 100
5669
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5670
+ * @readonly
5773
5671
  */
5774
- membershipId?: string;
5672
+ _updatedDate?: Date | null;
5775
5673
  /**
5776
- * ID of the application providing this payment option
5777
- * @format GUID
5674
+ * Amount.
5675
+ * @readonly
5676
+ * @immutable
5778
5677
  */
5779
- appId?: string;
5780
- /** The name of used membership */
5781
- membershipName?: MembershipName;
5782
- /** Additional data about this membership */
5783
- membershipAdditionalData?: Record<string, any> | null;
5784
- /** Catalog and item reference info. */
5785
- catalogReference?: CatalogReference;
5786
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5787
- serviceProperties?: ServiceProperties;
5678
+ amount?: Price;
5788
5679
  /**
5789
- * Usually would be the same as catalogReference.catalogItemId
5790
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5791
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5792
- * @minLength 1
5793
- * @maxLength 36
5680
+ * Reversal amount. Present only when status is REVERSED.
5681
+ * @readonly
5794
5682
  */
5795
- rootCatalogItemId?: string | null;
5683
+ reversalAmount?: Price;
5796
5684
  /**
5797
- * line item id of Checkout/Order line item
5798
- * @minLength 1
5799
- * @maxLength 100
5685
+ * Status.
5686
+ *
5687
+ * Default: `"APPROVED"`.
5800
5688
  */
5801
- lineItemId?: string;
5689
+ status?: ChargebackStatusWithLiterals;
5690
+ /**
5691
+ * External chargeback ID.
5692
+ * @format GUID
5693
+ * @readonly
5694
+ * @immutable
5695
+ */
5696
+ externalId?: string | null;
5802
5697
  }
5803
- interface MembershipName {
5698
+ declare enum ChargebackStatus {
5699
+ /** Chargeback was approved. */
5700
+ APPROVED = "APPROVED",
5701
+ /** Chargeback was reversed. */
5702
+ REVERSED = "REVERSED"
5703
+ }
5704
+ /** @enumType */
5705
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5706
+ interface PaymentMethodName {
5804
5707
  /**
5805
- * Membership name in the site's original language.
5806
- * @maxLength 100
5708
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5709
+ * @maxLength 150
5807
5710
  */
5808
- original?: string;
5711
+ buyerLanguageName?: string | null;
5809
5712
  /**
5810
- * Membership name translated into the buyer's language.
5713
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5811
5714
  *
5812
- * Default: The value of `original`
5813
- * @maxLength 100
5715
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5716
+ * @maxLength 150
5814
5717
  */
5815
- translated?: string | null;
5816
- }
5817
- interface ChargeMembershipsResponse {
5718
+ siteLanguageName?: string | null;
5719
+ /**
5720
+ * User-provided payment method name.
5721
+ *
5722
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5723
+ */
5724
+ userDefinedName?: UserDefinedPaymentMethodName;
5818
5725
  }
5819
- interface TriggerRefundRequest {
5726
+ interface GiftCardPaymentDetails {
5820
5727
  /**
5821
- * The order this refund related to
5822
- * @minLength 1
5728
+ * Gift card payment ID.
5823
5729
  * @maxLength 100
5824
5730
  */
5825
- ecomOrderId: string;
5731
+ giftCardPaymentId?: string;
5826
5732
  /**
5827
- * Refund operations information
5828
- * @minSize 1
5829
- * @maxSize 1
5733
+ * Gift card ID.
5734
+ * @internal
5735
+ * @deprecated
5830
5736
  */
5831
- payments: PaymentRefund[];
5832
- /** Business model of a refund */
5833
- details?: RefundDetails;
5834
- /** Side effect details related to refund */
5835
- sideEffects?: RefundSideEffects;
5836
- }
5837
- interface PaymentRefund {
5737
+ giftCardId?: string;
5838
5738
  /**
5839
- * Specific payment within the order to refund
5739
+ * ID of the app that created the gift card.
5840
5740
  * @format GUID
5841
5741
  */
5842
- paymentId?: string;
5843
- /** Refund amount. Not relevant for membership and gift card refunds. */
5844
- amount?: Price;
5742
+ appId?: string;
5845
5743
  /**
5846
- * Whether refund is made externally and manually (on the payment provider's side)
5847
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5848
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5744
+ * Whether the gift card is voided.
5745
+ * @readonly
5746
+ * @deprecated Whether the gift card is voided.
5747
+ * @replacedBy payment.status
5748
+ * @targetRemovalDate 2026-11-01
5849
5749
  */
5850
- externalRefund?: boolean;
5750
+ voided?: boolean;
5851
5751
  /**
5852
- * Gateway refund id. When param is present, new refund is not created.
5853
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5854
- * and all side effects from request will be executed.
5855
- * @internal
5752
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5753
+ * @maxLength 30
5754
+ * @immutable
5755
+ */
5756
+ obfuscatedCode?: string | null;
5757
+ }
5758
+ interface MembershipPaymentDetails {
5759
+ /**
5760
+ * Membership ID.
5761
+ * @maxLength 200
5762
+ */
5763
+ membershipId?: string;
5764
+ /**
5765
+ * ID of the line item this membership applies to.
5856
5766
  * @minLength 1
5857
5767
  * @maxLength 100
5858
5768
  */
5859
- gatewayRefundId?: string | null;
5860
- }
5861
- interface RefundSideEffects {
5862
- /** Inventory restock details as part of this refund. */
5863
- restockInfo?: RestockInfo;
5864
- /** Whether to send a refund confirmation email to the customer. */
5865
- sendOrderRefundedEmail?: boolean;
5769
+ lineItemId?: string;
5866
5770
  /**
5867
- * Custom message added to the refund confirmation email.
5771
+ * Payment status.
5772
+ * @deprecated Payment status.
5773
+ * @replacedBy payment.status
5774
+ * @targetRemovalDate 2026-11-01
5775
+ */
5776
+ status?: MembershipPaymentStatusWithLiterals;
5777
+ /** Membership name. */
5778
+ name?: MembershipName;
5779
+ /**
5780
+ * The transaction ID in the membership system. Can be used to void the transaction.
5868
5781
  * @minLength 1
5869
- * @maxLength 1000
5782
+ * @maxLength 100
5870
5783
  */
5871
- customMessage?: string | null;
5872
- }
5873
- interface RestockInfo {
5874
- /** Restock type. */
5875
- type?: RestockTypeWithLiterals;
5784
+ externalTransactionId?: string | null;
5876
5785
  /**
5877
- * Deprecated, use items instead
5878
- * @internal
5879
- * @maxSize 300
5880
- * @deprecated
5786
+ * Whether the membership is voided.
5787
+ * @readonly
5788
+ * @deprecated Whether the membership is voided.
5789
+ * @replacedBy payment.status
5790
+ * @targetRemovalDate 2026-11-01
5881
5791
  */
5882
- lineItemIds?: string[];
5792
+ voided?: boolean;
5883
5793
  /**
5884
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5885
- * @maxSize 300
5794
+ * ID of the application providing this payment option.
5795
+ * @format GUID
5886
5796
  */
5887
- items?: RestockItem[];
5797
+ providerAppId?: string;
5798
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5799
+ futureMembership?: FutureMembershipDetails;
5888
5800
  }
5889
- declare enum RestockType {
5890
- NO_ITEMS = "NO_ITEMS",
5891
- ALL_ITEMS = "ALL_ITEMS",
5892
- SOME_ITEMS = "SOME_ITEMS"
5801
+ declare enum MembershipPaymentStatus {
5802
+ /** Payment was charged. */
5803
+ CHARGED = "CHARGED",
5804
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5805
+ CHARGE_FAILED = "CHARGE_FAILED",
5806
+ /** Payment is pending. */
5807
+ CHARGE_PENDING = "CHARGE_PENDING",
5808
+ /** Payment was voided. */
5809
+ VOIDED = "VOIDED"
5893
5810
  }
5894
5811
  /** @enumType */
5895
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5896
- interface RestockItem {
5812
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5813
+ interface FutureMembershipDetails {
5897
5814
  /**
5898
- * ID of the line item being restocked.
5815
+ * ID of the plan line item in the order from which the membership will be created.
5899
5816
  * @format GUID
5900
5817
  */
5901
5818
  lineItemId?: string;
5902
5819
  /**
5903
- * Line item quantity being restocked.
5904
- * @min 1
5905
- * @max 100000
5906
- */
5907
- quantity?: number;
5908
- /**
5909
- * Per-location breakdown of restock quantities.
5910
- * @internal
5911
- * @maxSize 5
5820
+ * ID of the benefit the future membership will grant.
5821
+ * @maxLength 200
5912
5822
  */
5913
- restockLocations?: RestockLocation[];
5914
- }
5915
- interface TriggerRefundResponse {
5916
- /** All order's transactions after the refunds were added */
5917
- orderTransactions?: OrderTransactions;
5918
- /** Created refund ID */
5919
- refundId?: string | null;
5920
- /** Payment ID's that the refund execution had failed for */
5921
- failedPaymentIds?: ItemMetadata[];
5823
+ benefitId?: string;
5922
5824
  }
5923
- /**
5924
- * A record of all payments and refunds associated with an order.
5925
- *
5926
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5927
- */
5928
- interface OrderTransactions {
5825
+ interface WixReceiptInfo {
5929
5826
  /**
5930
- * Order ID.
5827
+ * Receipt ID
5931
5828
  * @format GUID
5932
5829
  */
5933
- orderId?: string;
5830
+ receiptId?: string;
5934
5831
  /**
5935
- * Record of payments made to the merchant.
5936
- * @maxSize 100
5832
+ * Display number of receipt
5833
+ * @minLength 1
5834
+ * @maxLength 40
5937
5835
  */
5938
- payments?: Payment[];
5836
+ displayNumber?: string | null;
5837
+ }
5838
+ interface ExternalReceiptInfo {
5939
5839
  /**
5940
- * Record of refunds made to the buyer.
5941
- * @maxSize 300
5840
+ * External receipt ID
5841
+ * @maxLength 100
5942
5842
  */
5943
- refunds?: Refund[];
5944
- }
5945
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5946
- /** Regular payment details. */
5947
- regularPaymentDetails?: RegularPaymentDetails;
5948
- /** Gift card payment details. */
5949
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5950
- /** Membership payment details. */
5951
- membershipPaymentDetails?: MembershipPaymentDetails;
5952
- /**
5953
- * Receipt created by Wix
5954
- * @internal
5955
- */
5956
- wixReceipt?: WixReceiptInfo;
5957
- /**
5958
- * Receipt created by an external system.
5959
- * @internal
5960
- */
5961
- externalReceipt?: ExternalReceiptInfo;
5962
- /** @internal */
5963
- canceled?: CanceledStatusDetails;
5964
- /** @internal */
5965
- declined?: DeclinedStatusDetails;
5966
- /** @internal */
5967
- voided?: VoidedStatusDetails;
5843
+ receiptId?: string | null;
5968
5844
  /**
5969
- * Payment ID.
5845
+ * ID of the app providing the receipt
5970
5846
  * @format GUID
5971
- * @readonly
5972
5847
  */
5973
- _id?: string | null;
5974
- /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
5975
- _createdDate?: Date | null;
5848
+ appId?: string | null;
5976
5849
  /**
5977
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5978
- * @readonly
5850
+ * Display number of receipt
5851
+ * @minLength 1
5852
+ * @maxLength 40
5979
5853
  */
5980
- _updatedDate?: Date | null;
5981
- /** Payment amount. */
5982
- amount?: Price;
5854
+ displayNumber?: string | null;
5855
+ }
5856
+ interface CashRoundingDetails {
5983
5857
  /**
5984
- * Whether refunds for this payment are disabled.
5985
- * + `true`: This payment is not refundable.
5986
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5858
+ * Payment amount before cash rounding was applied.
5859
+ * When provided, balance and status calculations use this value instead of `amount`
5860
+ * to prevent false overpayment or underpayment due to rounding.
5987
5861
  */
5988
- refundDisabled?: boolean;
5862
+ unroundedAmount?: Price;
5989
5863
  /**
5990
- * Whether receipt generation is allowed for this payment.
5991
- * + `true`: This payment supports receipt generation.
5992
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5864
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5865
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5993
5866
  * @readonly
5994
5867
  */
5995
- supportReceiptGeneration?: boolean;
5996
- /** Details about cash rounding applied to this payment, when relevant. */
5997
- cashRounding?: CashRoundingDetails;
5868
+ roundingAdjustment?: CashRounding;
5869
+ }
5870
+ declare enum PaymentStatus {
5871
+ /** Payment was charged successfully. */
5872
+ APPROVED = "APPROVED",
5873
+ /** Payment is being processed and hasn't been confirmed yet. */
5874
+ PENDING = "PENDING",
5875
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5876
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5877
+ /** Payment was canceled before it was charged. */
5878
+ CANCELED = "CANCELED",
5879
+ /** Payment was declined by the payment provider. */
5880
+ DECLINED = "DECLINED",
5881
+ /** Payment was fully refunded. */
5882
+ REFUNDED = "REFUNDED",
5883
+ /** Part of the payment amount was refunded. */
5884
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5885
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5886
+ AUTHORIZED = "AUTHORIZED",
5998
5887
  /**
5999
- * Overall payment status.
5888
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6000
5889
  *
6001
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6002
- */
6003
- status?: PaymentStatusWithLiterals;
6004
- /**
6005
- * Detailed payment status information including gateway reason codes and status-specific details.
6006
- * @internal
6007
- */
6008
- paymentStatusDetails?: PaymentStatusDetails;
6009
- /**
6010
- * Location where the payment was processed.
6011
- * @internal
6012
- * @format GUID
6013
- * @immutable
6014
- */
6015
- locationId?: string | null;
6016
- /**
6017
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6018
- * @format GUID
5890
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6019
5891
  */
6020
- chargeCorrelationId?: string | null;
5892
+ VOIDED = "VOIDED"
6021
5893
  }
6022
- /** @oneof */
6023
- interface PaymentPaymentDetailsOneOf {
6024
- /** Regular payment details. */
6025
- regularPaymentDetails?: RegularPaymentDetails;
6026
- /** Gift card payment details. */
6027
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6028
- /** Membership payment details. */
6029
- membershipPaymentDetails?: MembershipPaymentDetails;
5894
+ /** @enumType */
5895
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5896
+ interface CanceledStatusDetails {
5897
+ reason?: CanceledReasonWithLiterals;
6030
5898
  }
6031
- /** @oneof */
6032
- interface PaymentReceiptInfoOneOf {
6033
- /**
6034
- * Receipt created by Wix
6035
- * @internal
6036
- */
6037
- wixReceipt?: WixReceiptInfo;
5899
+ declare enum CanceledReason {
5900
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5901
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5902
+ /** Payment was not completed by user and expired. */
5903
+ EXPIRED = "EXPIRED"
5904
+ }
5905
+ /** @enumType */
5906
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5907
+ interface DeclinedStatusDetails {
5908
+ reason?: DeclinedReasonWithLiterals;
5909
+ }
5910
+ declare enum DeclinedReason {
5911
+ /** Corresponding charge failed. */
5912
+ CHARGE_FAILED = "CHARGE_FAILED",
5913
+ /** Payment details expired. */
5914
+ EXPIRED = "EXPIRED",
5915
+ /** Insufficient funds. */
5916
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5917
+ /** Gift card was disabled before charge was attempted. */
5918
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5919
+ }
5920
+ /** @enumType */
5921
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5922
+ interface VoidedStatusDetails {
5923
+ reason?: VoidedReasonWithLiterals;
5924
+ }
5925
+ declare enum VoidedReason {
5926
+ /** Payment was voided by merchant request. */
5927
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5928
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5929
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5930
+ }
5931
+ /** @enumType */
5932
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5933
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5934
+ /** @internal */
5935
+ canceled?: CanceledStatusDetails;
5936
+ /** @internal */
5937
+ declined?: DeclinedStatusDetails;
5938
+ /** @internal */
5939
+ voided?: VoidedStatusDetails;
6038
5940
  /**
6039
- * Receipt created by an external system.
5941
+ * Reason code from the payment gateway.
6040
5942
  * @internal
5943
+ * @minLength 1
5944
+ * @maxLength 10
6041
5945
  */
6042
- externalReceipt?: ExternalReceiptInfo;
5946
+ paymentGatewayReasonCode?: string | null;
6043
5947
  }
6044
5948
  /** @oneof */
6045
- interface PaymentStatusDetailsOneOf {
5949
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6046
5950
  /** @internal */
6047
5951
  canceled?: CanceledStatusDetails;
6048
5952
  /** @internal */
@@ -6050,775 +5954,1055 @@ interface PaymentStatusDetailsOneOf {
6050
5954
  /** @internal */
6051
5955
  voided?: VoidedStatusDetails;
6052
5956
  }
6053
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6054
- /** Credit card details. */
6055
- creditCardDetails?: CreditCardPaymentMethodDetails;
5957
+ interface Refund {
6056
5958
  /**
6057
- * Wix Payments order ID.
6058
- * @maxLength 100
5959
+ * Refund ID.
5960
+ * @format GUID
5961
+ * @readonly
6059
5962
  */
6060
- paymentOrderId?: string | null;
5963
+ _id?: string;
6061
5964
  /**
6062
- * Payment gateway's transaction ID.
6063
- * This field is only returned when the value of `offline_payment` is `false`.
6064
- * @maxLength 100
5965
+ * List of transactions.
5966
+ * @maxSize 50
6065
5967
  */
6066
- gatewayTransactionId?: string | null;
5968
+ transactions?: RefundTransaction[];
5969
+ /** Refund business details. */
5970
+ details?: RefundDetails;
6067
5971
  /**
6068
- * Payment method.
6069
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6070
- * Non-exhaustive list of supported values:
6071
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6072
- * @maxLength 150
6073
- * @deprecated Payment method.
6074
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6075
- * Non-exhaustive list of supported values:
6076
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6077
- * @replacedBy payment_method_name
6078
- * @targetRemovalDate 2026-07-01
5972
+ * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5973
+ * @readonly
5974
+ * @immutable
6079
5975
  */
6080
- paymentMethod?: string | null;
5976
+ _createdDate?: Date | null;
6081
5977
  /**
6082
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6083
- * @maxLength 100
5978
+ * Aggregated refund summary.
5979
+ * @readonly
6084
5980
  */
6085
- providerTransactionId?: string | null;
6086
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6087
- offlinePayment?: boolean;
5981
+ summary?: AggregatedRefundSummary;
6088
5982
  /**
6089
- * Payment status.
6090
- * @deprecated Payment status.
6091
- * @replacedBy payment.status
6092
- * @targetRemovalDate 2026-11-01
5983
+ * ID of the app that initiated this refund.
5984
+ * @format GUID
5985
+ * @readonly
5986
+ * @immutable
6093
5987
  */
6094
- status?: TransactionStatusWithLiterals;
6095
- /** Whether there is a payment agreement that allows for future charges. */
6096
- savedPaymentMethod?: boolean;
6097
- /** Authorization details. */
6098
- authorizationDetails?: AuthorizationDetails;
5988
+ requestingServiceAppId?: string | null;
5989
+ }
5990
+ interface RefundTransaction {
6099
5991
  /**
6100
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6101
- * @internal
6102
- * @maxLength 300
5992
+ * ID of the payment associated with this refund.
5993
+ * @format GUID
5994
+ * @immutable
6103
5995
  */
6104
- paymentProvider?: string | null;
5996
+ paymentId?: string;
6105
5997
  /**
6106
- * Record of chargebacks made by the buyer.
6107
- * @maxSize 6
5998
+ * Refund amount.
5999
+ * @immutable
6108
6000
  */
6109
- chargebacks?: Chargeback[];
6001
+ amount?: Price;
6002
+ /** Refund status. */
6003
+ refundStatus?: RefundStatusWithLiterals;
6004
+ /** Optional details of current refund status. */
6005
+ refundStatusInfo?: RefundStatusInfo;
6110
6006
  /**
6111
- * Payment method ID.
6112
- * @internal
6113
- * @maxLength 36
6007
+ * Payment gateway's refund ID.
6008
+ * This field is only returned when the value of `external_refund` is `false`.
6009
+ * @format GUID
6114
6010
  */
6115
- paymentMethodId?: string | null;
6116
- /** Platform fee amount associated with this payment. */
6117
- platformFee?: Price;
6118
- /**
6119
- * Payment method with buyer and optional owner translations.
6120
- * Non-exhaustive list of supported values:
6121
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6011
+ gatewayRefundId?: string | null;
6012
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6013
+ providerRefundId?: string | null;
6014
+ /**
6015
+ * Whether refund was made externally and manually on the payment provider's side.
6016
+ * @immutable
6122
6017
  */
6123
- paymentMethodName?: PaymentMethodName;
6124
- }
6125
- /** @oneof */
6126
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6127
- /** Credit card details. */
6128
- creditCardDetails?: CreditCardPaymentMethodDetails;
6018
+ externalRefund?: boolean;
6019
+ /**
6020
+ * Location where the refund was processed.
6021
+ * @internal
6022
+ * @format GUID
6023
+ * @immutable
6024
+ */
6025
+ locationId?: string | null;
6129
6026
  }
6130
- declare enum TransactionStatus {
6131
- UNDEFINED = "UNDEFINED",
6132
- APPROVED = "APPROVED",
6027
+ /** Refund transaction status. */
6028
+ declare enum RefundStatus {
6029
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6133
6030
  PENDING = "PENDING",
6134
- PENDING_MERCHANT = "PENDING_MERCHANT",
6135
- CANCELED = "CANCELED",
6136
- DECLINED = "DECLINED",
6137
- REFUNDED = "REFUNDED",
6138
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6139
- AUTHORIZED = "AUTHORIZED",
6140
- VOIDED = "VOIDED"
6031
+ /** Refund transaction succeeded. */
6032
+ SUCCEEDED = "SUCCEEDED",
6033
+ /** Refund transaction failed. */
6034
+ FAILED = "FAILED",
6035
+ /** Refund request acknowledged, and will be executed soon. */
6036
+ SCHEDULED = "SCHEDULED",
6037
+ /** Refund was initiated on payment provider side. */
6038
+ STARTED = "STARTED"
6141
6039
  }
6142
6040
  /** @enumType */
6143
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6144
- interface CreditCardPaymentMethodDetails {
6041
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6042
+ interface RefundStatusInfo {
6145
6043
  /**
6146
- * The last 4 digits of the card number.
6147
- * @maxLength 4
6044
+ * Reason code for the refund's current status.
6045
+ *
6046
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6047
+ * @minLength 1
6048
+ * @maxLength 10
6148
6049
  */
6149
- lastFourDigits?: string | null;
6050
+ paymentGatewayReasonCode?: string | null;
6150
6051
  /**
6151
- * Card issuer's brand.
6152
- * @maxLength 100
6052
+ * Free text explanation of current refund status.
6053
+ * @minLength 1
6054
+ * @maxLength 1000
6153
6055
  */
6154
- brand?: string | null;
6056
+ description?: string | null;
6155
6057
  }
6156
- interface AuthorizationDetails {
6058
+ interface AggregatedRefundSummary {
6059
+ /** Total amount requested for refund. */
6060
+ requestedRefund?: Price;
6061
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6062
+ pendingRefund?: Price;
6063
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6064
+ refunded?: Price;
6065
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6066
+ failedRefundAmount?: Price;
6067
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6068
+ pending?: boolean;
6069
+ /** Breakdown of refunded items. Available only after refund is complete. */
6070
+ breakdown?: RefundItemsBreakdown;
6071
+ }
6072
+ interface RefundItemsBreakdown {
6157
6073
  /**
6158
- * Whether the authorized payment is of a delayed capture.
6159
- * @readonly
6074
+ * Refunded line items and the amount refunded for each.
6075
+ * @maxSize 300
6160
6076
  */
6161
- delayedCapture?: boolean;
6162
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6163
- authorizedDate?: Date | null;
6077
+ lineItems?: LineItemRefundSummary[];
6078
+ }
6079
+ interface LineItemRefundSummary {
6164
6080
  /**
6165
- * List of captures associated with payment
6166
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6167
- * @maxSize 1
6081
+ * ID of the refunded line item.
6082
+ * @format GUID
6168
6083
  */
6169
- captures?: AuthorizationCapture[];
6170
- /** Void associated with payment */
6171
- void?: AuthorizationVoid;
6172
- /** Scheduled action for this transaction */
6173
- scheduledAction?: V1ScheduledAction;
6084
+ lineItemId?: string;
6085
+ /** Total refunded amount for the line item. */
6086
+ totalRefundedAmount?: Price;
6174
6087
  }
6175
- interface AuthorizationCapture {
6088
+ interface CalculateRefundRequest {
6176
6089
  /**
6177
- * Capture ID.
6178
- * @format GUID
6179
- * @readonly
6090
+ * Order ID
6091
+ * @minLength 1
6092
+ * @maxLength 100
6180
6093
  */
6181
- _id?: string | null;
6182
- /** Status of this capture action */
6183
- status?: AuthorizationCaptureStatusWithLiterals;
6094
+ ecomOrderId?: string;
6184
6095
  /**
6185
- * Amount of this capture
6186
- * @immutable
6096
+ * Refunded line items and quantity
6097
+ * @maxSize 300
6187
6098
  */
6188
- amount?: Price;
6189
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6190
- _createdDate?: Date | null;
6191
- /** In case of status is FAILED may contain failure details */
6192
- failureDetails?: AuthorizationActionFailureDetails;
6193
- }
6194
- declare enum AuthorizationCaptureStatus {
6195
- /** Capture operation still in progress. */
6196
- PENDING = "PENDING",
6197
- /** Capture operation succeeded. */
6198
- SUCCEEDED = "SUCCEEDED",
6199
- /** Capture operation failed. */
6200
- FAILED = "FAILED"
6201
- }
6202
- /** @enumType */
6203
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6204
- interface AuthorizationActionFailureDetails {
6205
- /** @maxLength 100 */
6206
- failureCode?: string;
6207
- }
6208
- interface AuthorizationVoid {
6209
- /** Status of this void action */
6210
- status?: AuthorizationVoidStatusWithLiterals;
6211
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6212
- voidedDate?: Date | null;
6213
- /** In case of status is FAILED may contain failure details */
6214
- failureDetails?: AuthorizationActionFailureDetails;
6215
- /** Reason of void action */
6216
- reason?: ReasonWithLiterals;
6217
- }
6218
- declare enum AuthorizationVoidStatus {
6219
- /** Void operation still in progress. */
6220
- PENDING = "PENDING",
6221
- /** Void operation succeeded. */
6222
- SUCCEEDED = "SUCCEEDED",
6223
- /** Void operation failed. */
6224
- FAILED = "FAILED"
6225
- }
6226
- /** @enumType */
6227
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6228
- /** Reason the authorization was voided. */
6229
- declare enum Reason {
6230
- /** Authorization was voided by user. */
6231
- MANUAL = "MANUAL",
6232
- /** Authorization passed execution date. */
6233
- SCHEDULED = "SCHEDULED"
6234
- }
6235
- /** @enumType */
6236
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6237
- interface V1ScheduledAction {
6238
- /** Type of the action. */
6239
- actionType?: ActionTypeWithLiterals;
6240
- /** The date and time of the action. */
6241
- executionDate?: Date | null;
6242
- }
6243
- declare enum ActionType {
6244
- VOID = "VOID",
6245
- CAPTURE = "CAPTURE"
6099
+ refundItems?: CalculateRefundItemRequest[];
6100
+ /** Should include shipping in refund calculation */
6101
+ refundShipping?: boolean;
6246
6102
  }
6247
- /** @enumType */
6248
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6249
- interface Chargeback {
6103
+ interface CalculateRefundItemRequest {
6250
6104
  /**
6251
- * Chargeback ID.
6105
+ * ID of the line item being refunded
6252
6106
  * @format GUID
6253
- * @readonly
6254
- * @immutable
6255
6107
  */
6256
6108
  _id?: string;
6257
6109
  /**
6258
- * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6259
- * @readonly
6260
- * @immutable
6261
- */
6262
- _createdDate?: Date | null;
6263
- /**
6264
- * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6265
- * @readonly
6110
+ * How much of that line item is being refunded
6111
+ * @min 1
6112
+ * @max 100000
6266
6113
  */
6267
- _updatedDate?: Date | null;
6114
+ quantity?: number;
6115
+ }
6116
+ interface CalculateRefundResponse {
6117
+ /** Total refundable amount */
6118
+ total?: Price;
6119
+ /** Tax cost of the order */
6120
+ tax?: Price;
6121
+ /** Discount given for this order */
6122
+ discount?: Price;
6123
+ /** Total cost of the order (without tax) */
6124
+ subtotal?: Price;
6125
+ /** Total shipping cost for order */
6126
+ shipping?: Price;
6127
+ /** Previous refund given on that order */
6128
+ previouslyRefundedAmount?: Price;
6268
6129
  /**
6269
- * Amount.
6270
- * @readonly
6271
- * @immutable
6130
+ * The refundable items of that order
6131
+ * @maxSize 300
6272
6132
  */
6273
- amount?: Price;
6133
+ items?: CalculateRefundItemResponse[];
6134
+ }
6135
+ interface CalculateRefundItemResponse {
6274
6136
  /**
6275
- * Reversal amount. Present only when status is REVERSED.
6276
- * @readonly
6137
+ * Line item ID
6138
+ * @format GUID
6277
6139
  */
6278
- reversalAmount?: Price;
6140
+ _id?: string;
6141
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6142
+ price?: Price;
6143
+ }
6144
+ interface VoidAuthorizedPaymentsRequest {
6279
6145
  /**
6280
- * Status.
6281
- *
6282
- * Default: `"APPROVED"`.
6146
+ * Wix eCommerce order ID
6147
+ * @minLength 1
6148
+ * @maxLength 100
6283
6149
  */
6284
- status?: ChargebackStatusWithLiterals;
6150
+ ecomOrderId: string;
6285
6151
  /**
6286
- * External chargeback ID.
6152
+ * Payment IDs
6153
+ * @minSize 1
6154
+ * @maxSize 100
6287
6155
  * @format GUID
6288
- * @readonly
6289
- * @immutable
6290
6156
  */
6291
- externalId?: string | null;
6292
- }
6293
- declare enum ChargebackStatus {
6294
- /** Chargeback was approved. */
6295
- APPROVED = "APPROVED",
6296
- /** Chargeback was reversed. */
6297
- REVERSED = "REVERSED"
6157
+ paymentIds: string[];
6298
6158
  }
6299
- /** @enumType */
6300
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6301
- interface PaymentMethodName {
6159
+ interface VoidAuthorizedPaymentsResponse {
6160
+ /** All order's transactions after the void was triggered */
6161
+ orderTransactions?: OrderTransactions;
6162
+ }
6163
+ interface CaptureAuthorizedPaymentsRequest {
6302
6164
  /**
6303
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6304
- * @maxLength 150
6165
+ * Wix eCommerce order ID
6166
+ * @minLength 1
6167
+ * @maxLength 100
6305
6168
  */
6306
- buyerLanguageName?: string | null;
6169
+ ecomOrderId: string;
6307
6170
  /**
6308
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6309
- *
6310
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6311
- * @maxLength 150
6171
+ * Capture payments information
6172
+ * @minSize 1
6173
+ * @maxSize 100
6312
6174
  */
6313
- siteLanguageName?: string | null;
6175
+ payments: PaymentCapture[];
6176
+ }
6177
+ interface PaymentCapture {
6314
6178
  /**
6315
- * User-provided payment method name.
6316
- *
6317
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6179
+ * Payment ID
6180
+ * @format GUID
6318
6181
  */
6319
- userDefinedName?: UserDefinedPaymentMethodName;
6182
+ paymentId?: string | null;
6183
+ /**
6184
+ * Capture amount.
6185
+ * If not provided - full authorized amount will be captured.
6186
+ */
6187
+ amount?: Price;
6320
6188
  }
6321
- interface GiftCardPaymentDetails {
6189
+ interface CaptureAuthorizedPaymentsResponse {
6190
+ /** All order's transactions after the capture was triggered */
6191
+ orderTransactions?: OrderTransactions;
6192
+ }
6193
+ interface ChargeSavedPaymentMethodRequest {
6322
6194
  /**
6323
- * Gift card payment ID.
6195
+ * Ecom Order ID.
6196
+ * @minLength 1
6324
6197
  * @maxLength 100
6325
6198
  */
6326
- giftCardPaymentId?: string;
6199
+ ecomOrderId?: string;
6200
+ /** Amount to be charged */
6201
+ amount?: Price;
6202
+ }
6203
+ interface ChargeSavedPaymentMethodResponse {
6204
+ /** Payment gateway's order ID (e.g Wix Payments) */
6205
+ paymentGatewayOrderId?: string;
6206
+ }
6207
+ interface SendBuyerConfirmationEmailRequest {
6208
+ /** @format GUID */
6209
+ orderId?: string;
6210
+ }
6211
+ interface SendBuyerConfirmationEmailResponse {
6212
+ }
6213
+ interface SendBuyerPaymentsReceivedEmailRequest {
6327
6214
  /**
6328
- * Gift card ID.
6329
- * @internal
6330
- * @deprecated
6215
+ * @minLength 1
6216
+ * @maxLength 100
6331
6217
  */
6332
- giftCardId?: string;
6218
+ orderId?: string;
6219
+ }
6220
+ interface SendBuyerPaymentsReceivedEmailResponse {
6221
+ }
6222
+ interface SendBuyerPickupConfirmationEmailRequest {
6333
6223
  /**
6334
- * ID of the app that created the gift card.
6335
- * @format GUID
6224
+ * @minLength 1
6225
+ * @maxLength 100
6336
6226
  */
6337
- appId?: string;
6227
+ orderId?: string;
6228
+ }
6229
+ interface SendBuyerPickupConfirmationEmailResponse {
6230
+ }
6231
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
6338
6232
  /**
6339
- * Whether the gift card is voided.
6340
- * @readonly
6341
- * @deprecated Whether the gift card is voided.
6342
- * @replacedBy payment.status
6343
- * @targetRemovalDate 2026-11-01
6233
+ * IDs of orders to send pickup emails for.
6234
+ * @minSize 1
6235
+ * @maxSize 300
6344
6236
  */
6345
- voided?: boolean;
6237
+ orderIds?: string[];
6238
+ }
6239
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
6240
+ }
6241
+ interface SendBuyerShippingConfirmationEmailRequest {
6346
6242
  /**
6347
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6348
- * @maxLength 30
6349
- * @immutable
6243
+ * @minLength 1
6244
+ * @maxLength 100
6350
6245
  */
6351
- obfuscatedCode?: string | null;
6246
+ orderId?: string;
6352
6247
  }
6353
- interface MembershipPaymentDetails {
6248
+ interface SendBuyerShippingConfirmationEmailResponse {
6249
+ }
6250
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
6354
6251
  /**
6355
- * Membership ID.
6356
- * @maxLength 200
6252
+ * IDs of orders to send pickup emails for.
6253
+ * @minSize 1
6254
+ * @maxSize 300
6357
6255
  */
6358
- membershipId?: string;
6256
+ orderIds?: string[];
6257
+ }
6258
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
6259
+ }
6260
+ interface SendMerchantOrderReceivedNotificationRequest {
6359
6261
  /**
6360
- * ID of the line item this membership applies to.
6361
6262
  * @minLength 1
6362
6263
  * @maxLength 100
6363
6264
  */
6364
- lineItemId?: string;
6365
- /**
6366
- * Payment status.
6367
- * @deprecated Payment status.
6368
- * @replacedBy payment.status
6369
- * @targetRemovalDate 2026-11-01
6370
- */
6371
- status?: MembershipPaymentStatusWithLiterals;
6372
- /** Membership name. */
6373
- name?: MembershipName;
6265
+ orderId?: string;
6266
+ }
6267
+ interface SendMerchantOrderReceivedNotificationResponse {
6268
+ }
6269
+ interface SendCancelRefundEmailRequest {
6374
6270
  /**
6375
- * The transaction ID in the membership system. Can be used to void the transaction.
6271
+ * The ID of order that is canceled/refunded
6376
6272
  * @minLength 1
6377
6273
  * @maxLength 100
6378
6274
  */
6379
- externalTransactionId?: string | null;
6275
+ orderId?: string;
6380
6276
  /**
6381
- * Whether the membership is voided.
6382
- * @readonly
6383
- * @deprecated Whether the membership is voided.
6384
- * @replacedBy payment.status
6385
- * @targetRemovalDate 2026-11-01
6277
+ * Personal note added to the email (optional)
6278
+ * @minLength 1
6279
+ * @maxLength 1000
6386
6280
  */
6387
- voided?: boolean;
6281
+ customMessage?: string | null;
6282
+ /** Refund amount */
6283
+ refundAmount?: Price;
6388
6284
  /**
6389
- * ID of the application providing this payment option.
6285
+ * Refund ID. (Optional)
6390
6286
  * @format GUID
6391
6287
  */
6392
- providerAppId?: string;
6393
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6394
- futureMembership?: FutureMembershipDetails;
6288
+ refundId?: string | null;
6395
6289
  }
6396
- declare enum MembershipPaymentStatus {
6397
- /** Payment was charged. */
6398
- CHARGED = "CHARGED",
6399
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6400
- CHARGE_FAILED = "CHARGE_FAILED",
6401
- /** Payment is pending. */
6402
- CHARGE_PENDING = "CHARGE_PENDING",
6403
- /** Payment was voided. */
6404
- VOIDED = "VOIDED"
6290
+ interface SendCancelRefundEmailResponse {
6405
6291
  }
6406
- /** @enumType */
6407
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6408
- interface FutureMembershipDetails {
6292
+ interface SendRefundEmailRequest {
6409
6293
  /**
6410
- * ID of the plan line item in the order from which the membership will be created.
6294
+ * The ID of order that is refunded
6411
6295
  * @format GUID
6412
6296
  */
6413
- lineItemId?: string;
6414
- /**
6415
- * ID of the benefit the future membership will grant.
6416
- * @maxLength 200
6417
- */
6418
- benefitId?: string;
6419
- }
6420
- interface WixReceiptInfo {
6297
+ orderId?: string;
6421
6298
  /**
6422
- * Receipt ID
6299
+ * Refund ID
6423
6300
  * @format GUID
6424
6301
  */
6425
- receiptId?: string;
6302
+ refundId?: string;
6426
6303
  /**
6427
- * Display number of receipt
6304
+ * Personal note added to the email (optional)
6428
6305
  * @minLength 1
6429
- * @maxLength 40
6306
+ * @maxLength 1000
6430
6307
  */
6431
- displayNumber?: string | null;
6308
+ customMessage?: string | null;
6432
6309
  }
6433
- interface ExternalReceiptInfo {
6310
+ interface SendRefundEmailResponse {
6311
+ }
6312
+ interface SendFulfillmentEmailRequest {
6313
+ /** @format GUID */
6314
+ orderId?: string;
6315
+ /** @format GUID */
6316
+ fulfillerId?: string;
6317
+ }
6318
+ interface SendFulfillmentEmailResponse {
6319
+ }
6320
+ interface SendMerchantOrderReceivedPushRequest {
6434
6321
  /**
6435
- * External receipt ID
6322
+ * @minLength 1
6436
6323
  * @maxLength 100
6437
6324
  */
6438
- receiptId?: string | null;
6325
+ orderId?: string;
6326
+ }
6327
+ interface SendMerchantOrderReceivedPushResponse {
6328
+ }
6329
+ interface PreviewEmailByTypeRequest {
6330
+ emailType?: PreviewEmailTypeWithLiterals;
6331
+ }
6332
+ declare enum PreviewEmailType {
6333
+ ORDER_PLACED = "ORDER_PLACED",
6334
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6335
+ ORDER_SHIPPED = "ORDER_SHIPPED",
6336
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6337
+ }
6338
+ /** @enumType */
6339
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6340
+ interface PreviewEmailByTypeResponse {
6341
+ emailPreview?: string;
6342
+ }
6343
+ interface PreviewRefundEmailRequest {
6439
6344
  /**
6440
- * ID of the app providing the receipt
6441
- * @format GUID
6345
+ * @minLength 1
6346
+ * @maxLength 100
6442
6347
  */
6443
- appId?: string | null;
6348
+ orderId?: string;
6349
+ /** Refund amount */
6350
+ refundAmount?: Price;
6351
+ /** Refund business details */
6352
+ details?: RefundDetails;
6444
6353
  /**
6445
- * Display number of receipt
6354
+ * Personal note added to the email (optional)
6446
6355
  * @minLength 1
6447
- * @maxLength 40
6356
+ * @maxLength 1000
6448
6357
  */
6449
- displayNumber?: string | null;
6450
- }
6451
- interface CashRoundingDetails {
6358
+ customMessage?: string | null;
6452
6359
  /**
6453
- * Payment amount before cash rounding was applied.
6454
- * When provided, balance and status calculations use this value instead of `amount`
6455
- * to prevent false overpayment or underpayment due to rounding.
6360
+ * Refund ID. (Optional)
6361
+ * @format GUID
6456
6362
  */
6457
- unroundedAmount?: Price;
6363
+ refundId?: string | null;
6364
+ }
6365
+ interface PreviewRefundEmailResponse {
6366
+ emailPreview?: string;
6367
+ }
6368
+ interface PreviewCancelEmailRequest {
6458
6369
  /**
6459
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6460
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6461
- * @readonly
6370
+ * @minLength 1
6371
+ * @maxLength 100
6462
6372
  */
6463
- roundingAdjustment?: CashRounding;
6373
+ orderId?: string;
6374
+ /**
6375
+ * Personal note added to the email (optional)
6376
+ * @minLength 1
6377
+ * @maxLength 1000
6378
+ */
6379
+ customMessage?: string | null;
6464
6380
  }
6465
- declare enum PaymentStatus {
6466
- /** Payment was charged successfully. */
6467
- APPROVED = "APPROVED",
6468
- /** Payment is being processed and hasn't been confirmed yet. */
6469
- PENDING = "PENDING",
6470
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
6471
- PENDING_MERCHANT = "PENDING_MERCHANT",
6472
- /** Payment was canceled before it was charged. */
6473
- CANCELED = "CANCELED",
6474
- /** Payment was declined by the payment provider. */
6475
- DECLINED = "DECLINED",
6476
- /** Payment was fully refunded. */
6477
- REFUNDED = "REFUNDED",
6478
- /** Part of the payment amount was refunded. */
6479
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6480
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
6481
- AUTHORIZED = "AUTHORIZED",
6381
+ interface PreviewCancelEmailResponse {
6382
+ emailPreview?: string;
6383
+ }
6384
+ interface PreviewCancelRefundEmailRequest {
6482
6385
  /**
6483
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6484
- *
6485
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6386
+ * @minLength 1
6387
+ * @maxLength 100
6486
6388
  */
6487
- VOIDED = "VOIDED"
6389
+ orderId?: string;
6390
+ /**
6391
+ * Personal note added to the email (optional)
6392
+ * @minLength 1
6393
+ * @maxLength 1000
6394
+ */
6395
+ customMessage?: string | null;
6396
+ /** Refund amount */
6397
+ refundAmount?: Price;
6398
+ /**
6399
+ * Refund ID. (Optional)
6400
+ * @format GUID
6401
+ */
6402
+ refundId?: string | null;
6488
6403
  }
6489
- /** @enumType */
6490
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6491
- interface CanceledStatusDetails {
6492
- reason?: CanceledReasonWithLiterals;
6404
+ interface PreviewCancelRefundEmailResponse {
6405
+ emailPreview?: string;
6493
6406
  }
6494
- declare enum CanceledReason {
6495
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6496
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6497
- /** Payment was not completed by user and expired. */
6498
- EXPIRED = "EXPIRED"
6407
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
6499
6408
  }
6500
- /** @enumType */
6501
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6502
- interface DeclinedStatusDetails {
6503
- reason?: DeclinedReasonWithLiterals;
6409
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
6410
+ emailPreview?: string;
6504
6411
  }
6505
- declare enum DeclinedReason {
6506
- /** Corresponding charge failed. */
6507
- CHARGE_FAILED = "CHARGE_FAILED",
6508
- /** Payment details expired. */
6509
- EXPIRED = "EXPIRED",
6510
- /** Insufficient funds. */
6511
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6512
- /** Gift card was disabled before charge was attempted. */
6513
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6412
+ interface PreviewBuyerConfirmationEmailRequest {
6413
+ }
6414
+ interface PreviewBuyerConfirmationEmailResponse {
6415
+ emailPreview?: string;
6416
+ }
6417
+ interface PreviewBuyerPickupConfirmationEmailRequest {
6418
+ }
6419
+ interface PreviewBuyerPickupConfirmationEmailResponse {
6420
+ emailPreview?: string;
6421
+ }
6422
+ interface PreviewShippingConfirmationEmailRequest {
6423
+ }
6424
+ interface PreviewShippingConfirmationEmailResponse {
6425
+ emailPreview?: string;
6426
+ }
6427
+ interface PreviewResendDownloadLinksEmailRequest {
6428
+ }
6429
+ interface PreviewResendDownloadLinksEmailResponse {
6430
+ emailPreview?: string;
6431
+ }
6432
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6433
+ /** Emitted on a meta site creation. */
6434
+ siteCreated?: SiteCreated;
6435
+ /** Emitted on a meta site transfer completion. */
6436
+ siteTransferred?: SiteTransferred;
6437
+ /** Emitted on a meta site deletion. */
6438
+ siteDeleted?: SiteDeleted;
6439
+ /** Emitted on a meta site restoration. */
6440
+ siteUndeleted?: SiteUndeleted;
6441
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6442
+ sitePublished?: SitePublished;
6443
+ /** Emitted on a meta site unpublish. */
6444
+ siteUnpublished?: SiteUnpublished;
6445
+ /** Emitted when meta site is marked as template. */
6446
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6447
+ /** Emitted when meta site is marked as a WixSite. */
6448
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6449
+ /** Emitted when an application is provisioned (installed). */
6450
+ serviceProvisioned?: ServiceProvisioned;
6451
+ /** Emitted when an application is removed (uninstalled). */
6452
+ serviceRemoved?: ServiceRemoved;
6453
+ /** Emitted when meta site name (URL slug) is changed. */
6454
+ siteRenamedPayload?: SiteRenamed;
6455
+ /** Emitted when meta site was permanently deleted. */
6456
+ hardDeleted?: SiteHardDeleted;
6457
+ /** Emitted on a namespace change. */
6458
+ namespaceChanged?: NamespaceChanged;
6459
+ /** Emitted when Studio is attached. */
6460
+ studioAssigned?: StudioAssigned;
6461
+ /** Emitted when Studio is detached. */
6462
+ studioUnassigned?: StudioUnassigned;
6463
+ /**
6464
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6465
+ * the actual URL.
6466
+ *
6467
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6468
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6469
+ */
6470
+ urlChanged?: SiteUrlChanged;
6471
+ /** Site is marked as PurgedExternally */
6472
+ sitePurgedExternally?: SitePurgedExternally;
6473
+ /** Emitted when Odeditor is attached. */
6474
+ odeditorAssigned?: OdeditorAssigned;
6475
+ /** Emitted when Odeditor is detached. */
6476
+ odeditorUnassigned?: OdeditorUnassigned;
6477
+ /** Emitted when Picasso is attached. */
6478
+ picassoAssigned?: PicassoAssigned;
6479
+ /** Emitted when Picasso is detached. */
6480
+ picassoUnassigned?: PicassoUnassigned;
6481
+ /** Emitted when Wixel is attached. */
6482
+ wixelAssigned?: WixelAssigned;
6483
+ /** Emitted when Wixel is detached. */
6484
+ wixelUnassigned?: WixelUnassigned;
6485
+ /** Emitted when StudioTwo is attached. */
6486
+ studioTwoAssigned?: StudioTwoAssigned;
6487
+ /** Emitted when StudioTwo is detached. */
6488
+ studioTwoUnassigned?: StudioTwoUnassigned;
6489
+ /** Emitted when media from user domain is enabled. */
6490
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6491
+ /** Emitted when media from user domain is disabled. */
6492
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6493
+ /** Emitted when Editorless is attached. */
6494
+ editorlessAssigned?: EditorlessAssigned;
6495
+ /** Emitted when Editorless is detached. */
6496
+ editorlessUnassigned?: EditorlessUnassigned;
6497
+ /**
6498
+ * A meta site id.
6499
+ * @format GUID
6500
+ */
6501
+ metaSiteId?: string;
6502
+ /** A meta site version. Monotonically increasing. */
6503
+ version?: string;
6504
+ /** A timestamp of the event. */
6505
+ timestamp?: string;
6506
+ /**
6507
+ * TODO(meta-site): Change validation once validations are disabled for consumers
6508
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6509
+ * @maxSize 4000
6510
+ */
6511
+ assets?: Asset[];
6512
+ }
6513
+ /** @oneof */
6514
+ interface MetaSiteSpecialEventPayloadOneOf {
6515
+ /** Emitted on a meta site creation. */
6516
+ siteCreated?: SiteCreated;
6517
+ /** Emitted on a meta site transfer completion. */
6518
+ siteTransferred?: SiteTransferred;
6519
+ /** Emitted on a meta site deletion. */
6520
+ siteDeleted?: SiteDeleted;
6521
+ /** Emitted on a meta site restoration. */
6522
+ siteUndeleted?: SiteUndeleted;
6523
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6524
+ sitePublished?: SitePublished;
6525
+ /** Emitted on a meta site unpublish. */
6526
+ siteUnpublished?: SiteUnpublished;
6527
+ /** Emitted when meta site is marked as template. */
6528
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6529
+ /** Emitted when meta site is marked as a WixSite. */
6530
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6531
+ /** Emitted when an application is provisioned (installed). */
6532
+ serviceProvisioned?: ServiceProvisioned;
6533
+ /** Emitted when an application is removed (uninstalled). */
6534
+ serviceRemoved?: ServiceRemoved;
6535
+ /** Emitted when meta site name (URL slug) is changed. */
6536
+ siteRenamedPayload?: SiteRenamed;
6537
+ /** Emitted when meta site was permanently deleted. */
6538
+ hardDeleted?: SiteHardDeleted;
6539
+ /** Emitted on a namespace change. */
6540
+ namespaceChanged?: NamespaceChanged;
6541
+ /** Emitted when Studio is attached. */
6542
+ studioAssigned?: StudioAssigned;
6543
+ /** Emitted when Studio is detached. */
6544
+ studioUnassigned?: StudioUnassigned;
6545
+ /**
6546
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6547
+ * the actual URL.
6548
+ *
6549
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6550
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6551
+ */
6552
+ urlChanged?: SiteUrlChanged;
6553
+ /** Site is marked as PurgedExternally */
6554
+ sitePurgedExternally?: SitePurgedExternally;
6555
+ /** Emitted when Odeditor is attached. */
6556
+ odeditorAssigned?: OdeditorAssigned;
6557
+ /** Emitted when Odeditor is detached. */
6558
+ odeditorUnassigned?: OdeditorUnassigned;
6559
+ /** Emitted when Picasso is attached. */
6560
+ picassoAssigned?: PicassoAssigned;
6561
+ /** Emitted when Picasso is detached. */
6562
+ picassoUnassigned?: PicassoUnassigned;
6563
+ /** Emitted when Wixel is attached. */
6564
+ wixelAssigned?: WixelAssigned;
6565
+ /** Emitted when Wixel is detached. */
6566
+ wixelUnassigned?: WixelUnassigned;
6567
+ /** Emitted when StudioTwo is attached. */
6568
+ studioTwoAssigned?: StudioTwoAssigned;
6569
+ /** Emitted when StudioTwo is detached. */
6570
+ studioTwoUnassigned?: StudioTwoUnassigned;
6571
+ /** Emitted when media from user domain is enabled. */
6572
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6573
+ /** Emitted when media from user domain is disabled. */
6574
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6575
+ /** Emitted when Editorless is attached. */
6576
+ editorlessAssigned?: EditorlessAssigned;
6577
+ /** Emitted when Editorless is detached. */
6578
+ editorlessUnassigned?: EditorlessUnassigned;
6579
+ }
6580
+ interface Asset {
6581
+ /**
6582
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6583
+ * @maxLength 36
6584
+ */
6585
+ appDefId?: string;
6586
+ /**
6587
+ * An instance id. For legacy reasons may be UUID or a string.
6588
+ * @maxLength 200
6589
+ */
6590
+ instanceId?: string;
6591
+ /** An application state. */
6592
+ state?: StateWithLiterals;
6593
+ }
6594
+ declare enum State {
6595
+ UNKNOWN = "UNKNOWN",
6596
+ ENABLED = "ENABLED",
6597
+ DISABLED = "DISABLED",
6598
+ PENDING = "PENDING",
6599
+ DEMO = "DEMO"
6514
6600
  }
6515
6601
  /** @enumType */
6516
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6517
- interface VoidedStatusDetails {
6518
- reason?: VoidedReasonWithLiterals;
6602
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6603
+ interface SiteCreated {
6604
+ /**
6605
+ * A template identifier (empty if not created from a template).
6606
+ * @maxLength 36
6607
+ */
6608
+ originTemplateId?: string;
6609
+ /**
6610
+ * An account id of the owner.
6611
+ * @format GUID
6612
+ */
6613
+ ownerId?: string;
6614
+ /** A context in which meta site was created. */
6615
+ context?: SiteCreatedContextWithLiterals;
6616
+ /**
6617
+ * A meta site id from which this site was created.
6618
+ *
6619
+ * In case of a creation from a template it's a template id.
6620
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6621
+ * @format GUID
6622
+ */
6623
+ originMetaSiteId?: string | null;
6624
+ /**
6625
+ * A meta site name (URL slug).
6626
+ * @maxLength 20
6627
+ */
6628
+ siteName?: string;
6629
+ /** A namespace. */
6630
+ namespace?: NamespaceWithLiterals;
6519
6631
  }
6520
- declare enum VoidedReason {
6521
- /** Payment was voided by merchant request. */
6522
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6523
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6524
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6632
+ declare enum SiteCreatedContext {
6633
+ /** A valid option, we don't expose all reasons why site might be created. */
6634
+ OTHER = "OTHER",
6635
+ /** A meta site was created from template. */
6636
+ FROM_TEMPLATE = "FROM_TEMPLATE",
6637
+ /** A meta site was created by copying of the transfferred meta site. */
6638
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6639
+ /** A copy of existing meta site. */
6640
+ DUPLICATE = "DUPLICATE",
6641
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6642
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6643
+ /** deprecated A meta site was created for Flash editor. */
6644
+ FLASH = "FLASH"
6525
6645
  }
6526
6646
  /** @enumType */
6527
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6528
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6529
- /** @internal */
6530
- canceled?: CanceledStatusDetails;
6531
- /** @internal */
6532
- declined?: DeclinedStatusDetails;
6533
- /** @internal */
6534
- voided?: VoidedStatusDetails;
6647
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6648
+ declare enum Namespace {
6649
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6650
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6651
+ WIX = "WIX",
6652
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6653
+ SHOUT_OUT = "SHOUT_OUT",
6654
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6655
+ ALBUMS = "ALBUMS",
6656
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6657
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6658
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6659
+ HOTELS = "HOTELS",
6660
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6661
+ CLUBS = "CLUBS",
6662
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6663
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6535
6664
  /**
6536
- * Reason code from the payment gateway.
6537
- * @internal
6538
- * @minLength 1
6539
- * @maxLength 10
6665
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6666
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6540
6667
  */
6541
- paymentGatewayReasonCode?: string | null;
6542
- }
6543
- /** @oneof */
6544
- interface PaymentStatusDetailsStatusDetailsOneOf {
6545
- /** @internal */
6546
- canceled?: CanceledStatusDetails;
6547
- /** @internal */
6548
- declined?: DeclinedStatusDetails;
6549
- /** @internal */
6550
- voided?: VoidedStatusDetails;
6551
- }
6552
- interface Refund {
6668
+ DEV_SITE = "DEV_SITE",
6669
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6670
+ LOGOS = "LOGOS",
6671
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6672
+ VIDEO_MAKER = "VIDEO_MAKER",
6673
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6674
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6675
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6676
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6553
6677
  /**
6554
- * Refund ID.
6555
- * @format GUID
6556
- * @readonly
6678
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6679
+ *
6680
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
6557
6681
  */
6558
- _id?: string;
6682
+ HTML_DRAFT = "HTML_DRAFT",
6559
6683
  /**
6560
- * List of transactions.
6561
- * @maxSize 50
6684
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6685
+ * Will be accessible from Site List and will not have a website app.
6686
+ * Once the user attaches a site, the site will become a regular wixsite.
6562
6687
  */
6563
- transactions?: RefundTransaction[];
6564
- /** Refund business details. */
6565
- details?: RefundDetails;
6688
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
6689
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6690
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
6691
+ /** It is to be used in the Business First efforts. */
6692
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
6693
+ /** Bookings business flow with no site. */
6694
+ ANYWHERE = "ANYWHERE",
6695
+ /** Namespace for Headless Backoffice with no editor */
6696
+ HEADLESS = "HEADLESS",
6566
6697
  /**
6567
- * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6568
- * @readonly
6569
- * @immutable
6698
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6699
+ * The site will be used for account level CSM feature for enterprise
6570
6700
  */
6571
- _createdDate?: Date | null;
6701
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6702
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6703
+ RISE = "RISE",
6572
6704
  /**
6573
- * Aggregated refund summary.
6574
- * @readonly
6705
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6706
+ * There's a blank site behind the scene but it's blank).
6707
+ * The Mobile company will be the owner of this namespace.
6575
6708
  */
6576
- summary?: AggregatedRefundSummary;
6709
+ BRANDED_FIRST = "BRANDED_FIRST",
6710
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6711
+ NOWNIA = "NOWNIA",
6577
6712
  /**
6578
- * ID of the app that initiated this refund.
6579
- * @format GUID
6580
- * @readonly
6581
- * @immutable
6713
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
6714
+ * The Partners company owns this namespace.
6582
6715
  */
6583
- requestingServiceAppId?: string | null;
6584
- }
6585
- interface RefundTransaction {
6716
+ UGC_TEMPLATE = "UGC_TEMPLATE",
6717
+ /** Codux Headless Sites */
6718
+ CODUX = "CODUX",
6719
+ /** Bobb - AI Design Creator. */
6720
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6586
6721
  /**
6587
- * ID of the payment associated with this refund.
6588
- * @format GUID
6589
- * @immutable
6722
+ * Shared Blog Site is a unique single site across Enterprise account,
6723
+ * This site will hold all Blog posts related to the Marketing product.
6590
6724
  */
6591
- paymentId?: string;
6725
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6726
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6727
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6728
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6729
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6730
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6731
+ MIMIR = "MIMIR",
6732
+ /** Wix Twins platform. */
6733
+ TWINS = "TWINS",
6734
+ /** Wix Nano. */
6735
+ NANO = "NANO",
6736
+ /** Base44 headless sites. */
6737
+ BASE44 = "BASE44",
6738
+ /** Wix Channels Sites */
6739
+ CHANNELS = "CHANNELS",
6740
+ /** Nautilus platform. */
6741
+ NAUTILUS = "NAUTILUS",
6592
6742
  /**
6593
- * Refund amount.
6594
- * @immutable
6743
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6744
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6595
6745
  */
6596
- amount?: Price;
6597
- /** Refund status. */
6598
- refundStatus?: RefundStatusWithLiterals;
6599
- /** Optional details of current refund status. */
6600
- refundStatusInfo?: RefundStatusInfo;
6746
+ SYMPHONY = "SYMPHONY",
6747
+ /** Nautilus platform app. */
6748
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6601
6749
  /**
6602
- * Payment gateway's refund ID.
6603
- * This field is only returned when the value of `external_refund` is `false`.
6604
- * @format GUID
6750
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6751
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6605
6752
  */
6606
- gatewayRefundId?: string | null;
6607
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6608
- providerRefundId?: string | null;
6753
+ VIBU = "VIBU",
6609
6754
  /**
6610
- * Whether refund was made externally and manually on the payment provider's side.
6611
- * @immutable
6755
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6756
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6757
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6758
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6612
6759
  */
6613
- externalRefund?: boolean;
6760
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6614
6761
  /**
6615
- * Location where the refund was processed.
6616
- * @internal
6762
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6763
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6764
+ */
6765
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6766
+ }
6767
+ /** @enumType */
6768
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
6769
+ /** Site transferred to another user. */
6770
+ interface SiteTransferred {
6771
+ /**
6772
+ * A previous owner id (user that transfers meta site).
6617
6773
  * @format GUID
6618
- * @immutable
6619
6774
  */
6620
- locationId?: string | null;
6775
+ oldOwnerId?: string;
6776
+ /**
6777
+ * A new owner id (user that accepts meta site).
6778
+ * @format GUID
6779
+ */
6780
+ newOwnerId?: string;
6621
6781
  }
6622
- /** Refund transaction status. */
6623
- declare enum RefundStatus {
6624
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6625
- PENDING = "PENDING",
6626
- /** Refund transaction succeeded. */
6627
- SUCCEEDED = "SUCCEEDED",
6628
- /** Refund transaction failed. */
6629
- FAILED = "FAILED",
6630
- /** Refund request acknowledged, and will be executed soon. */
6631
- SCHEDULED = "SCHEDULED",
6632
- /** Refund was initiated on payment provider side. */
6633
- STARTED = "STARTED"
6782
+ /** Soft deletion of the meta site. Could be restored. */
6783
+ interface SiteDeleted {
6784
+ /** A deletion context. */
6785
+ deleteContext?: DeleteContext;
6634
6786
  }
6635
- /** @enumType */
6636
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6637
- interface RefundStatusInfo {
6787
+ interface DeleteContext {
6788
+ /** When the meta site was deleted. */
6789
+ dateDeleted?: Date | null;
6790
+ /** A status. */
6791
+ deleteStatus?: DeleteStatusWithLiterals;
6638
6792
  /**
6639
- * Reason code for the refund's current status.
6640
- *
6641
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6642
- * @minLength 1
6643
- * @maxLength 10
6793
+ * A reason (flow).
6794
+ * @maxLength 255
6644
6795
  */
6645
- paymentGatewayReasonCode?: string | null;
6796
+ deleteOrigin?: string;
6646
6797
  /**
6647
- * Free text explanation of current refund status.
6648
- * @minLength 1
6649
- * @maxLength 1000
6798
+ * A service that deleted it.
6799
+ * @maxLength 255
6650
6800
  */
6651
- description?: string | null;
6801
+ initiatorId?: string | null;
6652
6802
  }
6653
- interface AggregatedRefundSummary {
6654
- /** Total amount requested for refund. */
6655
- requestedRefund?: Price;
6656
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6657
- pendingRefund?: Price;
6658
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6659
- refunded?: Price;
6660
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6661
- failedRefundAmount?: Price;
6662
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6663
- pending?: boolean;
6664
- /** Breakdown of refunded items. Available only after refund is complete. */
6665
- breakdown?: RefundItemsBreakdown;
6803
+ declare enum DeleteStatus {
6804
+ UNKNOWN = "UNKNOWN",
6805
+ TRASH = "TRASH",
6806
+ DELETED = "DELETED",
6807
+ PENDING_PURGE = "PENDING_PURGE",
6808
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6666
6809
  }
6667
- interface RefundItemsBreakdown {
6810
+ /** @enumType */
6811
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6812
+ /** Restoration of the meta site. */
6813
+ interface SiteUndeleted {
6814
+ }
6815
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6816
+ interface SitePublished {
6817
+ }
6818
+ interface SiteUnpublished {
6819
+ /**
6820
+ * A list of URLs previously associated with the meta site.
6821
+ * @maxLength 4000
6822
+ * @maxSize 10000
6823
+ */
6824
+ urls?: string[];
6825
+ }
6826
+ interface SiteMarkedAsTemplate {
6827
+ }
6828
+ interface SiteMarkedAsWixSite {
6829
+ }
6830
+ /**
6831
+ * Represents a service provisioned a site.
6832
+ *
6833
+ * Note on `origin_instance_id`:
6834
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6835
+ * This is because of the following scenario:
6836
+ *
6837
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6838
+ * such as a product catalog. When you create a site from this template, you inherit this
6839
+ * default product catalog. However, if the template's product catalog is modified,
6840
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6841
+ * your site remains consistent with what you initially received and does not include any
6842
+ * changes made to the original template afterward.
6843
+ * To ensure this, the TPA on the template gets a new instance_id.
6844
+ */
6845
+ interface ServiceProvisioned {
6668
6846
  /**
6669
- * Refunded line items and the amount refunded for each.
6670
- * @maxSize 300
6847
+ * Either UUID or EmbeddedServiceType.
6848
+ * @maxLength 36
6671
6849
  */
6672
- lineItems?: LineItemRefundSummary[];
6673
- }
6674
- interface LineItemRefundSummary {
6850
+ appDefId?: string;
6675
6851
  /**
6676
- * ID of the refunded line item.
6677
- * @format GUID
6852
+ * Not only UUID. Something here could be something weird.
6853
+ * @maxLength 36
6678
6854
  */
6679
- lineItemId?: string;
6680
- /** Total refunded amount for the line item. */
6681
- totalRefundedAmount?: Price;
6682
- }
6683
- interface CalculateRefundRequest {
6855
+ instanceId?: string;
6684
6856
  /**
6685
- * Order ID
6686
- * @minLength 1
6687
- * @maxLength 100
6857
+ * An instance id from which this instance is originated.
6858
+ * @maxLength 36
6688
6859
  */
6689
- ecomOrderId?: string;
6860
+ originInstanceId?: string;
6690
6861
  /**
6691
- * Refunded line items and quantity
6692
- * @maxSize 300
6862
+ * A version.
6863
+ * @maxLength 500
6693
6864
  */
6694
- refundItems?: CalculateRefundItemRequest[];
6695
- /** Should include shipping in refund calculation */
6696
- refundShipping?: boolean;
6697
- }
6698
- interface CalculateRefundItemRequest {
6865
+ version?: string | null;
6699
6866
  /**
6700
- * ID of the line item being refunded
6867
+ * The origin meta site id
6701
6868
  * @format GUID
6702
6869
  */
6703
- _id?: string;
6870
+ originMetaSiteId?: string | null;
6871
+ }
6872
+ interface ServiceRemoved {
6704
6873
  /**
6705
- * How much of that line item is being refunded
6706
- * @min 1
6707
- * @max 100000
6874
+ * Either UUID or EmbeddedServiceType.
6875
+ * @maxLength 36
6708
6876
  */
6709
- quantity?: number;
6710
- }
6711
- interface CalculateRefundResponse {
6712
- /** Total refundable amount */
6713
- total?: Price;
6714
- /** Tax cost of the order */
6715
- tax?: Price;
6716
- /** Discount given for this order */
6717
- discount?: Price;
6718
- /** Total cost of the order (without tax) */
6719
- subtotal?: Price;
6720
- /** Total shipping cost for order */
6721
- shipping?: Price;
6722
- /** Previous refund given on that order */
6723
- previouslyRefundedAmount?: Price;
6877
+ appDefId?: string;
6724
6878
  /**
6725
- * The refundable items of that order
6726
- * @maxSize 300
6879
+ * Not only UUID. Something here could be something weird.
6880
+ * @maxLength 36
6727
6881
  */
6728
- items?: CalculateRefundItemResponse[];
6729
- }
6730
- interface CalculateRefundItemResponse {
6882
+ instanceId?: string;
6731
6883
  /**
6732
- * Line item ID
6733
- * @format GUID
6884
+ * A version.
6885
+ * @maxLength 500
6734
6886
  */
6735
- _id?: string;
6736
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6737
- price?: Price;
6887
+ version?: string | null;
6738
6888
  }
6739
- interface VoidAuthorizedPaymentsRequest {
6889
+ /** Rename of the site. Meaning, free public url has been changed as well. */
6890
+ interface SiteRenamed {
6740
6891
  /**
6741
- * Wix eCommerce order ID
6742
- * @minLength 1
6743
- * @maxLength 100
6892
+ * A new meta site name (URL slug).
6893
+ * @maxLength 20
6744
6894
  */
6745
- ecomOrderId: string;
6895
+ newSiteName?: string;
6746
6896
  /**
6747
- * Payment IDs
6748
- * @minSize 1
6749
- * @maxSize 100
6750
- * @format GUID
6897
+ * A previous meta site name (URL slug).
6898
+ * @maxLength 255
6751
6899
  */
6752
- paymentIds: string[];
6900
+ oldSiteName?: string;
6753
6901
  }
6754
- interface VoidAuthorizedPaymentsResponse {
6755
- /** All order's transactions after the void was triggered */
6756
- orderTransactions?: OrderTransactions;
6902
+ /**
6903
+ * Hard deletion of the meta site.
6904
+ *
6905
+ * Could not be restored. Therefore it's desirable to cleanup data.
6906
+ */
6907
+ interface SiteHardDeleted {
6908
+ /** A deletion context. */
6909
+ deleteContext?: DeleteContext;
6757
6910
  }
6758
- interface CaptureAuthorizedPaymentsRequest {
6759
- /**
6760
- * Wix eCommerce order ID
6761
- * @minLength 1
6762
- * @maxLength 100
6763
- */
6764
- ecomOrderId: string;
6911
+ interface NamespaceChanged {
6912
+ /** A previous namespace. */
6913
+ oldNamespace?: NamespaceWithLiterals;
6914
+ /** A new namespace. */
6915
+ newNamespace?: NamespaceWithLiterals;
6916
+ }
6917
+ /** Assigned Studio editor */
6918
+ interface StudioAssigned {
6919
+ }
6920
+ /** Unassigned Studio editor */
6921
+ interface StudioUnassigned {
6922
+ }
6923
+ /**
6924
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6925
+ *
6926
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6927
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
6928
+ *
6929
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6930
+ */
6931
+ interface SiteUrlChanged {
6932
+ }
6933
+ /**
6934
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6935
+ * Consumed by other teams to remove relevant data.
6936
+ */
6937
+ interface SitePurgedExternally {
6765
6938
  /**
6766
- * Capture payments information
6767
- * @minSize 1
6939
+ * @maxLength 2048
6768
6940
  * @maxSize 100
6941
+ * @deprecated
6942
+ * @targetRemovalDate 2025-04-15
6769
6943
  */
6770
- payments: PaymentCapture[];
6944
+ appDefId?: string[];
6771
6945
  }
6772
- interface PaymentCapture {
6773
- /**
6774
- * Payment ID
6775
- * @format GUID
6776
- */
6777
- paymentId?: string | null;
6778
- /**
6779
- * Capture amount.
6780
- * If not provided - full authorized amount will be captured.
6781
- */
6782
- amount?: Price;
6946
+ /** Assigned Odeditor */
6947
+ interface OdeditorAssigned {
6783
6948
  }
6784
- interface CaptureAuthorizedPaymentsResponse {
6785
- /** All order's transactions after the capture was triggered */
6786
- orderTransactions?: OrderTransactions;
6949
+ /** Unassigned Odeditor */
6950
+ interface OdeditorUnassigned {
6787
6951
  }
6788
- interface ChargeSavedPaymentMethodRequest {
6789
- /**
6790
- * Ecom Order ID.
6791
- * @minLength 1
6792
- * @maxLength 100
6793
- */
6794
- ecomOrderId?: string;
6795
- /** Amount to be charged */
6796
- amount?: Price;
6952
+ /** Assigned Picasso editor */
6953
+ interface PicassoAssigned {
6797
6954
  }
6798
- interface ChargeSavedPaymentMethodResponse {
6799
- /** Payment gateway's order ID (e.g Wix Payments) */
6800
- paymentGatewayOrderId?: string;
6955
+ /** Unassigned Picasso */
6956
+ interface PicassoUnassigned {
6801
6957
  }
6802
- interface V1TriggerReindexRequest {
6803
- /** @format GUID */
6804
- metasiteId?: string;
6805
- /**
6806
- * @minLength 1
6807
- * @maxLength 100
6808
- * @maxSize 100
6809
- */
6810
- orderIds?: string[];
6958
+ /** Assigned Wixel */
6959
+ interface WixelAssigned {
6811
6960
  }
6812
- interface V1TriggerReindexResponse {
6961
+ /** Unassigned Wixel */
6962
+ interface WixelUnassigned {
6813
6963
  }
6814
- interface V1TriggerReindexOrderRequest {
6815
- /** @format GUID */
6816
- metasiteId?: string;
6817
- /**
6818
- * @minLength 1
6819
- * @maxLength 100
6820
- */
6821
- orderId?: string;
6964
+ /** Assigned StudioTwo */
6965
+ interface StudioTwoAssigned {
6966
+ }
6967
+ /** Unassigned StudioTwo */
6968
+ interface StudioTwoUnassigned {
6969
+ }
6970
+ /** Media from user domain is enabled. */
6971
+ interface UserDomainMediaEnabled {
6972
+ }
6973
+ /** Media from user domain is disabled. */
6974
+ interface UserDomainMediaDisabled {
6975
+ }
6976
+ /** Assigned Editorless */
6977
+ interface EditorlessAssigned {
6978
+ }
6979
+ /** Unassigned Editorless */
6980
+ interface EditorlessUnassigned {
6981
+ }
6982
+ interface HasCustomEmailConfigurationsRequest {
6983
+ }
6984
+ interface HasCustomEmailConfigurationsResponse {
6985
+ hasCustomConfigurations?: boolean;
6986
+ }
6987
+ interface AddToAutomationMigrationPopulationRequest {
6988
+ /** When true, sends custom email configurations to automation system via email */
6989
+ sendCustomEmailConfigs?: boolean;
6990
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6991
+ origin?: OriginWithLiterals;
6992
+ }
6993
+ declare enum Origin {
6994
+ OPT_IN = "OPT_IN",
6995
+ MIGRATION = "MIGRATION"
6996
+ }
6997
+ /** @enumType */
6998
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6999
+ interface AddToAutomationMigrationPopulationResponse {
7000
+ success?: boolean;
7001
+ }
7002
+ interface IsInAutomationMigrationPopulationRequest {
7003
+ }
7004
+ interface IsInAutomationMigrationPopulationResponse {
7005
+ inPopulation?: boolean;
6822
7006
  }
6823
7007
  interface DiffmatokyPayload {
6824
7008
  left?: string;
@@ -9969,6 +10153,13 @@ interface UpdateOrder {
9969
10153
  * @immutable
9970
10154
  */
9971
10155
  taxIncludedInPrices?: boolean;
10156
+ /**
10157
+ * Cross-border repricing marker of the order: whether repricing is in force for it and which base tax region it uses. Set once at creation; an edit never changes it. One per order, unlike the per-line `CrossBorderPriceAdjustment` record.
10158
+ * @internal
10159
+ * @readonly
10160
+ * @immutable
10161
+ */
10162
+ crossBorderRepricing?: CrossBorderRepricing;
9972
10163
  /**
9973
10164
  * Site language in which original values are shown.
9974
10165
  * @readonly
@@ -10447,6 +10638,12 @@ interface UpdateOrderLineItem {
10447
10638
  * @readonly
10448
10639
  */
10449
10640
  serviceProperties?: ServiceProperties;
10641
+ /**
10642
+ * Cross-border repricing record of this line item on a site whose catalog prices include tax: the catalog price, the base region's tax removed from it and the rate used.
10643
+ * @internal
10644
+ * @readonly
10645
+ */
10646
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
10450
10647
  }
10451
10648
  /**
10452
10649
  * Adds a merchant comment to an order.
@@ -10640,4 +10837,4 @@ interface BulkUpdateOrderTagsOptions {
10640
10837
  unassignTags?: TagsTags;
10641
10838
  }
10642
10839
 
10643
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, TransactionStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, LineItemQuantityChangeType as aA, ActivityType as aB, OrderActivityTypeEnumActivityType as aC, AttributionSource as aD, ChannelType as aE, AdditionalFeeSource as aF, OrderActionType as aG, SpecificItemsCouponBehavior as aH, ChargeType as aI, VersioningMode as aJ, DeltaPaymentOptionType as aK, InventoryAction as aL, WebhookIdentityType as aM, PreviewEmailType as aN, State as aO, SiteCreatedContext as aP, Namespace as aQ, DeleteStatus as aR, Origin as aS, ScheduledAction as aT, DurationUnit as aU, PaymentCollectabilityStatus as aV, PredefinedPaymentMethod as aW, RefundableStatus as aX, NonRefundableReason as aY, ManuallyRefundableReason as aZ, RestockType as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, PaymentStatusEnumPaymentStatus as as, FulfillmentStatus as at, WeightUnit as au, VatType as av, PickupMethod as aw, OrderStatus as ax, DiscountType as ay, DiscountReason as az, type SetOrderNumberCounterResponse as b, type AddressWithContact as b$, AuthorizationCaptureStatus as b0, AuthorizationVoidStatus as b1, Reason as b2, ActionType as b3, ChargebackStatus as b4, MembershipPaymentStatus as b5, PaymentStatus as b6, CanceledReason as b7, DeclinedReason as b8, VoidedReason as b9, type LineItemTaxInfo as bA, type LineItemTaxBreakdown as bB, type DigitalFile as bC, type SubscriptionInfo as bD, type SubscriptionTitle as bE, type SubscriptionDescription as bF, type SubscriptionSettings as bG, type FreeTrialPeriod as bH, type BillingSettings as bI, type BillingAdjustment as bJ, type BillingAdjustmentPriceSummary as bK, type CyclePriceOverride as bL, type PriceDescription as bM, type LocationAndQuantity as bN, type TaxableAddress as bO, type TaxableAddressTaxableAddressDataOneOf as bP, type DecimalQuantity as bQ, type DecimalQuantityUnitOneOf as bR, type TranslatableString as bS, type ExtendedFields as bT, type ModifierGroup as bU, type ItemModifier as bV, type ServiceProperties as bW, type BuyerInfo as bX, type BuyerInfoIdOneOf as bY, type CurrencyConversionDetails as bZ, type PriceSummary as b_, RefundStatus as ba, SortOrder as bb, OrderApprovalStrategy as bc, Placement as bd, SubdivisionType as be, SourceType as bf, CustomFieldGroup as bg, ValueType as bh, DepositType as bi, InvoiceStatus as bj, type OrderLineItem as bk, type ProductName as bl, type CatalogReference as bm, type DescriptionLine as bn, type DescriptionLineValueOneOf as bo, type DescriptionLineDescriptionLineValueOneOf as bp, type DescriptionLineName as bq, type PlainTextValue as br, type Color as bs, type FocalPoint as bt, type PhysicalProperties as bu, type Dimensions as bv, type ItemType as bw, type ItemTypeItemTypeDataOneOf as bx, type RestockLocation as by, type ItemTaxFullDetails as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedAsStoreCredit as c$, type Address as c0, type StreetAddress as c1, type AddressLocation as c2, type FullAddressContactDetails as c3, type VatId as c4, type V1ShippingInformation as c5, type DeliveryLogistics as c6, type DeliveryLogisticsAddressOneOf as c7, type PickupDetails as c8, type PickupAddress as c9, type OrderChangeValueOneOf as cA, type LineItemChanges as cB, type LineItemQuantityChange as cC, type LineItemPriceChange as cD, type LineItemProductNameChange as cE, type LineItemDescriptionLineChange as cF, type LineItemModifiersChange as cG, type ManagedLineItem as cH, type ManagedDiscount as cI, type TranslatedValue as cJ, type LineItemAmount as cK, type ManagedAdditionalFee as cL, type TotalPriceChange as cM, type ShippingInformationChange as cN, type ShippingInformation as cO, type SavedPaymentMethod as cP, type AuthorizedPaymentCreated as cQ, type AuthorizedPaymentCaptured as cR, type AuthorizedPaymentVoided as cS, type RefundInitiated as cT, type RefundedPayment as cU, type RefundedPaymentKindOneOf as cV, type RegularPaymentRefund as cW, type GiftCardPaymentRefund as cX, type MembershipPaymentRefund as cY, type PaymentRefunded as cZ, type PaymentRefundFailed as c_, type DeliveryTimeSlot as ca, type ShippingPrice as cb, type ShippingRegion as cc, type TaxSummary as cd, type OrderTaxInfo as ce, type OrderTaxBreakdown as cf, type AppliedDiscount as cg, type AppliedDiscountDiscountSourceOneOf as ch, type Coupon as ci, type MerchantDiscount as cj, type MerchantDiscountMerchantDiscountReasonOneOf as ck, type DiscountRule as cl, type DiscountRuleName as cm, type LineItemDiscount as cn, type ItemCombination as co, type ItemCombinationLineItem as cp, type Activity as cq, type ActivityContentOneOf as cr, type CustomActivity as cs, type MerchantComment as ct, type OrderRefunded as cu, type OrderCreatedFromExchange as cv, type NewExchangeOrderCreated as cw, type LineItemExchangeData as cx, type DraftOrderChangesApplied as cy, type OrderChange as cz, type PreparePaymentCollectionOptions as d, type ItemChangedDetails as d$, type PaymentPending as d0, type PaymentPendingPaymentDetailsOneOf as d1, type RegularPayment as d2, type RegularPaymentPaymentMethodDetailsOneOf as d3, type CreditCardDetails as d4, type PaymentCanceled as d5, type PaymentCanceledPaymentDetailsOneOf as d6, type PaymentDeclined as d7, type PaymentDeclinedPaymentDetailsOneOf as d8, type ReceiptCreated as d9, type FormIdentifier as dA, type PlatformFeeSummary as dB, type PlatformFee as dC, type UpdateInternalDocumentsEvent as dD, type UpdateInternalDocumentsEventOperationOneOf as dE, type InternalDocument as dF, type InternalDocumentUpdateOperation as dG, type DeleteByIdsOperation as dH, type DeleteByFilterOperation as dI, type InternalDocumentUpdateByFilterOperation as dJ, type InternalUpdateExistingOperation as dK, type VersionedDocumentUpdateOperation as dL, type VersionedDeleteByIdsOperation as dM, type VersionedDocumentId as dN, type OrderApproved as dO, type OrdersExperiments as dP, type OrderRejectedEventOrderRejected as dQ, type OrderItemsRestocked as dR, type V1RestockItem as dS, type OrderImported as dT, type ImportedOrderDeleted as dU, type PaymentStatusUpdated as dV, type FulfillmentStatusUpdated as dW, type OrderCanceledEventOrderCanceled as dX, type OrderDeltasCommitted as dY, type CommittedDiffs as dZ, type CommittedDiffsShippingUpdateInfoOneOf as d_, type ReceiptCreatedReceiptInfoOneOf as da, type WixReceipt as db, type ExternalReceipt as dc, type ReceiptSent as dd, type ReceiptSentReceiptInfoOneOf as de, type ChargebackCreated as df, type ChargebackReversed as dg, type CreatedBy as dh, type CreatedByStringOneOf as di, type ChannelInfo as dj, type CustomField as dk, type BalanceSummary as dl, type Balance as dm, type CashRounding as dn, type AdditionalFee as dp, type FulfillmentStatusesAggregate as dq, type Tags as dr, type TagList as ds, type Location as dt, type OrderSettings as du, type OrderSettingsAllowedActionsOneOf as dv, type OrderSettingsEditableByOneOf as dw, type CustomAllowedActions as dx, type OwnerApps as dy, type FormInfo as dz, type PreparePaymentCollectionResponse as e, type PreviewBuyerPaymentsReceivedEmailRequest as e$, type OrderLineItemChangedDetails as e0, type DecimalQuantityUpdate as e1, type LineItemDelta as e2, type LineItemDeltaDeltaOneOf as e3, type AppliedDiscountDelta as e4, type AppliedDiscountDeltaDeltaOneOf as e5, type AdditionalFeeDelta as e6, type AdditionalFeeDeltaDeltaOneOf as e7, type DraftOrderCommitSettings as e8, type InventoryUpdateDetails as e9, type SendBuyerShippingConfirmationEmailRequest as eA, type SendBuyerShippingConfirmationEmailResponse as eB, type BulkSendBuyerShippingConfirmationEmailsRequest as eC, type BulkSendBuyerShippingConfirmationEmailsResponse as eD, type SendMerchantOrderReceivedNotificationRequest as eE, type SendMerchantOrderReceivedNotificationResponse as eF, type SendCancelRefundEmailRequest as eG, type SendCancelRefundEmailResponse as eH, type SendRefundEmailRequest as eI, type SendRefundEmailResponse as eJ, type SendFulfillmentEmailRequest as eK, type SendFulfillmentEmailResponse as eL, type SendMerchantOrderReceivedPushRequest as eM, type SendMerchantOrderReceivedPushResponse as eN, type PreviewEmailByTypeRequest as eO, type PreviewEmailByTypeResponse as eP, type PreviewRefundEmailRequest as eQ, type RefundDetails as eR, type RefundItem as eS, type LineItemRefund as eT, type AdditionalFeeRefund as eU, type ShippingRefund as eV, type PreviewRefundEmailResponse as eW, type PreviewCancelEmailRequest as eX, type PreviewCancelEmailResponse as eY, type PreviewCancelRefundEmailRequest as eZ, type PreviewCancelRefundEmailResponse as e_, type TriggerReindexRequest as ea, type TriggerReindexResponse as eb, type DomainEvent as ec, type DomainEventBodyOneOf as ed, type EntityCreatedEvent as ee, type RestoreInfo as ef, type EntityUpdatedEvent as eg, type EntityDeletedEvent as eh, type ActionEvent as ei, type Empty as ej, type TriggerReindexOrderRequest as ek, type MessageEnvelope as el, type IdentificationData as em, type IdentificationDataIdOneOf as en, type AccountInfo as eo, type ImportOrderRequest as ep, type SetOrderNumberCounterRequest as eq, type BulkDeleteImportedOrdersRequest as er, type SendBuyerConfirmationEmailRequest as es, type SendBuyerConfirmationEmailResponse as et, type SendBuyerPaymentsReceivedEmailRequest as eu, type SendBuyerPaymentsReceivedEmailResponse as ev, type SendBuyerPickupConfirmationEmailRequest as ew, type SendBuyerPickupConfirmationEmailResponse as ex, type BulkSendBuyerPickupConfirmationEmailsRequest as ey, type BulkSendBuyerPickupConfirmationEmailsResponse as ez, type PreparePaymentCollectionApplicationErrors as f, type GetRefundabilityStatusRequest as f$, type PreviewBuyerPaymentsReceivedEmailResponse as f0, type PreviewBuyerConfirmationEmailRequest as f1, type PreviewBuyerConfirmationEmailResponse as f2, type PreviewBuyerPickupConfirmationEmailRequest as f3, type PreviewBuyerPickupConfirmationEmailResponse as f4, type PreviewShippingConfirmationEmailRequest as f5, type PreviewShippingConfirmationEmailResponse as f6, type PreviewResendDownloadLinksEmailRequest as f7, type PreviewResendDownloadLinksEmailResponse as f8, type MetaSiteSpecialEvent as f9, type StudioTwoAssigned as fA, type StudioTwoUnassigned as fB, type UserDomainMediaEnabled as fC, type UserDomainMediaDisabled as fD, type EditorlessAssigned as fE, type EditorlessUnassigned as fF, type HasCustomEmailConfigurationsRequest as fG, type HasCustomEmailConfigurationsResponse as fH, type AddToAutomationMigrationPopulationRequest as fI, type AddToAutomationMigrationPopulationResponse as fJ, type IsInAutomationMigrationPopulationRequest as fK, type IsInAutomationMigrationPopulationResponse as fL, type PreparePaymentCollectionRequest as fM, type RedirectUrls as fN, type DelayedCaptureSettings as fO, type Duration as fP, type GetPaymentCollectabilityStatusRequest as fQ, type RecordManuallyCollectedPaymentRequest as fR, type UserDefinedPaymentMethodName as fS, type UserDefinedPaymentMethodNameKindOneOf as fT, type RecordManuallyCollectedPaymentResponse as fU, type MarkOrderAsPaidRequest as fV, type BulkMarkOrdersAsPaidRequest as fW, type BulkOrderResult as fX, type ItemMetadata as fY, type ApplicationError as fZ, type BulkActionMetadata as f_, type MetaSiteSpecialEventPayloadOneOf as fa, type Asset as fb, type SiteCreated as fc, type SiteTransferred as fd, type SiteDeleted as fe, type DeleteContext as ff, type SiteUndeleted as fg, type SitePublished as fh, type SiteUnpublished as fi, type SiteMarkedAsTemplate as fj, type SiteMarkedAsWixSite as fk, type ServiceProvisioned as fl, type ServiceRemoved as fm, type SiteRenamed as fn, type SiteHardDeleted as fo, type NamespaceChanged as fp, type StudioAssigned as fq, type StudioUnassigned as fr, type SiteUrlChanged as fs, type SitePurgedExternally as ft, type OdeditorAssigned as fu, type OdeditorUnassigned as fv, type PicassoAssigned as fw, type PicassoUnassigned as fx, type WixelAssigned as fy, type WixelUnassigned as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type PlatformPaging as g$, type Refundability as g0, type RefundabilityAdditionalRefundabilityInfoOneOf as g1, type CreatePaymentGatewayOrderRequest as g2, type ChargedBy as g3, type ChargeMembershipsRequest as g4, type MembershipChargeItem as g5, type MembershipName as g6, type ChargeMembershipsResponse as g7, type TriggerRefundRequest as g8, type RefundSideEffects as g9, type PaymentStatusDetails as gA, type PaymentStatusDetailsStatusDetailsOneOf as gB, type Refund as gC, type RefundTransaction as gD, type RefundStatusInfo as gE, type AggregatedRefundSummary as gF, type RefundItemsBreakdown as gG, type LineItemRefundSummary as gH, type CalculateRefundRequest as gI, type CalculateRefundItemRequest as gJ, type CalculateRefundResponse as gK, type CalculateRefundItemResponse as gL, type VoidAuthorizedPaymentsRequest as gM, type CaptureAuthorizedPaymentsRequest as gN, type ChargeSavedPaymentMethodRequest as gO, type ChargeSavedPaymentMethodResponse as gP, type V1TriggerReindexRequest as gQ, type V1TriggerReindexResponse as gR, type V1TriggerReindexOrderRequest as gS, type DiffmatokyPayload as gT, type ErrorInformation as gU, type GetOrderRequest as gV, type GetOrderResponse as gW, type InternalQueryOrdersRequest as gX, type PlatformQuery as gY, type PlatformQueryPagingMethodOneOf as gZ, type Sorting as g_, type RestockInfo as ga, type RestockItem as gb, type OrderTransactions as gc, type Payment as gd, type PaymentPaymentDetailsOneOf as ge, type PaymentReceiptInfoOneOf as gf, type PaymentStatusDetailsOneOf as gg, type RegularPaymentDetails as gh, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gi, type CreditCardPaymentMethodDetails as gj, type AuthorizationDetails as gk, type AuthorizationCapture as gl, type AuthorizationActionFailureDetails as gm, type AuthorizationVoid as gn, type V1ScheduledAction as go, type Chargeback as gp, type PaymentMethodName as gq, type GiftCardPaymentDetails as gr, type MembershipPaymentDetails as gs, type FutureMembershipDetails as gt, type WixReceiptInfo as gu, type ExternalReceiptInfo as gv, type CashRoundingDetails as gw, type CanceledStatusDetails as gx, type DeclinedStatusDetails as gy, type VoidedStatusDetails as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type TrackingLinkAdded as h$, type CursorPaging as h0, type InternalQueryOrdersResponse as h1, type PlatformPagingMetadata as h2, type Cursors as h3, type QueryOrderRequest as h4, type QueryOrderResponse as h5, type SearchOrdersRequest as h6, type CursorSearch as h7, type CursorSearchPagingMethodOneOf as h8, type CursorPagingMetadata as h9, type BulkUnArchiveOrdersResponse as hA, type BulkUnArchiveOrdersByFilterRequest as hB, type BulkUnArchiveOrdersByFilterResponse as hC, type UpdateBuyerInfoRequest as hD, type BuyerInfoUpdate as hE, type UpdateBuyerInfoResponse as hF, type UpdateBuyerEmailRequest as hG, type UpdateBuyerEmailResponse as hH, type UpdateOrderShippingAddressRequest as hI, type UpdateOrderShippingAddressResponse as hJ, type UpdateBillingContactDetailsRequest as hK, type UpdateBillingContactDetailsResponse as hL, type UpdateOrderLineItemRequest as hM, type UpdateOrderLineItemsRequest as hN, type MaskedOrderLineItem as hO, type UpdateOrderLineItemsResponse as hP, type AddInternalActivityRequest as hQ, type InternalActivity as hR, type InternalActivityContentOneOf as hS, type OrderPlaced as hT, type OrderPaid as hU, type OrderFulfilled as hV, type OrderNotFulfilled as hW, type OrderCanceled as hX, type DownloadLinkSent as hY, type TrackingNumberAdded as hZ, type TrackingNumberEdited as h_, type CreateOrderRequest as ha, type OrderCreationSettings as hb, type OrderCreationSettingsEditableByOneOf as hc, type OrderCreateNotifications as hd, type CreateOrderResponse as he, type UpdateOrderRequest as hf, type UpdateOrderResponse as hg, type BulkUpdateOrdersRequest as hh, type CommitDeltasRequest as hi, type DraftOrderDiffs as hj, type DraftOrderDiffsShippingUpdateInfoOneOf as hk, type DraftOrderDiffsBuyerUpdateInfoOneOf as hl, type DraftOrderDiffsBillingUpdateInfoOneOf as hm, type DraftOrderDiffsRecipientUpdateInfoOneOf as hn, type V1LineItemDelta as ho, type V1LineItemDeltaDeltaOneOf as hp, type CommitDeltasResponse as hq, type ArchiveOrderRequest as hr, type ArchiveOrderResponse as hs, type BulkArchiveOrdersRequest as ht, type BulkArchiveOrdersResponse as hu, type BulkArchiveOrdersByFilterRequest as hv, type BulkArchiveOrdersByFilterResponse as hw, type UnArchiveOrderRequest as hx, type UnArchiveOrderResponse as hy, type BulkUnArchiveOrdersRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type Cancel as i$, type ShippingConfirmationEmailSent as i0, type InvoiceAdded as i1, type InvoiceSent as i2, type FulfillerEmailSent as i3, type ShippingAddressEdited as i4, type EmailEdited as i5, type PickupReadyEmailSent as i6, type OrderPartiallyPaid as i7, type OrderPending as i8, type OrderRejected as i9, type BulkMarkAsUnfulfilledByFilterResponse as iA, type BulkSetBusinessLocationRequest as iB, type BulkSetBusinessLocationResponse as iC, type BulkSetBusinessLocationResult as iD, type V1MarkOrderAsPaidRequest as iE, type V1MarkOrderAsPaidResponse as iF, type V1BulkMarkOrdersAsPaidRequest as iG, type V1BulkMarkOrdersAsPaidResponse as iH, type V1CreatePaymentGatewayOrderRequest as iI, type V1CreatePaymentGatewayOrderResponse as iJ, type GetShipmentsRequest as iK, type GetShipmentsResponse as iL, type AggregateOrdersRequest as iM, type DecrementItemsQuantityRequest as iN, type DecrementData as iO, type DecrementItemsQuantityResponse as iP, type BulkUpdateOrderTagsRequest as iQ, type TagsTags as iR, type TagsTagList as iS, type BulkUpdateOrderTagsResult as iT, type SendOrderUpdatedDomainEventRequest as iU, type SendOrderUpdatedDomainEventResponse as iV, type Task as iW, type TaskKey as iX, type TaskAction as iY, type TaskActionActionOneOf as iZ, type Complete as i_, type AddInternalActivityResponse as ia, type AddActivityRequest as ib, type PublicActivityContentOneOf as ic, type AddActivitiesRequest as id, type UpdateActivityRequest as ie, type DeleteActivityRequest as ig, type UpdateLineItemsDescriptionLinesRequest as ih, type LineItemUpdate as ii, type UpdateLineItemsDescriptionLinesResponse as ij, type MarkOrderAsSeenByHumanRequest as ik, type MarkOrderAsSeenByHumanResponse as il, type CancelOrderRequest as im, type UpdateOrderStatusRequest as io, type MarkAsFulfilledRequest as ip, type MarkAsFulfilledResponse as iq, type BulkMarkAsFulfilledRequest as ir, type BulkMarkAsFulfilledResponse as is, type BulkMarkAsFulfilledByFilterRequest as it, type BulkMarkAsFulfilledByFilterResponse as iu, type MarkAsUnfulfilledRequest as iv, type MarkAsUnfulfilledResponse as iw, type BulkMarkAsUnfulfilledRequest as ix, type BulkMarkAsUnfulfilledResponse as iy, type BulkMarkAsUnfulfilledByFilterRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type AdditionalFeeSourceWithLiterals as j$, type Reschedule as j0, type InvoiceSentEvent as j1, type IdAndVersion as j2, type InvoiceFields as j3, type Customer as j4, type Email as j5, type QuotesAddress as j6, type AddressDescription as j7, type Phone as j8, type Company as j9, type BaseEventMetadata as jA, type EventMetadata as jB, type AccountInfoMetadata as jC, type OrderSearchSpec as jD, utils as jE, type DescriptionLineTypeWithLiterals as jF, type DimensionsUnitWithLiterals as jG, type ItemTypePresetWithLiterals as jH, type PaymentOptionTypeWithLiterals as jI, type JurisdictionTypeWithLiterals as jJ, type SubscriptionFrequencyWithLiterals as jK, type ProductPeriodAlignmentWithLiterals as jL, type AdjustmentTypeWithLiterals as jM, type TaxableAddressTypeWithLiterals as jN, type MeasurementUnitWithLiterals as jO, type PaymentStatusEnumPaymentStatusWithLiterals as jP, type FulfillmentStatusWithLiterals as jQ, type WeightUnitWithLiterals as jR, type VatTypeWithLiterals as jS, type PickupMethodWithLiterals as jT, type DiscountTypeWithLiterals as jU, type DiscountReasonWithLiterals as jV, type LineItemQuantityChangeTypeWithLiterals as jW, type ActivityTypeWithLiterals as jX, type OrderActivityTypeEnumActivityTypeWithLiterals as jY, type AttributionSourceWithLiterals as jZ, type ChannelTypeWithLiterals as j_, type CommonAddress as ja, type CommonAddressStreetOneOf as jb, type Subdivision as jc, type StandardDetails as jd, type ShippingContactDetails as je, type InvoiceDates as jf, type LineItems as jg, type LineItem as jh, type BigDecimalWrapper as ji, type LineItemTax as jj, type Source as jk, type LineItemMetaData as jl, type Locale as jm, type TotalPrice as jn, type ItemizedFee as jo, type Discount as jp, type DiscountOneDiscountTypeOneOf as jq, type CalculatedTaxes as jr, type CalculatedTax as js, type Payments as jt, type InvoicesPayment as ju, type MetaData as jv, type InvoiceDynamicPriceTotals as jw, type CustomFieldValue as jx, type Value as jy, type Deposit as jz, type GetRefundabilityStatusResponse as k, triggerRefund as k$, type OrderActionTypeWithLiterals as k0, type SpecificItemsCouponBehaviorWithLiterals as k1, type ChargeTypeWithLiterals as k2, type VersioningModeWithLiterals as k3, type DeltaPaymentOptionTypeWithLiterals as k4, type InventoryActionWithLiterals as k5, type WebhookIdentityTypeWithLiterals as k6, type PreviewEmailTypeWithLiterals as k7, type StateWithLiterals as k8, type SiteCreatedContextWithLiterals as k9, type SubdivisionTypeWithLiterals as kA, type SourceTypeWithLiterals as kB, type CustomFieldGroupWithLiterals as kC, type ValueTypeWithLiterals as kD, type DepositTypeWithLiterals as kE, type InvoiceStatusWithLiterals as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, recordManuallyCollectedPayment as kV, paymentCollectionMarkOrderAsPaid as kW, paymentCollectionBulkMarkOrdersAsPaid as kX, getRefundabilityStatus as kY, paymentCollectionCreatePaymentGatewayOrder as kZ, chargeMemberships as k_, type NamespaceWithLiterals as ka, type DeleteStatusWithLiterals as kb, type OriginWithLiterals as kc, type ScheduledActionWithLiterals as kd, type DurationUnitWithLiterals as ke, type PaymentCollectabilityStatusWithLiterals as kf, type PredefinedPaymentMethodWithLiterals as kg, type RefundableStatusWithLiterals as kh, type NonRefundableReasonWithLiterals as ki, type ManuallyRefundableReasonWithLiterals as kj, type RestockTypeWithLiterals as kk, type TransactionStatusWithLiterals as kl, type AuthorizationCaptureStatusWithLiterals as km, type AuthorizationVoidStatusWithLiterals as kn, type ReasonWithLiterals as ko, type ActionTypeWithLiterals as kp, type ChargebackStatusWithLiterals as kq, type MembershipPaymentStatusWithLiterals as kr, type PaymentStatusWithLiterals as ks, type CanceledReasonWithLiterals as kt, type DeclinedReasonWithLiterals as ku, type VoidedReasonWithLiterals as kv, type RefundStatusWithLiterals as kw, type SortOrderWithLiterals as kx, type OrderApprovalStrategyWithLiterals as ky, type PlacementWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, voidAuthorizedPayments as l0, captureAuthorizedPayments as l1, getOrder as l2, createOrder as l3, updateOrder as l4, bulkUpdateOrders as l5, updateOrderLineItem as l6, addActivity as l7, addActivities as l8, updateActivity as l9, deleteActivity as la, cancelOrder as lb, updateOrderStatus as lc, aggregateOrders as ld, bulkUpdateOrderTags as le, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10840
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, AuthorizationVoidStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountReason as aD, LineItemQuantityChangeType as aE, ActivityType as aF, OrderActivityTypeEnumActivityType as aG, AttributionSource as aH, ChannelType as aI, AdditionalFeeSource as aJ, OrderActionType as aK, SpecificItemsCouponBehavior as aL, ChargeType as aM, VersioningMode as aN, DeltaPaymentOptionType as aO, InventoryAction as aP, WebhookIdentityType as aQ, ScheduledAction as aR, DurationUnit as aS, PaymentCollectabilityStatus as aT, PredefinedPaymentMethod as aU, RefundableStatus as aV, NonRefundableReason as aW, ManuallyRefundableReason as aX, RestockType as aY, TransactionStatus as aZ, AuthorizationCaptureStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type CrossBorderPriceAdjustment as b$, Reason as b0, ActionType as b1, ChargebackStatus as b2, MembershipPaymentStatus as b3, PaymentStatus as b4, CanceledReason as b5, DeclinedReason as b6, VoidedReason as b7, RefundStatus as b8, PreviewEmailType as b9, type ItemType as bA, type ItemTypeItemTypeDataOneOf as bB, type RestockLocation as bC, type ItemTaxFullDetails as bD, type LineItemTaxInfo as bE, type LineItemTaxBreakdown as bF, type DigitalFile as bG, type SubscriptionInfo as bH, type SubscriptionTitle as bI, type SubscriptionDescription as bJ, type SubscriptionSettings as bK, type FreeTrialPeriod as bL, type BillingSettings as bM, type BillingAdjustment as bN, type BillingAdjustmentPriceSummary as bO, type CyclePriceOverride as bP, type PriceDescription as bQ, type LocationAndQuantity as bR, type TaxableAddress as bS, type TaxableAddressTaxableAddressDataOneOf as bT, type DecimalQuantity as bU, type DecimalQuantityUnitOneOf as bV, type TranslatableString as bW, type ExtendedFields as bX, type ModifierGroup as bY, type ItemModifier as bZ, type ServiceProperties as b_, State as ba, SiteCreatedContext as bb, Namespace as bc, DeleteStatus as bd, Origin as be, SortOrder as bf, OrderApprovalStrategy as bg, Placement as bh, SubdivisionType as bi, SourceType as bj, CustomFieldGroup as bk, ValueType as bl, DepositType as bm, InvoiceStatus as bn, type OrderLineItem as bo, type ProductName as bp, type CatalogReference as bq, type DescriptionLine as br, type DescriptionLineValueOneOf as bs, type DescriptionLineDescriptionLineValueOneOf as bt, type DescriptionLineName as bu, type PlainTextValue as bv, type Color as bw, type FocalPoint as bx, type PhysicalProperties as by, type Dimensions as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedPayment as c$, type BuyerInfo as c0, type BuyerInfoIdOneOf as c1, type CurrencyConversionDetails as c2, type CrossBorderRepricing as c3, type PriceSummary as c4, type AddressWithContact as c5, type Address as c6, type StreetAddress as c7, type AddressLocation as c8, type FullAddressContactDetails as c9, type MerchantComment as cA, type OrderRefunded as cB, type OrderCreatedFromExchange as cC, type NewExchangeOrderCreated as cD, type LineItemExchangeData as cE, type DraftOrderChangesApplied as cF, type OrderChange as cG, type OrderChangeValueOneOf as cH, type LineItemChanges as cI, type LineItemQuantityChange as cJ, type LineItemPriceChange as cK, type LineItemProductNameChange as cL, type LineItemDescriptionLineChange as cM, type LineItemModifiersChange as cN, type ManagedLineItem as cO, type ManagedDiscount as cP, type TranslatedValue as cQ, type LineItemAmount as cR, type ManagedAdditionalFee as cS, type TotalPriceChange as cT, type ShippingInformationChange as cU, type ShippingInformation as cV, type SavedPaymentMethod as cW, type AuthorizedPaymentCreated as cX, type AuthorizedPaymentCaptured as cY, type AuthorizedPaymentVoided as cZ, type RefundInitiated as c_, type VatId as ca, type V1ShippingInformation as cb, type DeliveryLogistics as cc, type DeliveryLogisticsAddressOneOf as cd, type PickupDetails as ce, type PickupAddress as cf, type DeliveryTimeSlot as cg, type ShippingPrice as ch, type ShippingRegion as ci, type TaxSummary as cj, type OrderTaxInfo as ck, type OrderTaxBreakdown as cl, type CrossBorderCalculation as cm, type AppliedDiscount as cn, type AppliedDiscountDiscountSourceOneOf as co, type Coupon as cp, type MerchantDiscount as cq, type MerchantDiscountMerchantDiscountReasonOneOf as cr, type DiscountRule as cs, type DiscountRuleName as ct, type LineItemDiscount as cu, type ItemCombination as cv, type ItemCombinationLineItem as cw, type Activity as cx, type ActivityContentOneOf as cy, type CustomActivity as cz, type PreparePaymentCollectionOptions as d, type ImportedOrderDeleted as d$, type RefundedPaymentKindOneOf as d0, type RegularPaymentRefund as d1, type GiftCardPaymentRefund as d2, type MembershipPaymentRefund as d3, type PaymentRefunded as d4, type PaymentRefundFailed as d5, type RefundedAsStoreCredit as d6, type PaymentPending as d7, type PaymentPendingPaymentDetailsOneOf as d8, type RegularPayment as d9, type Location as dA, type OrderSettings as dB, type OrderSettingsAllowedActionsOneOf as dC, type OrderSettingsEditableByOneOf as dD, type CustomAllowedActions as dE, type OwnerApps as dF, type FormInfo as dG, type FormIdentifier as dH, type PlatformFeeSummary as dI, type PlatformFee as dJ, type UpdateInternalDocumentsEvent as dK, type UpdateInternalDocumentsEventOperationOneOf as dL, type InternalDocument as dM, type InternalDocumentUpdateOperation as dN, type DeleteByIdsOperation as dO, type DeleteByFilterOperation as dP, type InternalDocumentUpdateByFilterOperation as dQ, type InternalUpdateExistingOperation as dR, type VersionedDocumentUpdateOperation as dS, type VersionedDeleteByIdsOperation as dT, type VersionedDocumentId as dU, type OrderApproved as dV, type OrdersExperiments as dW, type OrderRejectedEventOrderRejected as dX, type OrderItemsRestocked as dY, type V1RestockItem as dZ, type OrderImported as d_, type RegularPaymentPaymentMethodDetailsOneOf as da, type CreditCardDetails as db, type PaymentCanceled as dc, type PaymentCanceledPaymentDetailsOneOf as dd, type PaymentDeclined as de, type PaymentDeclinedPaymentDetailsOneOf as df, type ReceiptCreated as dg, type ReceiptCreatedReceiptInfoOneOf as dh, type WixReceipt as di, type ExternalReceipt as dj, type ReceiptSent as dk, type ReceiptSentReceiptInfoOneOf as dl, type ChargebackCreated as dm, type ChargebackReversed as dn, type CreatedBy as dp, type CreatedByStringOneOf as dq, type ChannelInfo as dr, type CustomField as ds, type BalanceSummary as dt, type Balance as du, type CashRounding as dv, type AdditionalFee as dw, type FulfillmentStatusesAggregate as dx, type Tags as dy, type TagList as dz, type PreparePaymentCollectionResponse as e, type TriggerRefundRequest as e$, type PaymentStatusUpdated as e0, type FulfillmentStatusUpdated as e1, type OrderCanceledEventOrderCanceled as e2, type OrderDeltasCommitted as e3, type CommittedDiffs as e4, type CommittedDiffsShippingUpdateInfoOneOf as e5, type ItemChangedDetails as e6, type OrderLineItemChangedDetails as e7, type DecimalQuantityUpdate as e8, type CrossBorderAdjustmentUpdate as e9, type V1TriggerReindexRequest as eA, type V1TriggerReindexResponse as eB, type V1TriggerReindexOrderRequest as eC, type PreparePaymentCollectionRequest as eD, type RedirectUrls as eE, type DelayedCaptureSettings as eF, type Duration as eG, type GetPaymentCollectabilityStatusRequest as eH, type RecordManuallyCollectedPaymentRequest as eI, type UserDefinedPaymentMethodName as eJ, type UserDefinedPaymentMethodNameKindOneOf as eK, type RecordManuallyCollectedPaymentResponse as eL, type MarkOrderAsPaidRequest as eM, type BulkMarkOrdersAsPaidRequest as eN, type BulkOrderResult as eO, type ItemMetadata as eP, type ApplicationError as eQ, type BulkActionMetadata as eR, type GetRefundabilityStatusRequest as eS, type Refundability as eT, type RefundabilityAdditionalRefundabilityInfoOneOf as eU, type CreatePaymentGatewayOrderRequest as eV, type ChargedBy as eW, type ChargeMembershipsRequest as eX, type MembershipChargeItem as eY, type MembershipName as eZ, type ChargeMembershipsResponse as e_, type LineItemDelta as ea, type LineItemDeltaDeltaOneOf as eb, type AppliedDiscountDelta as ec, type AppliedDiscountDeltaDeltaOneOf as ed, type AdditionalFeeDelta as ee, type AdditionalFeeDeltaDeltaOneOf as ef, type DraftOrderCommitSettings as eg, type InventoryUpdateDetails as eh, type TriggerReindexRequest as ei, type TriggerReindexResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type TriggerReindexOrderRequest as es, type MessageEnvelope as et, type IdentificationData as eu, type IdentificationDataIdOneOf as ev, type AccountInfo as ew, type ImportOrderRequest as ex, type SetOrderNumberCounterRequest as ey, type BulkDeleteImportedOrdersRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type SendCancelRefundEmailResponse as f$, type RefundDetails as f0, type RefundItem as f1, type LineItemRefund as f2, type AdditionalFeeRefund as f3, type ShippingRefund as f4, type RefundSideEffects as f5, type RestockInfo as f6, type RestockItem as f7, type OrderTransactions as f8, type Payment as f9, type RefundStatusInfo as fA, type AggregatedRefundSummary as fB, type RefundItemsBreakdown as fC, type LineItemRefundSummary as fD, type CalculateRefundRequest as fE, type CalculateRefundItemRequest as fF, type CalculateRefundResponse as fG, type CalculateRefundItemResponse as fH, type VoidAuthorizedPaymentsRequest as fI, type CaptureAuthorizedPaymentsRequest as fJ, type ChargeSavedPaymentMethodRequest as fK, type ChargeSavedPaymentMethodResponse as fL, type SendBuyerConfirmationEmailRequest as fM, type SendBuyerConfirmationEmailResponse as fN, type SendBuyerPaymentsReceivedEmailRequest as fO, type SendBuyerPaymentsReceivedEmailResponse as fP, type SendBuyerPickupConfirmationEmailRequest as fQ, type SendBuyerPickupConfirmationEmailResponse as fR, type BulkSendBuyerPickupConfirmationEmailsRequest as fS, type BulkSendBuyerPickupConfirmationEmailsResponse as fT, type SendBuyerShippingConfirmationEmailRequest as fU, type SendBuyerShippingConfirmationEmailResponse as fV, type BulkSendBuyerShippingConfirmationEmailsRequest as fW, type BulkSendBuyerShippingConfirmationEmailsResponse as fX, type SendMerchantOrderReceivedNotificationRequest as fY, type SendMerchantOrderReceivedNotificationResponse as fZ, type SendCancelRefundEmailRequest as f_, type PaymentPaymentDetailsOneOf as fa, type PaymentReceiptInfoOneOf as fb, type PaymentStatusDetailsOneOf as fc, type RegularPaymentDetails as fd, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fe, type CreditCardPaymentMethodDetails as ff, type AuthorizationDetails as fg, type AuthorizationCapture as fh, type AuthorizationActionFailureDetails as fi, type AuthorizationVoid as fj, type V1ScheduledAction as fk, type Chargeback as fl, type PaymentMethodName as fm, type GiftCardPaymentDetails as fn, type MembershipPaymentDetails as fo, type FutureMembershipDetails as fp, type WixReceiptInfo as fq, type ExternalReceiptInfo as fr, type CashRoundingDetails as fs, type CanceledStatusDetails as ft, type DeclinedStatusDetails as fu, type VoidedStatusDetails as fv, type PaymentStatusDetails as fw, type PaymentStatusDetailsStatusDetailsOneOf as fx, type Refund as fy, type RefundTransaction as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type DiffmatokyPayload as g$, type SendRefundEmailRequest as g0, type SendRefundEmailResponse as g1, type SendFulfillmentEmailRequest as g2, type SendFulfillmentEmailResponse as g3, type SendMerchantOrderReceivedPushRequest as g4, type SendMerchantOrderReceivedPushResponse as g5, type PreviewEmailByTypeRequest as g6, type PreviewEmailByTypeResponse as g7, type PreviewRefundEmailRequest as g8, type PreviewRefundEmailResponse as g9, type ServiceProvisioned as gA, type ServiceRemoved as gB, type SiteRenamed as gC, type SiteHardDeleted as gD, type NamespaceChanged as gE, type StudioAssigned as gF, type StudioUnassigned as gG, type SiteUrlChanged as gH, type SitePurgedExternally as gI, type OdeditorAssigned as gJ, type OdeditorUnassigned as gK, type PicassoAssigned as gL, type PicassoUnassigned as gM, type WixelAssigned as gN, type WixelUnassigned as gO, type StudioTwoAssigned as gP, type StudioTwoUnassigned as gQ, type UserDomainMediaEnabled as gR, type UserDomainMediaDisabled as gS, type EditorlessAssigned as gT, type EditorlessUnassigned as gU, type HasCustomEmailConfigurationsRequest as gV, type HasCustomEmailConfigurationsResponse as gW, type AddToAutomationMigrationPopulationRequest as gX, type AddToAutomationMigrationPopulationResponse as gY, type IsInAutomationMigrationPopulationRequest as gZ, type IsInAutomationMigrationPopulationResponse as g_, type PreviewCancelEmailRequest as ga, type PreviewCancelEmailResponse as gb, type PreviewCancelRefundEmailRequest as gc, type PreviewCancelRefundEmailResponse as gd, type PreviewBuyerPaymentsReceivedEmailRequest as ge, type PreviewBuyerPaymentsReceivedEmailResponse as gf, type PreviewBuyerConfirmationEmailRequest as gg, type PreviewBuyerConfirmationEmailResponse as gh, type PreviewBuyerPickupConfirmationEmailRequest as gi, type PreviewBuyerPickupConfirmationEmailResponse as gj, type PreviewShippingConfirmationEmailRequest as gk, type PreviewShippingConfirmationEmailResponse as gl, type PreviewResendDownloadLinksEmailRequest as gm, type PreviewResendDownloadLinksEmailResponse as gn, type MetaSiteSpecialEvent as go, type MetaSiteSpecialEventPayloadOneOf as gp, type Asset as gq, type SiteCreated as gr, type SiteTransferred as gs, type SiteDeleted as gt, type DeleteContext as gu, type SiteUndeleted as gv, type SitePublished as gw, type SiteUnpublished as gx, type SiteMarkedAsTemplate as gy, type SiteMarkedAsWixSite as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type OrderPlaced as h$, type ErrorInformation as h0, type GetOrderRequest as h1, type GetOrderResponse as h2, type InternalQueryOrdersRequest as h3, type PlatformQuery as h4, type PlatformQueryPagingMethodOneOf as h5, type Sorting as h6, type PlatformPaging as h7, type CursorPaging as h8, type InternalQueryOrdersResponse as h9, type ArchiveOrderResponse as hA, type BulkArchiveOrdersRequest as hB, type BulkArchiveOrdersResponse as hC, type BulkArchiveOrdersByFilterRequest as hD, type BulkArchiveOrdersByFilterResponse as hE, type UnArchiveOrderRequest as hF, type UnArchiveOrderResponse as hG, type BulkUnArchiveOrdersRequest as hH, type BulkUnArchiveOrdersResponse as hI, type BulkUnArchiveOrdersByFilterRequest as hJ, type BulkUnArchiveOrdersByFilterResponse as hK, type UpdateBuyerInfoRequest as hL, type BuyerInfoUpdate as hM, type UpdateBuyerInfoResponse as hN, type UpdateBuyerEmailRequest as hO, type UpdateBuyerEmailResponse as hP, type UpdateOrderShippingAddressRequest as hQ, type UpdateOrderShippingAddressResponse as hR, type UpdateBillingContactDetailsRequest as hS, type UpdateBillingContactDetailsResponse as hT, type UpdateOrderLineItemRequest as hU, type UpdateOrderLineItemsRequest as hV, type MaskedOrderLineItem as hW, type UpdateOrderLineItemsResponse as hX, type AddInternalActivityRequest as hY, type InternalActivity as hZ, type InternalActivityContentOneOf as h_, type PlatformPagingMetadata as ha, type Cursors as hb, type QueryOrderRequest as hc, type QueryOrderResponse as hd, type SearchOrdersRequest as he, type CursorSearch as hf, type CursorSearchPagingMethodOneOf as hg, type CursorPagingMetadata as hh, type CreateOrderRequest as hi, type OrderCreationSettings as hj, type OrderCreationSettingsEditableByOneOf as hk, type OrderCreateNotifications as hl, type CreateOrderResponse as hm, type UpdateOrderRequest as hn, type UpdateOrderResponse as ho, type BulkUpdateOrdersRequest as hp, type CommitDeltasRequest as hq, type DraftOrderDiffs as hr, type DraftOrderDiffsShippingUpdateInfoOneOf as hs, type DraftOrderDiffsBuyerUpdateInfoOneOf as ht, type DraftOrderDiffsBillingUpdateInfoOneOf as hu, type DraftOrderDiffsRecipientUpdateInfoOneOf as hv, type V1LineItemDelta as hw, type V1LineItemDeltaDeltaOneOf as hx, type CommitDeltasResponse as hy, type ArchiveOrderRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type BulkUpdateOrderTagsResult as i$, type OrderPaid as i0, type OrderFulfilled as i1, type OrderNotFulfilled as i2, type OrderCanceled as i3, type DownloadLinkSent as i4, type TrackingNumberAdded as i5, type TrackingNumberEdited as i6, type TrackingLinkAdded as i7, type ShippingConfirmationEmailSent as i8, type InvoiceAdded as i9, type BulkMarkAsFulfilledResponse as iA, type BulkMarkAsFulfilledByFilterRequest as iB, type BulkMarkAsFulfilledByFilterResponse as iC, type MarkAsUnfulfilledRequest as iD, type MarkAsUnfulfilledResponse as iE, type BulkMarkAsUnfulfilledRequest as iF, type BulkMarkAsUnfulfilledResponse as iG, type BulkMarkAsUnfulfilledByFilterRequest as iH, type BulkMarkAsUnfulfilledByFilterResponse as iI, type BulkSetBusinessLocationRequest as iJ, type BulkSetBusinessLocationResponse as iK, type BulkSetBusinessLocationResult as iL, type V1MarkOrderAsPaidRequest as iM, type V1MarkOrderAsPaidResponse as iN, type V1BulkMarkOrdersAsPaidRequest as iO, type V1BulkMarkOrdersAsPaidResponse as iP, type V1CreatePaymentGatewayOrderRequest as iQ, type V1CreatePaymentGatewayOrderResponse as iR, type GetShipmentsRequest as iS, type GetShipmentsResponse as iT, type AggregateOrdersRequest as iU, type DecrementItemsQuantityRequest as iV, type DecrementData as iW, type DecrementItemsQuantityResponse as iX, type BulkUpdateOrderTagsRequest as iY, type TagsTags as iZ, type TagsTagList as i_, type InvoiceSent as ia, type FulfillerEmailSent as ib, type ShippingAddressEdited as ic, type EmailEdited as id, type PickupReadyEmailSent as ie, type OrderPartiallyPaid as ig, type OrderPending as ih, type OrderRejected as ii, type AddInternalActivityResponse as ij, type AddActivityRequest as ik, type PublicActivityContentOneOf as il, type AddActivitiesRequest as im, type UpdateActivityRequest as io, type DeleteActivityRequest as ip, type UpdateLineItemsDescriptionLinesRequest as iq, type LineItemUpdate as ir, type UpdateLineItemsDescriptionLinesResponse as is, type MarkOrderAsSeenByHumanRequest as it, type MarkOrderAsSeenByHumanResponse as iu, type CancelOrderRequest as iv, type UpdateOrderStatusRequest as iw, type MarkAsFulfilledRequest as ix, type MarkAsFulfilledResponse as iy, type BulkMarkAsFulfilledRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type WeightUnitWithLiterals as j$, type SendOrderUpdatedDomainEventRequest as j0, type SendOrderUpdatedDomainEventResponse as j1, type Task as j2, type TaskKey as j3, type TaskAction as j4, type TaskActionActionOneOf as j5, type Complete as j6, type Cancel as j7, type Reschedule as j8, type InvoiceSentEvent as j9, type CalculatedTax as jA, type Payments as jB, type InvoicesPayment as jC, type MetaData as jD, type InvoiceDynamicPriceTotals as jE, type CustomFieldValue as jF, type Value as jG, type Deposit as jH, type BaseEventMetadata as jI, type EventMetadata as jJ, type AccountInfoMetadata as jK, type OrderSearchSpec as jL, utils as jM, type DescriptionLineTypeWithLiterals as jN, type DimensionsUnitWithLiterals as jO, type ItemTypePresetWithLiterals as jP, type PaymentOptionTypeWithLiterals as jQ, type JurisdictionTypeWithLiterals as jR, type SubscriptionFrequencyWithLiterals as jS, type ProductPeriodAlignmentWithLiterals as jT, type AdjustmentTypeWithLiterals as jU, type TaxableAddressTypeWithLiterals as jV, type MeasurementUnitWithLiterals as jW, type RepriceStatusWithLiterals as jX, type BaseRateSourceWithLiterals as jY, type PaymentStatusEnumPaymentStatusWithLiterals as jZ, type FulfillmentStatusWithLiterals as j_, type IdAndVersion as ja, type InvoiceFields as jb, type Customer as jc, type Email as jd, type QuotesAddress as je, type AddressDescription as jf, type Phone as jg, type Company as jh, type CommonAddress as ji, type CommonAddressStreetOneOf as jj, type Subdivision as jk, type StandardDetails as jl, type ShippingContactDetails as jm, type InvoiceDates as jn, type LineItems as jo, type LineItem as jp, type BigDecimalWrapper as jq, type LineItemTax as jr, type Source as js, type LineItemMetaData as jt, type Locale as ju, type TotalPrice as jv, type ItemizedFee as jw, type Discount as jx, type DiscountOneDiscountTypeOneOf as jy, type CalculatedTaxes as jz, type GetRefundabilityStatusResponse as k, onOrderUpdated as k$, type VatTypeWithLiterals as k0, type PickupMethodWithLiterals as k1, type CrossBorderNotApplicableReasonWithLiterals as k2, type CrossBorderRepricingModeWithLiterals as k3, type DiscountTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type DeclinedReasonWithLiterals as kA, type VoidedReasonWithLiterals as kB, type RefundStatusWithLiterals as kC, type PreviewEmailTypeWithLiterals as kD, type StateWithLiterals as kE, type SiteCreatedContextWithLiterals as kF, type NamespaceWithLiterals as kG, type DeleteStatusWithLiterals as kH, type OriginWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type CommonSearchWithEntityContext as kS, onOrderApproved as kT, onOrderCanceled as kU, onOrderCommitted as kV, onOrderCreated as kW, onOrderFulfilled as kX, onOrderImported as kY, onOrderImportedOrderDeleted as kZ, onOrderPaymentStatusUpdated as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type ScheduledActionWithLiterals as kj, type DurationUnitWithLiterals as kk, type PaymentCollectabilityStatusWithLiterals as kl, type PredefinedPaymentMethodWithLiterals as km, type RefundableStatusWithLiterals as kn, type NonRefundableReasonWithLiterals as ko, type ManuallyRefundableReasonWithLiterals as kp, type RestockTypeWithLiterals as kq, type TransactionStatusWithLiterals as kr, type AuthorizationCaptureStatusWithLiterals as ks, type AuthorizationVoidStatusWithLiterals as kt, type ReasonWithLiterals as ku, type ActionTypeWithLiterals as kv, type ChargebackStatusWithLiterals as kw, type MembershipPaymentStatusWithLiterals as kx, type PaymentStatusWithLiterals as ky, type CanceledReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, importOrder as l0, setOrderNumberCounter as l1, bulkDeleteImportedOrders as l2, preparePaymentCollection as l3, getPaymentCollectabilityStatus as l4, recordManuallyCollectedPayment as l5, paymentCollectionMarkOrderAsPaid as l6, paymentCollectionBulkMarkOrdersAsPaid as l7, getRefundabilityStatus as l8, paymentCollectionCreatePaymentGatewayOrder as l9, chargeMemberships as la, triggerRefund as lb, voidAuthorizedPayments as lc, captureAuthorizedPayments as ld, getOrder as le, createOrder as lf, updateOrder as lg, bulkUpdateOrders as lh, updateOrderLineItem as li, addActivity as lj, addActivities as lk, updateActivity as ll, deleteActivity as lm, cancelOrder as ln, updateOrderStatus as lo, aggregateOrders as lp, bulkUpdateOrderTags as lq, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };