@wix/auto_sdk_ecom_orders 1.0.327 → 1.0.328

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