@wix/auto_sdk_ecom_orders 1.0.331 → 1.0.333

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