@wix/auto_sdk_ecom_orders 1.0.333 → 1.0.335

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