@wix/auto_sdk_ecom_orders 1.0.328 → 1.0.330

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