@wix/auto_sdk_ecom_orders 1.0.313 → 1.0.315

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-Dq-hzhTr.d.ts → ecom-v1-order-orders.universal-DXcKuMZ8.d.ts} +1705 -1705
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -80
  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 +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1705 -1705
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-Dq-hzhTr.d.mts → ecom-v1-order-orders.universal-DXcKuMZ8.d.mts} +1705 -1705
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -80
  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 +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1705 -1705
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-DLFaXYdm.d.ts → ecom-v1-order-orders.universal-Cc6i2pkz.d.ts} +1830 -1830
  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 +1830 -1830
  25. package/build/internal/es/{ecom-v1-order-orders.universal-DLFaXYdm.d.mts → ecom-v1-order-orders.universal-Cc6i2pkz.d.mts} +1830 -1830
  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 +1830 -1830
  29. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, ev as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ez as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, eA as RecordManuallyCollectedPaymentRequest$1, eD as RecordManuallyCollectedPaymentResponse$1, eE as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eF as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eK as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eN as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eP as ChargeMembershipsRequest$1, eS as ChargeMembershipsResponse$1, eT as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fA as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fB as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gV as GetOrderRequest$1, gW as GetOrderResponse$1, h6 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, ha as CreateOrderRequest$1, he as CreateOrderResponse$1, hf as UpdateOrderRequest$1, hg as UpdateOrderResponse$1, hh as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hM as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ib as AddActivityRequest$1, N as AddActivityResponse$1, id as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ie as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ig as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, im as CancelOrderRequest$1, a0 as CancelOrderResponse$1, io as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iM as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iQ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DLFaXYdm.mjs';
1
+ import { ep as ImportOrderRequest$1, I as ImportOrderResponse$1, eq as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, er as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fM as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fQ as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fR as RecordManuallyCollectedPaymentRequest$1, fU as RecordManuallyCollectedPaymentResponse$1, fV as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, fW as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, f$ as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, g2 as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, g4 as ChargeMembershipsRequest$1, g7 as ChargeMembershipsResponse$1, g8 as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gM as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gN as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gV as GetOrderRequest$1, gW as GetOrderResponse$1, h6 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, ha as CreateOrderRequest$1, he as CreateOrderResponse$1, hf as UpdateOrderRequest$1, hg as UpdateOrderResponse$1, hh as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hM as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ib as AddActivityRequest$1, N as AddActivityResponse$1, id as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ie as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ig as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, im as CancelOrderRequest$1, a0 as CancelOrderResponse$1, io as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iM as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iQ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-Cc6i2pkz.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -1109,6 +1109,23 @@ interface BillingAdjustmentPriceSummary {
1109
1109
  /** Total price after tax. */
1110
1110
  total?: Price;
1111
1111
  }
1112
+ /**
1113
+ * Cycle price override as applied to a single billing cycle: the regular price and the price the
1114
+ * override set for that cycle.
1115
+ */
1116
+ interface CyclePriceOverride {
1117
+ /**
1118
+ * Billing cycle this order covers. `1` for the order created at checkout.
1119
+ * Same value as `subscriptionInfo.cycleNumber`.
1120
+ * @min 1
1121
+ * @max 999
1122
+ */
1123
+ cycle?: number;
1124
+ /** Regular (recurring) unit price of the line item. */
1125
+ basePrice?: Price;
1126
+ /** Unit price the cycle price override set for this cycle, before line item discounts (coupons). */
1127
+ overriddenPrice?: Price;
1128
+ }
1112
1129
  interface PriceDescription {
1113
1130
  /**
1114
1131
  * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
@@ -4552,2345 +4569,2328 @@ interface BulkDeleteImportedOrdersResponse {
4552
4569
  */
4553
4570
  jobId?: string;
4554
4571
  }
4555
- /**
4556
- * Cycle price override as applied to a single billing cycle: the regular price and the price the
4557
- * override set for that cycle.
4558
- */
4559
- interface CyclePriceOverride {
4560
- /**
4561
- * Billing cycle this order covers. `1` for the order created at checkout.
4562
- * Same value as `subscriptionInfo.cycleNumber`.
4563
- * @min 1
4564
- * @max 999
4565
- */
4566
- cycle?: number;
4567
- /** Regular (recurring) unit price of the line item. */
4568
- basePrice?: Price;
4569
- /** Unit price the cycle price override set for this cycle, before line item discounts (coupons). */
4570
- overriddenPrice?: Price;
4571
- }
4572
- interface V1TriggerReindexRequest {
4572
+ interface SendBuyerConfirmationEmailRequest {
4573
4573
  /** @format GUID */
4574
- metasiteId?: string;
4574
+ orderId?: string;
4575
+ }
4576
+ interface SendBuyerConfirmationEmailResponse {
4577
+ }
4578
+ interface SendBuyerPaymentsReceivedEmailRequest {
4575
4579
  /**
4576
4580
  * @minLength 1
4577
4581
  * @maxLength 100
4578
- * @maxSize 100
4579
4582
  */
4580
- orderIds?: string[];
4583
+ orderId?: string;
4581
4584
  }
4582
- interface V1TriggerReindexResponse {
4585
+ interface SendBuyerPaymentsReceivedEmailResponse {
4583
4586
  }
4584
- interface V1TriggerReindexOrderRequest {
4585
- /** @format GUID */
4586
- metasiteId?: string;
4587
+ interface SendBuyerPickupConfirmationEmailRequest {
4587
4588
  /**
4588
4589
  * @minLength 1
4589
4590
  * @maxLength 100
4590
4591
  */
4591
4592
  orderId?: string;
4592
4593
  }
4593
- interface PreparePaymentCollectionRequest {
4594
+ interface SendBuyerPickupConfirmationEmailResponse {
4595
+ }
4596
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4597
+ /**
4598
+ * IDs of orders to send pickup emails for.
4599
+ * @minSize 1
4600
+ * @maxSize 300
4601
+ */
4602
+ orderIds?: string[];
4603
+ }
4604
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4605
+ }
4606
+ interface SendBuyerShippingConfirmationEmailRequest {
4594
4607
  /**
4595
- * Ecom order ID.
4596
4608
  * @minLength 1
4597
4609
  * @maxLength 100
4598
4610
  */
4599
- ecomOrderId: string;
4600
- /** Amount to collect */
4601
- amount: Price;
4611
+ orderId?: string;
4612
+ }
4613
+ interface SendBuyerShippingConfirmationEmailResponse {
4614
+ }
4615
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4602
4616
  /**
4603
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4604
- * Existing payment gateway order will be updated with a new amount.
4605
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4617
+ * IDs of orders to send pickup emails for.
4618
+ * @minSize 1
4619
+ * @maxSize 300
4606
4620
  */
4607
- paymentGatewayOrderId?: string | null;
4621
+ orderIds?: string[];
4622
+ }
4623
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4624
+ }
4625
+ interface SendMerchantOrderReceivedNotificationRequest {
4608
4626
  /**
4609
- * Whether to delay capture of the payment.
4610
- * Default: false
4611
- * @deprecated Whether to delay capture of the payment.
4612
- * Default: false
4613
- * @replacedBy delayed_capture_settings.scheduled_action
4614
- * @targetRemovalDate 2024-09-30
4627
+ * @minLength 1
4628
+ * @maxLength 100
4615
4629
  */
4616
- delayedCapture?: boolean;
4630
+ orderId?: string;
4631
+ }
4632
+ interface SendMerchantOrderReceivedNotificationResponse {
4633
+ }
4634
+ interface SendCancelRefundEmailRequest {
4617
4635
  /**
4618
- * Specifies whether payment collection is initiated by Merchant or User of User
4619
- * Default: `true`
4620
- * @internal
4636
+ * The ID of order that is canceled/refunded
4637
+ * @minLength 1
4638
+ * @maxLength 100
4621
4639
  */
4622
- merchantInitiated?: boolean | null;
4640
+ orderId?: string;
4623
4641
  /**
4624
- * Redirect urls which are used to return buyer to third party system.
4625
- * @internal
4642
+ * Personal note added to the email (optional)
4643
+ * @minLength 1
4644
+ * @maxLength 1000
4626
4645
  */
4627
- redirectUrls?: RedirectUrls;
4628
- /** Delayed capture payment settings */
4629
- delayedCaptureSettings?: DelayedCaptureSettings;
4630
- }
4631
- interface RedirectUrls {
4646
+ customMessage?: string | null;
4647
+ /** Refund amount */
4648
+ refundAmount?: Price;
4632
4649
  /**
4633
- * URL to redirect buyer in case of approved (successful) transaction
4634
- * @format WEB_URL
4650
+ * Refund ID. (Optional)
4651
+ * @format GUID
4635
4652
  */
4636
- successUrl?: string | null;
4653
+ refundId?: string | null;
4654
+ }
4655
+ interface SendCancelRefundEmailResponse {
4656
+ }
4657
+ interface SendRefundEmailRequest {
4637
4658
  /**
4638
- * URL to redirect buyer in case of buyer canceled the transaction
4639
- * @format WEB_URL
4659
+ * The ID of order that is refunded
4660
+ * @format GUID
4640
4661
  */
4641
- cancelUrl?: string | null;
4662
+ orderId?: string;
4642
4663
  /**
4643
- * URL to redirect buyer in case of failed/rejected transaction
4644
- * @format WEB_URL
4664
+ * Refund ID
4665
+ * @format GUID
4645
4666
  */
4646
- errorUrl?: string | null;
4667
+ refundId?: string;
4647
4668
  /**
4648
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4649
- * @format WEB_URL
4669
+ * Personal note added to the email (optional)
4670
+ * @minLength 1
4671
+ * @maxLength 1000
4650
4672
  */
4651
- pendingUrl?: string | null;
4673
+ customMessage?: string | null;
4652
4674
  }
4653
- interface DelayedCaptureSettings {
4654
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4655
- scheduledAction?: ScheduledActionWithLiterals;
4656
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4657
- delayDuration?: Duration;
4675
+ interface SendRefundEmailResponse {
4658
4676
  }
4659
- declare enum ScheduledAction {
4660
- /** Whether payment will be auto-voided when duration passes */
4661
- VOID = "VOID",
4662
- /** Whether payment will be auto-captured when duration passes */
4663
- CAPTURE = "CAPTURE"
4677
+ interface SendFulfillmentEmailRequest {
4678
+ /** @format GUID */
4679
+ orderId?: string;
4680
+ /** @format GUID */
4681
+ fulfillerId?: string;
4664
4682
  }
4665
- /** @enumType */
4666
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4667
- interface Duration {
4683
+ interface SendFulfillmentEmailResponse {
4684
+ }
4685
+ interface SendMerchantOrderReceivedPushRequest {
4668
4686
  /**
4669
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4670
- * @min 1
4687
+ * @minLength 1
4688
+ * @maxLength 100
4671
4689
  */
4672
- count?: number;
4673
- /** Duration unit: MINUTES, HOURS and DAYS */
4674
- unit?: DurationUnitWithLiterals;
4690
+ orderId?: string;
4675
4691
  }
4676
- declare enum DurationUnit {
4677
- MINUTES = "MINUTES",
4678
- HOURS = "HOURS",
4679
- DAYS = "DAYS"
4692
+ interface SendMerchantOrderReceivedPushResponse {
4693
+ }
4694
+ interface PreviewEmailByTypeRequest {
4695
+ emailType?: PreviewEmailTypeWithLiterals;
4696
+ }
4697
+ declare enum PreviewEmailType {
4698
+ ORDER_PLACED = "ORDER_PLACED",
4699
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4700
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4701
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4680
4702
  }
4681
4703
  /** @enumType */
4682
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4683
- interface PreparePaymentCollectionResponse {
4684
- /** Payment gateway order id which is associated with given payment */
4685
- paymentGatewayOrderId?: string;
4704
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4705
+ interface PreviewEmailByTypeResponse {
4706
+ emailPreview?: string;
4686
4707
  }
4687
- interface GetPaymentCollectabilityStatusRequest {
4708
+ interface PreviewRefundEmailRequest {
4688
4709
  /**
4689
- * Ecom order ID.
4690
4710
  * @minLength 1
4691
4711
  * @maxLength 100
4692
4712
  */
4693
- ecomOrderId: string;
4694
- }
4695
- interface GetPaymentCollectabilityStatusResponse {
4696
- /** Payment collectability status */
4697
- status?: PaymentCollectabilityStatusWithLiterals;
4698
- /** Collectable order amount */
4699
- amount?: Price;
4713
+ orderId?: string;
4714
+ /** Refund amount */
4715
+ refundAmount?: Price;
4716
+ /** Refund business details */
4717
+ details?: RefundDetails;
4700
4718
  /**
4701
- * Whether authorization supported
4702
- * @internal
4719
+ * Personal note added to the email (optional)
4720
+ * @minLength 1
4721
+ * @maxLength 1000
4703
4722
  */
4704
- authorizationSupported?: boolean;
4723
+ customMessage?: string | null;
4705
4724
  /**
4706
- * Whether custom amount is supported for payment collection
4707
- * @internal
4725
+ * Refund ID. (Optional)
4726
+ * @format GUID
4708
4727
  */
4709
- customAmountSupported?: boolean;
4710
- }
4711
- declare enum PaymentCollectabilityStatus {
4712
- UNKNOWN = "UNKNOWN",
4713
- COLLECTABLE = "COLLECTABLE",
4714
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4715
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4716
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4717
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4718
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4719
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4720
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4721
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4722
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4723
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4724
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4728
+ refundId?: string | null;
4725
4729
  }
4726
- /** @enumType */
4727
- 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';
4728
- interface RecordManuallyCollectedPaymentRequest {
4730
+ /** Business model of a refund request */
4731
+ interface RefundDetails {
4729
4732
  /**
4730
- * Order ID.
4731
- * @minLength 1
4732
- * @maxLength 100
4733
+ * Order line item IDs and quantities that were refunded.
4734
+ * @maxSize 300
4733
4735
  */
4734
- orderId: string;
4735
- /** Amount to be recorded as approved manual payment for given order */
4736
- amount: Price;
4736
+ items?: RefundItem[];
4737
+ /** Whether the shipping fee was also refunded. */
4738
+ shippingIncluded?: boolean;
4737
4739
  /**
4738
- * Payment method name provided by user.
4739
- *
4740
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4741
- * @internal
4740
+ * Reason for the refund, provided by customer (optional).
4741
+ * @maxLength 200
4742
4742
  */
4743
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4744
- }
4745
- /**
4746
- * User-defined payment method name.
4747
- * Allows specifying either a predefined type or a custom name.
4748
- */
4749
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4750
- /** Predefined payment method. */
4751
- predefined?: PredefinedPaymentMethodWithLiterals;
4743
+ reason?: string | null;
4752
4744
  /**
4753
- * Custom payment method name provided by user.
4754
- *
4755
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4756
- * @minLength 1
4757
- * @maxLength 150
4745
+ * Line items that were refunded.
4746
+ * @maxSize 300
4758
4747
  */
4759
- custom?: string | null;
4760
- }
4761
- /** @oneof */
4762
- interface UserDefinedPaymentMethodNameKindOneOf {
4763
- /** Predefined payment method. */
4764
- predefined?: PredefinedPaymentMethodWithLiterals;
4748
+ lineItems?: LineItemRefund[];
4765
4749
  /**
4766
- * Custom payment method name provided by user.
4767
- *
4768
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4769
- * @minLength 1
4770
- * @maxLength 150
4750
+ * Additional fees that were refunded.
4751
+ * @maxSize 100
4771
4752
  */
4772
- custom?: string | null;
4773
- }
4774
- /** Predefined payment method types for offline/manual payments. */
4775
- declare enum PredefinedPaymentMethod {
4776
- /** Cash payment. */
4777
- CASH = "CASH",
4778
- /** Bank transfer. */
4779
- BANK_TRANSFER = "BANK_TRANSFER",
4780
- /** Payment by check. */
4781
- CHECK = "CHECK"
4782
- }
4783
- /** @enumType */
4784
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4785
- interface RecordManuallyCollectedPaymentResponse {
4753
+ additionalFees?: AdditionalFeeRefund[];
4754
+ /** Shipping amount that was refunded. */
4755
+ shipping?: ShippingRefund;
4786
4756
  }
4787
- interface MarkOrderAsPaidRequest {
4757
+ interface RefundItem {
4788
4758
  /**
4789
- * Ecom order ID.
4790
- * @minLength 1
4791
- * @maxLength 100
4759
+ * Line item ID the refunded line item.
4760
+ * @format GUID
4792
4761
  */
4793
- ecomOrderId: string;
4762
+ lineItemId?: string;
4794
4763
  /**
4795
- * Payment method name provided by user.
4796
- *
4797
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4798
- * @internal
4764
+ * Line item quantity refunded.
4765
+ * @min 1
4766
+ * @max 100000
4799
4767
  */
4800
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4801
- }
4802
- interface MarkOrderAsPaidResponse {
4803
- /** Updated order. */
4804
- order?: Order;
4768
+ quantity?: number;
4805
4769
  }
4806
- interface BulkMarkOrdersAsPaidRequest {
4770
+ interface LineItemRefund {
4807
4771
  /**
4808
- * IDs of orders to mark as paid.
4809
- * @minSize 1
4810
- * @maxSize 100
4811
- * @minLength 1
4812
- * @maxLength 100
4772
+ * Line item ID.
4773
+ * @format GUID
4774
+ * @immutable
4813
4775
  */
4814
- ecomOrderIds: string[];
4815
- }
4816
- interface BulkMarkOrdersAsPaidResponse {
4776
+ lineItemId?: string;
4817
4777
  /**
4818
- * Items updated by the bulk action.
4819
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4778
+ * Refund quantity.
4779
+ * @min 1
4780
+ * @max 100000
4781
+ * @immutable
4820
4782
  */
4821
- results?: BulkOrderResult[];
4822
- /** Bulk action metadata. */
4823
- bulkActionMetadata?: BulkActionMetadata;
4783
+ quantity?: number;
4824
4784
  }
4825
- interface BulkOrderResult {
4826
- /** Item metadata. */
4827
- itemMetadata?: ItemMetadata;
4785
+ interface AdditionalFeeRefund {
4828
4786
  /**
4829
- * Updated order.
4830
- *
4831
- * Returned when `returnFullEntity = true`.
4787
+ * Additional fee ID.
4788
+ * @format GUID
4789
+ * @immutable
4832
4790
  */
4833
- item?: Order;
4834
- }
4835
- interface ItemMetadata {
4836
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4837
- id?: string | null;
4838
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4839
- originalIndex?: number;
4840
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4841
- success?: boolean;
4842
- /** Details about the error in case of failure. */
4843
- error?: ApplicationError;
4844
- }
4845
- interface ApplicationError {
4846
- /** Error code. */
4847
- code?: string;
4848
- /** Description of the error. */
4849
- description?: string;
4850
- /** Data related to the error. */
4851
- data?: Record<string, any> | null;
4852
- }
4853
- interface BulkActionMetadata {
4854
- /** Number of items that were successfully processed. */
4855
- totalSuccesses?: number;
4856
- /** Number of items that couldn't be processed. */
4857
- totalFailures?: number;
4858
- /** Number of failures without details because detailed failure threshold was exceeded. */
4859
- undetailedFailures?: number;
4860
- }
4861
- interface GetRefundabilityStatusRequest {
4791
+ additionalFeeId?: string;
4862
4792
  /**
4863
- * Order ID.
4864
- * @minLength 1
4865
- * @maxLength 100
4793
+ * Refund amount.
4794
+ * @immutable
4866
4795
  */
4867
- ecomOrderId: string;
4796
+ amount?: Price;
4868
4797
  }
4869
- interface GetRefundabilityStatusResponse {
4870
- /**
4871
- * Refundability details.
4872
- * @maxSize 300
4873
- */
4874
- refundabilities?: Refundability[];
4798
+ interface ShippingRefund {
4875
4799
  /**
4876
- * Whether the order supports refunding per item.
4877
- * @deprecated
4800
+ * Refund amount.
4801
+ * @immutable
4878
4802
  */
4879
- refundablePerItem?: boolean;
4880
- }
4881
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4882
- /** Reason why payment is not refundable. */
4883
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4884
- /** Reason why payment is only refundable manually. */
4885
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4886
- /** Payment ID. */
4887
- paymentId?: string;
4888
- /** Payment refundability status. */
4889
- refundabilityStatus?: RefundableStatusWithLiterals;
4890
- /** Link to payment provider dashboard. */
4891
- providerLink?: string | null;
4892
- }
4893
- /** @oneof */
4894
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4895
- /** Reason why payment is not refundable. */
4896
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4897
- /** Reason why payment is only refundable manually. */
4898
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4899
- }
4900
- declare enum RefundableStatus {
4901
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4902
- MANUAL = "MANUAL",
4903
- REFUNDABLE = "REFUNDABLE"
4904
- }
4905
- /** @enumType */
4906
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4907
- declare enum NonRefundableReason {
4908
- NONE = "NONE",
4909
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4910
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4911
- INTERNAL_ERROR = "INTERNAL_ERROR",
4912
- NOT_PAID = "NOT_PAID",
4913
- ACCESS_DENIED = "ACCESS_DENIED",
4914
- ZERO_PRICE = "ZERO_PRICE",
4915
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4916
- PENDING_REFUND = "PENDING_REFUND",
4917
- FORBIDDEN = "FORBIDDEN",
4918
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4919
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4920
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4803
+ amount?: Price;
4921
4804
  }
4922
- /** @enumType */
4923
- 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';
4924
- declare enum ManuallyRefundableReason {
4925
- EXPIRED = "EXPIRED",
4926
- NOT_SUPPORTED = "NOT_SUPPORTED",
4927
- OFFLINE = "OFFLINE",
4928
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4805
+ interface PreviewRefundEmailResponse {
4806
+ emailPreview?: string;
4929
4807
  }
4930
- /** @enumType */
4931
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4932
- interface CreatePaymentGatewayOrderRequest {
4808
+ interface PreviewCancelEmailRequest {
4933
4809
  /**
4934
- * Ecom order ID.
4935
4810
  * @minLength 1
4936
4811
  * @maxLength 100
4937
4812
  */
4938
- ecomOrderId: string;
4939
- /** Information about the user who initiated the payment. */
4940
- chargedBy?: ChargedBy;
4941
- /**
4942
- * Whether to delay capture of the payment.
4943
- *
4944
- * Default: false
4945
- * @internal
4946
- */
4947
- delayedCapture?: boolean;
4948
- }
4949
- interface ChargedBy {
4950
- /**
4951
- * ID - id of the user who initiated the payment
4952
- * @format GUID
4953
- */
4954
- id?: string;
4813
+ orderId?: string;
4955
4814
  /**
4956
- * Full name - name of the user who initiated the payment
4815
+ * Personal note added to the email (optional)
4957
4816
  * @minLength 1
4958
- * @maxLength 200
4817
+ * @maxLength 1000
4959
4818
  */
4960
- fullName?: string | null;
4819
+ customMessage?: string | null;
4961
4820
  }
4962
- interface CreatePaymentGatewayOrderResponse {
4963
- /** ID of the order created in the payment gateway */
4964
- paymentGatewayOrderId?: string;
4821
+ interface PreviewCancelEmailResponse {
4822
+ emailPreview?: string;
4965
4823
  }
4966
- interface ChargeMembershipsRequest {
4824
+ interface PreviewCancelRefundEmailRequest {
4967
4825
  /**
4968
- * Order ID.
4969
4826
  * @minLength 1
4970
4827
  * @maxLength 100
4971
4828
  */
4972
- ecomOrderId: string;
4829
+ orderId?: string;
4973
4830
  /**
4974
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4975
- * but a user which is using the membership on behalf of the a member
4976
- * @format GUID
4977
- */
4978
- memberId: string;
4979
- /**
4980
- * List of items to be paid by memberships
4981
- * @minSize 1
4982
- * @maxSize 300
4983
- */
4984
- membershipCharges?: MembershipChargeItem[];
4985
- }
4986
- interface MembershipChargeItem {
4987
- /**
4988
- * The id of used membership
4831
+ * Personal note added to the email (optional)
4989
4832
  * @minLength 1
4990
- * @maxLength 100
4833
+ * @maxLength 1000
4991
4834
  */
4992
- membershipId?: string;
4835
+ customMessage?: string | null;
4836
+ /** Refund amount */
4837
+ refundAmount?: Price;
4993
4838
  /**
4994
- * ID of the application providing this payment option
4839
+ * Refund ID. (Optional)
4995
4840
  * @format GUID
4996
4841
  */
4997
- appId?: string;
4998
- /** The name of used membership */
4999
- membershipName?: MembershipName;
5000
- /** Additional data about this membership */
5001
- membershipAdditionalData?: Record<string, any> | null;
5002
- /** Catalog and item reference info. */
5003
- catalogReference?: CatalogReference;
5004
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5005
- serviceProperties?: ServiceProperties;
5006
- /**
5007
- * Usually would be the same as catalogReference.catalogItemId
5008
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5009
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5010
- * @minLength 1
5011
- * @maxLength 36
5012
- */
5013
- rootCatalogItemId?: string | null;
5014
- /**
5015
- * line item id of Checkout/Order line item
5016
- * @minLength 1
5017
- * @maxLength 100
5018
- */
5019
- lineItemId?: string;
4842
+ refundId?: string | null;
5020
4843
  }
5021
- interface MembershipName {
5022
- /**
5023
- * Membership name in the site's original language.
5024
- * @maxLength 100
5025
- */
5026
- original?: string;
5027
- /**
5028
- * Membership name translated into the buyer's language.
5029
- *
5030
- * Default: The value of `original`
5031
- * @maxLength 100
5032
- */
5033
- translated?: string | null;
4844
+ interface PreviewCancelRefundEmailResponse {
4845
+ emailPreview?: string;
5034
4846
  }
5035
- interface ChargeMembershipsResponse {
4847
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5036
4848
  }
5037
- interface TriggerRefundRequest {
5038
- /**
5039
- * The order this refund related to
5040
- * @minLength 1
5041
- * @maxLength 100
5042
- */
5043
- ecomOrderId: string;
5044
- /**
5045
- * Refund operations information
5046
- * @minSize 1
5047
- * @maxSize 1
5048
- */
5049
- payments: PaymentRefund[];
5050
- /** Business model of a refund */
5051
- details?: RefundDetails;
5052
- /** Side effect details related to refund */
5053
- sideEffects?: RefundSideEffects;
4849
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4850
+ emailPreview?: string;
5054
4851
  }
5055
- interface PaymentRefund {
5056
- /**
5057
- * Specific payment within the order to refund
5058
- * @format GUID
5059
- */
5060
- paymentId?: string;
5061
- /** Refund amount. Not relevant for membership and gift card refunds. */
5062
- amount?: Price;
5063
- /**
5064
- * Whether refund is made externally and manually (on the payment provider's side)
5065
- * 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.
5066
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5067
- */
5068
- externalRefund?: boolean;
5069
- /**
5070
- * Gateway refund id. When param is present, new refund is not created.
5071
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5072
- * and all side effects from request will be executed.
5073
- * @internal
5074
- * @minLength 1
5075
- * @maxLength 100
5076
- */
5077
- gatewayRefundId?: string | null;
4852
+ interface PreviewBuyerConfirmationEmailRequest {
5078
4853
  }
5079
- /** Business model of a refund request */
5080
- interface RefundDetails {
5081
- /**
5082
- * Order line item IDs and quantities that were refunded.
5083
- * @maxSize 300
5084
- */
5085
- items?: RefundItem[];
5086
- /** Whether the shipping fee was also refunded. */
5087
- shippingIncluded?: boolean;
5088
- /**
5089
- * Reason for the refund, provided by customer (optional).
5090
- * @maxLength 200
5091
- */
5092
- reason?: string | null;
5093
- /**
5094
- * Line items that were refunded.
5095
- * @maxSize 300
5096
- */
5097
- lineItems?: LineItemRefund[];
5098
- /**
5099
- * Additional fees that were refunded.
5100
- * @maxSize 100
5101
- */
5102
- additionalFees?: AdditionalFeeRefund[];
5103
- /** Shipping amount that was refunded. */
5104
- shipping?: ShippingRefund;
4854
+ interface PreviewBuyerConfirmationEmailResponse {
4855
+ emailPreview?: string;
5105
4856
  }
5106
- interface RefundItem {
5107
- /**
5108
- * Line item ID the refunded line item.
5109
- * @format GUID
5110
- */
5111
- lineItemId?: string;
5112
- /**
5113
- * Line item quantity refunded.
5114
- * @min 1
5115
- * @max 100000
5116
- */
5117
- quantity?: number;
4857
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5118
4858
  }
5119
- interface LineItemRefund {
5120
- /**
5121
- * Line item ID.
5122
- * @format GUID
5123
- * @immutable
5124
- */
5125
- lineItemId?: string;
5126
- /**
5127
- * Refund quantity.
5128
- * @min 1
5129
- * @max 100000
5130
- * @immutable
5131
- */
5132
- quantity?: number;
4859
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4860
+ emailPreview?: string;
5133
4861
  }
5134
- interface AdditionalFeeRefund {
4862
+ interface PreviewShippingConfirmationEmailRequest {
4863
+ }
4864
+ interface PreviewShippingConfirmationEmailResponse {
4865
+ emailPreview?: string;
4866
+ }
4867
+ interface PreviewResendDownloadLinksEmailRequest {
4868
+ }
4869
+ interface PreviewResendDownloadLinksEmailResponse {
4870
+ emailPreview?: string;
4871
+ }
4872
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4873
+ /** Emitted on a meta site creation. */
4874
+ siteCreated?: SiteCreated;
4875
+ /** Emitted on a meta site transfer completion. */
4876
+ siteTransferred?: SiteTransferred;
4877
+ /** Emitted on a meta site deletion. */
4878
+ siteDeleted?: SiteDeleted;
4879
+ /** Emitted on a meta site restoration. */
4880
+ siteUndeleted?: SiteUndeleted;
4881
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4882
+ sitePublished?: SitePublished;
4883
+ /** Emitted on a meta site unpublish. */
4884
+ siteUnpublished?: SiteUnpublished;
4885
+ /** Emitted when meta site is marked as template. */
4886
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4887
+ /** Emitted when meta site is marked as a WixSite. */
4888
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4889
+ /** Emitted when an application is provisioned (installed). */
4890
+ serviceProvisioned?: ServiceProvisioned;
4891
+ /** Emitted when an application is removed (uninstalled). */
4892
+ serviceRemoved?: ServiceRemoved;
4893
+ /** Emitted when meta site name (URL slug) is changed. */
4894
+ siteRenamedPayload?: SiteRenamed;
4895
+ /** Emitted when meta site was permanently deleted. */
4896
+ hardDeleted?: SiteHardDeleted;
4897
+ /** Emitted on a namespace change. */
4898
+ namespaceChanged?: NamespaceChanged;
4899
+ /** Emitted when Studio is attached. */
4900
+ studioAssigned?: StudioAssigned;
4901
+ /** Emitted when Studio is detached. */
4902
+ studioUnassigned?: StudioUnassigned;
5135
4903
  /**
5136
- * Additional fee ID.
5137
- * @format GUID
5138
- * @immutable
4904
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4905
+ * the actual URL.
4906
+ *
4907
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4908
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5139
4909
  */
5140
- additionalFeeId?: string;
4910
+ urlChanged?: SiteUrlChanged;
4911
+ /** Site is marked as PurgedExternally */
4912
+ sitePurgedExternally?: SitePurgedExternally;
4913
+ /** Emitted when Odeditor is attached. */
4914
+ odeditorAssigned?: OdeditorAssigned;
4915
+ /** Emitted when Odeditor is detached. */
4916
+ odeditorUnassigned?: OdeditorUnassigned;
4917
+ /** Emitted when Picasso is attached. */
4918
+ picassoAssigned?: PicassoAssigned;
4919
+ /** Emitted when Picasso is detached. */
4920
+ picassoUnassigned?: PicassoUnassigned;
4921
+ /** Emitted when Wixel is attached. */
4922
+ wixelAssigned?: WixelAssigned;
4923
+ /** Emitted when Wixel is detached. */
4924
+ wixelUnassigned?: WixelUnassigned;
4925
+ /** Emitted when StudioTwo is attached. */
4926
+ studioTwoAssigned?: StudioTwoAssigned;
4927
+ /** Emitted when StudioTwo is detached. */
4928
+ studioTwoUnassigned?: StudioTwoUnassigned;
4929
+ /** Emitted when media from user domain is enabled. */
4930
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4931
+ /** Emitted when media from user domain is disabled. */
4932
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4933
+ /** Emitted when Editorless is attached. */
4934
+ editorlessAssigned?: EditorlessAssigned;
4935
+ /** Emitted when Editorless is detached. */
4936
+ editorlessUnassigned?: EditorlessUnassigned;
5141
4937
  /**
5142
- * Refund amount.
5143
- * @immutable
4938
+ * A meta site id.
4939
+ * @format GUID
5144
4940
  */
5145
- amount?: Price;
5146
- }
5147
- interface ShippingRefund {
4941
+ metaSiteId?: string;
4942
+ /** A meta site version. Monotonically increasing. */
4943
+ version?: string;
4944
+ /** A timestamp of the event. */
4945
+ timestamp?: string;
5148
4946
  /**
5149
- * Refund amount.
5150
- * @immutable
4947
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4948
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4949
+ * @maxSize 4000
5151
4950
  */
5152
- amount?: Price;
4951
+ assets?: Asset[];
5153
4952
  }
5154
- interface RefundSideEffects {
5155
- /** Inventory restock details as part of this refund. */
5156
- restockInfo?: RestockInfo;
5157
- /** Whether to send a refund confirmation email to the customer. */
5158
- sendOrderRefundedEmail?: boolean;
4953
+ /** @oneof */
4954
+ interface MetaSiteSpecialEventPayloadOneOf {
4955
+ /** Emitted on a meta site creation. */
4956
+ siteCreated?: SiteCreated;
4957
+ /** Emitted on a meta site transfer completion. */
4958
+ siteTransferred?: SiteTransferred;
4959
+ /** Emitted on a meta site deletion. */
4960
+ siteDeleted?: SiteDeleted;
4961
+ /** Emitted on a meta site restoration. */
4962
+ siteUndeleted?: SiteUndeleted;
4963
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4964
+ sitePublished?: SitePublished;
4965
+ /** Emitted on a meta site unpublish. */
4966
+ siteUnpublished?: SiteUnpublished;
4967
+ /** Emitted when meta site is marked as template. */
4968
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4969
+ /** Emitted when meta site is marked as a WixSite. */
4970
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4971
+ /** Emitted when an application is provisioned (installed). */
4972
+ serviceProvisioned?: ServiceProvisioned;
4973
+ /** Emitted when an application is removed (uninstalled). */
4974
+ serviceRemoved?: ServiceRemoved;
4975
+ /** Emitted when meta site name (URL slug) is changed. */
4976
+ siteRenamedPayload?: SiteRenamed;
4977
+ /** Emitted when meta site was permanently deleted. */
4978
+ hardDeleted?: SiteHardDeleted;
4979
+ /** Emitted on a namespace change. */
4980
+ namespaceChanged?: NamespaceChanged;
4981
+ /** Emitted when Studio is attached. */
4982
+ studioAssigned?: StudioAssigned;
4983
+ /** Emitted when Studio is detached. */
4984
+ studioUnassigned?: StudioUnassigned;
5159
4985
  /**
5160
- * Custom message added to the refund confirmation email.
5161
- * @minLength 1
5162
- * @maxLength 1000
4986
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4987
+ * the actual URL.
4988
+ *
4989
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4990
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5163
4991
  */
5164
- customMessage?: string | null;
4992
+ urlChanged?: SiteUrlChanged;
4993
+ /** Site is marked as PurgedExternally */
4994
+ sitePurgedExternally?: SitePurgedExternally;
4995
+ /** Emitted when Odeditor is attached. */
4996
+ odeditorAssigned?: OdeditorAssigned;
4997
+ /** Emitted when Odeditor is detached. */
4998
+ odeditorUnassigned?: OdeditorUnassigned;
4999
+ /** Emitted when Picasso is attached. */
5000
+ picassoAssigned?: PicassoAssigned;
5001
+ /** Emitted when Picasso is detached. */
5002
+ picassoUnassigned?: PicassoUnassigned;
5003
+ /** Emitted when Wixel is attached. */
5004
+ wixelAssigned?: WixelAssigned;
5005
+ /** Emitted when Wixel is detached. */
5006
+ wixelUnassigned?: WixelUnassigned;
5007
+ /** Emitted when StudioTwo is attached. */
5008
+ studioTwoAssigned?: StudioTwoAssigned;
5009
+ /** Emitted when StudioTwo is detached. */
5010
+ studioTwoUnassigned?: StudioTwoUnassigned;
5011
+ /** Emitted when media from user domain is enabled. */
5012
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5013
+ /** Emitted when media from user domain is disabled. */
5014
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5015
+ /** Emitted when Editorless is attached. */
5016
+ editorlessAssigned?: EditorlessAssigned;
5017
+ /** Emitted when Editorless is detached. */
5018
+ editorlessUnassigned?: EditorlessUnassigned;
5165
5019
  }
5166
- interface RestockInfo {
5167
- /** Restock type. */
5168
- type?: RestockTypeWithLiterals;
5020
+ interface Asset {
5169
5021
  /**
5170
- * Deprecated, use items instead
5171
- * @internal
5172
- * @maxSize 300
5173
- * @deprecated
5022
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5023
+ * @maxLength 36
5174
5024
  */
5175
- lineItemIds?: string[];
5025
+ appDefId?: string;
5176
5026
  /**
5177
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5178
- * @maxSize 300
5027
+ * An instance id. For legacy reasons may be UUID or a string.
5028
+ * @maxLength 200
5179
5029
  */
5180
- items?: RestockItem[];
5030
+ instanceId?: string;
5031
+ /** An application state. */
5032
+ state?: StateWithLiterals;
5181
5033
  }
5182
- declare enum RestockType {
5183
- NO_ITEMS = "NO_ITEMS",
5184
- ALL_ITEMS = "ALL_ITEMS",
5185
- SOME_ITEMS = "SOME_ITEMS"
5034
+ declare enum State {
5035
+ UNKNOWN = "UNKNOWN",
5036
+ ENABLED = "ENABLED",
5037
+ DISABLED = "DISABLED",
5038
+ PENDING = "PENDING",
5039
+ DEMO = "DEMO"
5186
5040
  }
5187
5041
  /** @enumType */
5188
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5189
- interface RestockItem {
5042
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5043
+ interface SiteCreated {
5190
5044
  /**
5191
- * ID of the line item being restocked.
5045
+ * A template identifier (empty if not created from a template).
5046
+ * @maxLength 36
5047
+ */
5048
+ originTemplateId?: string;
5049
+ /**
5050
+ * An account id of the owner.
5192
5051
  * @format GUID
5193
5052
  */
5194
- lineItemId?: string;
5053
+ ownerId?: string;
5054
+ /** A context in which meta site was created. */
5055
+ context?: SiteCreatedContextWithLiterals;
5195
5056
  /**
5196
- * Line item quantity being restocked.
5197
- * @min 1
5198
- * @max 100000
5057
+ * A meta site id from which this site was created.
5058
+ *
5059
+ * In case of a creation from a template it's a template id.
5060
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5061
+ * @format GUID
5199
5062
  */
5200
- quantity?: number;
5063
+ originMetaSiteId?: string | null;
5201
5064
  /**
5202
- * Per-location breakdown of restock quantities.
5203
- * @internal
5204
- * @maxSize 5
5065
+ * A meta site name (URL slug).
5066
+ * @maxLength 20
5205
5067
  */
5206
- restockLocations?: RestockLocation[];
5068
+ siteName?: string;
5069
+ /** A namespace. */
5070
+ namespace?: NamespaceWithLiterals;
5207
5071
  }
5208
- interface TriggerRefundResponse {
5209
- /** All order's transactions after the refunds were added */
5210
- orderTransactions?: OrderTransactions;
5211
- /** Created refund ID */
5212
- refundId?: string | null;
5213
- /** Payment ID's that the refund execution had failed for */
5214
- failedPaymentIds?: ItemMetadata[];
5072
+ declare enum SiteCreatedContext {
5073
+ /** A valid option, we don't expose all reasons why site might be created. */
5074
+ OTHER = "OTHER",
5075
+ /** A meta site was created from template. */
5076
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5077
+ /** A meta site was created by copying of the transfferred meta site. */
5078
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5079
+ /** A copy of existing meta site. */
5080
+ DUPLICATE = "DUPLICATE",
5081
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5082
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5083
+ /** deprecated A meta site was created for Flash editor. */
5084
+ FLASH = "FLASH"
5215
5085
  }
5216
- /**
5217
- * A record of all payments and refunds associated with an order.
5218
- *
5219
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5220
- */
5221
- interface OrderTransactions {
5086
+ /** @enumType */
5087
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5088
+ declare enum Namespace {
5089
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5090
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5091
+ WIX = "WIX",
5092
+ /** 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. */
5093
+ SHOUT_OUT = "SHOUT_OUT",
5094
+ /** 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. */
5095
+ ALBUMS = "ALBUMS",
5096
+ /** 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. */
5097
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5098
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5099
+ HOTELS = "HOTELS",
5100
+ /** 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. */
5101
+ CLUBS = "CLUBS",
5102
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5103
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5222
5104
  /**
5223
- * Order ID.
5224
- * @format GUID
5105
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5106
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5225
5107
  */
5226
- orderId?: string;
5108
+ DEV_SITE = "DEV_SITE",
5109
+ /** 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. */
5110
+ LOGOS = "LOGOS",
5111
+ /** 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. */
5112
+ VIDEO_MAKER = "VIDEO_MAKER",
5113
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5114
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5115
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5116
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5227
5117
  /**
5228
- * Record of payments made to the merchant.
5229
- * @maxSize 100
5118
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5119
+ *
5120
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5230
5121
  */
5231
- payments?: Payment[];
5122
+ HTML_DRAFT = "HTML_DRAFT",
5232
5123
  /**
5233
- * Record of refunds made to the buyer.
5234
- * @maxSize 300
5124
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5125
+ * Will be accessible from Site List and will not have a website app.
5126
+ * Once the user attaches a site, the site will become a regular wixsite.
5235
5127
  */
5236
- refunds?: Refund[];
5237
- }
5238
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5239
- /** Regular payment details. */
5240
- regularPaymentDetails?: RegularPaymentDetails;
5241
- /** Gift card payment details. */
5242
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5243
- /** Membership payment details. */
5244
- membershipPaymentDetails?: MembershipPaymentDetails;
5128
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5129
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5130
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5131
+ /** It is to be used in the Business First efforts. */
5132
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5133
+ /** Bookings business flow with no site. */
5134
+ ANYWHERE = "ANYWHERE",
5135
+ /** Namespace for Headless Backoffice with no editor */
5136
+ HEADLESS = "HEADLESS",
5245
5137
  /**
5246
- * Receipt created by Wix
5247
- * @internal
5138
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5139
+ * The site will be used for account level CSM feature for enterprise
5248
5140
  */
5249
- wixReceipt?: WixReceiptInfo;
5141
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5142
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5143
+ RISE = "RISE",
5250
5144
  /**
5251
- * Receipt created by an external system.
5252
- * @internal
5145
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5146
+ * There's a blank site behind the scene but it's blank).
5147
+ * The Mobile company will be the owner of this namespace.
5253
5148
  */
5254
- externalReceipt?: ExternalReceiptInfo;
5255
- /** @internal */
5256
- canceled?: CanceledStatusDetails;
5257
- /** @internal */
5258
- declined?: DeclinedStatusDetails;
5259
- /** @internal */
5260
- voided?: VoidedStatusDetails;
5149
+ BRANDED_FIRST = "BRANDED_FIRST",
5150
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5151
+ NOWNIA = "NOWNIA",
5261
5152
  /**
5262
- * Payment ID.
5263
- * @format GUID
5264
- * @readonly
5153
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5154
+ * The Partners company owns this namespace.
5265
5155
  */
5266
- id?: string | null;
5267
- /** 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. */
5268
- createdDate?: Date | null;
5156
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5157
+ /** Codux Headless Sites */
5158
+ CODUX = "CODUX",
5159
+ /** Bobb - AI Design Creator. */
5160
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5269
5161
  /**
5270
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5271
- * @readonly
5162
+ * Shared Blog Site is a unique single site across Enterprise account,
5163
+ * This site will hold all Blog posts related to the Marketing product.
5272
5164
  */
5273
- updatedDate?: Date | null;
5274
- /** Payment amount. */
5275
- amount?: Price;
5165
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5166
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5167
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5168
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5169
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5170
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5171
+ MIMIR = "MIMIR",
5172
+ /** Wix Twins platform. */
5173
+ TWINS = "TWINS",
5174
+ /** Wix Nano. */
5175
+ NANO = "NANO",
5176
+ /** Base44 headless sites. */
5177
+ BASE44 = "BASE44",
5178
+ /** Wix Channels Sites */
5179
+ CHANNELS = "CHANNELS",
5180
+ /** Nautilus platform. */
5181
+ NAUTILUS = "NAUTILUS",
5276
5182
  /**
5277
- * Whether refunds for this payment are disabled.
5278
- * + `true`: This payment is not refundable.
5279
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5183
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5184
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5280
5185
  */
5281
- refundDisabled?: boolean;
5186
+ SYMPHONY = "SYMPHONY",
5187
+ /** Nautilus platform app. */
5188
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5282
5189
  /**
5283
- * Whether receipt generation is allowed for this payment.
5284
- * + `true`: This payment supports receipt generation.
5285
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5286
- * @readonly
5190
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5191
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5287
5192
  */
5288
- supportReceiptGeneration?: boolean;
5289
- /** Details about cash rounding applied to this payment, when relevant. */
5290
- cashRounding?: CashRoundingDetails;
5193
+ VIBU = "VIBU",
5291
5194
  /**
5292
- * Overall payment status.
5293
- *
5294
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5195
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5196
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5197
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5198
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5295
5199
  */
5296
- status?: PaymentStatusWithLiterals;
5200
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5297
5201
  /**
5298
- * Detailed payment status information including gateway reason codes and status-specific details.
5299
- * @internal
5202
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5203
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5300
5204
  */
5301
- paymentStatusDetails?: PaymentStatusDetails;
5205
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5206
+ }
5207
+ /** @enumType */
5208
+ 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';
5209
+ /** Site transferred to another user. */
5210
+ interface SiteTransferred {
5302
5211
  /**
5303
- * Location where the payment was processed.
5304
- * @internal
5212
+ * A previous owner id (user that transfers meta site).
5305
5213
  * @format GUID
5306
- * @immutable
5307
5214
  */
5308
- locationId?: string | null;
5215
+ oldOwnerId?: string;
5309
5216
  /**
5310
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5217
+ * A new owner id (user that accepts meta site).
5311
5218
  * @format GUID
5312
5219
  */
5313
- chargeCorrelationId?: string | null;
5220
+ newOwnerId?: string;
5314
5221
  }
5315
- /** @oneof */
5316
- interface PaymentPaymentDetailsOneOf {
5317
- /** Regular payment details. */
5318
- regularPaymentDetails?: RegularPaymentDetails;
5319
- /** Gift card payment details. */
5320
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5321
- /** Membership payment details. */
5322
- membershipPaymentDetails?: MembershipPaymentDetails;
5222
+ /** Soft deletion of the meta site. Could be restored. */
5223
+ interface SiteDeleted {
5224
+ /** A deletion context. */
5225
+ deleteContext?: DeleteContext;
5323
5226
  }
5324
- /** @oneof */
5325
- interface PaymentReceiptInfoOneOf {
5227
+ interface DeleteContext {
5228
+ /** When the meta site was deleted. */
5229
+ dateDeleted?: Date | null;
5230
+ /** A status. */
5231
+ deleteStatus?: DeleteStatusWithLiterals;
5326
5232
  /**
5327
- * Receipt created by Wix
5328
- * @internal
5233
+ * A reason (flow).
5234
+ * @maxLength 255
5329
5235
  */
5330
- wixReceipt?: WixReceiptInfo;
5236
+ deleteOrigin?: string;
5331
5237
  /**
5332
- * Receipt created by an external system.
5333
- * @internal
5238
+ * A service that deleted it.
5239
+ * @maxLength 255
5334
5240
  */
5335
- externalReceipt?: ExternalReceiptInfo;
5241
+ initiatorId?: string | null;
5336
5242
  }
5337
- /** @oneof */
5338
- interface PaymentStatusDetailsOneOf {
5339
- /** @internal */
5340
- canceled?: CanceledStatusDetails;
5341
- /** @internal */
5342
- declined?: DeclinedStatusDetails;
5343
- /** @internal */
5344
- voided?: VoidedStatusDetails;
5243
+ declare enum DeleteStatus {
5244
+ UNKNOWN = "UNKNOWN",
5245
+ TRASH = "TRASH",
5246
+ DELETED = "DELETED",
5247
+ PENDING_PURGE = "PENDING_PURGE",
5248
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5345
5249
  }
5346
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5347
- /** Credit card details. */
5348
- creditCardDetails?: CreditCardPaymentMethodDetails;
5250
+ /** @enumType */
5251
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5252
+ /** Restoration of the meta site. */
5253
+ interface SiteUndeleted {
5254
+ }
5255
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5256
+ interface SitePublished {
5257
+ }
5258
+ interface SiteUnpublished {
5349
5259
  /**
5350
- * Wix Payments order ID.
5351
- * @maxLength 100
5260
+ * A list of URLs previously associated with the meta site.
5261
+ * @maxLength 4000
5262
+ * @maxSize 10000
5352
5263
  */
5353
- paymentOrderId?: string | null;
5264
+ urls?: string[];
5265
+ }
5266
+ interface SiteMarkedAsTemplate {
5267
+ }
5268
+ interface SiteMarkedAsWixSite {
5269
+ }
5270
+ /**
5271
+ * Represents a service provisioned a site.
5272
+ *
5273
+ * Note on `origin_instance_id`:
5274
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5275
+ * This is because of the following scenario:
5276
+ *
5277
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5278
+ * such as a product catalog. When you create a site from this template, you inherit this
5279
+ * default product catalog. However, if the template's product catalog is modified,
5280
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5281
+ * your site remains consistent with what you initially received and does not include any
5282
+ * changes made to the original template afterward.
5283
+ * To ensure this, the TPA on the template gets a new instance_id.
5284
+ */
5285
+ interface ServiceProvisioned {
5354
5286
  /**
5355
- * Payment gateway's transaction ID.
5356
- * This field is only returned when the value of `offline_payment` is `false`.
5357
- * @maxLength 100
5287
+ * Either UUID or EmbeddedServiceType.
5288
+ * @maxLength 36
5358
5289
  */
5359
- gatewayTransactionId?: string | null;
5290
+ appDefId?: string;
5360
5291
  /**
5361
- * Payment method.
5362
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5363
- * Non-exhaustive list of supported values:
5364
- * + `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`
5365
- * @maxLength 150
5366
- * @deprecated Payment method.
5367
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5368
- * Non-exhaustive list of supported values:
5369
- * + `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`
5370
- * @replacedBy payment_method_name
5371
- * @targetRemovalDate 2026-07-01
5292
+ * Not only UUID. Something here could be something weird.
5293
+ * @maxLength 36
5372
5294
  */
5373
- paymentMethod?: string | null;
5295
+ instanceId?: string;
5374
5296
  /**
5375
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5376
- * @maxLength 100
5297
+ * An instance id from which this instance is originated.
5298
+ * @maxLength 36
5377
5299
  */
5378
- providerTransactionId?: string | null;
5379
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5380
- offlinePayment?: boolean;
5300
+ originInstanceId?: string;
5381
5301
  /**
5382
- * Payment status.
5383
- * @deprecated Payment status.
5384
- * @replacedBy payment.status
5385
- * @targetRemovalDate 2026-11-01
5302
+ * A version.
5303
+ * @maxLength 500
5386
5304
  */
5387
- status?: TransactionStatusWithLiterals;
5388
- /** Whether there is a payment agreement that allows for future charges. */
5389
- savedPaymentMethod?: boolean;
5390
- /** Authorization details. */
5391
- authorizationDetails?: AuthorizationDetails;
5305
+ version?: string | null;
5392
5306
  /**
5393
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5394
- * @internal
5395
- * @maxLength 300
5307
+ * The origin meta site id
5308
+ * @format GUID
5396
5309
  */
5397
- paymentProvider?: string | null;
5310
+ originMetaSiteId?: string | null;
5311
+ }
5312
+ interface ServiceRemoved {
5398
5313
  /**
5399
- * Record of chargebacks made by the buyer.
5400
- * @maxSize 6
5314
+ * Either UUID or EmbeddedServiceType.
5315
+ * @maxLength 36
5401
5316
  */
5402
- chargebacks?: Chargeback[];
5317
+ appDefId?: string;
5403
5318
  /**
5404
- * Payment method ID.
5405
- * @internal
5319
+ * Not only UUID. Something here could be something weird.
5406
5320
  * @maxLength 36
5407
5321
  */
5408
- paymentMethodId?: string | null;
5409
- /** Platform fee amount associated with this payment. */
5410
- platformFee?: Price;
5322
+ instanceId?: string;
5411
5323
  /**
5412
- * Payment method with buyer and optional owner translations.
5413
- * Non-exhaustive list of supported values:
5414
- * + `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`
5324
+ * A version.
5325
+ * @maxLength 500
5415
5326
  */
5416
- paymentMethodName?: PaymentMethodName;
5417
- }
5418
- /** @oneof */
5419
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5420
- /** Credit card details. */
5421
- creditCardDetails?: CreditCardPaymentMethodDetails;
5422
- }
5423
- declare enum TransactionStatus {
5424
- UNDEFINED = "UNDEFINED",
5425
- APPROVED = "APPROVED",
5426
- PENDING = "PENDING",
5427
- PENDING_MERCHANT = "PENDING_MERCHANT",
5428
- CANCELED = "CANCELED",
5429
- DECLINED = "DECLINED",
5430
- REFUNDED = "REFUNDED",
5431
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5432
- AUTHORIZED = "AUTHORIZED",
5433
- VOIDED = "VOIDED"
5327
+ version?: string | null;
5434
5328
  }
5435
- /** @enumType */
5436
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5437
- interface CreditCardPaymentMethodDetails {
5329
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5330
+ interface SiteRenamed {
5438
5331
  /**
5439
- * The last 4 digits of the card number.
5440
- * @maxLength 4
5332
+ * A new meta site name (URL slug).
5333
+ * @maxLength 20
5441
5334
  */
5442
- lastFourDigits?: string | null;
5335
+ newSiteName?: string;
5443
5336
  /**
5444
- * Card issuer's brand.
5445
- * @maxLength 100
5337
+ * A previous meta site name (URL slug).
5338
+ * @maxLength 255
5446
5339
  */
5447
- brand?: string | null;
5340
+ oldSiteName?: string;
5448
5341
  }
5449
- interface AuthorizationDetails {
5450
- /**
5451
- * Whether the authorized payment is of a delayed capture.
5452
- * @readonly
5453
- */
5454
- delayedCapture?: boolean;
5455
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5456
- authorizedDate?: Date | null;
5457
- /**
5458
- * List of captures associated with payment
5459
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5460
- * @maxSize 1
5461
- */
5462
- captures?: AuthorizationCapture[];
5463
- /** Void associated with payment */
5464
- void?: AuthorizationVoid;
5465
- /** Scheduled action for this transaction */
5466
- scheduledAction?: V1ScheduledAction;
5342
+ /**
5343
+ * Hard deletion of the meta site.
5344
+ *
5345
+ * Could not be restored. Therefore it's desirable to cleanup data.
5346
+ */
5347
+ interface SiteHardDeleted {
5348
+ /** A deletion context. */
5349
+ deleteContext?: DeleteContext;
5467
5350
  }
5468
- interface AuthorizationCapture {
5469
- /**
5470
- * Capture ID.
5471
- * @format GUID
5472
- * @readonly
5473
- */
5474
- id?: string | null;
5475
- /** Status of this capture action */
5476
- status?: AuthorizationCaptureStatusWithLiterals;
5351
+ interface NamespaceChanged {
5352
+ /** A previous namespace. */
5353
+ oldNamespace?: NamespaceWithLiterals;
5354
+ /** A new namespace. */
5355
+ newNamespace?: NamespaceWithLiterals;
5356
+ }
5357
+ /** Assigned Studio editor */
5358
+ interface StudioAssigned {
5359
+ }
5360
+ /** Unassigned Studio editor */
5361
+ interface StudioUnassigned {
5362
+ }
5363
+ /**
5364
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5365
+ *
5366
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5367
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5368
+ *
5369
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5370
+ */
5371
+ interface SiteUrlChanged {
5372
+ }
5373
+ /**
5374
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5375
+ * Consumed by other teams to remove relevant data.
5376
+ */
5377
+ interface SitePurgedExternally {
5477
5378
  /**
5478
- * Amount of this capture
5479
- * @immutable
5379
+ * @maxLength 2048
5380
+ * @maxSize 100
5381
+ * @deprecated
5382
+ * @targetRemovalDate 2025-04-15
5480
5383
  */
5481
- amount?: Price;
5482
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5483
- createdDate?: Date | null;
5484
- /** In case of status is FAILED may contain failure details */
5485
- failureDetails?: AuthorizationActionFailureDetails;
5384
+ appDefId?: string[];
5486
5385
  }
5487
- declare enum AuthorizationCaptureStatus {
5488
- /** Capture operation still in progress. */
5489
- PENDING = "PENDING",
5490
- /** Capture operation succeeded. */
5491
- SUCCEEDED = "SUCCEEDED",
5492
- /** Capture operation failed. */
5493
- FAILED = "FAILED"
5386
+ /** Assigned Odeditor */
5387
+ interface OdeditorAssigned {
5494
5388
  }
5495
- /** @enumType */
5496
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5497
- interface AuthorizationActionFailureDetails {
5498
- /** @maxLength 100 */
5499
- failureCode?: string;
5389
+ /** Unassigned Odeditor */
5390
+ interface OdeditorUnassigned {
5500
5391
  }
5501
- interface AuthorizationVoid {
5502
- /** Status of this void action */
5503
- status?: AuthorizationVoidStatusWithLiterals;
5504
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5505
- voidedDate?: Date | null;
5506
- /** In case of status is FAILED may contain failure details */
5507
- failureDetails?: AuthorizationActionFailureDetails;
5508
- /** Reason of void action */
5509
- reason?: ReasonWithLiterals;
5392
+ /** Assigned Picasso editor */
5393
+ interface PicassoAssigned {
5510
5394
  }
5511
- declare enum AuthorizationVoidStatus {
5512
- /** Void operation still in progress. */
5513
- PENDING = "PENDING",
5514
- /** Void operation succeeded. */
5515
- SUCCEEDED = "SUCCEEDED",
5516
- /** Void operation failed. */
5517
- FAILED = "FAILED"
5395
+ /** Unassigned Picasso */
5396
+ interface PicassoUnassigned {
5518
5397
  }
5519
- /** @enumType */
5520
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5521
- /** Reason the authorization was voided. */
5522
- declare enum Reason {
5523
- /** Authorization was voided by user. */
5524
- MANUAL = "MANUAL",
5525
- /** Authorization passed execution date. */
5526
- SCHEDULED = "SCHEDULED"
5398
+ /** Assigned Wixel */
5399
+ interface WixelAssigned {
5527
5400
  }
5528
- /** @enumType */
5529
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5530
- interface V1ScheduledAction {
5531
- /** Type of the action. */
5532
- actionType?: ActionTypeWithLiterals;
5533
- /** The date and time of the action. */
5534
- executionDate?: Date | null;
5401
+ /** Unassigned Wixel */
5402
+ interface WixelUnassigned {
5535
5403
  }
5536
- declare enum ActionType {
5537
- VOID = "VOID",
5538
- CAPTURE = "CAPTURE"
5404
+ /** Assigned StudioTwo */
5405
+ interface StudioTwoAssigned {
5406
+ }
5407
+ /** Unassigned StudioTwo */
5408
+ interface StudioTwoUnassigned {
5409
+ }
5410
+ /** Media from user domain is enabled. */
5411
+ interface UserDomainMediaEnabled {
5412
+ }
5413
+ /** Media from user domain is disabled. */
5414
+ interface UserDomainMediaDisabled {
5415
+ }
5416
+ /** Assigned Editorless */
5417
+ interface EditorlessAssigned {
5418
+ }
5419
+ /** Unassigned Editorless */
5420
+ interface EditorlessUnassigned {
5421
+ }
5422
+ interface HasCustomEmailConfigurationsRequest {
5423
+ }
5424
+ interface HasCustomEmailConfigurationsResponse {
5425
+ hasCustomConfigurations?: boolean;
5426
+ }
5427
+ interface AddToAutomationMigrationPopulationRequest {
5428
+ /** When true, sends custom email configurations to automation system via email */
5429
+ sendCustomEmailConfigs?: boolean;
5430
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5431
+ origin?: OriginWithLiterals;
5432
+ }
5433
+ declare enum Origin {
5434
+ OPT_IN = "OPT_IN",
5435
+ MIGRATION = "MIGRATION"
5539
5436
  }
5540
5437
  /** @enumType */
5541
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5542
- interface Chargeback {
5543
- /**
5544
- * Chargeback ID.
5545
- * @format GUID
5546
- * @readonly
5547
- * @immutable
5548
- */
5549
- id?: string;
5550
- /**
5551
- * 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.
5552
- * @readonly
5553
- * @immutable
5554
- */
5555
- createdDate?: Date | null;
5438
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5439
+ interface AddToAutomationMigrationPopulationResponse {
5440
+ success?: boolean;
5441
+ }
5442
+ interface IsInAutomationMigrationPopulationRequest {
5443
+ }
5444
+ interface IsInAutomationMigrationPopulationResponse {
5445
+ inPopulation?: boolean;
5446
+ }
5447
+ interface PreparePaymentCollectionRequest {
5556
5448
  /**
5557
- * 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.
5558
- * @readonly
5449
+ * Ecom order ID.
5450
+ * @minLength 1
5451
+ * @maxLength 100
5559
5452
  */
5560
- updatedDate?: Date | null;
5453
+ ecomOrderId: string;
5454
+ /** Amount to collect */
5455
+ amount: Price;
5561
5456
  /**
5562
- * Amount.
5563
- * @readonly
5564
- * @immutable
5457
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5458
+ * Existing payment gateway order will be updated with a new amount.
5459
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5565
5460
  */
5566
- amount?: Price;
5461
+ paymentGatewayOrderId?: string | null;
5567
5462
  /**
5568
- * Reversal amount. Present only when status is REVERSED.
5569
- * @readonly
5463
+ * Whether to delay capture of the payment.
5464
+ * Default: false
5465
+ * @deprecated Whether to delay capture of the payment.
5466
+ * Default: false
5467
+ * @replacedBy delayed_capture_settings.scheduled_action
5468
+ * @targetRemovalDate 2024-09-30
5570
5469
  */
5571
- reversalAmount?: Price;
5470
+ delayedCapture?: boolean;
5572
5471
  /**
5573
- * Status.
5574
- *
5575
- * Default: `"APPROVED"`.
5472
+ * Specifies whether payment collection is initiated by Merchant or User of User
5473
+ * Default: `true`
5474
+ * @internal
5576
5475
  */
5577
- status?: ChargebackStatusWithLiterals;
5476
+ merchantInitiated?: boolean | null;
5578
5477
  /**
5579
- * External chargeback ID.
5580
- * @format GUID
5581
- * @readonly
5582
- * @immutable
5478
+ * Redirect urls which are used to return buyer to third party system.
5479
+ * @internal
5583
5480
  */
5584
- externalId?: string | null;
5585
- }
5586
- declare enum ChargebackStatus {
5587
- /** Chargeback was approved. */
5588
- APPROVED = "APPROVED",
5589
- /** Chargeback was reversed. */
5590
- REVERSED = "REVERSED"
5481
+ redirectUrls?: RedirectUrls;
5482
+ /** Delayed capture payment settings */
5483
+ delayedCaptureSettings?: DelayedCaptureSettings;
5591
5484
  }
5592
- /** @enumType */
5593
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5594
- interface PaymentMethodName {
5485
+ interface RedirectUrls {
5595
5486
  /**
5596
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5597
- * @maxLength 150
5487
+ * URL to redirect buyer in case of approved (successful) transaction
5488
+ * @format WEB_URL
5598
5489
  */
5599
- buyerLanguageName?: string | null;
5490
+ successUrl?: string | null;
5600
5491
  /**
5601
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5602
- *
5603
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5604
- * @maxLength 150
5492
+ * URL to redirect buyer in case of buyer canceled the transaction
5493
+ * @format WEB_URL
5605
5494
  */
5606
- siteLanguageName?: string | null;
5495
+ cancelUrl?: string | null;
5607
5496
  /**
5608
- * User-provided payment method name.
5609
- *
5610
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5497
+ * URL to redirect buyer in case of failed/rejected transaction
5498
+ * @format WEB_URL
5611
5499
  */
5612
- userDefinedName?: UserDefinedPaymentMethodName;
5613
- }
5614
- interface GiftCardPaymentDetails {
5500
+ errorUrl?: string | null;
5615
5501
  /**
5616
- * Gift card payment ID.
5617
- * @maxLength 100
5502
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5503
+ * @format WEB_URL
5618
5504
  */
5619
- giftCardPaymentId?: string;
5505
+ pendingUrl?: string | null;
5506
+ }
5507
+ interface DelayedCaptureSettings {
5508
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5509
+ scheduledAction?: ScheduledActionWithLiterals;
5510
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5511
+ delayDuration?: Duration;
5512
+ }
5513
+ declare enum ScheduledAction {
5514
+ /** Whether payment will be auto-voided when duration passes */
5515
+ VOID = "VOID",
5516
+ /** Whether payment will be auto-captured when duration passes */
5517
+ CAPTURE = "CAPTURE"
5518
+ }
5519
+ /** @enumType */
5520
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5521
+ interface Duration {
5620
5522
  /**
5621
- * Gift card ID.
5622
- * @internal
5623
- * @deprecated
5523
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5524
+ * @min 1
5624
5525
  */
5625
- giftCardId?: string;
5526
+ count?: number;
5527
+ /** Duration unit: MINUTES, HOURS and DAYS */
5528
+ unit?: DurationUnitWithLiterals;
5529
+ }
5530
+ declare enum DurationUnit {
5531
+ MINUTES = "MINUTES",
5532
+ HOURS = "HOURS",
5533
+ DAYS = "DAYS"
5534
+ }
5535
+ /** @enumType */
5536
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5537
+ interface PreparePaymentCollectionResponse {
5538
+ /** Payment gateway order id which is associated with given payment */
5539
+ paymentGatewayOrderId?: string;
5540
+ }
5541
+ interface GetPaymentCollectabilityStatusRequest {
5626
5542
  /**
5627
- * ID of the app that created the gift card.
5628
- * @format GUID
5543
+ * Ecom order ID.
5544
+ * @minLength 1
5545
+ * @maxLength 100
5629
5546
  */
5630
- appId?: string;
5547
+ ecomOrderId: string;
5548
+ }
5549
+ interface GetPaymentCollectabilityStatusResponse {
5550
+ /** Payment collectability status */
5551
+ status?: PaymentCollectabilityStatusWithLiterals;
5552
+ /** Collectable order amount */
5553
+ amount?: Price;
5631
5554
  /**
5632
- * Whether the gift card is voided.
5633
- * @readonly
5634
- * @deprecated Whether the gift card is voided.
5635
- * @replacedBy payment.status
5636
- * @targetRemovalDate 2026-11-01
5555
+ * Whether authorization supported
5556
+ * @internal
5637
5557
  */
5638
- voided?: boolean;
5558
+ authorizationSupported?: boolean;
5639
5559
  /**
5640
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5641
- * @maxLength 30
5642
- * @immutable
5560
+ * Whether custom amount is supported for payment collection
5561
+ * @internal
5643
5562
  */
5644
- obfuscatedCode?: string | null;
5563
+ customAmountSupported?: boolean;
5645
5564
  }
5646
- interface MembershipPaymentDetails {
5647
- /**
5648
- * Membership ID.
5649
- * @maxLength 200
5650
- */
5651
- membershipId?: string;
5565
+ declare enum PaymentCollectabilityStatus {
5566
+ UNKNOWN = "UNKNOWN",
5567
+ COLLECTABLE = "COLLECTABLE",
5568
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5569
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5570
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5571
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5572
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5573
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5574
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5575
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5576
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5577
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5578
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5579
+ }
5580
+ /** @enumType */
5581
+ 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';
5582
+ interface RecordManuallyCollectedPaymentRequest {
5652
5583
  /**
5653
- * ID of the line item this membership applies to.
5584
+ * Order ID.
5654
5585
  * @minLength 1
5655
5586
  * @maxLength 100
5656
5587
  */
5657
- lineItemId?: string;
5588
+ orderId: string;
5589
+ /** Amount to be recorded as approved manual payment for given order */
5590
+ amount: Price;
5658
5591
  /**
5659
- * Payment status.
5660
- * @deprecated Payment status.
5661
- * @replacedBy payment.status
5662
- * @targetRemovalDate 2026-11-01
5592
+ * Payment method name provided by user.
5593
+ *
5594
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5595
+ * @internal
5663
5596
  */
5664
- status?: MembershipPaymentStatusWithLiterals;
5665
- /** Membership name. */
5666
- name?: MembershipName;
5597
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5598
+ }
5599
+ /**
5600
+ * User-defined payment method name.
5601
+ * Allows specifying either a predefined type or a custom name.
5602
+ */
5603
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5604
+ /** Predefined payment method. */
5605
+ predefined?: PredefinedPaymentMethodWithLiterals;
5667
5606
  /**
5668
- * The transaction ID in the membership system. Can be used to void the transaction.
5607
+ * Custom payment method name provided by user.
5608
+ *
5609
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5669
5610
  * @minLength 1
5670
- * @maxLength 100
5671
- */
5672
- externalTransactionId?: string | null;
5673
- /**
5674
- * Whether the membership is voided.
5675
- * @readonly
5676
- * @deprecated Whether the membership is voided.
5677
- * @replacedBy payment.status
5678
- * @targetRemovalDate 2026-11-01
5611
+ * @maxLength 150
5679
5612
  */
5680
- voided?: boolean;
5613
+ custom?: string | null;
5614
+ }
5615
+ /** @oneof */
5616
+ interface UserDefinedPaymentMethodNameKindOneOf {
5617
+ /** Predefined payment method. */
5618
+ predefined?: PredefinedPaymentMethodWithLiterals;
5681
5619
  /**
5682
- * ID of the application providing this payment option.
5683
- * @format GUID
5620
+ * Custom payment method name provided by user.
5621
+ *
5622
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5623
+ * @minLength 1
5624
+ * @maxLength 150
5684
5625
  */
5685
- providerAppId?: string;
5686
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5687
- futureMembership?: FutureMembershipDetails;
5626
+ custom?: string | null;
5688
5627
  }
5689
- declare enum MembershipPaymentStatus {
5690
- /** Payment was charged. */
5691
- CHARGED = "CHARGED",
5692
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5693
- CHARGE_FAILED = "CHARGE_FAILED",
5694
- /** Payment is pending. */
5695
- CHARGE_PENDING = "CHARGE_PENDING",
5696
- /** Payment was voided. */
5697
- VOIDED = "VOIDED"
5628
+ /** Predefined payment method types for offline/manual payments. */
5629
+ declare enum PredefinedPaymentMethod {
5630
+ /** Cash payment. */
5631
+ CASH = "CASH",
5632
+ /** Bank transfer. */
5633
+ BANK_TRANSFER = "BANK_TRANSFER",
5634
+ /** Payment by check. */
5635
+ CHECK = "CHECK"
5698
5636
  }
5699
5637
  /** @enumType */
5700
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5701
- interface FutureMembershipDetails {
5638
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5639
+ interface RecordManuallyCollectedPaymentResponse {
5640
+ }
5641
+ interface MarkOrderAsPaidRequest {
5702
5642
  /**
5703
- * ID of the plan line item in the order from which the membership will be created.
5704
- * @format GUID
5643
+ * Ecom order ID.
5644
+ * @minLength 1
5645
+ * @maxLength 100
5705
5646
  */
5706
- lineItemId?: string;
5647
+ ecomOrderId: string;
5707
5648
  /**
5708
- * ID of the benefit the future membership will grant.
5709
- * @maxLength 200
5649
+ * Payment method name provided by user.
5650
+ *
5651
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5652
+ * @internal
5710
5653
  */
5711
- benefitId?: string;
5654
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5712
5655
  }
5713
- interface WixReceiptInfo {
5714
- /**
5715
- * Receipt ID
5716
- * @format GUID
5717
- */
5718
- receiptId?: string;
5656
+ interface MarkOrderAsPaidResponse {
5657
+ /** Updated order. */
5658
+ order?: Order;
5659
+ }
5660
+ interface BulkMarkOrdersAsPaidRequest {
5719
5661
  /**
5720
- * Display number of receipt
5662
+ * IDs of orders to mark as paid.
5663
+ * @minSize 1
5664
+ * @maxSize 100
5721
5665
  * @minLength 1
5722
- * @maxLength 40
5666
+ * @maxLength 100
5723
5667
  */
5724
- displayNumber?: string | null;
5668
+ ecomOrderIds: string[];
5725
5669
  }
5726
- interface ExternalReceiptInfo {
5670
+ interface BulkMarkOrdersAsPaidResponse {
5727
5671
  /**
5728
- * External receipt ID
5729
- * @maxLength 100
5672
+ * Items updated by the bulk action.
5673
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5730
5674
  */
5731
- receiptId?: string | null;
5675
+ results?: BulkOrderResult[];
5676
+ /** Bulk action metadata. */
5677
+ bulkActionMetadata?: BulkActionMetadata;
5678
+ }
5679
+ interface BulkOrderResult {
5680
+ /** Item metadata. */
5681
+ itemMetadata?: ItemMetadata;
5732
5682
  /**
5733
- * ID of the app providing the receipt
5734
- * @format GUID
5683
+ * Updated order.
5684
+ *
5685
+ * Returned when `returnFullEntity = true`.
5735
5686
  */
5736
- appId?: string | null;
5687
+ item?: Order;
5688
+ }
5689
+ interface ItemMetadata {
5690
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5691
+ id?: string | null;
5692
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5693
+ originalIndex?: number;
5694
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5695
+ success?: boolean;
5696
+ /** Details about the error in case of failure. */
5697
+ error?: ApplicationError;
5698
+ }
5699
+ interface ApplicationError {
5700
+ /** Error code. */
5701
+ code?: string;
5702
+ /** Description of the error. */
5703
+ description?: string;
5704
+ /** Data related to the error. */
5705
+ data?: Record<string, any> | null;
5706
+ }
5707
+ interface BulkActionMetadata {
5708
+ /** Number of items that were successfully processed. */
5709
+ totalSuccesses?: number;
5710
+ /** Number of items that couldn't be processed. */
5711
+ totalFailures?: number;
5712
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5713
+ undetailedFailures?: number;
5714
+ }
5715
+ interface GetRefundabilityStatusRequest {
5737
5716
  /**
5738
- * Display number of receipt
5717
+ * Order ID.
5739
5718
  * @minLength 1
5740
- * @maxLength 40
5719
+ * @maxLength 100
5741
5720
  */
5742
- displayNumber?: string | null;
5721
+ ecomOrderId: string;
5743
5722
  }
5744
- interface CashRoundingDetails {
5745
- /**
5746
- * Payment amount before cash rounding was applied.
5747
- * When provided, balance and status calculations use this value instead of `amount`
5748
- * to prevent false overpayment or underpayment due to rounding.
5749
- */
5750
- unroundedAmount?: Price;
5723
+ interface GetRefundabilityStatusResponse {
5751
5724
  /**
5752
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5753
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5754
- * @readonly
5725
+ * Refundability details.
5726
+ * @maxSize 300
5755
5727
  */
5756
- roundingAdjustment?: CashRounding;
5757
- }
5758
- declare enum PaymentStatus {
5759
- /** Payment was charged successfully. */
5760
- APPROVED = "APPROVED",
5761
- /** Payment is being processed and hasn't been confirmed yet. */
5762
- PENDING = "PENDING",
5763
- /** 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. */
5764
- PENDING_MERCHANT = "PENDING_MERCHANT",
5765
- /** Payment was canceled before it was charged. */
5766
- CANCELED = "CANCELED",
5767
- /** Payment was declined by the payment provider. */
5768
- DECLINED = "DECLINED",
5769
- /** Payment was fully refunded. */
5770
- REFUNDED = "REFUNDED",
5771
- /** Part of the payment amount was refunded. */
5772
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5773
- /** 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. */
5774
- AUTHORIZED = "AUTHORIZED",
5728
+ refundabilities?: Refundability[];
5775
5729
  /**
5776
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5777
- *
5778
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5730
+ * Whether the order supports refunding per item.
5731
+ * @deprecated
5779
5732
  */
5780
- VOIDED = "VOIDED"
5781
- }
5782
- /** @enumType */
5783
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5784
- interface CanceledStatusDetails {
5785
- reason?: CanceledReasonWithLiterals;
5733
+ refundablePerItem?: boolean;
5786
5734
  }
5787
- declare enum CanceledReason {
5788
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5789
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5790
- /** Payment was not completed by user and expired. */
5791
- EXPIRED = "EXPIRED"
5735
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5736
+ /** Reason why payment is not refundable. */
5737
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5738
+ /** Reason why payment is only refundable manually. */
5739
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5740
+ /** Payment ID. */
5741
+ paymentId?: string;
5742
+ /** Payment refundability status. */
5743
+ refundabilityStatus?: RefundableStatusWithLiterals;
5744
+ /** Link to payment provider dashboard. */
5745
+ providerLink?: string | null;
5792
5746
  }
5793
- /** @enumType */
5794
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5795
- interface DeclinedStatusDetails {
5796
- reason?: DeclinedReasonWithLiterals;
5747
+ /** @oneof */
5748
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5749
+ /** Reason why payment is not refundable. */
5750
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5751
+ /** Reason why payment is only refundable manually. */
5752
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5797
5753
  }
5798
- declare enum DeclinedReason {
5799
- /** Corresponding charge failed. */
5800
- CHARGE_FAILED = "CHARGE_FAILED",
5801
- /** Payment details expired. */
5802
- EXPIRED = "EXPIRED",
5803
- /** Insufficient funds. */
5804
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5805
- /** Gift card was disabled before charge was attempted. */
5806
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5754
+ declare enum RefundableStatus {
5755
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5756
+ MANUAL = "MANUAL",
5757
+ REFUNDABLE = "REFUNDABLE"
5807
5758
  }
5808
5759
  /** @enumType */
5809
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5810
- interface VoidedStatusDetails {
5811
- reason?: VoidedReasonWithLiterals;
5760
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5761
+ declare enum NonRefundableReason {
5762
+ NONE = "NONE",
5763
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5764
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5765
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5766
+ NOT_PAID = "NOT_PAID",
5767
+ ACCESS_DENIED = "ACCESS_DENIED",
5768
+ ZERO_PRICE = "ZERO_PRICE",
5769
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5770
+ PENDING_REFUND = "PENDING_REFUND",
5771
+ FORBIDDEN = "FORBIDDEN",
5772
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5773
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5774
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5812
5775
  }
5813
- declare enum VoidedReason {
5814
- /** Payment was voided by merchant request. */
5815
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5816
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5817
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5776
+ /** @enumType */
5777
+ 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';
5778
+ declare enum ManuallyRefundableReason {
5779
+ EXPIRED = "EXPIRED",
5780
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5781
+ OFFLINE = "OFFLINE",
5782
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5818
5783
  }
5819
5784
  /** @enumType */
5820
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5821
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5822
- /** @internal */
5823
- canceled?: CanceledStatusDetails;
5824
- /** @internal */
5825
- declined?: DeclinedStatusDetails;
5826
- /** @internal */
5827
- voided?: VoidedStatusDetails;
5785
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5786
+ interface CreatePaymentGatewayOrderRequest {
5828
5787
  /**
5829
- * Reason code from the payment gateway.
5830
- * @internal
5788
+ * Ecom order ID.
5831
5789
  * @minLength 1
5832
- * @maxLength 10
5790
+ * @maxLength 100
5833
5791
  */
5834
- paymentGatewayReasonCode?: string | null;
5835
- }
5836
- /** @oneof */
5837
- interface PaymentStatusDetailsStatusDetailsOneOf {
5838
- /** @internal */
5839
- canceled?: CanceledStatusDetails;
5840
- /** @internal */
5841
- declined?: DeclinedStatusDetails;
5842
- /** @internal */
5843
- voided?: VoidedStatusDetails;
5792
+ ecomOrderId: string;
5793
+ /** Information about the user who initiated the payment. */
5794
+ chargedBy?: ChargedBy;
5795
+ /**
5796
+ * Whether to delay capture of the payment.
5797
+ *
5798
+ * Default: false
5799
+ * @internal
5800
+ */
5801
+ delayedCapture?: boolean;
5844
5802
  }
5845
- interface Refund {
5803
+ interface ChargedBy {
5846
5804
  /**
5847
- * Refund ID.
5805
+ * ID - id of the user who initiated the payment
5848
5806
  * @format GUID
5849
- * @readonly
5850
5807
  */
5851
5808
  id?: string;
5852
5809
  /**
5853
- * List of transactions.
5854
- * @maxSize 50
5810
+ * Full name - name of the user who initiated the payment
5811
+ * @minLength 1
5812
+ * @maxLength 200
5855
5813
  */
5856
- transactions?: RefundTransaction[];
5857
- /** Refund business details. */
5858
- details?: RefundDetails;
5814
+ fullName?: string | null;
5815
+ }
5816
+ interface CreatePaymentGatewayOrderResponse {
5817
+ /** ID of the order created in the payment gateway */
5818
+ paymentGatewayOrderId?: string;
5819
+ }
5820
+ interface ChargeMembershipsRequest {
5859
5821
  /**
5860
- * 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.
5861
- * @readonly
5862
- * @immutable
5822
+ * Order ID.
5823
+ * @minLength 1
5824
+ * @maxLength 100
5863
5825
  */
5864
- createdDate?: Date | null;
5826
+ ecomOrderId: string;
5865
5827
  /**
5866
- * Aggregated refund summary.
5867
- * @readonly
5828
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5829
+ * but a user which is using the membership on behalf of the a member
5830
+ * @format GUID
5868
5831
  */
5869
- summary?: AggregatedRefundSummary;
5832
+ memberId: string;
5870
5833
  /**
5871
- * ID of the app that initiated this refund.
5872
- * @format GUID
5873
- * @readonly
5874
- * @immutable
5834
+ * List of items to be paid by memberships
5835
+ * @minSize 1
5836
+ * @maxSize 300
5875
5837
  */
5876
- requestingServiceAppId?: string | null;
5838
+ membershipCharges?: MembershipChargeItem[];
5877
5839
  }
5878
- interface RefundTransaction {
5840
+ interface MembershipChargeItem {
5879
5841
  /**
5880
- * ID of the payment associated with this refund.
5842
+ * The id of used membership
5843
+ * @minLength 1
5844
+ * @maxLength 100
5845
+ */
5846
+ membershipId?: string;
5847
+ /**
5848
+ * ID of the application providing this payment option
5881
5849
  * @format GUID
5882
- * @immutable
5883
5850
  */
5884
- paymentId?: string;
5851
+ appId?: string;
5852
+ /** The name of used membership */
5853
+ membershipName?: MembershipName;
5854
+ /** Additional data about this membership */
5855
+ membershipAdditionalData?: Record<string, any> | null;
5856
+ /** Catalog and item reference info. */
5857
+ catalogReference?: CatalogReference;
5858
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5859
+ serviceProperties?: ServiceProperties;
5885
5860
  /**
5886
- * Refund amount.
5887
- * @immutable
5861
+ * Usually would be the same as catalogReference.catalogItemId
5862
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5863
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5864
+ * @minLength 1
5865
+ * @maxLength 36
5888
5866
  */
5889
- amount?: Price;
5890
- /** Refund status. */
5891
- refundStatus?: RefundStatusWithLiterals;
5892
- /** Optional details of current refund status. */
5893
- refundStatusInfo?: RefundStatusInfo;
5867
+ rootCatalogItemId?: string | null;
5894
5868
  /**
5895
- * Payment gateway's refund ID.
5896
- * This field is only returned when the value of `external_refund` is `false`.
5897
- * @format GUID
5869
+ * line item id of Checkout/Order line item
5870
+ * @minLength 1
5871
+ * @maxLength 100
5898
5872
  */
5899
- gatewayRefundId?: string | null;
5900
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5901
- providerRefundId?: string | null;
5873
+ lineItemId?: string;
5874
+ }
5875
+ interface MembershipName {
5902
5876
  /**
5903
- * Whether refund was made externally and manually on the payment provider's side.
5904
- * @immutable
5877
+ * Membership name in the site's original language.
5878
+ * @maxLength 100
5905
5879
  */
5906
- externalRefund?: boolean;
5880
+ original?: string;
5907
5881
  /**
5908
- * Location where the refund was processed.
5909
- * @internal
5910
- * @format GUID
5911
- * @immutable
5882
+ * Membership name translated into the buyer's language.
5883
+ *
5884
+ * Default: The value of `original`
5885
+ * @maxLength 100
5912
5886
  */
5913
- locationId?: string | null;
5887
+ translated?: string | null;
5914
5888
  }
5915
- /** Refund transaction status. */
5916
- declare enum RefundStatus {
5917
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5918
- PENDING = "PENDING",
5919
- /** Refund transaction succeeded. */
5920
- SUCCEEDED = "SUCCEEDED",
5921
- /** Refund transaction failed. */
5922
- FAILED = "FAILED",
5923
- /** Refund request acknowledged, and will be executed soon. */
5924
- SCHEDULED = "SCHEDULED",
5925
- /** Refund was initiated on payment provider side. */
5926
- STARTED = "STARTED"
5889
+ interface ChargeMembershipsResponse {
5927
5890
  }
5928
- /** @enumType */
5929
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5930
- interface RefundStatusInfo {
5891
+ interface TriggerRefundRequest {
5892
+ /**
5893
+ * The order this refund related to
5894
+ * @minLength 1
5895
+ * @maxLength 100
5896
+ */
5897
+ ecomOrderId: string;
5898
+ /**
5899
+ * Refund operations information
5900
+ * @minSize 1
5901
+ * @maxSize 1
5902
+ */
5903
+ payments: PaymentRefund[];
5904
+ /** Business model of a refund */
5905
+ details?: RefundDetails;
5906
+ /** Side effect details related to refund */
5907
+ sideEffects?: RefundSideEffects;
5908
+ }
5909
+ interface PaymentRefund {
5910
+ /**
5911
+ * Specific payment within the order to refund
5912
+ * @format GUID
5913
+ */
5914
+ paymentId?: string;
5915
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5916
+ amount?: Price;
5931
5917
  /**
5932
- * Reason code for the refund's current status.
5933
- *
5934
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5918
+ * Whether refund is made externally and manually (on the payment provider's side)
5919
+ * 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.
5920
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5921
+ */
5922
+ externalRefund?: boolean;
5923
+ /**
5924
+ * Gateway refund id. When param is present, new refund is not created.
5925
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5926
+ * and all side effects from request will be executed.
5927
+ * @internal
5935
5928
  * @minLength 1
5936
- * @maxLength 10
5929
+ * @maxLength 100
5937
5930
  */
5938
- paymentGatewayReasonCode?: string | null;
5931
+ gatewayRefundId?: string | null;
5932
+ }
5933
+ interface RefundSideEffects {
5934
+ /** Inventory restock details as part of this refund. */
5935
+ restockInfo?: RestockInfo;
5936
+ /** Whether to send a refund confirmation email to the customer. */
5937
+ sendOrderRefundedEmail?: boolean;
5939
5938
  /**
5940
- * Free text explanation of current refund status.
5939
+ * Custom message added to the refund confirmation email.
5941
5940
  * @minLength 1
5942
5941
  * @maxLength 1000
5943
5942
  */
5944
- description?: string | null;
5945
- }
5946
- interface AggregatedRefundSummary {
5947
- /** Total amount requested for refund. */
5948
- requestedRefund?: Price;
5949
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5950
- pendingRefund?: Price;
5951
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5952
- refunded?: Price;
5953
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5954
- failedRefundAmount?: Price;
5955
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5956
- pending?: boolean;
5957
- /** Breakdown of refunded items. Available only after refund is complete. */
5958
- breakdown?: RefundItemsBreakdown;
5943
+ customMessage?: string | null;
5959
5944
  }
5960
- interface RefundItemsBreakdown {
5945
+ interface RestockInfo {
5946
+ /** Restock type. */
5947
+ type?: RestockTypeWithLiterals;
5961
5948
  /**
5962
- * Refunded line items and the amount refunded for each.
5949
+ * Deprecated, use items instead
5950
+ * @internal
5963
5951
  * @maxSize 300
5952
+ * @deprecated
5964
5953
  */
5965
- lineItems?: LineItemRefundSummary[];
5954
+ lineItemIds?: string[];
5955
+ /**
5956
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5957
+ * @maxSize 300
5958
+ */
5959
+ items?: RestockItem[];
5966
5960
  }
5967
- interface LineItemRefundSummary {
5961
+ declare enum RestockType {
5962
+ NO_ITEMS = "NO_ITEMS",
5963
+ ALL_ITEMS = "ALL_ITEMS",
5964
+ SOME_ITEMS = "SOME_ITEMS"
5965
+ }
5966
+ /** @enumType */
5967
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5968
+ interface RestockItem {
5968
5969
  /**
5969
- * ID of the refunded line item.
5970
+ * ID of the line item being restocked.
5970
5971
  * @format GUID
5971
5972
  */
5972
5973
  lineItemId?: string;
5973
- /** Total refunded amount for the line item. */
5974
- totalRefundedAmount?: Price;
5975
- }
5976
- interface CalculateRefundRequest {
5977
5974
  /**
5978
- * Order ID
5979
- * @minLength 1
5980
- * @maxLength 100
5975
+ * Line item quantity being restocked.
5976
+ * @min 1
5977
+ * @max 100000
5981
5978
  */
5982
- ecomOrderId?: string;
5979
+ quantity?: number;
5983
5980
  /**
5984
- * Refunded line items and quantity
5985
- * @maxSize 300
5981
+ * Per-location breakdown of restock quantities.
5982
+ * @internal
5983
+ * @maxSize 5
5986
5984
  */
5987
- refundItems?: CalculateRefundItemRequest[];
5988
- /** Should include shipping in refund calculation */
5989
- refundShipping?: boolean;
5985
+ restockLocations?: RestockLocation[];
5990
5986
  }
5991
- interface CalculateRefundItemRequest {
5987
+ interface TriggerRefundResponse {
5988
+ /** All order's transactions after the refunds were added */
5989
+ orderTransactions?: OrderTransactions;
5990
+ /** Created refund ID */
5991
+ refundId?: string | null;
5992
+ /** Payment ID's that the refund execution had failed for */
5993
+ failedPaymentIds?: ItemMetadata[];
5994
+ }
5995
+ /**
5996
+ * A record of all payments and refunds associated with an order.
5997
+ *
5998
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5999
+ */
6000
+ interface OrderTransactions {
5992
6001
  /**
5993
- * ID of the line item being refunded
6002
+ * Order ID.
5994
6003
  * @format GUID
5995
6004
  */
5996
- id?: string;
6005
+ orderId?: string;
5997
6006
  /**
5998
- * How much of that line item is being refunded
5999
- * @min 1
6000
- * @max 100000
6007
+ * Record of payments made to the merchant.
6008
+ * @maxSize 100
6001
6009
  */
6002
- quantity?: number;
6003
- }
6004
- interface CalculateRefundResponse {
6005
- /** Total refundable amount */
6006
- total?: Price;
6007
- /** Tax cost of the order */
6008
- tax?: Price;
6009
- /** Discount given for this order */
6010
- discount?: Price;
6011
- /** Total cost of the order (without tax) */
6012
- subtotal?: Price;
6013
- /** Total shipping cost for order */
6014
- shipping?: Price;
6015
- /** Previous refund given on that order */
6016
- previouslyRefundedAmount?: Price;
6010
+ payments?: Payment[];
6017
6011
  /**
6018
- * The refundable items of that order
6012
+ * Record of refunds made to the buyer.
6019
6013
  * @maxSize 300
6020
6014
  */
6021
- items?: CalculateRefundItemResponse[];
6015
+ refunds?: Refund[];
6022
6016
  }
6023
- interface CalculateRefundItemResponse {
6017
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6018
+ /** Regular payment details. */
6019
+ regularPaymentDetails?: RegularPaymentDetails;
6020
+ /** Gift card payment details. */
6021
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6022
+ /** Membership payment details. */
6023
+ membershipPaymentDetails?: MembershipPaymentDetails;
6024
6024
  /**
6025
- * Line item ID
6025
+ * Receipt created by Wix
6026
+ * @internal
6027
+ */
6028
+ wixReceipt?: WixReceiptInfo;
6029
+ /**
6030
+ * Receipt created by an external system.
6031
+ * @internal
6032
+ */
6033
+ externalReceipt?: ExternalReceiptInfo;
6034
+ /** @internal */
6035
+ canceled?: CanceledStatusDetails;
6036
+ /** @internal */
6037
+ declined?: DeclinedStatusDetails;
6038
+ /** @internal */
6039
+ voided?: VoidedStatusDetails;
6040
+ /**
6041
+ * Payment ID.
6026
6042
  * @format GUID
6043
+ * @readonly
6027
6044
  */
6028
- id?: string;
6029
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6030
- price?: Price;
6031
- }
6032
- interface VoidAuthorizedPaymentsRequest {
6045
+ id?: string | null;
6046
+ /** 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. */
6047
+ createdDate?: Date | null;
6033
6048
  /**
6034
- * Wix eCommerce order ID
6035
- * @minLength 1
6036
- * @maxLength 100
6049
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6050
+ * @readonly
6037
6051
  */
6038
- ecomOrderId: string;
6052
+ updatedDate?: Date | null;
6053
+ /** Payment amount. */
6054
+ amount?: Price;
6039
6055
  /**
6040
- * Payment IDs
6041
- * @minSize 1
6042
- * @maxSize 100
6056
+ * Whether refunds for this payment are disabled.
6057
+ * + `true`: This payment is not refundable.
6058
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6059
+ */
6060
+ refundDisabled?: boolean;
6061
+ /**
6062
+ * Whether receipt generation is allowed for this payment.
6063
+ * + `true`: This payment supports receipt generation.
6064
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6065
+ * @readonly
6066
+ */
6067
+ supportReceiptGeneration?: boolean;
6068
+ /** Details about cash rounding applied to this payment, when relevant. */
6069
+ cashRounding?: CashRoundingDetails;
6070
+ /**
6071
+ * Overall payment status.
6072
+ *
6073
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6074
+ */
6075
+ status?: PaymentStatusWithLiterals;
6076
+ /**
6077
+ * Detailed payment status information including gateway reason codes and status-specific details.
6078
+ * @internal
6079
+ */
6080
+ paymentStatusDetails?: PaymentStatusDetails;
6081
+ /**
6082
+ * Location where the payment was processed.
6083
+ * @internal
6043
6084
  * @format GUID
6085
+ * @immutable
6044
6086
  */
6045
- paymentIds: string[];
6087
+ locationId?: string | null;
6088
+ /**
6089
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6090
+ * @format GUID
6091
+ */
6092
+ chargeCorrelationId?: string | null;
6046
6093
  }
6047
- interface VoidAuthorizedPaymentsResponse {
6048
- /** All order's transactions after the void was triggered */
6049
- orderTransactions?: OrderTransactions;
6094
+ /** @oneof */
6095
+ interface PaymentPaymentDetailsOneOf {
6096
+ /** Regular payment details. */
6097
+ regularPaymentDetails?: RegularPaymentDetails;
6098
+ /** Gift card payment details. */
6099
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6100
+ /** Membership payment details. */
6101
+ membershipPaymentDetails?: MembershipPaymentDetails;
6050
6102
  }
6051
- interface CaptureAuthorizedPaymentsRequest {
6103
+ /** @oneof */
6104
+ interface PaymentReceiptInfoOneOf {
6052
6105
  /**
6053
- * Wix eCommerce order ID
6054
- * @minLength 1
6055
- * @maxLength 100
6106
+ * Receipt created by Wix
6107
+ * @internal
6056
6108
  */
6057
- ecomOrderId: string;
6109
+ wixReceipt?: WixReceiptInfo;
6110
+ /**
6111
+ * Receipt created by an external system.
6112
+ * @internal
6113
+ */
6114
+ externalReceipt?: ExternalReceiptInfo;
6115
+ }
6116
+ /** @oneof */
6117
+ interface PaymentStatusDetailsOneOf {
6118
+ /** @internal */
6119
+ canceled?: CanceledStatusDetails;
6120
+ /** @internal */
6121
+ declined?: DeclinedStatusDetails;
6122
+ /** @internal */
6123
+ voided?: VoidedStatusDetails;
6124
+ }
6125
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6126
+ /** Credit card details. */
6127
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6058
6128
  /**
6059
- * Capture payments information
6060
- * @minSize 1
6061
- * @maxSize 100
6129
+ * Wix Payments order ID.
6130
+ * @maxLength 100
6062
6131
  */
6063
- payments: PaymentCapture[];
6064
- }
6065
- interface PaymentCapture {
6132
+ paymentOrderId?: string | null;
6066
6133
  /**
6067
- * Payment ID
6068
- * @format GUID
6134
+ * Payment gateway's transaction ID.
6135
+ * This field is only returned when the value of `offline_payment` is `false`.
6136
+ * @maxLength 100
6069
6137
  */
6070
- paymentId?: string | null;
6138
+ gatewayTransactionId?: string | null;
6071
6139
  /**
6072
- * Capture amount.
6073
- * If not provided - full authorized amount will be captured.
6140
+ * Payment method.
6141
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6142
+ * Non-exhaustive list of supported values:
6143
+ * + `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`
6144
+ * @maxLength 150
6145
+ * @deprecated Payment method.
6146
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6147
+ * Non-exhaustive list of supported values:
6148
+ * + `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`
6149
+ * @replacedBy payment_method_name
6150
+ * @targetRemovalDate 2026-07-01
6074
6151
  */
6075
- amount?: Price;
6076
- }
6077
- interface CaptureAuthorizedPaymentsResponse {
6078
- /** All order's transactions after the capture was triggered */
6079
- orderTransactions?: OrderTransactions;
6080
- }
6081
- interface ChargeSavedPaymentMethodRequest {
6152
+ paymentMethod?: string | null;
6082
6153
  /**
6083
- * Ecom Order ID.
6084
- * @minLength 1
6154
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6085
6155
  * @maxLength 100
6086
6156
  */
6087
- ecomOrderId?: string;
6088
- /** Amount to be charged */
6089
- amount?: Price;
6090
- }
6091
- interface ChargeSavedPaymentMethodResponse {
6092
- /** Payment gateway's order ID (e.g Wix Payments) */
6093
- paymentGatewayOrderId?: string;
6094
- }
6095
- interface SendBuyerConfirmationEmailRequest {
6096
- /** @format GUID */
6097
- orderId?: string;
6098
- }
6099
- interface SendBuyerConfirmationEmailResponse {
6100
- }
6101
- interface SendBuyerPaymentsReceivedEmailRequest {
6157
+ providerTransactionId?: string | null;
6158
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6159
+ offlinePayment?: boolean;
6102
6160
  /**
6103
- * @minLength 1
6104
- * @maxLength 100
6161
+ * Payment status.
6162
+ * @deprecated Payment status.
6163
+ * @replacedBy payment.status
6164
+ * @targetRemovalDate 2026-11-01
6105
6165
  */
6106
- orderId?: string;
6107
- }
6108
- interface SendBuyerPaymentsReceivedEmailResponse {
6109
- }
6110
- interface SendBuyerPickupConfirmationEmailRequest {
6166
+ status?: TransactionStatusWithLiterals;
6167
+ /** Whether there is a payment agreement that allows for future charges. */
6168
+ savedPaymentMethod?: boolean;
6169
+ /** Authorization details. */
6170
+ authorizationDetails?: AuthorizationDetails;
6111
6171
  /**
6112
- * @minLength 1
6113
- * @maxLength 100
6172
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6173
+ * @internal
6174
+ * @maxLength 300
6114
6175
  */
6115
- orderId?: string;
6116
- }
6117
- interface SendBuyerPickupConfirmationEmailResponse {
6118
- }
6119
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6176
+ paymentProvider?: string | null;
6120
6177
  /**
6121
- * IDs of orders to send pickup emails for.
6122
- * @minSize 1
6123
- * @maxSize 300
6178
+ * Record of chargebacks made by the buyer.
6179
+ * @maxSize 6
6124
6180
  */
6125
- orderIds?: string[];
6126
- }
6127
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6128
- }
6129
- interface SendBuyerShippingConfirmationEmailRequest {
6181
+ chargebacks?: Chargeback[];
6130
6182
  /**
6131
- * @minLength 1
6132
- * @maxLength 100
6183
+ * Payment method ID.
6184
+ * @internal
6185
+ * @maxLength 36
6133
6186
  */
6134
- orderId?: string;
6135
- }
6136
- interface SendBuyerShippingConfirmationEmailResponse {
6137
- }
6138
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6187
+ paymentMethodId?: string | null;
6188
+ /** Platform fee amount associated with this payment. */
6189
+ platformFee?: Price;
6139
6190
  /**
6140
- * IDs of orders to send pickup emails for.
6141
- * @minSize 1
6142
- * @maxSize 300
6191
+ * Payment method with buyer and optional owner translations.
6192
+ * Non-exhaustive list of supported values:
6193
+ * + `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`
6143
6194
  */
6144
- orderIds?: string[];
6195
+ paymentMethodName?: PaymentMethodName;
6145
6196
  }
6146
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6197
+ /** @oneof */
6198
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6199
+ /** Credit card details. */
6200
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6147
6201
  }
6148
- interface SendMerchantOrderReceivedNotificationRequest {
6202
+ declare enum TransactionStatus {
6203
+ UNDEFINED = "UNDEFINED",
6204
+ APPROVED = "APPROVED",
6205
+ PENDING = "PENDING",
6206
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6207
+ CANCELED = "CANCELED",
6208
+ DECLINED = "DECLINED",
6209
+ REFUNDED = "REFUNDED",
6210
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6211
+ AUTHORIZED = "AUTHORIZED",
6212
+ VOIDED = "VOIDED"
6213
+ }
6214
+ /** @enumType */
6215
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6216
+ interface CreditCardPaymentMethodDetails {
6149
6217
  /**
6150
- * @minLength 1
6151
- * @maxLength 100
6218
+ * The last 4 digits of the card number.
6219
+ * @maxLength 4
6152
6220
  */
6153
- orderId?: string;
6154
- }
6155
- interface SendMerchantOrderReceivedNotificationResponse {
6156
- }
6157
- interface SendCancelRefundEmailRequest {
6221
+ lastFourDigits?: string | null;
6158
6222
  /**
6159
- * The ID of order that is canceled/refunded
6160
- * @minLength 1
6223
+ * Card issuer's brand.
6161
6224
  * @maxLength 100
6162
6225
  */
6163
- orderId?: string;
6226
+ brand?: string | null;
6227
+ }
6228
+ interface AuthorizationDetails {
6164
6229
  /**
6165
- * Personal note added to the email (optional)
6166
- * @minLength 1
6167
- * @maxLength 1000
6230
+ * Whether the authorized payment is of a delayed capture.
6231
+ * @readonly
6168
6232
  */
6169
- customMessage?: string | null;
6170
- /** Refund amount */
6171
- refundAmount?: Price;
6233
+ delayedCapture?: boolean;
6234
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6235
+ authorizedDate?: Date | null;
6172
6236
  /**
6173
- * Refund ID. (Optional)
6174
- * @format GUID
6237
+ * List of captures associated with payment
6238
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6239
+ * @maxSize 1
6175
6240
  */
6176
- refundId?: string | null;
6177
- }
6178
- interface SendCancelRefundEmailResponse {
6241
+ captures?: AuthorizationCapture[];
6242
+ /** Void associated with payment */
6243
+ void?: AuthorizationVoid;
6244
+ /** Scheduled action for this transaction */
6245
+ scheduledAction?: V1ScheduledAction;
6179
6246
  }
6180
- interface SendRefundEmailRequest {
6181
- /**
6182
- * The ID of order that is refunded
6183
- * @format GUID
6184
- */
6185
- orderId?: string;
6247
+ interface AuthorizationCapture {
6186
6248
  /**
6187
- * Refund ID
6249
+ * Capture ID.
6188
6250
  * @format GUID
6251
+ * @readonly
6189
6252
  */
6190
- refundId?: string;
6253
+ id?: string | null;
6254
+ /** Status of this capture action */
6255
+ status?: AuthorizationCaptureStatusWithLiterals;
6191
6256
  /**
6192
- * Personal note added to the email (optional)
6193
- * @minLength 1
6194
- * @maxLength 1000
6257
+ * Amount of this capture
6258
+ * @immutable
6195
6259
  */
6196
- customMessage?: string | null;
6260
+ amount?: Price;
6261
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6262
+ createdDate?: Date | null;
6263
+ /** In case of status is FAILED may contain failure details */
6264
+ failureDetails?: AuthorizationActionFailureDetails;
6197
6265
  }
6198
- interface SendRefundEmailResponse {
6266
+ declare enum AuthorizationCaptureStatus {
6267
+ /** Capture operation still in progress. */
6268
+ PENDING = "PENDING",
6269
+ /** Capture operation succeeded. */
6270
+ SUCCEEDED = "SUCCEEDED",
6271
+ /** Capture operation failed. */
6272
+ FAILED = "FAILED"
6199
6273
  }
6200
- interface SendFulfillmentEmailRequest {
6201
- /** @format GUID */
6202
- orderId?: string;
6203
- /** @format GUID */
6204
- fulfillerId?: string;
6274
+ /** @enumType */
6275
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6276
+ interface AuthorizationActionFailureDetails {
6277
+ /** @maxLength 100 */
6278
+ failureCode?: string;
6205
6279
  }
6206
- interface SendFulfillmentEmailResponse {
6280
+ interface AuthorizationVoid {
6281
+ /** Status of this void action */
6282
+ status?: AuthorizationVoidStatusWithLiterals;
6283
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6284
+ voidedDate?: Date | null;
6285
+ /** In case of status is FAILED may contain failure details */
6286
+ failureDetails?: AuthorizationActionFailureDetails;
6287
+ /** Reason of void action */
6288
+ reason?: ReasonWithLiterals;
6207
6289
  }
6208
- interface SendMerchantOrderReceivedPushRequest {
6209
- /**
6210
- * @minLength 1
6211
- * @maxLength 100
6212
- */
6213
- orderId?: string;
6290
+ declare enum AuthorizationVoidStatus {
6291
+ /** Void operation still in progress. */
6292
+ PENDING = "PENDING",
6293
+ /** Void operation succeeded. */
6294
+ SUCCEEDED = "SUCCEEDED",
6295
+ /** Void operation failed. */
6296
+ FAILED = "FAILED"
6214
6297
  }
6215
- interface SendMerchantOrderReceivedPushResponse {
6298
+ /** @enumType */
6299
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6300
+ /** Reason the authorization was voided. */
6301
+ declare enum Reason {
6302
+ /** Authorization was voided by user. */
6303
+ MANUAL = "MANUAL",
6304
+ /** Authorization passed execution date. */
6305
+ SCHEDULED = "SCHEDULED"
6216
6306
  }
6217
- interface PreviewEmailByTypeRequest {
6218
- emailType?: PreviewEmailTypeWithLiterals;
6307
+ /** @enumType */
6308
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6309
+ interface V1ScheduledAction {
6310
+ /** Type of the action. */
6311
+ actionType?: ActionTypeWithLiterals;
6312
+ /** The date and time of the action. */
6313
+ executionDate?: Date | null;
6219
6314
  }
6220
- declare enum PreviewEmailType {
6221
- ORDER_PLACED = "ORDER_PLACED",
6222
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6223
- ORDER_SHIPPED = "ORDER_SHIPPED",
6224
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6315
+ declare enum ActionType {
6316
+ VOID = "VOID",
6317
+ CAPTURE = "CAPTURE"
6225
6318
  }
6226
6319
  /** @enumType */
6227
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6228
- interface PreviewEmailByTypeResponse {
6229
- emailPreview?: string;
6230
- }
6231
- interface PreviewRefundEmailRequest {
6232
- /**
6233
- * @minLength 1
6234
- * @maxLength 100
6235
- */
6236
- orderId?: string;
6237
- /** Refund amount */
6238
- refundAmount?: Price;
6239
- /** Refund business details */
6240
- details?: RefundDetails;
6320
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6321
+ interface Chargeback {
6241
6322
  /**
6242
- * Personal note added to the email (optional)
6243
- * @minLength 1
6244
- * @maxLength 1000
6323
+ * Chargeback ID.
6324
+ * @format GUID
6325
+ * @readonly
6326
+ * @immutable
6245
6327
  */
6246
- customMessage?: string | null;
6328
+ id?: string;
6247
6329
  /**
6248
- * Refund ID. (Optional)
6249
- * @format GUID
6330
+ * 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.
6331
+ * @readonly
6332
+ * @immutable
6250
6333
  */
6251
- refundId?: string | null;
6252
- }
6253
- interface PreviewRefundEmailResponse {
6254
- emailPreview?: string;
6255
- }
6256
- interface PreviewCancelEmailRequest {
6334
+ createdDate?: Date | null;
6257
6335
  /**
6258
- * @minLength 1
6259
- * @maxLength 100
6336
+ * 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.
6337
+ * @readonly
6260
6338
  */
6261
- orderId?: string;
6339
+ updatedDate?: Date | null;
6262
6340
  /**
6263
- * Personal note added to the email (optional)
6264
- * @minLength 1
6265
- * @maxLength 1000
6341
+ * Amount.
6342
+ * @readonly
6343
+ * @immutable
6266
6344
  */
6267
- customMessage?: string | null;
6268
- }
6269
- interface PreviewCancelEmailResponse {
6270
- emailPreview?: string;
6271
- }
6272
- interface PreviewCancelRefundEmailRequest {
6345
+ amount?: Price;
6273
6346
  /**
6274
- * @minLength 1
6275
- * @maxLength 100
6347
+ * Reversal amount. Present only when status is REVERSED.
6348
+ * @readonly
6276
6349
  */
6277
- orderId?: string;
6350
+ reversalAmount?: Price;
6278
6351
  /**
6279
- * Personal note added to the email (optional)
6280
- * @minLength 1
6281
- * @maxLength 1000
6352
+ * Status.
6353
+ *
6354
+ * Default: `"APPROVED"`.
6282
6355
  */
6283
- customMessage?: string | null;
6284
- /** Refund amount */
6285
- refundAmount?: Price;
6356
+ status?: ChargebackStatusWithLiterals;
6286
6357
  /**
6287
- * Refund ID. (Optional)
6358
+ * External chargeback ID.
6288
6359
  * @format GUID
6360
+ * @readonly
6361
+ * @immutable
6289
6362
  */
6290
- refundId?: string | null;
6291
- }
6292
- interface PreviewCancelRefundEmailResponse {
6293
- emailPreview?: string;
6294
- }
6295
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6296
- }
6297
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6298
- emailPreview?: string;
6299
- }
6300
- interface PreviewBuyerConfirmationEmailRequest {
6301
- }
6302
- interface PreviewBuyerConfirmationEmailResponse {
6303
- emailPreview?: string;
6304
- }
6305
- interface PreviewBuyerPickupConfirmationEmailRequest {
6306
- }
6307
- interface PreviewBuyerPickupConfirmationEmailResponse {
6308
- emailPreview?: string;
6309
- }
6310
- interface PreviewShippingConfirmationEmailRequest {
6311
- }
6312
- interface PreviewShippingConfirmationEmailResponse {
6313
- emailPreview?: string;
6314
- }
6315
- interface PreviewResendDownloadLinksEmailRequest {
6363
+ externalId?: string | null;
6316
6364
  }
6317
- interface PreviewResendDownloadLinksEmailResponse {
6318
- emailPreview?: string;
6365
+ declare enum ChargebackStatus {
6366
+ /** Chargeback was approved. */
6367
+ APPROVED = "APPROVED",
6368
+ /** Chargeback was reversed. */
6369
+ REVERSED = "REVERSED"
6319
6370
  }
6320
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6321
- /** Emitted on a meta site creation. */
6322
- siteCreated?: SiteCreated;
6323
- /** Emitted on a meta site transfer completion. */
6324
- siteTransferred?: SiteTransferred;
6325
- /** Emitted on a meta site deletion. */
6326
- siteDeleted?: SiteDeleted;
6327
- /** Emitted on a meta site restoration. */
6328
- siteUndeleted?: SiteUndeleted;
6329
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6330
- sitePublished?: SitePublished;
6331
- /** Emitted on a meta site unpublish. */
6332
- siteUnpublished?: SiteUnpublished;
6333
- /** Emitted when meta site is marked as template. */
6334
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6335
- /** Emitted when meta site is marked as a WixSite. */
6336
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6337
- /** Emitted when an application is provisioned (installed). */
6338
- serviceProvisioned?: ServiceProvisioned;
6339
- /** Emitted when an application is removed (uninstalled). */
6340
- serviceRemoved?: ServiceRemoved;
6341
- /** Emitted when meta site name (URL slug) is changed. */
6342
- siteRenamedPayload?: SiteRenamed;
6343
- /** Emitted when meta site was permanently deleted. */
6344
- hardDeleted?: SiteHardDeleted;
6345
- /** Emitted on a namespace change. */
6346
- namespaceChanged?: NamespaceChanged;
6347
- /** Emitted when Studio is attached. */
6348
- studioAssigned?: StudioAssigned;
6349
- /** Emitted when Studio is detached. */
6350
- studioUnassigned?: StudioUnassigned;
6371
+ /** @enumType */
6372
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6373
+ interface PaymentMethodName {
6351
6374
  /**
6352
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6353
- * the actual URL.
6354
- *
6355
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6356
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6375
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6376
+ * @maxLength 150
6357
6377
  */
6358
- urlChanged?: SiteUrlChanged;
6359
- /** Site is marked as PurgedExternally */
6360
- sitePurgedExternally?: SitePurgedExternally;
6361
- /** Emitted when Odeditor is attached. */
6362
- odeditorAssigned?: OdeditorAssigned;
6363
- /** Emitted when Odeditor is detached. */
6364
- odeditorUnassigned?: OdeditorUnassigned;
6365
- /** Emitted when Picasso is attached. */
6366
- picassoAssigned?: PicassoAssigned;
6367
- /** Emitted when Picasso is detached. */
6368
- picassoUnassigned?: PicassoUnassigned;
6369
- /** Emitted when Wixel is attached. */
6370
- wixelAssigned?: WixelAssigned;
6371
- /** Emitted when Wixel is detached. */
6372
- wixelUnassigned?: WixelUnassigned;
6373
- /** Emitted when StudioTwo is attached. */
6374
- studioTwoAssigned?: StudioTwoAssigned;
6375
- /** Emitted when StudioTwo is detached. */
6376
- studioTwoUnassigned?: StudioTwoUnassigned;
6377
- /** Emitted when media from user domain is enabled. */
6378
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6379
- /** Emitted when media from user domain is disabled. */
6380
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6381
- /** Emitted when Editorless is attached. */
6382
- editorlessAssigned?: EditorlessAssigned;
6383
- /** Emitted when Editorless is detached. */
6384
- editorlessUnassigned?: EditorlessUnassigned;
6378
+ buyerLanguageName?: string | null;
6385
6379
  /**
6386
- * A meta site id.
6387
- * @format GUID
6380
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6381
+ *
6382
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6383
+ * @maxLength 150
6388
6384
  */
6389
- metaSiteId?: string;
6390
- /** A meta site version. Monotonically increasing. */
6391
- version?: string;
6392
- /** A timestamp of the event. */
6393
- timestamp?: string;
6385
+ siteLanguageName?: string | null;
6394
6386
  /**
6395
- * TODO(meta-site): Change validation once validations are disabled for consumers
6396
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6397
- * @maxSize 4000
6387
+ * User-provided payment method name.
6388
+ *
6389
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6398
6390
  */
6399
- assets?: Asset[];
6391
+ userDefinedName?: UserDefinedPaymentMethodName;
6400
6392
  }
6401
- /** @oneof */
6402
- interface MetaSiteSpecialEventPayloadOneOf {
6403
- /** Emitted on a meta site creation. */
6404
- siteCreated?: SiteCreated;
6405
- /** Emitted on a meta site transfer completion. */
6406
- siteTransferred?: SiteTransferred;
6407
- /** Emitted on a meta site deletion. */
6408
- siteDeleted?: SiteDeleted;
6409
- /** Emitted on a meta site restoration. */
6410
- siteUndeleted?: SiteUndeleted;
6411
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6412
- sitePublished?: SitePublished;
6413
- /** Emitted on a meta site unpublish. */
6414
- siteUnpublished?: SiteUnpublished;
6415
- /** Emitted when meta site is marked as template. */
6416
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6417
- /** Emitted when meta site is marked as a WixSite. */
6418
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6419
- /** Emitted when an application is provisioned (installed). */
6420
- serviceProvisioned?: ServiceProvisioned;
6421
- /** Emitted when an application is removed (uninstalled). */
6422
- serviceRemoved?: ServiceRemoved;
6423
- /** Emitted when meta site name (URL slug) is changed. */
6424
- siteRenamedPayload?: SiteRenamed;
6425
- /** Emitted when meta site was permanently deleted. */
6426
- hardDeleted?: SiteHardDeleted;
6427
- /** Emitted on a namespace change. */
6428
- namespaceChanged?: NamespaceChanged;
6429
- /** Emitted when Studio is attached. */
6430
- studioAssigned?: StudioAssigned;
6431
- /** Emitted when Studio is detached. */
6432
- studioUnassigned?: StudioUnassigned;
6393
+ interface GiftCardPaymentDetails {
6394
+ /**
6395
+ * Gift card payment ID.
6396
+ * @maxLength 100
6397
+ */
6398
+ giftCardPaymentId?: string;
6399
+ /**
6400
+ * Gift card ID.
6401
+ * @internal
6402
+ * @deprecated
6403
+ */
6404
+ giftCardId?: string;
6433
6405
  /**
6434
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6435
- * the actual URL.
6436
- *
6437
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6438
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6406
+ * ID of the app that created the gift card.
6407
+ * @format GUID
6439
6408
  */
6440
- urlChanged?: SiteUrlChanged;
6441
- /** Site is marked as PurgedExternally */
6442
- sitePurgedExternally?: SitePurgedExternally;
6443
- /** Emitted when Odeditor is attached. */
6444
- odeditorAssigned?: OdeditorAssigned;
6445
- /** Emitted when Odeditor is detached. */
6446
- odeditorUnassigned?: OdeditorUnassigned;
6447
- /** Emitted when Picasso is attached. */
6448
- picassoAssigned?: PicassoAssigned;
6449
- /** Emitted when Picasso is detached. */
6450
- picassoUnassigned?: PicassoUnassigned;
6451
- /** Emitted when Wixel is attached. */
6452
- wixelAssigned?: WixelAssigned;
6453
- /** Emitted when Wixel is detached. */
6454
- wixelUnassigned?: WixelUnassigned;
6455
- /** Emitted when StudioTwo is attached. */
6456
- studioTwoAssigned?: StudioTwoAssigned;
6457
- /** Emitted when StudioTwo is detached. */
6458
- studioTwoUnassigned?: StudioTwoUnassigned;
6459
- /** Emitted when media from user domain is enabled. */
6460
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6461
- /** Emitted when media from user domain is disabled. */
6462
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6463
- /** Emitted when Editorless is attached. */
6464
- editorlessAssigned?: EditorlessAssigned;
6465
- /** Emitted when Editorless is detached. */
6466
- editorlessUnassigned?: EditorlessUnassigned;
6467
- }
6468
- interface Asset {
6409
+ appId?: string;
6469
6410
  /**
6470
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6471
- * @maxLength 36
6411
+ * Whether the gift card is voided.
6412
+ * @readonly
6413
+ * @deprecated Whether the gift card is voided.
6414
+ * @replacedBy payment.status
6415
+ * @targetRemovalDate 2026-11-01
6472
6416
  */
6473
- appDefId?: string;
6417
+ voided?: boolean;
6474
6418
  /**
6475
- * An instance id. For legacy reasons may be UUID or a string.
6419
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6420
+ * @maxLength 30
6421
+ * @immutable
6422
+ */
6423
+ obfuscatedCode?: string | null;
6424
+ }
6425
+ interface MembershipPaymentDetails {
6426
+ /**
6427
+ * Membership ID.
6476
6428
  * @maxLength 200
6477
6429
  */
6478
- instanceId?: string;
6479
- /** An application state. */
6480
- state?: StateWithLiterals;
6430
+ membershipId?: string;
6431
+ /**
6432
+ * ID of the line item this membership applies to.
6433
+ * @minLength 1
6434
+ * @maxLength 100
6435
+ */
6436
+ lineItemId?: string;
6437
+ /**
6438
+ * Payment status.
6439
+ * @deprecated Payment status.
6440
+ * @replacedBy payment.status
6441
+ * @targetRemovalDate 2026-11-01
6442
+ */
6443
+ status?: MembershipPaymentStatusWithLiterals;
6444
+ /** Membership name. */
6445
+ name?: MembershipName;
6446
+ /**
6447
+ * The transaction ID in the membership system. Can be used to void the transaction.
6448
+ * @minLength 1
6449
+ * @maxLength 100
6450
+ */
6451
+ externalTransactionId?: string | null;
6452
+ /**
6453
+ * Whether the membership is voided.
6454
+ * @readonly
6455
+ * @deprecated Whether the membership is voided.
6456
+ * @replacedBy payment.status
6457
+ * @targetRemovalDate 2026-11-01
6458
+ */
6459
+ voided?: boolean;
6460
+ /**
6461
+ * ID of the application providing this payment option.
6462
+ * @format GUID
6463
+ */
6464
+ providerAppId?: string;
6465
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6466
+ futureMembership?: FutureMembershipDetails;
6481
6467
  }
6482
- declare enum State {
6483
- UNKNOWN = "UNKNOWN",
6484
- ENABLED = "ENABLED",
6485
- DISABLED = "DISABLED",
6486
- PENDING = "PENDING",
6487
- DEMO = "DEMO"
6468
+ declare enum MembershipPaymentStatus {
6469
+ /** Payment was charged. */
6470
+ CHARGED = "CHARGED",
6471
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6472
+ CHARGE_FAILED = "CHARGE_FAILED",
6473
+ /** Payment is pending. */
6474
+ CHARGE_PENDING = "CHARGE_PENDING",
6475
+ /** Payment was voided. */
6476
+ VOIDED = "VOIDED"
6488
6477
  }
6489
6478
  /** @enumType */
6490
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6491
- interface SiteCreated {
6479
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6480
+ interface FutureMembershipDetails {
6492
6481
  /**
6493
- * A template identifier (empty if not created from a template).
6494
- * @maxLength 36
6482
+ * ID of the plan line item in the order from which the membership will be created.
6483
+ * @format GUID
6495
6484
  */
6496
- originTemplateId?: string;
6485
+ lineItemId?: string;
6497
6486
  /**
6498
- * An account id of the owner.
6499
- * @format GUID
6487
+ * ID of the benefit the future membership will grant.
6488
+ * @maxLength 200
6500
6489
  */
6501
- ownerId?: string;
6502
- /** A context in which meta site was created. */
6503
- context?: SiteCreatedContextWithLiterals;
6490
+ benefitId?: string;
6491
+ }
6492
+ interface WixReceiptInfo {
6504
6493
  /**
6505
- * A meta site id from which this site was created.
6506
- *
6507
- * In case of a creation from a template it's a template id.
6508
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6494
+ * Receipt ID
6509
6495
  * @format GUID
6510
6496
  */
6511
- originMetaSiteId?: string | null;
6497
+ receiptId?: string;
6512
6498
  /**
6513
- * A meta site name (URL slug).
6514
- * @maxLength 20
6499
+ * Display number of receipt
6500
+ * @minLength 1
6501
+ * @maxLength 40
6515
6502
  */
6516
- siteName?: string;
6517
- /** A namespace. */
6518
- namespace?: NamespaceWithLiterals;
6519
- }
6520
- declare enum SiteCreatedContext {
6521
- /** A valid option, we don't expose all reasons why site might be created. */
6522
- OTHER = "OTHER",
6523
- /** A meta site was created from template. */
6524
- FROM_TEMPLATE = "FROM_TEMPLATE",
6525
- /** A meta site was created by copying of the transfferred meta site. */
6526
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6527
- /** A copy of existing meta site. */
6528
- DUPLICATE = "DUPLICATE",
6529
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6530
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6531
- /** deprecated A meta site was created for Flash editor. */
6532
- FLASH = "FLASH"
6503
+ displayNumber?: string | null;
6533
6504
  }
6534
- /** @enumType */
6535
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6536
- declare enum Namespace {
6537
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6538
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6539
- WIX = "WIX",
6540
- /** 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. */
6541
- SHOUT_OUT = "SHOUT_OUT",
6542
- /** 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. */
6543
- ALBUMS = "ALBUMS",
6544
- /** 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. */
6545
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6546
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6547
- HOTELS = "HOTELS",
6548
- /** 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. */
6549
- CLUBS = "CLUBS",
6550
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6551
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6505
+ interface ExternalReceiptInfo {
6552
6506
  /**
6553
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6554
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6507
+ * External receipt ID
6508
+ * @maxLength 100
6555
6509
  */
6556
- DEV_SITE = "DEV_SITE",
6557
- /** 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. */
6558
- LOGOS = "LOGOS",
6559
- /** 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. */
6560
- VIDEO_MAKER = "VIDEO_MAKER",
6561
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6562
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6563
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6564
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6510
+ receiptId?: string | null;
6565
6511
  /**
6566
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6567
- *
6568
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6512
+ * ID of the app providing the receipt
6513
+ * @format GUID
6569
6514
  */
6570
- HTML_DRAFT = "HTML_DRAFT",
6515
+ appId?: string | null;
6571
6516
  /**
6572
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6573
- * Will be accessible from Site List and will not have a website app.
6574
- * Once the user attaches a site, the site will become a regular wixsite.
6517
+ * Display number of receipt
6518
+ * @minLength 1
6519
+ * @maxLength 40
6575
6520
  */
6576
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6577
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6578
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6579
- /** It is to be used in the Business First efforts. */
6580
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6581
- /** Bookings business flow with no site. */
6582
- ANYWHERE = "ANYWHERE",
6583
- /** Namespace for Headless Backoffice with no editor */
6584
- HEADLESS = "HEADLESS",
6521
+ displayNumber?: string | null;
6522
+ }
6523
+ interface CashRoundingDetails {
6585
6524
  /**
6586
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6587
- * The site will be used for account level CSM feature for enterprise
6525
+ * Payment amount before cash rounding was applied.
6526
+ * When provided, balance and status calculations use this value instead of `amount`
6527
+ * to prevent false overpayment or underpayment due to rounding.
6588
6528
  */
6589
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6590
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6591
- RISE = "RISE",
6529
+ unroundedAmount?: Price;
6530
+ /**
6531
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6532
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6533
+ * @readonly
6534
+ */
6535
+ roundingAdjustment?: CashRounding;
6536
+ }
6537
+ declare enum PaymentStatus {
6538
+ /** Payment was charged successfully. */
6539
+ APPROVED = "APPROVED",
6540
+ /** Payment is being processed and hasn't been confirmed yet. */
6541
+ PENDING = "PENDING",
6542
+ /** 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. */
6543
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6544
+ /** Payment was canceled before it was charged. */
6545
+ CANCELED = "CANCELED",
6546
+ /** Payment was declined by the payment provider. */
6547
+ DECLINED = "DECLINED",
6548
+ /** Payment was fully refunded. */
6549
+ REFUNDED = "REFUNDED",
6550
+ /** Part of the payment amount was refunded. */
6551
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6552
+ /** 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. */
6553
+ AUTHORIZED = "AUTHORIZED",
6592
6554
  /**
6593
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6594
- * There's a blank site behind the scene but it's blank).
6595
- * The Mobile company will be the owner of this namespace.
6555
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6556
+ *
6557
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6596
6558
  */
6597
- BRANDED_FIRST = "BRANDED_FIRST",
6598
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6599
- NOWNIA = "NOWNIA",
6559
+ VOIDED = "VOIDED"
6560
+ }
6561
+ /** @enumType */
6562
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6563
+ interface CanceledStatusDetails {
6564
+ reason?: CanceledReasonWithLiterals;
6565
+ }
6566
+ declare enum CanceledReason {
6567
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6568
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6569
+ /** Payment was not completed by user and expired. */
6570
+ EXPIRED = "EXPIRED"
6571
+ }
6572
+ /** @enumType */
6573
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6574
+ interface DeclinedStatusDetails {
6575
+ reason?: DeclinedReasonWithLiterals;
6576
+ }
6577
+ declare enum DeclinedReason {
6578
+ /** Corresponding charge failed. */
6579
+ CHARGE_FAILED = "CHARGE_FAILED",
6580
+ /** Payment details expired. */
6581
+ EXPIRED = "EXPIRED",
6582
+ /** Insufficient funds. */
6583
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6584
+ /** Gift card was disabled before charge was attempted. */
6585
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6586
+ }
6587
+ /** @enumType */
6588
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6589
+ interface VoidedStatusDetails {
6590
+ reason?: VoidedReasonWithLiterals;
6591
+ }
6592
+ declare enum VoidedReason {
6593
+ /** Payment was voided by merchant request. */
6594
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6595
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6596
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6597
+ }
6598
+ /** @enumType */
6599
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6600
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6601
+ /** @internal */
6602
+ canceled?: CanceledStatusDetails;
6603
+ /** @internal */
6604
+ declined?: DeclinedStatusDetails;
6605
+ /** @internal */
6606
+ voided?: VoidedStatusDetails;
6600
6607
  /**
6601
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6602
- * The Partners company owns this namespace.
6608
+ * Reason code from the payment gateway.
6609
+ * @internal
6610
+ * @minLength 1
6611
+ * @maxLength 10
6603
6612
  */
6604
- UGC_TEMPLATE = "UGC_TEMPLATE",
6605
- /** Codux Headless Sites */
6606
- CODUX = "CODUX",
6607
- /** Bobb - AI Design Creator. */
6608
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6613
+ paymentGatewayReasonCode?: string | null;
6614
+ }
6615
+ /** @oneof */
6616
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6617
+ /** @internal */
6618
+ canceled?: CanceledStatusDetails;
6619
+ /** @internal */
6620
+ declined?: DeclinedStatusDetails;
6621
+ /** @internal */
6622
+ voided?: VoidedStatusDetails;
6623
+ }
6624
+ interface Refund {
6609
6625
  /**
6610
- * Shared Blog Site is a unique single site across Enterprise account,
6611
- * This site will hold all Blog posts related to the Marketing product.
6626
+ * Refund ID.
6627
+ * @format GUID
6628
+ * @readonly
6612
6629
  */
6613
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6614
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6615
- STANDALONE_FORMS = "STANDALONE_FORMS",
6616
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6617
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6618
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6619
- MIMIR = "MIMIR",
6620
- /** Wix Twins platform. */
6621
- TWINS = "TWINS",
6622
- /** Wix Nano. */
6623
- NANO = "NANO",
6624
- /** Base44 headless sites. */
6625
- BASE44 = "BASE44",
6626
- /** Wix Channels Sites */
6627
- CHANNELS = "CHANNELS",
6628
- /** Nautilus platform. */
6629
- NAUTILUS = "NAUTILUS",
6630
+ id?: string;
6630
6631
  /**
6631
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6632
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6632
+ * List of transactions.
6633
+ * @maxSize 50
6633
6634
  */
6634
- SYMPHONY = "SYMPHONY",
6635
- /** Nautilus platform app. */
6636
- NAUTILUS_APPS = "NAUTILUS_APPS",
6635
+ transactions?: RefundTransaction[];
6636
+ /** Refund business details. */
6637
+ details?: RefundDetails;
6637
6638
  /**
6638
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6639
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6639
+ * 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.
6640
+ * @readonly
6641
+ * @immutable
6640
6642
  */
6641
- VIBU = "VIBU",
6643
+ createdDate?: Date | null;
6642
6644
  /**
6643
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6644
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6645
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6646
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6645
+ * Aggregated refund summary.
6646
+ * @readonly
6647
6647
  */
6648
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6648
+ summary?: AggregatedRefundSummary;
6649
6649
  /**
6650
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6651
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6650
+ * ID of the app that initiated this refund.
6651
+ * @format GUID
6652
+ * @readonly
6653
+ * @immutable
6652
6654
  */
6653
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6655
+ requestingServiceAppId?: string | null;
6654
6656
  }
6655
- /** @enumType */
6656
- 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';
6657
- /** Site transferred to another user. */
6658
- interface SiteTransferred {
6657
+ interface RefundTransaction {
6659
6658
  /**
6660
- * A previous owner id (user that transfers meta site).
6659
+ * ID of the payment associated with this refund.
6661
6660
  * @format GUID
6661
+ * @immutable
6662
6662
  */
6663
- oldOwnerId?: string;
6663
+ paymentId?: string;
6664
6664
  /**
6665
- * A new owner id (user that accepts meta site).
6665
+ * Refund amount.
6666
+ * @immutable
6667
+ */
6668
+ amount?: Price;
6669
+ /** Refund status. */
6670
+ refundStatus?: RefundStatusWithLiterals;
6671
+ /** Optional details of current refund status. */
6672
+ refundStatusInfo?: RefundStatusInfo;
6673
+ /**
6674
+ * Payment gateway's refund ID.
6675
+ * This field is only returned when the value of `external_refund` is `false`.
6666
6676
  * @format GUID
6667
6677
  */
6668
- newOwnerId?: string;
6669
- }
6670
- /** Soft deletion of the meta site. Could be restored. */
6671
- interface SiteDeleted {
6672
- /** A deletion context. */
6673
- deleteContext?: DeleteContext;
6674
- }
6675
- interface DeleteContext {
6676
- /** When the meta site was deleted. */
6677
- dateDeleted?: Date | null;
6678
- /** A status. */
6679
- deleteStatus?: DeleteStatusWithLiterals;
6678
+ gatewayRefundId?: string | null;
6679
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6680
+ providerRefundId?: string | null;
6680
6681
  /**
6681
- * A reason (flow).
6682
- * @maxLength 255
6682
+ * Whether refund was made externally and manually on the payment provider's side.
6683
+ * @immutable
6683
6684
  */
6684
- deleteOrigin?: string;
6685
+ externalRefund?: boolean;
6685
6686
  /**
6686
- * A service that deleted it.
6687
- * @maxLength 255
6687
+ * Location where the refund was processed.
6688
+ * @internal
6689
+ * @format GUID
6690
+ * @immutable
6688
6691
  */
6689
- initiatorId?: string | null;
6692
+ locationId?: string | null;
6690
6693
  }
6691
- declare enum DeleteStatus {
6692
- UNKNOWN = "UNKNOWN",
6693
- TRASH = "TRASH",
6694
- DELETED = "DELETED",
6695
- PENDING_PURGE = "PENDING_PURGE",
6696
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6694
+ /** Refund transaction status. */
6695
+ declare enum RefundStatus {
6696
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6697
+ PENDING = "PENDING",
6698
+ /** Refund transaction succeeded. */
6699
+ SUCCEEDED = "SUCCEEDED",
6700
+ /** Refund transaction failed. */
6701
+ FAILED = "FAILED",
6702
+ /** Refund request acknowledged, and will be executed soon. */
6703
+ SCHEDULED = "SCHEDULED",
6704
+ /** Refund was initiated on payment provider side. */
6705
+ STARTED = "STARTED"
6697
6706
  }
6698
6707
  /** @enumType */
6699
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6700
- /** Restoration of the meta site. */
6701
- interface SiteUndeleted {
6702
- }
6703
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6704
- interface SitePublished {
6705
- }
6706
- interface SiteUnpublished {
6708
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6709
+ interface RefundStatusInfo {
6707
6710
  /**
6708
- * A list of URLs previously associated with the meta site.
6709
- * @maxLength 4000
6710
- * @maxSize 10000
6711
+ * Reason code for the refund's current status.
6712
+ *
6713
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6714
+ * @minLength 1
6715
+ * @maxLength 10
6711
6716
  */
6712
- urls?: string[];
6713
- }
6714
- interface SiteMarkedAsTemplate {
6715
- }
6716
- interface SiteMarkedAsWixSite {
6717
+ paymentGatewayReasonCode?: string | null;
6718
+ /**
6719
+ * Free text explanation of current refund status.
6720
+ * @minLength 1
6721
+ * @maxLength 1000
6722
+ */
6723
+ description?: string | null;
6717
6724
  }
6718
- /**
6719
- * Represents a service provisioned a site.
6720
- *
6721
- * Note on `origin_instance_id`:
6722
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6723
- * This is because of the following scenario:
6724
- *
6725
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6726
- * such as a product catalog. When you create a site from this template, you inherit this
6727
- * default product catalog. However, if the template's product catalog is modified,
6728
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6729
- * your site remains consistent with what you initially received and does not include any
6730
- * changes made to the original template afterward.
6731
- * To ensure this, the TPA on the template gets a new instance_id.
6732
- */
6733
- interface ServiceProvisioned {
6725
+ interface AggregatedRefundSummary {
6726
+ /** Total amount requested for refund. */
6727
+ requestedRefund?: Price;
6728
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6729
+ pendingRefund?: Price;
6730
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6731
+ refunded?: Price;
6732
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6733
+ failedRefundAmount?: Price;
6734
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6735
+ pending?: boolean;
6736
+ /** Breakdown of refunded items. Available only after refund is complete. */
6737
+ breakdown?: RefundItemsBreakdown;
6738
+ }
6739
+ interface RefundItemsBreakdown {
6734
6740
  /**
6735
- * Either UUID or EmbeddedServiceType.
6736
- * @maxLength 36
6741
+ * Refunded line items and the amount refunded for each.
6742
+ * @maxSize 300
6737
6743
  */
6738
- appDefId?: string;
6744
+ lineItems?: LineItemRefundSummary[];
6745
+ }
6746
+ interface LineItemRefundSummary {
6739
6747
  /**
6740
- * Not only UUID. Something here could be something weird.
6741
- * @maxLength 36
6748
+ * ID of the refunded line item.
6749
+ * @format GUID
6742
6750
  */
6743
- instanceId?: string;
6751
+ lineItemId?: string;
6752
+ /** Total refunded amount for the line item. */
6753
+ totalRefundedAmount?: Price;
6754
+ }
6755
+ interface CalculateRefundRequest {
6744
6756
  /**
6745
- * An instance id from which this instance is originated.
6746
- * @maxLength 36
6757
+ * Order ID
6758
+ * @minLength 1
6759
+ * @maxLength 100
6747
6760
  */
6748
- originInstanceId?: string;
6761
+ ecomOrderId?: string;
6749
6762
  /**
6750
- * A version.
6751
- * @maxLength 500
6763
+ * Refunded line items and quantity
6764
+ * @maxSize 300
6752
6765
  */
6753
- version?: string | null;
6766
+ refundItems?: CalculateRefundItemRequest[];
6767
+ /** Should include shipping in refund calculation */
6768
+ refundShipping?: boolean;
6769
+ }
6770
+ interface CalculateRefundItemRequest {
6754
6771
  /**
6755
- * The origin meta site id
6772
+ * ID of the line item being refunded
6756
6773
  * @format GUID
6757
6774
  */
6758
- originMetaSiteId?: string | null;
6759
- }
6760
- interface ServiceRemoved {
6775
+ id?: string;
6761
6776
  /**
6762
- * Either UUID or EmbeddedServiceType.
6763
- * @maxLength 36
6777
+ * How much of that line item is being refunded
6778
+ * @min 1
6779
+ * @max 100000
6764
6780
  */
6765
- appDefId?: string;
6781
+ quantity?: number;
6782
+ }
6783
+ interface CalculateRefundResponse {
6784
+ /** Total refundable amount */
6785
+ total?: Price;
6786
+ /** Tax cost of the order */
6787
+ tax?: Price;
6788
+ /** Discount given for this order */
6789
+ discount?: Price;
6790
+ /** Total cost of the order (without tax) */
6791
+ subtotal?: Price;
6792
+ /** Total shipping cost for order */
6793
+ shipping?: Price;
6794
+ /** Previous refund given on that order */
6795
+ previouslyRefundedAmount?: Price;
6766
6796
  /**
6767
- * Not only UUID. Something here could be something weird.
6768
- * @maxLength 36
6797
+ * The refundable items of that order
6798
+ * @maxSize 300
6769
6799
  */
6770
- instanceId?: string;
6800
+ items?: CalculateRefundItemResponse[];
6801
+ }
6802
+ interface CalculateRefundItemResponse {
6771
6803
  /**
6772
- * A version.
6773
- * @maxLength 500
6804
+ * Line item ID
6805
+ * @format GUID
6774
6806
  */
6775
- version?: string | null;
6807
+ id?: string;
6808
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6809
+ price?: Price;
6776
6810
  }
6777
- /** Rename of the site. Meaning, free public url has been changed as well. */
6778
- interface SiteRenamed {
6811
+ interface VoidAuthorizedPaymentsRequest {
6779
6812
  /**
6780
- * A new meta site name (URL slug).
6781
- * @maxLength 20
6813
+ * Wix eCommerce order ID
6814
+ * @minLength 1
6815
+ * @maxLength 100
6782
6816
  */
6783
- newSiteName?: string;
6817
+ ecomOrderId: string;
6784
6818
  /**
6785
- * A previous meta site name (URL slug).
6786
- * @maxLength 255
6819
+ * Payment IDs
6820
+ * @minSize 1
6821
+ * @maxSize 100
6822
+ * @format GUID
6787
6823
  */
6788
- oldSiteName?: string;
6789
- }
6790
- /**
6791
- * Hard deletion of the meta site.
6792
- *
6793
- * Could not be restored. Therefore it's desirable to cleanup data.
6794
- */
6795
- interface SiteHardDeleted {
6796
- /** A deletion context. */
6797
- deleteContext?: DeleteContext;
6798
- }
6799
- interface NamespaceChanged {
6800
- /** A previous namespace. */
6801
- oldNamespace?: NamespaceWithLiterals;
6802
- /** A new namespace. */
6803
- newNamespace?: NamespaceWithLiterals;
6804
- }
6805
- /** Assigned Studio editor */
6806
- interface StudioAssigned {
6807
- }
6808
- /** Unassigned Studio editor */
6809
- interface StudioUnassigned {
6824
+ paymentIds: string[];
6810
6825
  }
6811
- /**
6812
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6813
- *
6814
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6815
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6816
- *
6817
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6818
- */
6819
- interface SiteUrlChanged {
6826
+ interface VoidAuthorizedPaymentsResponse {
6827
+ /** All order's transactions after the void was triggered */
6828
+ orderTransactions?: OrderTransactions;
6820
6829
  }
6821
- /**
6822
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6823
- * Consumed by other teams to remove relevant data.
6824
- */
6825
- interface SitePurgedExternally {
6830
+ interface CaptureAuthorizedPaymentsRequest {
6826
6831
  /**
6827
- * @maxLength 2048
6832
+ * Wix eCommerce order ID
6833
+ * @minLength 1
6834
+ * @maxLength 100
6835
+ */
6836
+ ecomOrderId: string;
6837
+ /**
6838
+ * Capture payments information
6839
+ * @minSize 1
6828
6840
  * @maxSize 100
6829
- * @deprecated
6830
- * @targetRemovalDate 2025-04-15
6831
6841
  */
6832
- appDefId?: string[];
6833
- }
6834
- /** Assigned Odeditor */
6835
- interface OdeditorAssigned {
6836
- }
6837
- /** Unassigned Odeditor */
6838
- interface OdeditorUnassigned {
6839
- }
6840
- /** Assigned Picasso editor */
6841
- interface PicassoAssigned {
6842
- }
6843
- /** Unassigned Picasso */
6844
- interface PicassoUnassigned {
6845
- }
6846
- /** Assigned Wixel */
6847
- interface WixelAssigned {
6848
- }
6849
- /** Unassigned Wixel */
6850
- interface WixelUnassigned {
6851
- }
6852
- /** Assigned StudioTwo */
6853
- interface StudioTwoAssigned {
6854
- }
6855
- /** Unassigned StudioTwo */
6856
- interface StudioTwoUnassigned {
6857
- }
6858
- /** Media from user domain is enabled. */
6859
- interface UserDomainMediaEnabled {
6860
- }
6861
- /** Media from user domain is disabled. */
6862
- interface UserDomainMediaDisabled {
6863
- }
6864
- /** Assigned Editorless */
6865
- interface EditorlessAssigned {
6866
- }
6867
- /** Unassigned Editorless */
6868
- interface EditorlessUnassigned {
6842
+ payments: PaymentCapture[];
6869
6843
  }
6870
- interface HasCustomEmailConfigurationsRequest {
6844
+ interface PaymentCapture {
6845
+ /**
6846
+ * Payment ID
6847
+ * @format GUID
6848
+ */
6849
+ paymentId?: string | null;
6850
+ /**
6851
+ * Capture amount.
6852
+ * If not provided - full authorized amount will be captured.
6853
+ */
6854
+ amount?: Price;
6871
6855
  }
6872
- interface HasCustomEmailConfigurationsResponse {
6873
- hasCustomConfigurations?: boolean;
6856
+ interface CaptureAuthorizedPaymentsResponse {
6857
+ /** All order's transactions after the capture was triggered */
6858
+ orderTransactions?: OrderTransactions;
6874
6859
  }
6875
- interface AddToAutomationMigrationPopulationRequest {
6876
- /** When true, sends custom email configurations to automation system via email */
6877
- sendCustomEmailConfigs?: boolean;
6878
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6879
- origin?: OriginWithLiterals;
6860
+ interface ChargeSavedPaymentMethodRequest {
6861
+ /**
6862
+ * Ecom Order ID.
6863
+ * @minLength 1
6864
+ * @maxLength 100
6865
+ */
6866
+ ecomOrderId?: string;
6867
+ /** Amount to be charged */
6868
+ amount?: Price;
6880
6869
  }
6881
- declare enum Origin {
6882
- OPT_IN = "OPT_IN",
6883
- MIGRATION = "MIGRATION"
6870
+ interface ChargeSavedPaymentMethodResponse {
6871
+ /** Payment gateway's order ID (e.g Wix Payments) */
6872
+ paymentGatewayOrderId?: string;
6884
6873
  }
6885
- /** @enumType */
6886
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6887
- interface AddToAutomationMigrationPopulationResponse {
6888
- success?: boolean;
6874
+ interface V1TriggerReindexRequest {
6875
+ /** @format GUID */
6876
+ metasiteId?: string;
6877
+ /**
6878
+ * @minLength 1
6879
+ * @maxLength 100
6880
+ * @maxSize 100
6881
+ */
6882
+ orderIds?: string[];
6889
6883
  }
6890
- interface IsInAutomationMigrationPopulationRequest {
6884
+ interface V1TriggerReindexResponse {
6891
6885
  }
6892
- interface IsInAutomationMigrationPopulationResponse {
6893
- inPopulation?: boolean;
6886
+ interface V1TriggerReindexOrderRequest {
6887
+ /** @format GUID */
6888
+ metasiteId?: string;
6889
+ /**
6890
+ * @minLength 1
6891
+ * @maxLength 100
6892
+ */
6893
+ orderId?: string;
6894
6894
  }
6895
6895
  interface DiffmatokyPayload {
6896
6896
  left?: string;