@wix/auto_sdk_ecom_orders 1.0.332 → 1.0.334

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-BvamC5-B.d.ts} +1687 -1687
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1687 -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-BvamC5-B.d.mts} +1687 -1687
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1687 -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-CAyh4UDq.d.ts} +1813 -1813
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1813 -1813
  25. package/build/internal/es/{ecom-v1-order-orders.universal-BVqsClnV.d.mts → ecom-v1-order-orders.universal-CAyh4UDq.d.mts} +1813 -1813
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1813 -1813
  29. package/package.json +3 -3
@@ -4818,2330 +4818,2330 @@ interface BulkDeleteImportedOrdersResponse {
4818
4818
  */
4819
4819
  jobId?: string;
4820
4820
  }
4821
- interface SendBuyerConfirmationEmailRequest {
4821
+ interface V1TriggerReindexRequest {
4822
4822
  /** @format GUID */
4823
- orderId?: string;
4824
- }
4825
- interface SendBuyerConfirmationEmailResponse {
4826
- }
4827
- interface SendBuyerPaymentsReceivedEmailRequest {
4823
+ metasiteId?: string;
4828
4824
  /**
4829
4825
  * @minLength 1
4830
4826
  * @maxLength 100
4827
+ * @maxSize 100
4831
4828
  */
4832
- orderId?: string;
4829
+ orderIds?: string[];
4833
4830
  }
4834
- interface SendBuyerPaymentsReceivedEmailResponse {
4831
+ interface V1TriggerReindexResponse {
4835
4832
  }
4836
- interface SendBuyerPickupConfirmationEmailRequest {
4833
+ interface V1TriggerReindexOrderRequest {
4834
+ /** @format GUID */
4835
+ metasiteId?: string;
4837
4836
  /**
4838
4837
  * @minLength 1
4839
4838
  * @maxLength 100
4840
4839
  */
4841
4840
  orderId?: string;
4842
4841
  }
4843
- interface SendBuyerPickupConfirmationEmailResponse {
4844
- }
4845
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4846
- /**
4847
- * IDs of orders to send pickup emails for.
4848
- * @minSize 1
4849
- * @maxSize 300
4850
- */
4851
- orderIds?: string[];
4852
- }
4853
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4854
- }
4855
- interface SendBuyerShippingConfirmationEmailRequest {
4842
+ interface PreparePaymentCollectionRequest {
4856
4843
  /**
4844
+ * Ecom order ID.
4857
4845
  * @minLength 1
4858
4846
  * @maxLength 100
4859
4847
  */
4860
- orderId?: string;
4861
- }
4862
- interface SendBuyerShippingConfirmationEmailResponse {
4863
- }
4864
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4848
+ ecomOrderId: string;
4849
+ /** Amount to collect */
4850
+ amount: Price;
4865
4851
  /**
4866
- * IDs of orders to send pickup emails for.
4867
- * @minSize 1
4868
- * @maxSize 300
4852
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4853
+ * Existing payment gateway order will be updated with a new amount.
4854
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4869
4855
  */
4870
- orderIds?: string[];
4871
- }
4872
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4873
- }
4874
- interface SendMerchantOrderReceivedNotificationRequest {
4856
+ paymentGatewayOrderId?: string | null;
4875
4857
  /**
4876
- * @minLength 1
4877
- * @maxLength 100
4858
+ * Whether to delay capture of the payment.
4859
+ * Default: false
4860
+ * @deprecated Whether to delay capture of the payment.
4861
+ * Default: false
4862
+ * @replacedBy delayed_capture_settings.scheduled_action
4863
+ * @targetRemovalDate 2024-09-30
4878
4864
  */
4879
- orderId?: string;
4880
- }
4881
- interface SendMerchantOrderReceivedNotificationResponse {
4882
- }
4883
- interface SendCancelRefundEmailRequest {
4865
+ delayedCapture?: boolean;
4884
4866
  /**
4885
- * The ID of order that is canceled/refunded
4886
- * @minLength 1
4887
- * @maxLength 100
4867
+ * Specifies whether payment collection is initiated by Merchant or User of User
4868
+ * Default: `true`
4869
+ * @internal
4888
4870
  */
4889
- orderId?: string;
4871
+ merchantInitiated?: boolean | null;
4890
4872
  /**
4891
- * Personal note added to the email (optional)
4892
- * @minLength 1
4893
- * @maxLength 1000
4873
+ * Redirect urls which are used to return buyer to third party system.
4874
+ * @internal
4894
4875
  */
4895
- customMessage?: string | null;
4896
- /** Refund amount */
4897
- refundAmount?: Price;
4876
+ redirectUrls?: RedirectUrls;
4877
+ /** Delayed capture payment settings */
4878
+ delayedCaptureSettings?: DelayedCaptureSettings;
4879
+ }
4880
+ interface RedirectUrls {
4898
4881
  /**
4899
- * Refund ID. (Optional)
4900
- * @format GUID
4882
+ * URL to redirect buyer in case of approved (successful) transaction
4883
+ * @format WEB_URL
4901
4884
  */
4902
- refundId?: string | null;
4903
- }
4904
- interface SendCancelRefundEmailResponse {
4905
- }
4906
- interface SendRefundEmailRequest {
4885
+ successUrl?: string | null;
4907
4886
  /**
4908
- * The ID of order that is refunded
4909
- * @format GUID
4887
+ * URL to redirect buyer in case of buyer canceled the transaction
4888
+ * @format WEB_URL
4910
4889
  */
4911
- orderId?: string;
4890
+ cancelUrl?: string | null;
4912
4891
  /**
4913
- * Refund ID
4914
- * @format GUID
4892
+ * URL to redirect buyer in case of failed/rejected transaction
4893
+ * @format WEB_URL
4915
4894
  */
4916
- refundId?: string;
4895
+ errorUrl?: string | null;
4917
4896
  /**
4918
- * Personal note added to the email (optional)
4919
- * @minLength 1
4920
- * @maxLength 1000
4897
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4898
+ * @format WEB_URL
4921
4899
  */
4922
- customMessage?: string | null;
4923
- }
4924
- interface SendRefundEmailResponse {
4900
+ pendingUrl?: string | null;
4925
4901
  }
4926
- interface SendFulfillmentEmailRequest {
4927
- /** @format GUID */
4928
- orderId?: string;
4929
- /** @format GUID */
4930
- fulfillerId?: string;
4902
+ interface DelayedCaptureSettings {
4903
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4904
+ scheduledAction?: ScheduledActionWithLiterals;
4905
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4906
+ delayDuration?: Duration;
4931
4907
  }
4932
- interface SendFulfillmentEmailResponse {
4908
+ declare enum ScheduledAction {
4909
+ /** Whether payment will be auto-voided when duration passes */
4910
+ VOID = "VOID",
4911
+ /** Whether payment will be auto-captured when duration passes */
4912
+ CAPTURE = "CAPTURE"
4933
4913
  }
4934
- interface SendMerchantOrderReceivedPushRequest {
4914
+ /** @enumType */
4915
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4916
+ interface Duration {
4935
4917
  /**
4936
- * @minLength 1
4937
- * @maxLength 100
4918
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4919
+ * @min 1
4938
4920
  */
4939
- orderId?: string;
4940
- }
4941
- interface SendMerchantOrderReceivedPushResponse {
4942
- }
4943
- interface PreviewEmailByTypeRequest {
4944
- emailType?: PreviewEmailTypeWithLiterals;
4921
+ count?: number;
4922
+ /** Duration unit: MINUTES, HOURS and DAYS */
4923
+ unit?: DurationUnitWithLiterals;
4945
4924
  }
4946
- declare enum PreviewEmailType {
4947
- ORDER_PLACED = "ORDER_PLACED",
4948
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4949
- ORDER_SHIPPED = "ORDER_SHIPPED",
4950
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4925
+ declare enum DurationUnit {
4926
+ MINUTES = "MINUTES",
4927
+ HOURS = "HOURS",
4928
+ DAYS = "DAYS"
4951
4929
  }
4952
4930
  /** @enumType */
4953
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4954
- interface PreviewEmailByTypeResponse {
4955
- emailPreview?: string;
4931
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4932
+ interface PreparePaymentCollectionResponse {
4933
+ /** Payment gateway order id which is associated with given payment */
4934
+ paymentGatewayOrderId?: string;
4956
4935
  }
4957
- interface PreviewRefundEmailRequest {
4936
+ interface GetPaymentCollectabilityStatusRequest {
4958
4937
  /**
4938
+ * Ecom order ID.
4959
4939
  * @minLength 1
4960
4940
  * @maxLength 100
4961
4941
  */
4962
- orderId?: string;
4963
- /** Refund amount */
4964
- refundAmount?: Price;
4965
- /** Refund business details */
4966
- details?: RefundDetails;
4942
+ ecomOrderId: string;
4943
+ }
4944
+ interface GetPaymentCollectabilityStatusResponse {
4945
+ /** Payment collectability status */
4946
+ status?: PaymentCollectabilityStatusWithLiterals;
4947
+ /** Collectable order amount */
4948
+ amount?: Price;
4967
4949
  /**
4968
- * Personal note added to the email (optional)
4969
- * @minLength 1
4970
- * @maxLength 1000
4950
+ * Whether authorization supported
4951
+ * @internal
4971
4952
  */
4972
- customMessage?: string | null;
4953
+ authorizationSupported?: boolean;
4973
4954
  /**
4974
- * Refund ID. (Optional)
4975
- * @format GUID
4955
+ * Whether custom amount is supported for payment collection
4956
+ * @internal
4976
4957
  */
4977
- refundId?: string | null;
4958
+ customAmountSupported?: boolean;
4978
4959
  }
4979
- /** Business model of a refund request */
4980
- interface RefundDetails {
4960
+ declare enum PaymentCollectabilityStatus {
4961
+ UNKNOWN = "UNKNOWN",
4962
+ COLLECTABLE = "COLLECTABLE",
4963
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4964
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4965
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4966
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4967
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4968
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4969
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4970
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4971
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4972
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4973
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4974
+ }
4975
+ /** @enumType */
4976
+ 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';
4977
+ interface RecordManuallyCollectedPaymentRequest {
4981
4978
  /**
4982
- * Order line item IDs and quantities that were refunded.
4983
- * @maxSize 300
4979
+ * Order ID.
4980
+ * @minLength 1
4981
+ * @maxLength 100
4984
4982
  */
4985
- items?: RefundItem[];
4986
- /** Whether the shipping fee was also refunded. */
4987
- shippingIncluded?: boolean;
4983
+ orderId: string;
4984
+ /** Amount to be recorded as approved manual payment for given order */
4985
+ amount: Price;
4988
4986
  /**
4989
- * Reason for the refund, provided by customer (optional).
4990
- * @maxLength 200
4987
+ * Payment method name provided by user.
4988
+ *
4989
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4990
+ * @internal
4991
4991
  */
4992
- reason?: string | null;
4992
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4993
+ }
4994
+ /**
4995
+ * User-defined payment method name.
4996
+ * Allows specifying either a predefined type or a custom name.
4997
+ */
4998
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4999
+ /** Predefined payment method. */
5000
+ predefined?: PredefinedPaymentMethodWithLiterals;
4993
5001
  /**
4994
- * Line items that were refunded.
4995
- * @maxSize 300
5002
+ * Custom payment method name provided by user.
5003
+ *
5004
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5005
+ * @minLength 1
5006
+ * @maxLength 150
4996
5007
  */
4997
- lineItems?: LineItemRefund[];
5008
+ custom?: string | null;
5009
+ }
5010
+ /** @oneof */
5011
+ interface UserDefinedPaymentMethodNameKindOneOf {
5012
+ /** Predefined payment method. */
5013
+ predefined?: PredefinedPaymentMethodWithLiterals;
4998
5014
  /**
4999
- * Additional fees that were refunded.
5000
- * @maxSize 100
5015
+ * Custom payment method name provided by user.
5016
+ *
5017
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5018
+ * @minLength 1
5019
+ * @maxLength 150
5001
5020
  */
5002
- additionalFees?: AdditionalFeeRefund[];
5003
- /** Shipping amount that was refunded. */
5004
- shipping?: ShippingRefund;
5021
+ custom?: string | null;
5005
5022
  }
5006
- interface RefundItem {
5023
+ /** Predefined payment method types for offline/manual payments. */
5024
+ declare enum PredefinedPaymentMethod {
5025
+ /** Cash payment. */
5026
+ CASH = "CASH",
5027
+ /** Bank transfer. */
5028
+ BANK_TRANSFER = "BANK_TRANSFER",
5029
+ /** Payment by check. */
5030
+ CHECK = "CHECK"
5031
+ }
5032
+ /** @enumType */
5033
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5034
+ interface RecordManuallyCollectedPaymentResponse {
5035
+ }
5036
+ interface MarkOrderAsPaidRequest {
5007
5037
  /**
5008
- * Line item ID the refunded line item.
5009
- * @format GUID
5038
+ * Ecom order ID.
5039
+ * @minLength 1
5040
+ * @maxLength 100
5010
5041
  */
5011
- lineItemId?: string;
5042
+ ecomOrderId: string;
5012
5043
  /**
5013
- * Line item quantity refunded.
5014
- * @min 1
5015
- * @max 100000
5044
+ * Payment method name provided by user.
5045
+ *
5046
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5047
+ * @internal
5016
5048
  */
5017
- quantity?: number;
5049
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5018
5050
  }
5019
- interface LineItemRefund {
5051
+ interface MarkOrderAsPaidResponse {
5052
+ /** Updated order. */
5053
+ order?: Order;
5054
+ }
5055
+ interface BulkMarkOrdersAsPaidRequest {
5020
5056
  /**
5021
- * Line item ID.
5022
- * @format GUID
5023
- * @immutable
5057
+ * IDs of orders to mark as paid.
5058
+ * @minSize 1
5059
+ * @maxSize 100
5060
+ * @minLength 1
5061
+ * @maxLength 100
5024
5062
  */
5025
- lineItemId?: string;
5063
+ ecomOrderIds: string[];
5064
+ }
5065
+ interface BulkMarkOrdersAsPaidResponse {
5026
5066
  /**
5027
- * Refund quantity.
5028
- * @min 1
5029
- * @max 100000
5030
- * @immutable
5067
+ * Items updated by the bulk action.
5068
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5031
5069
  */
5032
- quantity?: number;
5070
+ results?: BulkOrderResult[];
5071
+ /** Bulk action metadata. */
5072
+ bulkActionMetadata?: BulkActionMetadata;
5033
5073
  }
5034
- interface AdditionalFeeRefund {
5074
+ interface BulkOrderResult {
5075
+ /** Item metadata. */
5076
+ itemMetadata?: ItemMetadata;
5035
5077
  /**
5036
- * Additional fee ID.
5037
- * @format GUID
5038
- * @immutable
5078
+ * Updated order.
5079
+ *
5080
+ * Returned when `returnFullEntity = true`.
5039
5081
  */
5040
- additionalFeeId?: string;
5082
+ item?: Order;
5083
+ }
5084
+ interface ItemMetadata {
5085
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5086
+ _id?: string | null;
5087
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5088
+ originalIndex?: number;
5089
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5090
+ success?: boolean;
5091
+ /** Details about the error in case of failure. */
5092
+ error?: ApplicationError;
5093
+ }
5094
+ interface ApplicationError {
5095
+ /** Error code. */
5096
+ code?: string;
5097
+ /** Description of the error. */
5098
+ description?: string;
5099
+ /** Data related to the error. */
5100
+ data?: Record<string, any> | null;
5101
+ }
5102
+ interface BulkActionMetadata {
5103
+ /** Number of items that were successfully processed. */
5104
+ totalSuccesses?: number;
5105
+ /** Number of items that couldn't be processed. */
5106
+ totalFailures?: number;
5107
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5108
+ undetailedFailures?: number;
5109
+ }
5110
+ interface GetRefundabilityStatusRequest {
5041
5111
  /**
5042
- * Refund amount.
5043
- * @immutable
5112
+ * Order ID.
5113
+ * @minLength 1
5114
+ * @maxLength 100
5044
5115
  */
5045
- amount?: Price;
5116
+ ecomOrderId: string;
5046
5117
  }
5047
- interface ShippingRefund {
5118
+ interface GetRefundabilityStatusResponse {
5048
5119
  /**
5049
- * Refund amount.
5050
- * @immutable
5120
+ * Refundability details.
5121
+ * @maxSize 300
5051
5122
  */
5052
- amount?: Price;
5123
+ refundabilities?: Refundability[];
5124
+ /**
5125
+ * Whether the order supports refunding per item.
5126
+ * @deprecated
5127
+ */
5128
+ refundablePerItem?: boolean;
5053
5129
  }
5054
- interface PreviewRefundEmailResponse {
5055
- emailPreview?: string;
5130
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5131
+ /** Reason why payment is not refundable. */
5132
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5133
+ /** Reason why payment is only refundable manually. */
5134
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5135
+ /** Payment ID. */
5136
+ paymentId?: string;
5137
+ /** Payment refundability status. */
5138
+ refundabilityStatus?: RefundableStatusWithLiterals;
5139
+ /** Link to payment provider dashboard. */
5140
+ providerLink?: string | null;
5056
5141
  }
5057
- interface PreviewCancelEmailRequest {
5142
+ /** @oneof */
5143
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5144
+ /** Reason why payment is not refundable. */
5145
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5146
+ /** Reason why payment is only refundable manually. */
5147
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5148
+ }
5149
+ declare enum RefundableStatus {
5150
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5151
+ MANUAL = "MANUAL",
5152
+ REFUNDABLE = "REFUNDABLE"
5153
+ }
5154
+ /** @enumType */
5155
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5156
+ declare enum NonRefundableReason {
5157
+ NONE = "NONE",
5158
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5159
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5160
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5161
+ NOT_PAID = "NOT_PAID",
5162
+ ACCESS_DENIED = "ACCESS_DENIED",
5163
+ ZERO_PRICE = "ZERO_PRICE",
5164
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5165
+ PENDING_REFUND = "PENDING_REFUND",
5166
+ FORBIDDEN = "FORBIDDEN",
5167
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5168
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5169
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5170
+ }
5171
+ /** @enumType */
5172
+ 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';
5173
+ declare enum ManuallyRefundableReason {
5174
+ EXPIRED = "EXPIRED",
5175
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5176
+ OFFLINE = "OFFLINE",
5177
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5178
+ }
5179
+ /** @enumType */
5180
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5181
+ interface CreatePaymentGatewayOrderRequest {
5058
5182
  /**
5183
+ * Ecom order ID.
5059
5184
  * @minLength 1
5060
5185
  * @maxLength 100
5061
5186
  */
5062
- orderId?: string;
5187
+ ecomOrderId: string;
5188
+ /** Information about the user who initiated the payment. */
5189
+ chargedBy?: ChargedBy;
5063
5190
  /**
5064
- * Personal note added to the email (optional)
5191
+ * Whether to delay capture of the payment.
5192
+ *
5193
+ * Default: false
5194
+ * @internal
5195
+ */
5196
+ delayedCapture?: boolean;
5197
+ }
5198
+ interface ChargedBy {
5199
+ /**
5200
+ * ID - id of the user who initiated the payment
5201
+ * @format GUID
5202
+ */
5203
+ _id?: string;
5204
+ /**
5205
+ * Full name - name of the user who initiated the payment
5065
5206
  * @minLength 1
5066
- * @maxLength 1000
5207
+ * @maxLength 200
5067
5208
  */
5068
- customMessage?: string | null;
5209
+ fullName?: string | null;
5069
5210
  }
5070
- interface PreviewCancelEmailResponse {
5071
- emailPreview?: string;
5211
+ interface CreatePaymentGatewayOrderResponse {
5212
+ /** ID of the order created in the payment gateway */
5213
+ paymentGatewayOrderId?: string;
5072
5214
  }
5073
- interface PreviewCancelRefundEmailRequest {
5215
+ interface ChargeMembershipsRequest {
5074
5216
  /**
5217
+ * Order ID.
5075
5218
  * @minLength 1
5076
5219
  * @maxLength 100
5077
5220
  */
5078
- orderId?: string;
5221
+ ecomOrderId: string;
5079
5222
  /**
5080
- * Personal note added to the email (optional)
5223
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5224
+ * but a user which is using the membership on behalf of the a member
5225
+ * @format GUID
5226
+ */
5227
+ memberId: string;
5228
+ /**
5229
+ * List of items to be paid by memberships
5230
+ * @minSize 1
5231
+ * @maxSize 300
5232
+ */
5233
+ membershipCharges?: MembershipChargeItem[];
5234
+ }
5235
+ interface MembershipChargeItem {
5236
+ /**
5237
+ * The id of used membership
5081
5238
  * @minLength 1
5082
- * @maxLength 1000
5239
+ * @maxLength 100
5083
5240
  */
5084
- customMessage?: string | null;
5085
- /** Refund amount */
5086
- refundAmount?: Price;
5241
+ membershipId?: string;
5087
5242
  /**
5088
- * Refund ID. (Optional)
5243
+ * ID of the application providing this payment option
5089
5244
  * @format GUID
5090
5245
  */
5091
- refundId?: string | null;
5092
- }
5093
- interface PreviewCancelRefundEmailResponse {
5094
- emailPreview?: string;
5095
- }
5096
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5097
- }
5098
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5099
- emailPreview?: string;
5100
- }
5101
- interface PreviewBuyerConfirmationEmailRequest {
5102
- }
5103
- interface PreviewBuyerConfirmationEmailResponse {
5104
- emailPreview?: string;
5105
- }
5106
- interface PreviewBuyerPickupConfirmationEmailRequest {
5107
- }
5108
- interface PreviewBuyerPickupConfirmationEmailResponse {
5109
- emailPreview?: string;
5110
- }
5111
- interface PreviewShippingConfirmationEmailRequest {
5112
- }
5113
- interface PreviewShippingConfirmationEmailResponse {
5114
- emailPreview?: string;
5115
- }
5116
- interface PreviewResendDownloadLinksEmailRequest {
5117
- }
5118
- interface PreviewResendDownloadLinksEmailResponse {
5119
- emailPreview?: string;
5120
- }
5121
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5122
- /** Emitted on a meta site creation. */
5123
- siteCreated?: SiteCreated;
5124
- /** Emitted on a meta site transfer completion. */
5125
- siteTransferred?: SiteTransferred;
5126
- /** Emitted on a meta site deletion. */
5127
- siteDeleted?: SiteDeleted;
5128
- /** Emitted on a meta site restoration. */
5129
- siteUndeleted?: SiteUndeleted;
5130
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5131
- sitePublished?: SitePublished;
5132
- /** Emitted on a meta site unpublish. */
5133
- siteUnpublished?: SiteUnpublished;
5134
- /** Emitted when meta site is marked as template. */
5135
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5136
- /** Emitted when meta site is marked as a WixSite. */
5137
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5138
- /** Emitted when an application is provisioned (installed). */
5139
- serviceProvisioned?: ServiceProvisioned;
5140
- /** Emitted when an application is removed (uninstalled). */
5141
- serviceRemoved?: ServiceRemoved;
5142
- /** Emitted when meta site name (URL slug) is changed. */
5143
- siteRenamedPayload?: SiteRenamed;
5144
- /** Emitted when meta site was permanently deleted. */
5145
- hardDeleted?: SiteHardDeleted;
5146
- /** Emitted on a namespace change. */
5147
- namespaceChanged?: NamespaceChanged;
5148
- /** Emitted when Studio is attached. */
5149
- studioAssigned?: StudioAssigned;
5150
- /** Emitted when Studio is detached. */
5151
- studioUnassigned?: StudioUnassigned;
5152
- /**
5153
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5154
- * the actual URL.
5155
- *
5156
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5157
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5158
- */
5159
- urlChanged?: SiteUrlChanged;
5160
- /** Site is marked as PurgedExternally */
5161
- sitePurgedExternally?: SitePurgedExternally;
5162
- /** Emitted when Odeditor is attached. */
5163
- odeditorAssigned?: OdeditorAssigned;
5164
- /** Emitted when Odeditor is detached. */
5165
- odeditorUnassigned?: OdeditorUnassigned;
5166
- /** Emitted when Picasso is attached. */
5167
- picassoAssigned?: PicassoAssigned;
5168
- /** Emitted when Picasso is detached. */
5169
- picassoUnassigned?: PicassoUnassigned;
5170
- /** Emitted when Wixel is attached. */
5171
- wixelAssigned?: WixelAssigned;
5172
- /** Emitted when Wixel is detached. */
5173
- wixelUnassigned?: WixelUnassigned;
5174
- /** Emitted when StudioTwo is attached. */
5175
- studioTwoAssigned?: StudioTwoAssigned;
5176
- /** Emitted when StudioTwo is detached. */
5177
- studioTwoUnassigned?: StudioTwoUnassigned;
5178
- /** Emitted when media from user domain is enabled. */
5179
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5180
- /** Emitted when media from user domain is disabled. */
5181
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5182
- /** Emitted when Editorless is attached. */
5183
- editorlessAssigned?: EditorlessAssigned;
5184
- /** Emitted when Editorless is detached. */
5185
- editorlessUnassigned?: EditorlessUnassigned;
5186
- /**
5187
- * A meta site id.
5188
- * @format GUID
5189
- */
5190
- metaSiteId?: string;
5191
- /** A meta site version. Monotonically increasing. */
5192
- version?: string;
5193
- /** A timestamp of the event. */
5194
- timestamp?: string;
5195
- /**
5196
- * TODO(meta-site): Change validation once validations are disabled for consumers
5197
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5198
- * @maxSize 4000
5199
- */
5200
- assets?: Asset[];
5201
- }
5202
- /** @oneof */
5203
- interface MetaSiteSpecialEventPayloadOneOf {
5204
- /** Emitted on a meta site creation. */
5205
- siteCreated?: SiteCreated;
5206
- /** Emitted on a meta site transfer completion. */
5207
- siteTransferred?: SiteTransferred;
5208
- /** Emitted on a meta site deletion. */
5209
- siteDeleted?: SiteDeleted;
5210
- /** Emitted on a meta site restoration. */
5211
- siteUndeleted?: SiteUndeleted;
5212
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5213
- sitePublished?: SitePublished;
5214
- /** Emitted on a meta site unpublish. */
5215
- siteUnpublished?: SiteUnpublished;
5216
- /** Emitted when meta site is marked as template. */
5217
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5218
- /** Emitted when meta site is marked as a WixSite. */
5219
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5220
- /** Emitted when an application is provisioned (installed). */
5221
- serviceProvisioned?: ServiceProvisioned;
5222
- /** Emitted when an application is removed (uninstalled). */
5223
- serviceRemoved?: ServiceRemoved;
5224
- /** Emitted when meta site name (URL slug) is changed. */
5225
- siteRenamedPayload?: SiteRenamed;
5226
- /** Emitted when meta site was permanently deleted. */
5227
- hardDeleted?: SiteHardDeleted;
5228
- /** Emitted on a namespace change. */
5229
- namespaceChanged?: NamespaceChanged;
5230
- /** Emitted when Studio is attached. */
5231
- studioAssigned?: StudioAssigned;
5232
- /** Emitted when Studio is detached. */
5233
- studioUnassigned?: StudioUnassigned;
5234
- /**
5235
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5236
- * the actual URL.
5237
- *
5238
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5239
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5240
- */
5241
- urlChanged?: SiteUrlChanged;
5242
- /** Site is marked as PurgedExternally */
5243
- sitePurgedExternally?: SitePurgedExternally;
5244
- /** Emitted when Odeditor is attached. */
5245
- odeditorAssigned?: OdeditorAssigned;
5246
- /** Emitted when Odeditor is detached. */
5247
- odeditorUnassigned?: OdeditorUnassigned;
5248
- /** Emitted when Picasso is attached. */
5249
- picassoAssigned?: PicassoAssigned;
5250
- /** Emitted when Picasso is detached. */
5251
- picassoUnassigned?: PicassoUnassigned;
5252
- /** Emitted when Wixel is attached. */
5253
- wixelAssigned?: WixelAssigned;
5254
- /** Emitted when Wixel is detached. */
5255
- wixelUnassigned?: WixelUnassigned;
5256
- /** Emitted when StudioTwo is attached. */
5257
- studioTwoAssigned?: StudioTwoAssigned;
5258
- /** Emitted when StudioTwo is detached. */
5259
- studioTwoUnassigned?: StudioTwoUnassigned;
5260
- /** Emitted when media from user domain is enabled. */
5261
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5262
- /** Emitted when media from user domain is disabled. */
5263
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5264
- /** Emitted when Editorless is attached. */
5265
- editorlessAssigned?: EditorlessAssigned;
5266
- /** Emitted when Editorless is detached. */
5267
- editorlessUnassigned?: EditorlessUnassigned;
5268
- }
5269
- interface Asset {
5270
- /**
5271
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5272
- * @maxLength 36
5273
- */
5274
- appDefId?: string;
5275
- /**
5276
- * An instance id. For legacy reasons may be UUID or a string.
5277
- * @maxLength 200
5278
- */
5279
- instanceId?: string;
5280
- /** An application state. */
5281
- state?: StateWithLiterals;
5282
- }
5283
- declare enum State {
5284
- UNKNOWN = "UNKNOWN",
5285
- ENABLED = "ENABLED",
5286
- DISABLED = "DISABLED",
5287
- PENDING = "PENDING",
5288
- DEMO = "DEMO"
5289
- }
5290
- /** @enumType */
5291
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5292
- interface SiteCreated {
5246
+ appId?: string;
5247
+ /** The name of used membership */
5248
+ membershipName?: MembershipName;
5249
+ /** Additional data about this membership */
5250
+ membershipAdditionalData?: Record<string, any> | null;
5251
+ /** Catalog and item reference info. */
5252
+ catalogReference?: CatalogReference;
5253
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5254
+ serviceProperties?: ServiceProperties;
5293
5255
  /**
5294
- * A template identifier (empty if not created from a template).
5256
+ * Usually would be the same as catalogReference.catalogItemId
5257
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5258
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5259
+ * @minLength 1
5295
5260
  * @maxLength 36
5296
5261
  */
5297
- originTemplateId?: string;
5298
- /**
5299
- * An account id of the owner.
5300
- * @format GUID
5301
- */
5302
- ownerId?: string;
5303
- /** A context in which meta site was created. */
5304
- context?: SiteCreatedContextWithLiterals;
5305
- /**
5306
- * A meta site id from which this site was created.
5307
- *
5308
- * In case of a creation from a template it's a template id.
5309
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5310
- * @format GUID
5311
- */
5312
- originMetaSiteId?: string | null;
5313
- /**
5314
- * A meta site name (URL slug).
5315
- * @maxLength 20
5316
- */
5317
- siteName?: string;
5318
- /** A namespace. */
5319
- namespace?: NamespaceWithLiterals;
5320
- }
5321
- declare enum SiteCreatedContext {
5322
- /** A valid option, we don't expose all reasons why site might be created. */
5323
- OTHER = "OTHER",
5324
- /** A meta site was created from template. */
5325
- FROM_TEMPLATE = "FROM_TEMPLATE",
5326
- /** A meta site was created by copying of the transfferred meta site. */
5327
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5328
- /** A copy of existing meta site. */
5329
- DUPLICATE = "DUPLICATE",
5330
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5331
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5332
- /** deprecated A meta site was created for Flash editor. */
5333
- FLASH = "FLASH"
5334
- }
5335
- /** @enumType */
5336
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5337
- declare enum Namespace {
5338
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5339
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5340
- WIX = "WIX",
5341
- /** 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. */
5342
- SHOUT_OUT = "SHOUT_OUT",
5343
- /** 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. */
5344
- ALBUMS = "ALBUMS",
5345
- /** 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. */
5346
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5347
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5348
- HOTELS = "HOTELS",
5349
- /** 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. */
5350
- CLUBS = "CLUBS",
5351
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5352
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5353
- /**
5354
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5355
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5356
- */
5357
- DEV_SITE = "DEV_SITE",
5358
- /** 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. */
5359
- LOGOS = "LOGOS",
5360
- /** 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. */
5361
- VIDEO_MAKER = "VIDEO_MAKER",
5362
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5363
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5364
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5365
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5366
- /**
5367
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5368
- *
5369
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5370
- */
5371
- HTML_DRAFT = "HTML_DRAFT",
5372
- /**
5373
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5374
- * Will be accessible from Site List and will not have a website app.
5375
- * Once the user attaches a site, the site will become a regular wixsite.
5376
- */
5377
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5378
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5379
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5380
- /** It is to be used in the Business First efforts. */
5381
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5382
- /** Bookings business flow with no site. */
5383
- ANYWHERE = "ANYWHERE",
5384
- /** Namespace for Headless Backoffice with no editor */
5385
- HEADLESS = "HEADLESS",
5386
- /**
5387
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5388
- * The site will be used for account level CSM feature for enterprise
5262
+ rootCatalogItemId?: string | null;
5263
+ /**
5264
+ * line item id of Checkout/Order line item
5265
+ * @minLength 1
5266
+ * @maxLength 100
5389
5267
  */
5390
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5391
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5392
- RISE = "RISE",
5268
+ lineItemId?: string;
5269
+ }
5270
+ interface MembershipName {
5393
5271
  /**
5394
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5395
- * There's a blank site behind the scene but it's blank).
5396
- * The Mobile company will be the owner of this namespace.
5272
+ * Membership name in the site's original language.
5273
+ * @maxLength 100
5397
5274
  */
5398
- BRANDED_FIRST = "BRANDED_FIRST",
5399
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5400
- NOWNIA = "NOWNIA",
5275
+ original?: string;
5401
5276
  /**
5402
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5403
- * The Partners company owns this namespace.
5277
+ * Membership name translated into the buyer's language.
5278
+ *
5279
+ * Default: The value of `original`
5280
+ * @maxLength 100
5404
5281
  */
5405
- UGC_TEMPLATE = "UGC_TEMPLATE",
5406
- /** Codux Headless Sites */
5407
- CODUX = "CODUX",
5408
- /** Bobb - AI Design Creator. */
5409
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5282
+ translated?: string | null;
5283
+ }
5284
+ interface ChargeMembershipsResponse {
5285
+ }
5286
+ interface TriggerRefundRequest {
5410
5287
  /**
5411
- * Shared Blog Site is a unique single site across Enterprise account,
5412
- * This site will hold all Blog posts related to the Marketing product.
5288
+ * The order this refund related to
5289
+ * @minLength 1
5290
+ * @maxLength 100
5413
5291
  */
5414
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5415
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5416
- STANDALONE_FORMS = "STANDALONE_FORMS",
5417
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5418
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5419
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5420
- MIMIR = "MIMIR",
5421
- /** Wix Twins platform. */
5422
- TWINS = "TWINS",
5423
- /** Wix Nano. */
5424
- NANO = "NANO",
5425
- /** Base44 headless sites. */
5426
- BASE44 = "BASE44",
5427
- /** Wix Channels Sites */
5428
- CHANNELS = "CHANNELS",
5429
- /** Nautilus platform. */
5430
- NAUTILUS = "NAUTILUS",
5292
+ ecomOrderId: string;
5431
5293
  /**
5432
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5433
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5294
+ * Refund operations information
5295
+ * @minSize 1
5296
+ * @maxSize 1
5434
5297
  */
5435
- SYMPHONY = "SYMPHONY",
5436
- /** Nautilus platform app. */
5437
- NAUTILUS_APPS = "NAUTILUS_APPS",
5298
+ payments: PaymentRefund[];
5299
+ /** Business model of a refund */
5300
+ details?: RefundDetails;
5301
+ /** Side effect details related to refund */
5302
+ sideEffects?: RefundSideEffects;
5303
+ }
5304
+ interface PaymentRefund {
5438
5305
  /**
5439
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5440
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5306
+ * Specific payment within the order to refund
5307
+ * @format GUID
5441
5308
  */
5442
- VIBU = "VIBU",
5309
+ paymentId?: string;
5310
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5311
+ amount?: Price;
5443
5312
  /**
5444
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5445
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5446
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5447
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5313
+ * Whether refund is made externally and manually (on the payment provider's side)
5314
+ * 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.
5315
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5448
5316
  */
5449
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5317
+ externalRefund?: boolean;
5450
5318
  /**
5451
- * Dev-center development sites (com.wixpress.devcenter.dsm).
5452
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5319
+ * Gateway refund id. When param is present, new refund is not created.
5320
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5321
+ * and all side effects from request will be executed.
5322
+ * @internal
5323
+ * @minLength 1
5324
+ * @maxLength 100
5453
5325
  */
5454
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5326
+ gatewayRefundId?: string | null;
5455
5327
  }
5456
- /** @enumType */
5457
- 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';
5458
- /** Site transferred to another user. */
5459
- interface SiteTransferred {
5328
+ /** Business model of a refund request */
5329
+ interface RefundDetails {
5460
5330
  /**
5461
- * A previous owner id (user that transfers meta site).
5462
- * @format GUID
5331
+ * Order line item IDs and quantities that were refunded.
5332
+ * @maxSize 300
5463
5333
  */
5464
- oldOwnerId?: string;
5334
+ items?: RefundItem[];
5335
+ /** Whether the shipping fee was also refunded. */
5336
+ shippingIncluded?: boolean;
5465
5337
  /**
5466
- * A new owner id (user that accepts meta site).
5467
- * @format GUID
5338
+ * Reason for the refund, provided by customer (optional).
5339
+ * @maxLength 200
5468
5340
  */
5469
- newOwnerId?: string;
5470
- }
5471
- /** Soft deletion of the meta site. Could be restored. */
5472
- interface SiteDeleted {
5473
- /** A deletion context. */
5474
- deleteContext?: DeleteContext;
5475
- }
5476
- interface DeleteContext {
5477
- /** When the meta site was deleted. */
5478
- dateDeleted?: Date | null;
5479
- /** A status. */
5480
- deleteStatus?: DeleteStatusWithLiterals;
5341
+ reason?: string | null;
5481
5342
  /**
5482
- * A reason (flow).
5483
- * @maxLength 255
5343
+ * Line items that were refunded.
5344
+ * @maxSize 300
5484
5345
  */
5485
- deleteOrigin?: string;
5346
+ lineItems?: LineItemRefund[];
5486
5347
  /**
5487
- * A service that deleted it.
5488
- * @maxLength 255
5348
+ * Additional fees that were refunded.
5349
+ * @maxSize 100
5489
5350
  */
5490
- initiatorId?: string | null;
5491
- }
5492
- declare enum DeleteStatus {
5493
- UNKNOWN = "UNKNOWN",
5494
- TRASH = "TRASH",
5495
- DELETED = "DELETED",
5496
- PENDING_PURGE = "PENDING_PURGE",
5497
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5498
- }
5499
- /** @enumType */
5500
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5501
- /** Restoration of the meta site. */
5502
- interface SiteUndeleted {
5503
- }
5504
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5505
- interface SitePublished {
5351
+ additionalFees?: AdditionalFeeRefund[];
5352
+ /** Shipping amount that was refunded. */
5353
+ shipping?: ShippingRefund;
5506
5354
  }
5507
- interface SiteUnpublished {
5355
+ interface RefundItem {
5508
5356
  /**
5509
- * A list of URLs previously associated with the meta site.
5510
- * @maxLength 4000
5511
- * @maxSize 10000
5357
+ * Line item ID the refunded line item.
5358
+ * @format GUID
5512
5359
  */
5513
- urls?: string[];
5514
- }
5515
- interface SiteMarkedAsTemplate {
5516
- }
5517
- interface SiteMarkedAsWixSite {
5360
+ lineItemId?: string;
5361
+ /**
5362
+ * Line item quantity refunded.
5363
+ * @min 1
5364
+ * @max 100000
5365
+ */
5366
+ quantity?: number;
5518
5367
  }
5519
- /**
5520
- * Represents a service provisioned a site.
5521
- *
5522
- * Note on `origin_instance_id`:
5523
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5524
- * This is because of the following scenario:
5525
- *
5526
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5527
- * such as a product catalog. When you create a site from this template, you inherit this
5528
- * default product catalog. However, if the template's product catalog is modified,
5529
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5530
- * your site remains consistent with what you initially received and does not include any
5531
- * changes made to the original template afterward.
5532
- * To ensure this, the TPA on the template gets a new instance_id.
5533
- */
5534
- interface ServiceProvisioned {
5368
+ interface LineItemRefund {
5535
5369
  /**
5536
- * Either UUID or EmbeddedServiceType.
5537
- * @maxLength 36
5370
+ * Line item ID.
5371
+ * @format GUID
5372
+ * @immutable
5538
5373
  */
5539
- appDefId?: string;
5374
+ lineItemId?: string;
5540
5375
  /**
5541
- * Not only UUID. Something here could be something weird.
5542
- * @maxLength 36
5376
+ * Refund quantity.
5377
+ * @min 1
5378
+ * @max 100000
5379
+ * @immutable
5543
5380
  */
5544
- instanceId?: string;
5381
+ quantity?: number;
5382
+ }
5383
+ interface AdditionalFeeRefund {
5545
5384
  /**
5546
- * An instance id from which this instance is originated.
5547
- * @maxLength 36
5385
+ * Additional fee ID.
5386
+ * @format GUID
5387
+ * @immutable
5548
5388
  */
5549
- originInstanceId?: string;
5389
+ additionalFeeId?: string;
5550
5390
  /**
5551
- * A version.
5552
- * @maxLength 500
5391
+ * Refund amount.
5392
+ * @immutable
5553
5393
  */
5554
- version?: string | null;
5394
+ amount?: Price;
5395
+ }
5396
+ interface ShippingRefund {
5555
5397
  /**
5556
- * The origin meta site id
5557
- * @format GUID
5398
+ * Refund amount.
5399
+ * @immutable
5558
5400
  */
5559
- originMetaSiteId?: string | null;
5401
+ amount?: Price;
5560
5402
  }
5561
- interface ServiceRemoved {
5403
+ interface RefundSideEffects {
5404
+ /** Inventory restock details as part of this refund. */
5405
+ restockInfo?: RestockInfo;
5406
+ /** Whether to send a refund confirmation email to the customer. */
5407
+ sendOrderRefundedEmail?: boolean;
5562
5408
  /**
5563
- * Either UUID or EmbeddedServiceType.
5564
- * @maxLength 36
5409
+ * Custom message added to the refund confirmation email.
5410
+ * @minLength 1
5411
+ * @maxLength 1000
5565
5412
  */
5566
- appDefId?: string;
5413
+ customMessage?: string | null;
5414
+ }
5415
+ interface RestockInfo {
5416
+ /** Restock type. */
5417
+ type?: RestockTypeWithLiterals;
5567
5418
  /**
5568
- * Not only UUID. Something here could be something weird.
5569
- * @maxLength 36
5419
+ * Deprecated, use items instead
5420
+ * @internal
5421
+ * @maxSize 300
5422
+ * @deprecated
5570
5423
  */
5571
- instanceId?: string;
5424
+ lineItemIds?: string[];
5572
5425
  /**
5573
- * A version.
5574
- * @maxLength 500
5426
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5427
+ * @maxSize 300
5575
5428
  */
5576
- version?: string | null;
5429
+ items?: RestockItem[];
5577
5430
  }
5578
- /** Rename of the site. Meaning, free public url has been changed as well. */
5579
- interface SiteRenamed {
5431
+ declare enum RestockType {
5432
+ NO_ITEMS = "NO_ITEMS",
5433
+ ALL_ITEMS = "ALL_ITEMS",
5434
+ SOME_ITEMS = "SOME_ITEMS"
5435
+ }
5436
+ /** @enumType */
5437
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5438
+ interface RestockItem {
5580
5439
  /**
5581
- * A new meta site name (URL slug).
5582
- * @maxLength 20
5440
+ * ID of the line item being restocked.
5441
+ * @format GUID
5583
5442
  */
5584
- newSiteName?: string;
5443
+ lineItemId?: string;
5585
5444
  /**
5586
- * A previous meta site name (URL slug).
5587
- * @maxLength 255
5445
+ * Line item quantity being restocked.
5446
+ * @min 1
5447
+ * @max 100000
5588
5448
  */
5589
- oldSiteName?: string;
5590
- }
5591
- /**
5592
- * Hard deletion of the meta site.
5593
- *
5594
- * Could not be restored. Therefore it's desirable to cleanup data.
5595
- */
5596
- interface SiteHardDeleted {
5597
- /** A deletion context. */
5598
- deleteContext?: DeleteContext;
5599
- }
5600
- interface NamespaceChanged {
5601
- /** A previous namespace. */
5602
- oldNamespace?: NamespaceWithLiterals;
5603
- /** A new namespace. */
5604
- newNamespace?: NamespaceWithLiterals;
5605
- }
5606
- /** Assigned Studio editor */
5607
- interface StudioAssigned {
5449
+ quantity?: number;
5450
+ /**
5451
+ * Per-location breakdown of restock quantities.
5452
+ * @internal
5453
+ * @maxSize 5
5454
+ */
5455
+ restockLocations?: RestockLocation[];
5608
5456
  }
5609
- /** Unassigned Studio editor */
5610
- interface StudioUnassigned {
5457
+ interface TriggerRefundResponse {
5458
+ /** All order's transactions after the refunds were added */
5459
+ orderTransactions?: OrderTransactions;
5460
+ /** Created refund ID */
5461
+ refundId?: string | null;
5462
+ /** Payment ID's that the refund execution had failed for */
5463
+ failedPaymentIds?: ItemMetadata[];
5611
5464
  }
5612
5465
  /**
5613
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5614
- *
5615
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5616
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5466
+ * A record of all payments and refunds associated with an order.
5617
5467
  *
5618
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5619
- */
5620
- interface SiteUrlChanged {
5621
- }
5622
- /**
5623
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5624
- * Consumed by other teams to remove relevant data.
5468
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5625
5469
  */
5626
- interface SitePurgedExternally {
5470
+ interface OrderTransactions {
5627
5471
  /**
5628
- * @maxLength 2048
5629
- * @maxSize 100
5630
- * @deprecated
5631
- * @targetRemovalDate 2025-04-15
5472
+ * Order ID.
5473
+ * @format GUID
5632
5474
  */
5633
- appDefId?: string[];
5634
- }
5635
- /** Assigned Odeditor */
5636
- interface OdeditorAssigned {
5637
- }
5638
- /** Unassigned Odeditor */
5639
- interface OdeditorUnassigned {
5640
- }
5641
- /** Assigned Picasso editor */
5642
- interface PicassoAssigned {
5643
- }
5644
- /** Unassigned Picasso */
5645
- interface PicassoUnassigned {
5646
- }
5647
- /** Assigned Wixel */
5648
- interface WixelAssigned {
5649
- }
5650
- /** Unassigned Wixel */
5651
- interface WixelUnassigned {
5652
- }
5653
- /** Assigned StudioTwo */
5654
- interface StudioTwoAssigned {
5655
- }
5656
- /** Unassigned StudioTwo */
5657
- interface StudioTwoUnassigned {
5658
- }
5659
- /** Media from user domain is enabled. */
5660
- interface UserDomainMediaEnabled {
5661
- }
5662
- /** Media from user domain is disabled. */
5663
- interface UserDomainMediaDisabled {
5664
- }
5665
- /** Assigned Editorless */
5666
- interface EditorlessAssigned {
5667
- }
5668
- /** Unassigned Editorless */
5669
- interface EditorlessUnassigned {
5670
- }
5671
- interface HasCustomEmailConfigurationsRequest {
5672
- }
5673
- interface HasCustomEmailConfigurationsResponse {
5674
- hasCustomConfigurations?: boolean;
5675
- }
5676
- interface AddToAutomationMigrationPopulationRequest {
5677
- /** When true, sends custom email configurations to automation system via email */
5678
- sendCustomEmailConfigs?: boolean;
5679
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5680
- origin?: OriginWithLiterals;
5681
- }
5682
- declare enum Origin {
5683
- OPT_IN = "OPT_IN",
5684
- MIGRATION = "MIGRATION"
5685
- }
5686
- /** @enumType */
5687
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5688
- interface AddToAutomationMigrationPopulationResponse {
5689
- success?: boolean;
5690
- }
5691
- interface IsInAutomationMigrationPopulationRequest {
5692
- }
5693
- interface IsInAutomationMigrationPopulationResponse {
5694
- inPopulation?: boolean;
5695
- }
5696
- interface PreparePaymentCollectionRequest {
5475
+ orderId?: string;
5697
5476
  /**
5698
- * Ecom order ID.
5699
- * @minLength 1
5700
- * @maxLength 100
5477
+ * Record of payments made to the merchant.
5478
+ * @maxSize 100
5701
5479
  */
5702
- ecomOrderId: string;
5703
- /** Amount to collect */
5704
- amount: Price;
5480
+ payments?: Payment[];
5705
5481
  /**
5706
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5707
- * Existing payment gateway order will be updated with a new amount.
5708
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5482
+ * Record of refunds made to the buyer.
5483
+ * @maxSize 300
5709
5484
  */
5710
- paymentGatewayOrderId?: string | null;
5485
+ refunds?: Refund[];
5486
+ }
5487
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5488
+ /** Regular payment details. */
5489
+ regularPaymentDetails?: RegularPaymentDetails;
5490
+ /** Gift card payment details. */
5491
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5492
+ /** Membership payment details. */
5493
+ membershipPaymentDetails?: MembershipPaymentDetails;
5711
5494
  /**
5712
- * Whether to delay capture of the payment.
5713
- * Default: false
5714
- * @deprecated Whether to delay capture of the payment.
5715
- * Default: false
5716
- * @replacedBy delayed_capture_settings.scheduled_action
5717
- * @targetRemovalDate 2024-09-30
5495
+ * Receipt created by Wix
5496
+ * @internal
5718
5497
  */
5719
- delayedCapture?: boolean;
5498
+ wixReceipt?: WixReceiptInfo;
5720
5499
  /**
5721
- * Specifies whether payment collection is initiated by Merchant or User of User
5722
- * Default: `true`
5500
+ * Receipt created by an external system.
5723
5501
  * @internal
5724
5502
  */
5725
- merchantInitiated?: boolean | null;
5503
+ externalReceipt?: ExternalReceiptInfo;
5504
+ /** @internal */
5505
+ canceled?: CanceledStatusDetails;
5506
+ /** @internal */
5507
+ declined?: DeclinedStatusDetails;
5508
+ /** @internal */
5509
+ voided?: VoidedStatusDetails;
5726
5510
  /**
5727
- * Redirect urls which are used to return buyer to third party system.
5728
- * @internal
5511
+ * Payment ID.
5512
+ * @format GUID
5513
+ * @readonly
5729
5514
  */
5730
- redirectUrls?: RedirectUrls;
5731
- /** Delayed capture payment settings */
5732
- delayedCaptureSettings?: DelayedCaptureSettings;
5733
- }
5734
- interface RedirectUrls {
5515
+ _id?: string | null;
5516
+ /** 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. */
5517
+ _createdDate?: Date | null;
5735
5518
  /**
5736
- * URL to redirect buyer in case of approved (successful) transaction
5737
- * @format WEB_URL
5519
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5520
+ * @readonly
5738
5521
  */
5739
- successUrl?: string | null;
5522
+ _updatedDate?: Date | null;
5523
+ /** Payment amount. */
5524
+ amount?: Price;
5740
5525
  /**
5741
- * URL to redirect buyer in case of buyer canceled the transaction
5742
- * @format WEB_URL
5526
+ * Whether refunds for this payment are disabled.
5527
+ * + `true`: This payment is not refundable.
5528
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5743
5529
  */
5744
- cancelUrl?: string | null;
5530
+ refundDisabled?: boolean;
5745
5531
  /**
5746
- * URL to redirect buyer in case of failed/rejected transaction
5747
- * @format WEB_URL
5532
+ * Whether receipt generation is allowed for this payment.
5533
+ * + `true`: This payment supports receipt generation.
5534
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5535
+ * @readonly
5748
5536
  */
5749
- errorUrl?: string | null;
5537
+ supportReceiptGeneration?: boolean;
5538
+ /** Details about cash rounding applied to this payment, when relevant. */
5539
+ cashRounding?: CashRoundingDetails;
5750
5540
  /**
5751
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5752
- * @format WEB_URL
5541
+ * Overall payment status.
5542
+ *
5543
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5753
5544
  */
5754
- pendingUrl?: string | null;
5755
- }
5756
- interface DelayedCaptureSettings {
5757
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5758
- scheduledAction?: ScheduledActionWithLiterals;
5759
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5760
- delayDuration?: Duration;
5761
- }
5762
- declare enum ScheduledAction {
5763
- /** Whether payment will be auto-voided when duration passes */
5764
- VOID = "VOID",
5765
- /** Whether payment will be auto-captured when duration passes */
5766
- CAPTURE = "CAPTURE"
5767
- }
5768
- /** @enumType */
5769
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5770
- interface Duration {
5545
+ status?: PaymentStatusWithLiterals;
5771
5546
  /**
5772
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5773
- * @min 1
5547
+ * Detailed payment status information including gateway reason codes and status-specific details.
5548
+ * @internal
5774
5549
  */
5775
- count?: number;
5776
- /** Duration unit: MINUTES, HOURS and DAYS */
5777
- unit?: DurationUnitWithLiterals;
5778
- }
5779
- declare enum DurationUnit {
5780
- MINUTES = "MINUTES",
5781
- HOURS = "HOURS",
5782
- DAYS = "DAYS"
5783
- }
5784
- /** @enumType */
5785
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5786
- interface PreparePaymentCollectionResponse {
5787
- /** Payment gateway order id which is associated with given payment */
5788
- paymentGatewayOrderId?: string;
5789
- }
5790
- interface GetPaymentCollectabilityStatusRequest {
5550
+ paymentStatusDetails?: PaymentStatusDetails;
5791
5551
  /**
5792
- * Ecom order ID.
5793
- * @minLength 1
5794
- * @maxLength 100
5552
+ * Location where the payment was processed.
5553
+ * @internal
5554
+ * @format GUID
5555
+ * @immutable
5795
5556
  */
5796
- ecomOrderId: string;
5557
+ locationId?: string | null;
5558
+ /**
5559
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5560
+ * @format GUID
5561
+ */
5562
+ chargeCorrelationId?: string | null;
5797
5563
  }
5798
- interface GetPaymentCollectabilityStatusResponse {
5799
- /** Payment collectability status */
5800
- status?: PaymentCollectabilityStatusWithLiterals;
5801
- /** Collectable order amount */
5802
- amount?: Price;
5564
+ /** @oneof */
5565
+ interface PaymentPaymentDetailsOneOf {
5566
+ /** Regular payment details. */
5567
+ regularPaymentDetails?: RegularPaymentDetails;
5568
+ /** Gift card payment details. */
5569
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5570
+ /** Membership payment details. */
5571
+ membershipPaymentDetails?: MembershipPaymentDetails;
5572
+ }
5573
+ /** @oneof */
5574
+ interface PaymentReceiptInfoOneOf {
5803
5575
  /**
5804
- * Whether authorization supported
5576
+ * Receipt created by Wix
5805
5577
  * @internal
5806
5578
  */
5807
- authorizationSupported?: boolean;
5579
+ wixReceipt?: WixReceiptInfo;
5808
5580
  /**
5809
- * Whether custom amount is supported for payment collection
5581
+ * Receipt created by an external system.
5810
5582
  * @internal
5811
5583
  */
5812
- customAmountSupported?: boolean;
5584
+ externalReceipt?: ExternalReceiptInfo;
5813
5585
  }
5814
- declare enum PaymentCollectabilityStatus {
5815
- UNKNOWN = "UNKNOWN",
5816
- COLLECTABLE = "COLLECTABLE",
5817
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5818
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5819
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5820
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5821
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5822
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5823
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5824
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5825
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5826
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5827
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5586
+ /** @oneof */
5587
+ interface PaymentStatusDetailsOneOf {
5588
+ /** @internal */
5589
+ canceled?: CanceledStatusDetails;
5590
+ /** @internal */
5591
+ declined?: DeclinedStatusDetails;
5592
+ /** @internal */
5593
+ voided?: VoidedStatusDetails;
5828
5594
  }
5829
- /** @enumType */
5830
- 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';
5831
- interface RecordManuallyCollectedPaymentRequest {
5595
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5596
+ /** Credit card details. */
5597
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5832
5598
  /**
5833
- * Order ID.
5834
- * @minLength 1
5599
+ * Wix Payments order ID.
5835
5600
  * @maxLength 100
5836
5601
  */
5837
- orderId: string;
5838
- /** Amount to be recorded as approved manual payment for given order */
5839
- amount: Price;
5602
+ paymentOrderId?: string | null;
5840
5603
  /**
5841
- * Payment method name provided by user.
5842
- *
5843
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5844
- * @internal
5604
+ * Payment gateway's transaction ID.
5605
+ * This field is only returned when the value of `offline_payment` is `false`.
5606
+ * @maxLength 100
5845
5607
  */
5846
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5847
- }
5848
- /**
5849
- * User-defined payment method name.
5850
- * Allows specifying either a predefined type or a custom name.
5851
- */
5852
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5853
- /** Predefined payment method. */
5854
- predefined?: PredefinedPaymentMethodWithLiterals;
5608
+ gatewayTransactionId?: string | null;
5855
5609
  /**
5856
- * Custom payment method name provided by user.
5857
- *
5858
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5859
- * @minLength 1
5610
+ * Payment method.
5611
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5612
+ * Non-exhaustive list of supported values:
5613
+ * + `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`
5860
5614
  * @maxLength 150
5615
+ * @deprecated Payment method.
5616
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5617
+ * Non-exhaustive list of supported values:
5618
+ * + `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`
5619
+ * @replacedBy payment_method_name
5620
+ * @targetRemovalDate 2026-07-01
5861
5621
  */
5862
- custom?: string | null;
5863
- }
5864
- /** @oneof */
5865
- interface UserDefinedPaymentMethodNameKindOneOf {
5866
- /** Predefined payment method. */
5867
- predefined?: PredefinedPaymentMethodWithLiterals;
5622
+ paymentMethod?: string | null;
5868
5623
  /**
5869
- * Custom payment method name provided by user.
5870
- *
5871
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5872
- * @minLength 1
5873
- * @maxLength 150
5624
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5625
+ * @maxLength 100
5874
5626
  */
5875
- custom?: string | null;
5876
- }
5877
- /** Predefined payment method types for offline/manual payments. */
5878
- declare enum PredefinedPaymentMethod {
5879
- /** Cash payment. */
5880
- CASH = "CASH",
5881
- /** Bank transfer. */
5882
- BANK_TRANSFER = "BANK_TRANSFER",
5883
- /** Payment by check. */
5884
- CHECK = "CHECK"
5885
- }
5886
- /** @enumType */
5887
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5888
- interface RecordManuallyCollectedPaymentResponse {
5889
- }
5890
- interface MarkOrderAsPaidRequest {
5627
+ providerTransactionId?: string | null;
5628
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5629
+ offlinePayment?: boolean;
5891
5630
  /**
5892
- * Ecom order ID.
5893
- * @minLength 1
5894
- * @maxLength 100
5631
+ * Payment status.
5632
+ * @deprecated Payment status.
5633
+ * @replacedBy payment.status
5634
+ * @targetRemovalDate 2026-11-01
5895
5635
  */
5896
- ecomOrderId: string;
5636
+ status?: TransactionStatusWithLiterals;
5637
+ /** Whether there is a payment agreement that allows for future charges. */
5638
+ savedPaymentMethod?: boolean;
5639
+ /** Authorization details. */
5640
+ authorizationDetails?: AuthorizationDetails;
5897
5641
  /**
5898
- * Payment method name provided by user.
5899
- *
5900
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5642
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5901
5643
  * @internal
5644
+ * @maxLength 300
5902
5645
  */
5903
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5904
- }
5905
- interface MarkOrderAsPaidResponse {
5906
- /** Updated order. */
5907
- order?: Order;
5908
- }
5909
- interface BulkMarkOrdersAsPaidRequest {
5646
+ paymentProvider?: string | null;
5910
5647
  /**
5911
- * IDs of orders to mark as paid.
5912
- * @minSize 1
5913
- * @maxSize 100
5914
- * @minLength 1
5915
- * @maxLength 100
5648
+ * Record of chargebacks made by the buyer.
5649
+ * @maxSize 6
5916
5650
  */
5917
- ecomOrderIds: string[];
5918
- }
5919
- interface BulkMarkOrdersAsPaidResponse {
5651
+ chargebacks?: Chargeback[];
5920
5652
  /**
5921
- * Items updated by the bulk action.
5922
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5653
+ * Payment method ID.
5654
+ * @internal
5655
+ * @maxLength 36
5923
5656
  */
5924
- results?: BulkOrderResult[];
5925
- /** Bulk action metadata. */
5926
- bulkActionMetadata?: BulkActionMetadata;
5927
- }
5928
- interface BulkOrderResult {
5929
- /** Item metadata. */
5930
- itemMetadata?: ItemMetadata;
5657
+ paymentMethodId?: string | null;
5658
+ /** Platform fee amount associated with this payment. */
5659
+ platformFee?: Price;
5931
5660
  /**
5932
- * Updated order.
5933
- *
5934
- * Returned when `returnFullEntity = true`.
5661
+ * Payment method with buyer and optional owner translations.
5662
+ * Non-exhaustive list of supported values:
5663
+ * + `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`
5935
5664
  */
5936
- item?: Order;
5937
- }
5938
- interface ItemMetadata {
5939
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5940
- _id?: string | null;
5941
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5942
- originalIndex?: number;
5943
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5944
- success?: boolean;
5945
- /** Details about the error in case of failure. */
5946
- error?: ApplicationError;
5665
+ paymentMethodName?: PaymentMethodName;
5947
5666
  }
5948
- interface ApplicationError {
5949
- /** Error code. */
5950
- code?: string;
5951
- /** Description of the error. */
5952
- description?: string;
5953
- /** Data related to the error. */
5954
- data?: Record<string, any> | null;
5667
+ /** @oneof */
5668
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5669
+ /** Credit card details. */
5670
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5955
5671
  }
5956
- interface BulkActionMetadata {
5957
- /** Number of items that were successfully processed. */
5958
- totalSuccesses?: number;
5959
- /** Number of items that couldn't be processed. */
5960
- totalFailures?: number;
5961
- /** Number of failures without details because detailed failure threshold was exceeded. */
5962
- undetailedFailures?: number;
5672
+ declare enum TransactionStatus {
5673
+ UNDEFINED = "UNDEFINED",
5674
+ APPROVED = "APPROVED",
5675
+ PENDING = "PENDING",
5676
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5677
+ CANCELED = "CANCELED",
5678
+ DECLINED = "DECLINED",
5679
+ REFUNDED = "REFUNDED",
5680
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5681
+ AUTHORIZED = "AUTHORIZED",
5682
+ VOIDED = "VOIDED"
5963
5683
  }
5964
- interface GetRefundabilityStatusRequest {
5684
+ /** @enumType */
5685
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5686
+ interface CreditCardPaymentMethodDetails {
5965
5687
  /**
5966
- * Order ID.
5967
- * @minLength 1
5688
+ * The last 4 digits of the card number.
5689
+ * @maxLength 4
5690
+ */
5691
+ lastFourDigits?: string | null;
5692
+ /**
5693
+ * Card issuer's brand.
5968
5694
  * @maxLength 100
5969
5695
  */
5970
- ecomOrderId: string;
5696
+ brand?: string | null;
5971
5697
  }
5972
- interface GetRefundabilityStatusResponse {
5698
+ interface AuthorizationDetails {
5973
5699
  /**
5974
- * Refundability details.
5975
- * @maxSize 300
5700
+ * Whether the authorized payment is of a delayed capture.
5701
+ * @readonly
5976
5702
  */
5977
- refundabilities?: Refundability[];
5703
+ delayedCapture?: boolean;
5704
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5705
+ authorizedDate?: Date | null;
5978
5706
  /**
5979
- * Whether the order supports refunding per item.
5980
- * @deprecated
5707
+ * List of captures associated with payment
5708
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5709
+ * @maxSize 1
5981
5710
  */
5982
- refundablePerItem?: boolean;
5983
- }
5984
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5985
- /** Reason why payment is not refundable. */
5986
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5987
- /** Reason why payment is only refundable manually. */
5988
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5989
- /** Payment ID. */
5990
- paymentId?: string;
5991
- /** Payment refundability status. */
5992
- refundabilityStatus?: RefundableStatusWithLiterals;
5993
- /** Link to payment provider dashboard. */
5994
- providerLink?: string | null;
5711
+ captures?: AuthorizationCapture[];
5712
+ /** Void associated with payment */
5713
+ void?: AuthorizationVoid;
5714
+ /** Scheduled action for this transaction */
5715
+ scheduledAction?: V1ScheduledAction;
5995
5716
  }
5996
- /** @oneof */
5997
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5998
- /** Reason why payment is not refundable. */
5999
- nonRefundableReason?: NonRefundableReasonWithLiterals;
6000
- /** Reason why payment is only refundable manually. */
6001
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5717
+ interface AuthorizationCapture {
5718
+ /**
5719
+ * Capture ID.
5720
+ * @format GUID
5721
+ * @readonly
5722
+ */
5723
+ _id?: string | null;
5724
+ /** Status of this capture action */
5725
+ status?: AuthorizationCaptureStatusWithLiterals;
5726
+ /**
5727
+ * Amount of this capture
5728
+ * @immutable
5729
+ */
5730
+ amount?: Price;
5731
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5732
+ _createdDate?: Date | null;
5733
+ /** In case of status is FAILED may contain failure details */
5734
+ failureDetails?: AuthorizationActionFailureDetails;
6002
5735
  }
6003
- declare enum RefundableStatus {
6004
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
6005
- MANUAL = "MANUAL",
6006
- REFUNDABLE = "REFUNDABLE"
5736
+ declare enum AuthorizationCaptureStatus {
5737
+ /** Capture operation still in progress. */
5738
+ PENDING = "PENDING",
5739
+ /** Capture operation succeeded. */
5740
+ SUCCEEDED = "SUCCEEDED",
5741
+ /** Capture operation failed. */
5742
+ FAILED = "FAILED"
6007
5743
  }
6008
5744
  /** @enumType */
6009
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
6010
- declare enum NonRefundableReason {
6011
- NONE = "NONE",
6012
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
6013
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
6014
- INTERNAL_ERROR = "INTERNAL_ERROR",
6015
- NOT_PAID = "NOT_PAID",
6016
- ACCESS_DENIED = "ACCESS_DENIED",
6017
- ZERO_PRICE = "ZERO_PRICE",
6018
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
6019
- PENDING_REFUND = "PENDING_REFUND",
6020
- FORBIDDEN = "FORBIDDEN",
6021
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
6022
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
6023
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5745
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5746
+ interface AuthorizationActionFailureDetails {
5747
+ /** @maxLength 100 */
5748
+ failureCode?: string;
5749
+ }
5750
+ interface AuthorizationVoid {
5751
+ /** Status of this void action */
5752
+ status?: AuthorizationVoidStatusWithLiterals;
5753
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5754
+ voidedDate?: Date | null;
5755
+ /** In case of status is FAILED may contain failure details */
5756
+ failureDetails?: AuthorizationActionFailureDetails;
5757
+ /** Reason of void action */
5758
+ reason?: ReasonWithLiterals;
5759
+ }
5760
+ declare enum AuthorizationVoidStatus {
5761
+ /** Void operation still in progress. */
5762
+ PENDING = "PENDING",
5763
+ /** Void operation succeeded. */
5764
+ SUCCEEDED = "SUCCEEDED",
5765
+ /** Void operation failed. */
5766
+ FAILED = "FAILED"
6024
5767
  }
6025
5768
  /** @enumType */
6026
- 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';
6027
- declare enum ManuallyRefundableReason {
6028
- EXPIRED = "EXPIRED",
6029
- NOT_SUPPORTED = "NOT_SUPPORTED",
6030
- OFFLINE = "OFFLINE",
6031
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5769
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5770
+ /** Reason the authorization was voided. */
5771
+ declare enum Reason {
5772
+ /** Authorization was voided by user. */
5773
+ MANUAL = "MANUAL",
5774
+ /** Authorization passed execution date. */
5775
+ SCHEDULED = "SCHEDULED"
6032
5776
  }
6033
5777
  /** @enumType */
6034
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
6035
- interface CreatePaymentGatewayOrderRequest {
6036
- /**
6037
- * Ecom order ID.
6038
- * @minLength 1
6039
- * @maxLength 100
6040
- */
6041
- ecomOrderId: string;
6042
- /** Information about the user who initiated the payment. */
6043
- chargedBy?: ChargedBy;
6044
- /**
6045
- * Whether to delay capture of the payment.
6046
- *
6047
- * Default: false
6048
- * @internal
6049
- */
6050
- delayedCapture?: boolean;
5778
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5779
+ interface V1ScheduledAction {
5780
+ /** Type of the action. */
5781
+ actionType?: ActionTypeWithLiterals;
5782
+ /** The date and time of the action. */
5783
+ executionDate?: Date | null;
6051
5784
  }
6052
- interface ChargedBy {
5785
+ declare enum ActionType {
5786
+ VOID = "VOID",
5787
+ CAPTURE = "CAPTURE"
5788
+ }
5789
+ /** @enumType */
5790
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5791
+ interface Chargeback {
6053
5792
  /**
6054
- * ID - id of the user who initiated the payment
5793
+ * Chargeback ID.
6055
5794
  * @format GUID
5795
+ * @readonly
5796
+ * @immutable
6056
5797
  */
6057
5798
  _id?: string;
6058
5799
  /**
6059
- * Full name - name of the user who initiated the payment
6060
- * @minLength 1
6061
- * @maxLength 200
5800
+ * 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.
5801
+ * @readonly
5802
+ * @immutable
6062
5803
  */
6063
- fullName?: string | null;
6064
- }
6065
- interface CreatePaymentGatewayOrderResponse {
6066
- /** ID of the order created in the payment gateway */
6067
- paymentGatewayOrderId?: string;
6068
- }
6069
- interface ChargeMembershipsRequest {
5804
+ _createdDate?: Date | null;
6070
5805
  /**
6071
- * Order ID.
6072
- * @minLength 1
6073
- * @maxLength 100
5806
+ * 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.
5807
+ * @readonly
6074
5808
  */
6075
- ecomOrderId: string;
5809
+ _updatedDate?: Date | null;
6076
5810
  /**
6077
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
6078
- * but a user which is using the membership on behalf of the a member
6079
- * @format GUID
5811
+ * Amount.
5812
+ * @readonly
5813
+ * @immutable
6080
5814
  */
6081
- memberId: string;
5815
+ amount?: Price;
6082
5816
  /**
6083
- * List of items to be paid by memberships
6084
- * @minSize 1
6085
- * @maxSize 300
5817
+ * Reversal amount. Present only when status is REVERSED.
5818
+ * @readonly
6086
5819
  */
6087
- membershipCharges?: MembershipChargeItem[];
6088
- }
6089
- interface MembershipChargeItem {
5820
+ reversalAmount?: Price;
6090
5821
  /**
6091
- * The id of used membership
6092
- * @minLength 1
6093
- * @maxLength 100
5822
+ * Status.
5823
+ *
5824
+ * Default: `"APPROVED"`.
6094
5825
  */
6095
- membershipId?: string;
5826
+ status?: ChargebackStatusWithLiterals;
6096
5827
  /**
6097
- * ID of the application providing this payment option
5828
+ * External chargeback ID.
6098
5829
  * @format GUID
5830
+ * @readonly
5831
+ * @immutable
6099
5832
  */
6100
- appId?: string;
6101
- /** The name of used membership */
6102
- membershipName?: MembershipName;
6103
- /** Additional data about this membership */
6104
- membershipAdditionalData?: Record<string, any> | null;
6105
- /** Catalog and item reference info. */
6106
- catalogReference?: CatalogReference;
6107
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
6108
- serviceProperties?: ServiceProperties;
6109
- /**
6110
- * Usually would be the same as catalogReference.catalogItemId
6111
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
6112
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
6113
- * @minLength 1
6114
- * @maxLength 36
6115
- */
6116
- rootCatalogItemId?: string | null;
5833
+ externalId?: string | null;
5834
+ }
5835
+ declare enum ChargebackStatus {
5836
+ /** Chargeback was approved. */
5837
+ APPROVED = "APPROVED",
5838
+ /** Chargeback was reversed. */
5839
+ REVERSED = "REVERSED"
5840
+ }
5841
+ /** @enumType */
5842
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5843
+ interface PaymentMethodName {
6117
5844
  /**
6118
- * line item id of Checkout/Order line item
6119
- * @minLength 1
6120
- * @maxLength 100
5845
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5846
+ * @maxLength 150
6121
5847
  */
6122
- lineItemId?: string;
6123
- }
6124
- interface MembershipName {
5848
+ buyerLanguageName?: string | null;
6125
5849
  /**
6126
- * Membership name in the site's original language.
6127
- * @maxLength 100
5850
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5851
+ *
5852
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5853
+ * @maxLength 150
6128
5854
  */
6129
- original?: string;
5855
+ siteLanguageName?: string | null;
6130
5856
  /**
6131
- * Membership name translated into the buyer's language.
5857
+ * User-provided payment method name.
6132
5858
  *
6133
- * Default: The value of `original`
6134
- * @maxLength 100
5859
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6135
5860
  */
6136
- translated?: string | null;
6137
- }
6138
- interface ChargeMembershipsResponse {
5861
+ userDefinedName?: UserDefinedPaymentMethodName;
6139
5862
  }
6140
- interface TriggerRefundRequest {
5863
+ interface GiftCardPaymentDetails {
6141
5864
  /**
6142
- * The order this refund related to
6143
- * @minLength 1
5865
+ * Gift card payment ID.
6144
5866
  * @maxLength 100
6145
5867
  */
6146
- ecomOrderId: string;
5868
+ giftCardPaymentId?: string;
6147
5869
  /**
6148
- * Refund operations information
6149
- * @minSize 1
6150
- * @maxSize 1
5870
+ * Gift card ID.
5871
+ * @internal
5872
+ * @deprecated
6151
5873
  */
6152
- payments: PaymentRefund[];
6153
- /** Business model of a refund */
6154
- details?: RefundDetails;
6155
- /** Side effect details related to refund */
6156
- sideEffects?: RefundSideEffects;
6157
- }
6158
- interface PaymentRefund {
5874
+ giftCardId?: string;
6159
5875
  /**
6160
- * Specific payment within the order to refund
5876
+ * ID of the app that created the gift card.
6161
5877
  * @format GUID
6162
5878
  */
6163
- paymentId?: string;
6164
- /** Refund amount. Not relevant for membership and gift card refunds. */
6165
- amount?: Price;
5879
+ appId?: string;
6166
5880
  /**
6167
- * Whether refund is made externally and manually (on the payment provider's side)
6168
- * 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.
6169
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5881
+ * Whether the gift card is voided.
5882
+ * @readonly
5883
+ * @deprecated Whether the gift card is voided.
5884
+ * @replacedBy payment.status
5885
+ * @targetRemovalDate 2026-11-01
6170
5886
  */
6171
- externalRefund?: boolean;
5887
+ voided?: boolean;
6172
5888
  /**
6173
- * Gateway refund id. When param is present, new refund is not created.
6174
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6175
- * and all side effects from request will be executed.
6176
- * @internal
5889
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5890
+ * @maxLength 30
5891
+ * @immutable
5892
+ */
5893
+ obfuscatedCode?: string | null;
5894
+ }
5895
+ interface MembershipPaymentDetails {
5896
+ /**
5897
+ * Membership ID.
5898
+ * @maxLength 200
5899
+ */
5900
+ membershipId?: string;
5901
+ /**
5902
+ * ID of the line item this membership applies to.
6177
5903
  * @minLength 1
6178
5904
  * @maxLength 100
6179
5905
  */
6180
- gatewayRefundId?: string | null;
6181
- }
6182
- interface RefundSideEffects {
6183
- /** Inventory restock details as part of this refund. */
6184
- restockInfo?: RestockInfo;
6185
- /** Whether to send a refund confirmation email to the customer. */
6186
- sendOrderRefundedEmail?: boolean;
5906
+ lineItemId?: string;
6187
5907
  /**
6188
- * Custom message added to the refund confirmation email.
5908
+ * Payment status.
5909
+ * @deprecated Payment status.
5910
+ * @replacedBy payment.status
5911
+ * @targetRemovalDate 2026-11-01
5912
+ */
5913
+ status?: MembershipPaymentStatusWithLiterals;
5914
+ /** Membership name. */
5915
+ name?: MembershipName;
5916
+ /**
5917
+ * The transaction ID in the membership system. Can be used to void the transaction.
6189
5918
  * @minLength 1
6190
- * @maxLength 1000
5919
+ * @maxLength 100
6191
5920
  */
6192
- customMessage?: string | null;
6193
- }
6194
- interface RestockInfo {
6195
- /** Restock type. */
6196
- type?: RestockTypeWithLiterals;
5921
+ externalTransactionId?: string | null;
6197
5922
  /**
6198
- * Deprecated, use items instead
6199
- * @internal
6200
- * @maxSize 300
6201
- * @deprecated
5923
+ * Whether the membership is voided.
5924
+ * @readonly
5925
+ * @deprecated Whether the membership is voided.
5926
+ * @replacedBy payment.status
5927
+ * @targetRemovalDate 2026-11-01
6202
5928
  */
6203
- lineItemIds?: string[];
5929
+ voided?: boolean;
6204
5930
  /**
6205
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6206
- * @maxSize 300
5931
+ * ID of the application providing this payment option.
5932
+ * @format GUID
6207
5933
  */
6208
- items?: RestockItem[];
5934
+ providerAppId?: string;
5935
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5936
+ futureMembership?: FutureMembershipDetails;
6209
5937
  }
6210
- declare enum RestockType {
6211
- NO_ITEMS = "NO_ITEMS",
6212
- ALL_ITEMS = "ALL_ITEMS",
6213
- SOME_ITEMS = "SOME_ITEMS"
5938
+ declare enum MembershipPaymentStatus {
5939
+ /** Payment was charged. */
5940
+ CHARGED = "CHARGED",
5941
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5942
+ CHARGE_FAILED = "CHARGE_FAILED",
5943
+ /** Payment is pending. */
5944
+ CHARGE_PENDING = "CHARGE_PENDING",
5945
+ /** Payment was voided. */
5946
+ VOIDED = "VOIDED"
6214
5947
  }
6215
5948
  /** @enumType */
6216
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6217
- interface RestockItem {
5949
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5950
+ interface FutureMembershipDetails {
6218
5951
  /**
6219
- * ID of the line item being restocked.
5952
+ * ID of the plan line item in the order from which the membership will be created.
6220
5953
  * @format GUID
6221
5954
  */
6222
5955
  lineItemId?: string;
6223
5956
  /**
6224
- * Line item quantity being restocked.
6225
- * @min 1
6226
- * @max 100000
5957
+ * ID of the benefit the future membership will grant.
5958
+ * @maxLength 200
6227
5959
  */
6228
- quantity?: number;
5960
+ benefitId?: string;
5961
+ }
5962
+ interface WixReceiptInfo {
6229
5963
  /**
6230
- * Per-location breakdown of restock quantities.
6231
- * @internal
6232
- * @maxSize 5
5964
+ * Receipt ID
5965
+ * @format GUID
6233
5966
  */
6234
- restockLocations?: RestockLocation[];
6235
- }
6236
- interface TriggerRefundResponse {
6237
- /** All order's transactions after the refunds were added */
6238
- orderTransactions?: OrderTransactions;
6239
- /** Created refund ID */
6240
- refundId?: string | null;
6241
- /** Payment ID's that the refund execution had failed for */
6242
- failedPaymentIds?: ItemMetadata[];
5967
+ receiptId?: string;
5968
+ /**
5969
+ * Display number of receipt
5970
+ * @minLength 1
5971
+ * @maxLength 40
5972
+ */
5973
+ displayNumber?: string | null;
6243
5974
  }
6244
- /**
6245
- * A record of all payments and refunds associated with an order.
6246
- *
6247
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6248
- */
6249
- interface OrderTransactions {
5975
+ interface ExternalReceiptInfo {
6250
5976
  /**
6251
- * Order ID.
5977
+ * External receipt ID
5978
+ * @maxLength 100
5979
+ */
5980
+ receiptId?: string | null;
5981
+ /**
5982
+ * ID of the app providing the receipt
6252
5983
  * @format GUID
6253
5984
  */
6254
- orderId?: string;
5985
+ appId?: string | null;
6255
5986
  /**
6256
- * Record of payments made to the merchant.
6257
- * @maxSize 100
5987
+ * Display number of receipt
5988
+ * @minLength 1
5989
+ * @maxLength 40
6258
5990
  */
6259
- payments?: Payment[];
5991
+ displayNumber?: string | null;
5992
+ }
5993
+ interface CashRoundingDetails {
6260
5994
  /**
6261
- * Record of refunds made to the buyer.
6262
- * @maxSize 300
5995
+ * Payment amount before cash rounding was applied.
5996
+ * When provided, balance and status calculations use this value instead of `amount`
5997
+ * to prevent false overpayment or underpayment due to rounding.
6263
5998
  */
6264
- refunds?: Refund[];
5999
+ unroundedAmount?: Price;
6000
+ /**
6001
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6002
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6003
+ * @readonly
6004
+ */
6005
+ roundingAdjustment?: CashRounding;
6006
+ }
6007
+ declare enum PaymentStatus {
6008
+ /** Payment was charged successfully. */
6009
+ APPROVED = "APPROVED",
6010
+ /** Payment is being processed and hasn't been confirmed yet. */
6011
+ PENDING = "PENDING",
6012
+ /** 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. */
6013
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6014
+ /** Payment was canceled before it was charged. */
6015
+ CANCELED = "CANCELED",
6016
+ /** Payment was declined by the payment provider. */
6017
+ DECLINED = "DECLINED",
6018
+ /** Payment was fully refunded. */
6019
+ REFUNDED = "REFUNDED",
6020
+ /** Part of the payment amount was refunded. */
6021
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6022
+ /** 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. */
6023
+ AUTHORIZED = "AUTHORIZED",
6024
+ /**
6025
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6026
+ *
6027
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6028
+ */
6029
+ VOIDED = "VOIDED"
6030
+ }
6031
+ /** @enumType */
6032
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6033
+ interface CanceledStatusDetails {
6034
+ reason?: CanceledReasonWithLiterals;
6035
+ }
6036
+ declare enum CanceledReason {
6037
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6038
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6039
+ /** Payment was not completed by user and expired. */
6040
+ EXPIRED = "EXPIRED"
6041
+ }
6042
+ /** @enumType */
6043
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6044
+ interface DeclinedStatusDetails {
6045
+ reason?: DeclinedReasonWithLiterals;
6046
+ }
6047
+ declare enum DeclinedReason {
6048
+ /** Corresponding charge failed. */
6049
+ CHARGE_FAILED = "CHARGE_FAILED",
6050
+ /** Payment details expired. */
6051
+ EXPIRED = "EXPIRED",
6052
+ /** Insufficient funds. */
6053
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6054
+ /** Gift card was disabled before charge was attempted. */
6055
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6056
+ }
6057
+ /** @enumType */
6058
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6059
+ interface VoidedStatusDetails {
6060
+ reason?: VoidedReasonWithLiterals;
6265
6061
  }
6266
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6267
- /** Regular payment details. */
6268
- regularPaymentDetails?: RegularPaymentDetails;
6269
- /** Gift card payment details. */
6270
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6271
- /** Membership payment details. */
6272
- membershipPaymentDetails?: MembershipPaymentDetails;
6273
- /**
6274
- * Receipt created by Wix
6275
- * @internal
6276
- */
6277
- wixReceipt?: WixReceiptInfo;
6062
+ declare enum VoidedReason {
6063
+ /** Payment was voided by merchant request. */
6064
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6065
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6066
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6067
+ }
6068
+ /** @enumType */
6069
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6070
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6071
+ /** @internal */
6072
+ canceled?: CanceledStatusDetails;
6073
+ /** @internal */
6074
+ declined?: DeclinedStatusDetails;
6075
+ /** @internal */
6076
+ voided?: VoidedStatusDetails;
6278
6077
  /**
6279
- * Receipt created by an external system.
6078
+ * Reason code from the payment gateway.
6280
6079
  * @internal
6080
+ * @minLength 1
6081
+ * @maxLength 10
6281
6082
  */
6282
- externalReceipt?: ExternalReceiptInfo;
6083
+ paymentGatewayReasonCode?: string | null;
6084
+ }
6085
+ /** @oneof */
6086
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6283
6087
  /** @internal */
6284
6088
  canceled?: CanceledStatusDetails;
6285
6089
  /** @internal */
6286
6090
  declined?: DeclinedStatusDetails;
6287
6091
  /** @internal */
6288
6092
  voided?: VoidedStatusDetails;
6093
+ }
6094
+ interface Refund {
6289
6095
  /**
6290
- * Payment ID.
6096
+ * Refund ID.
6291
6097
  * @format GUID
6292
6098
  * @readonly
6293
6099
  */
6294
- _id?: string | null;
6295
- /** 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. */
6296
- _createdDate?: Date | null;
6100
+ _id?: string;
6297
6101
  /**
6298
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6102
+ * List of transactions.
6103
+ * @maxSize 50
6104
+ */
6105
+ transactions?: RefundTransaction[];
6106
+ /** Refund business details. */
6107
+ details?: RefundDetails;
6108
+ /**
6109
+ * 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.
6299
6110
  * @readonly
6111
+ * @immutable
6300
6112
  */
6301
- _updatedDate?: Date | null;
6302
- /** Payment amount. */
6303
- amount?: Price;
6113
+ _createdDate?: Date | null;
6304
6114
  /**
6305
- * Whether refunds for this payment are disabled.
6306
- * + `true`: This payment is not refundable.
6307
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6115
+ * Aggregated refund summary.
6116
+ *
6117
+ * 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.
6118
+ * @readonly
6308
6119
  */
6309
- refundDisabled?: boolean;
6120
+ summary?: AggregatedRefundSummary;
6310
6121
  /**
6311
- * Whether receipt generation is allowed for this payment.
6312
- * + `true`: This payment supports receipt generation.
6313
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6122
+ * ID of the app that initiated this refund.
6123
+ * @format GUID
6314
6124
  * @readonly
6125
+ * @immutable
6315
6126
  */
6316
- supportReceiptGeneration?: boolean;
6317
- /** Details about cash rounding applied to this payment, when relevant. */
6318
- cashRounding?: CashRoundingDetails;
6127
+ requestingServiceAppId?: string | null;
6128
+ }
6129
+ interface RefundTransaction {
6319
6130
  /**
6320
- * Overall payment status.
6321
- *
6322
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6131
+ * ID of the payment associated with this refund.
6132
+ * @format GUID
6133
+ * @immutable
6323
6134
  */
6324
- status?: PaymentStatusWithLiterals;
6135
+ paymentId?: string;
6325
6136
  /**
6326
- * Detailed payment status information including gateway reason codes and status-specific details.
6327
- * @internal
6137
+ * Refund amount.
6138
+ * @immutable
6328
6139
  */
6329
- paymentStatusDetails?: PaymentStatusDetails;
6140
+ amount?: Price;
6141
+ /** Refund status. */
6142
+ refundStatus?: RefundStatusWithLiterals;
6143
+ /** Optional details of current refund status. */
6144
+ refundStatusInfo?: RefundStatusInfo;
6330
6145
  /**
6331
- * Location where the payment was processed.
6332
- * @internal
6146
+ * Payment gateway's refund ID.
6147
+ * This field is only returned when the value of `external_refund` is `false`.
6333
6148
  * @format GUID
6149
+ */
6150
+ gatewayRefundId?: string | null;
6151
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6152
+ providerRefundId?: string | null;
6153
+ /**
6154
+ * Whether refund was made externally and manually on the payment provider's side.
6334
6155
  * @immutable
6335
6156
  */
6336
- locationId?: string | null;
6157
+ externalRefund?: boolean;
6337
6158
  /**
6338
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6159
+ * Location where the refund was processed.
6160
+ * @internal
6339
6161
  * @format GUID
6162
+ * @immutable
6340
6163
  */
6341
- chargeCorrelationId?: string | null;
6164
+ locationId?: string | null;
6342
6165
  }
6343
- /** @oneof */
6344
- interface PaymentPaymentDetailsOneOf {
6345
- /** Regular payment details. */
6346
- regularPaymentDetails?: RegularPaymentDetails;
6347
- /** Gift card payment details. */
6348
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6349
- /** Membership payment details. */
6350
- membershipPaymentDetails?: MembershipPaymentDetails;
6166
+ /** Refund transaction status. */
6167
+ declare enum RefundStatus {
6168
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6169
+ PENDING = "PENDING",
6170
+ /** Refund transaction succeeded. */
6171
+ SUCCEEDED = "SUCCEEDED",
6172
+ /** Refund transaction failed. */
6173
+ FAILED = "FAILED",
6174
+ /** Refund request acknowledged, and will be executed soon. */
6175
+ SCHEDULED = "SCHEDULED",
6176
+ /** Refund was initiated on payment provider side. */
6177
+ STARTED = "STARTED"
6351
6178
  }
6352
- /** @oneof */
6353
- interface PaymentReceiptInfoOneOf {
6179
+ /** @enumType */
6180
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6181
+ interface RefundStatusInfo {
6354
6182
  /**
6355
- * Receipt created by Wix
6356
- * @internal
6183
+ * Reason code for the refund's current status.
6184
+ *
6185
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6186
+ * @minLength 1
6187
+ * @maxLength 10
6357
6188
  */
6358
- wixReceipt?: WixReceiptInfo;
6189
+ paymentGatewayReasonCode?: string | null;
6359
6190
  /**
6360
- * Receipt created by an external system.
6361
- * @internal
6191
+ * Free text explanation of current refund status.
6192
+ * @minLength 1
6193
+ * @maxLength 1000
6362
6194
  */
6363
- externalReceipt?: ExternalReceiptInfo;
6195
+ description?: string | null;
6364
6196
  }
6365
- /** @oneof */
6366
- interface PaymentStatusDetailsOneOf {
6367
- /** @internal */
6368
- canceled?: CanceledStatusDetails;
6369
- /** @internal */
6370
- declined?: DeclinedStatusDetails;
6371
- /** @internal */
6372
- voided?: VoidedStatusDetails;
6197
+ interface AggregatedRefundSummary {
6198
+ /** Total amount requested for refund. */
6199
+ requestedRefund?: Price;
6200
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6201
+ pendingRefund?: Price;
6202
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6203
+ refunded?: Price;
6204
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6205
+ failedRefundAmount?: Price;
6206
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6207
+ pending?: boolean;
6208
+ /** Breakdown of refunded items. Available only after refund is complete. */
6209
+ breakdown?: RefundItemsBreakdown;
6373
6210
  }
6374
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6375
- /** Credit card details. */
6376
- creditCardDetails?: CreditCardPaymentMethodDetails;
6211
+ interface RefundItemsBreakdown {
6377
6212
  /**
6378
- * Wix Payments order ID.
6379
- * @maxLength 100
6213
+ * Refunded line items and the amount refunded for each.
6214
+ * @maxSize 300
6380
6215
  */
6381
- paymentOrderId?: string | null;
6216
+ lineItems?: LineItemRefundSummary[];
6217
+ }
6218
+ interface LineItemRefundSummary {
6382
6219
  /**
6383
- * Payment gateway's transaction ID.
6384
- * This field is only returned when the value of `offline_payment` is `false`.
6220
+ * ID of the refunded line item.
6221
+ * @format GUID
6222
+ */
6223
+ lineItemId?: string;
6224
+ /** Total refunded amount for the line item. */
6225
+ totalRefundedAmount?: Price;
6226
+ }
6227
+ interface CalculateRefundRequest {
6228
+ /**
6229
+ * Order ID
6230
+ * @minLength 1
6385
6231
  * @maxLength 100
6386
6232
  */
6387
- gatewayTransactionId?: string | null;
6233
+ ecomOrderId?: string;
6388
6234
  /**
6389
- * Payment method.
6390
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6391
- * Non-exhaustive list of supported values:
6392
- * + `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`
6393
- * @maxLength 150
6394
- * @deprecated Payment method.
6395
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6396
- * Non-exhaustive list of supported values:
6397
- * + `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`
6398
- * @replacedBy payment_method_name
6399
- * @targetRemovalDate 2026-07-01
6235
+ * Refunded line items and quantity
6236
+ * @maxSize 300
6237
+ */
6238
+ refundItems?: CalculateRefundItemRequest[];
6239
+ /** Should include shipping in refund calculation */
6240
+ refundShipping?: boolean;
6241
+ }
6242
+ interface CalculateRefundItemRequest {
6243
+ /**
6244
+ * ID of the line item being refunded
6245
+ * @format GUID
6246
+ */
6247
+ _id?: string;
6248
+ /**
6249
+ * How much of that line item is being refunded
6250
+ * @min 1
6251
+ * @max 100000
6252
+ */
6253
+ quantity?: number;
6254
+ }
6255
+ interface CalculateRefundResponse {
6256
+ /** Total refundable amount */
6257
+ total?: Price;
6258
+ /** Tax cost of the order */
6259
+ tax?: Price;
6260
+ /** Discount given for this order */
6261
+ discount?: Price;
6262
+ /** Total cost of the order (without tax) */
6263
+ subtotal?: Price;
6264
+ /** Total shipping cost for order */
6265
+ shipping?: Price;
6266
+ /** Previous refund given on that order */
6267
+ previouslyRefundedAmount?: Price;
6268
+ /**
6269
+ * The refundable items of that order
6270
+ * @maxSize 300
6271
+ */
6272
+ items?: CalculateRefundItemResponse[];
6273
+ }
6274
+ interface CalculateRefundItemResponse {
6275
+ /**
6276
+ * Line item ID
6277
+ * @format GUID
6400
6278
  */
6401
- paymentMethod?: string | null;
6279
+ _id?: string;
6280
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6281
+ price?: Price;
6282
+ }
6283
+ interface VoidAuthorizedPaymentsRequest {
6402
6284
  /**
6403
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6285
+ * Wix eCommerce order ID
6286
+ * @minLength 1
6404
6287
  * @maxLength 100
6405
6288
  */
6406
- providerTransactionId?: string | null;
6407
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6408
- offlinePayment?: boolean;
6289
+ ecomOrderId: string;
6409
6290
  /**
6410
- * Payment status.
6411
- * @deprecated Payment status.
6412
- * @replacedBy payment.status
6413
- * @targetRemovalDate 2026-11-01
6291
+ * Payment IDs
6292
+ * @minSize 1
6293
+ * @maxSize 100
6294
+ * @format GUID
6414
6295
  */
6415
- status?: TransactionStatusWithLiterals;
6416
- /** Whether there is a payment agreement that allows for future charges. */
6417
- savedPaymentMethod?: boolean;
6418
- /** Authorization details. */
6419
- authorizationDetails?: AuthorizationDetails;
6296
+ paymentIds: string[];
6297
+ }
6298
+ interface VoidAuthorizedPaymentsResponse {
6299
+ /** All order's transactions after the void was triggered */
6300
+ orderTransactions?: OrderTransactions;
6301
+ }
6302
+ interface CaptureAuthorizedPaymentsRequest {
6420
6303
  /**
6421
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6422
- * @internal
6423
- * @maxLength 300
6304
+ * Wix eCommerce order ID
6305
+ * @minLength 1
6306
+ * @maxLength 100
6424
6307
  */
6425
- paymentProvider?: string | null;
6308
+ ecomOrderId: string;
6426
6309
  /**
6427
- * Record of chargebacks made by the buyer.
6428
- * @maxSize 6
6310
+ * Capture payments information
6311
+ * @minSize 1
6312
+ * @maxSize 100
6429
6313
  */
6430
- chargebacks?: Chargeback[];
6314
+ payments: PaymentCapture[];
6315
+ }
6316
+ interface PaymentCapture {
6431
6317
  /**
6432
- * Payment method ID.
6433
- * @internal
6434
- * @maxLength 36
6318
+ * Payment ID
6319
+ * @format GUID
6435
6320
  */
6436
- paymentMethodId?: string | null;
6437
- /** Platform fee amount associated with this payment. */
6438
- platformFee?: Price;
6321
+ paymentId?: string | null;
6439
6322
  /**
6440
- * Payment method with buyer and optional owner translations.
6441
- * Non-exhaustive list of supported values:
6442
- * + `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`
6323
+ * Capture amount.
6324
+ * If not provided - full authorized amount will be captured.
6443
6325
  */
6444
- paymentMethodName?: PaymentMethodName;
6445
- }
6446
- /** @oneof */
6447
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6448
- /** Credit card details. */
6449
- creditCardDetails?: CreditCardPaymentMethodDetails;
6326
+ amount?: Price;
6450
6327
  }
6451
- declare enum TransactionStatus {
6452
- UNDEFINED = "UNDEFINED",
6453
- APPROVED = "APPROVED",
6454
- PENDING = "PENDING",
6455
- PENDING_MERCHANT = "PENDING_MERCHANT",
6456
- CANCELED = "CANCELED",
6457
- DECLINED = "DECLINED",
6458
- REFUNDED = "REFUNDED",
6459
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6460
- AUTHORIZED = "AUTHORIZED",
6461
- VOIDED = "VOIDED"
6328
+ interface CaptureAuthorizedPaymentsResponse {
6329
+ /** All order's transactions after the capture was triggered */
6330
+ orderTransactions?: OrderTransactions;
6462
6331
  }
6463
- /** @enumType */
6464
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6465
- interface CreditCardPaymentMethodDetails {
6466
- /**
6467
- * The last 4 digits of the card number.
6468
- * @maxLength 4
6469
- */
6470
- lastFourDigits?: string | null;
6332
+ interface ChargeSavedPaymentMethodRequest {
6471
6333
  /**
6472
- * Card issuer's brand.
6334
+ * Ecom Order ID.
6335
+ * @minLength 1
6473
6336
  * @maxLength 100
6474
6337
  */
6475
- brand?: string | null;
6338
+ ecomOrderId?: string;
6339
+ /** Amount to be charged */
6340
+ amount?: Price;
6476
6341
  }
6477
- interface AuthorizationDetails {
6478
- /**
6479
- * Whether the authorized payment is of a delayed capture.
6480
- * @readonly
6481
- */
6482
- delayedCapture?: boolean;
6483
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6484
- authorizedDate?: Date | null;
6342
+ interface ChargeSavedPaymentMethodResponse {
6343
+ /** Payment gateway's order ID (e.g Wix Payments) */
6344
+ paymentGatewayOrderId?: string;
6345
+ }
6346
+ interface SendBuyerConfirmationEmailRequest {
6347
+ /** @format GUID */
6348
+ orderId?: string;
6349
+ }
6350
+ interface SendBuyerConfirmationEmailResponse {
6351
+ }
6352
+ interface SendBuyerPaymentsReceivedEmailRequest {
6485
6353
  /**
6486
- * List of captures associated with payment
6487
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6488
- * @maxSize 1
6354
+ * @minLength 1
6355
+ * @maxLength 100
6489
6356
  */
6490
- captures?: AuthorizationCapture[];
6491
- /** Void associated with payment */
6492
- void?: AuthorizationVoid;
6493
- /** Scheduled action for this transaction */
6494
- scheduledAction?: V1ScheduledAction;
6357
+ orderId?: string;
6495
6358
  }
6496
- interface AuthorizationCapture {
6359
+ interface SendBuyerPaymentsReceivedEmailResponse {
6360
+ }
6361
+ interface SendBuyerPickupConfirmationEmailRequest {
6497
6362
  /**
6498
- * Capture ID.
6499
- * @format GUID
6500
- * @readonly
6363
+ * @minLength 1
6364
+ * @maxLength 100
6501
6365
  */
6502
- _id?: string | null;
6503
- /** Status of this capture action */
6504
- status?: AuthorizationCaptureStatusWithLiterals;
6366
+ orderId?: string;
6367
+ }
6368
+ interface SendBuyerPickupConfirmationEmailResponse {
6369
+ }
6370
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
6505
6371
  /**
6506
- * Amount of this capture
6507
- * @immutable
6372
+ * IDs of orders to send pickup emails for.
6373
+ * @minSize 1
6374
+ * @maxSize 300
6508
6375
  */
6509
- amount?: Price;
6510
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6511
- _createdDate?: Date | null;
6512
- /** In case of status is FAILED may contain failure details */
6513
- failureDetails?: AuthorizationActionFailureDetails;
6376
+ orderIds?: string[];
6514
6377
  }
6515
- declare enum AuthorizationCaptureStatus {
6516
- /** Capture operation still in progress. */
6517
- PENDING = "PENDING",
6518
- /** Capture operation succeeded. */
6519
- SUCCEEDED = "SUCCEEDED",
6520
- /** Capture operation failed. */
6521
- FAILED = "FAILED"
6378
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
6522
6379
  }
6523
- /** @enumType */
6524
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6525
- interface AuthorizationActionFailureDetails {
6526
- /** @maxLength 100 */
6527
- failureCode?: string;
6380
+ interface SendBuyerShippingConfirmationEmailRequest {
6381
+ /**
6382
+ * @minLength 1
6383
+ * @maxLength 100
6384
+ */
6385
+ orderId?: string;
6528
6386
  }
6529
- interface AuthorizationVoid {
6530
- /** Status of this void action */
6531
- status?: AuthorizationVoidStatusWithLiterals;
6532
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6533
- voidedDate?: Date | null;
6534
- /** In case of status is FAILED may contain failure details */
6535
- failureDetails?: AuthorizationActionFailureDetails;
6536
- /** Reason of void action */
6537
- reason?: ReasonWithLiterals;
6387
+ interface SendBuyerShippingConfirmationEmailResponse {
6538
6388
  }
6539
- declare enum AuthorizationVoidStatus {
6540
- /** Void operation still in progress. */
6541
- PENDING = "PENDING",
6542
- /** Void operation succeeded. */
6543
- SUCCEEDED = "SUCCEEDED",
6544
- /** Void operation failed. */
6545
- FAILED = "FAILED"
6389
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
6390
+ /**
6391
+ * IDs of orders to send pickup emails for.
6392
+ * @minSize 1
6393
+ * @maxSize 300
6394
+ */
6395
+ orderIds?: string[];
6546
6396
  }
6547
- /** @enumType */
6548
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6549
- /** Reason the authorization was voided. */
6550
- declare enum Reason {
6551
- /** Authorization was voided by user. */
6552
- MANUAL = "MANUAL",
6553
- /** Authorization passed execution date. */
6554
- SCHEDULED = "SCHEDULED"
6397
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
6555
6398
  }
6556
- /** @enumType */
6557
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6558
- interface V1ScheduledAction {
6559
- /** Type of the action. */
6560
- actionType?: ActionTypeWithLiterals;
6561
- /** The date and time of the action. */
6562
- executionDate?: Date | null;
6399
+ interface SendMerchantOrderReceivedNotificationRequest {
6400
+ /**
6401
+ * @minLength 1
6402
+ * @maxLength 100
6403
+ */
6404
+ orderId?: string;
6563
6405
  }
6564
- declare enum ActionType {
6565
- VOID = "VOID",
6566
- CAPTURE = "CAPTURE"
6406
+ interface SendMerchantOrderReceivedNotificationResponse {
6567
6407
  }
6568
- /** @enumType */
6569
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6570
- interface Chargeback {
6408
+ interface SendCancelRefundEmailRequest {
6571
6409
  /**
6572
- * Chargeback ID.
6573
- * @format GUID
6574
- * @readonly
6575
- * @immutable
6410
+ * The ID of order that is canceled/refunded
6411
+ * @minLength 1
6412
+ * @maxLength 100
6576
6413
  */
6577
- _id?: string;
6414
+ orderId?: string;
6578
6415
  /**
6579
- * 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.
6580
- * @readonly
6581
- * @immutable
6416
+ * Personal note added to the email (optional)
6417
+ * @minLength 1
6418
+ * @maxLength 1000
6582
6419
  */
6583
- _createdDate?: Date | null;
6420
+ customMessage?: string | null;
6421
+ /** Refund amount */
6422
+ refundAmount?: Price;
6584
6423
  /**
6585
- * 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.
6586
- * @readonly
6424
+ * Refund ID. (Optional)
6425
+ * @format GUID
6587
6426
  */
6588
- _updatedDate?: Date | null;
6427
+ refundId?: string | null;
6428
+ }
6429
+ interface SendCancelRefundEmailResponse {
6430
+ }
6431
+ interface SendRefundEmailRequest {
6589
6432
  /**
6590
- * Amount.
6591
- * @readonly
6592
- * @immutable
6433
+ * The ID of order that is refunded
6434
+ * @format GUID
6593
6435
  */
6594
- amount?: Price;
6436
+ orderId?: string;
6595
6437
  /**
6596
- * Reversal amount. Present only when status is REVERSED.
6597
- * @readonly
6438
+ * Refund ID
6439
+ * @format GUID
6598
6440
  */
6599
- reversalAmount?: Price;
6441
+ refundId?: string;
6600
6442
  /**
6601
- * Status.
6602
- *
6603
- * Default: `"APPROVED"`.
6443
+ * Personal note added to the email (optional)
6444
+ * @minLength 1
6445
+ * @maxLength 1000
6604
6446
  */
6605
- status?: ChargebackStatusWithLiterals;
6447
+ customMessage?: string | null;
6448
+ }
6449
+ interface SendRefundEmailResponse {
6450
+ }
6451
+ interface SendFulfillmentEmailRequest {
6452
+ /** @format GUID */
6453
+ orderId?: string;
6454
+ /** @format GUID */
6455
+ fulfillerId?: string;
6456
+ }
6457
+ interface SendFulfillmentEmailResponse {
6458
+ }
6459
+ interface SendMerchantOrderReceivedPushRequest {
6606
6460
  /**
6607
- * External chargeback ID.
6608
- * @format GUID
6609
- * @readonly
6610
- * @immutable
6461
+ * @minLength 1
6462
+ * @maxLength 100
6611
6463
  */
6612
- externalId?: string | null;
6464
+ orderId?: string;
6613
6465
  }
6614
- declare enum ChargebackStatus {
6615
- /** Chargeback was approved. */
6616
- APPROVED = "APPROVED",
6617
- /** Chargeback was reversed. */
6618
- REVERSED = "REVERSED"
6466
+ interface SendMerchantOrderReceivedPushResponse {
6467
+ }
6468
+ interface PreviewEmailByTypeRequest {
6469
+ emailType?: PreviewEmailTypeWithLiterals;
6470
+ }
6471
+ declare enum PreviewEmailType {
6472
+ ORDER_PLACED = "ORDER_PLACED",
6473
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6474
+ ORDER_SHIPPED = "ORDER_SHIPPED",
6475
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6619
6476
  }
6620
6477
  /** @enumType */
6621
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6622
- interface PaymentMethodName {
6478
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6479
+ interface PreviewEmailByTypeResponse {
6480
+ emailPreview?: string;
6481
+ }
6482
+ interface PreviewRefundEmailRequest {
6623
6483
  /**
6624
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6625
- * @maxLength 150
6484
+ * @minLength 1
6485
+ * @maxLength 100
6626
6486
  */
6627
- buyerLanguageName?: string | null;
6487
+ orderId?: string;
6488
+ /** Refund amount */
6489
+ refundAmount?: Price;
6490
+ /** Refund business details */
6491
+ details?: RefundDetails;
6628
6492
  /**
6629
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6630
- *
6631
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6632
- * @maxLength 150
6493
+ * Personal note added to the email (optional)
6494
+ * @minLength 1
6495
+ * @maxLength 1000
6633
6496
  */
6634
- siteLanguageName?: string | null;
6497
+ customMessage?: string | null;
6635
6498
  /**
6636
- * User-provided payment method name.
6637
- *
6638
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6499
+ * Refund ID. (Optional)
6500
+ * @format GUID
6639
6501
  */
6640
- userDefinedName?: UserDefinedPaymentMethodName;
6502
+ refundId?: string | null;
6641
6503
  }
6642
- interface GiftCardPaymentDetails {
6504
+ interface PreviewRefundEmailResponse {
6505
+ emailPreview?: string;
6506
+ }
6507
+ interface PreviewCancelEmailRequest {
6643
6508
  /**
6644
- * Gift card payment ID.
6509
+ * @minLength 1
6645
6510
  * @maxLength 100
6646
6511
  */
6647
- giftCardPaymentId?: string;
6512
+ orderId?: string;
6648
6513
  /**
6649
- * Gift card ID.
6650
- * @internal
6651
- * @deprecated
6514
+ * Personal note added to the email (optional)
6515
+ * @minLength 1
6516
+ * @maxLength 1000
6652
6517
  */
6653
- giftCardId?: string;
6518
+ customMessage?: string | null;
6519
+ }
6520
+ interface PreviewCancelEmailResponse {
6521
+ emailPreview?: string;
6522
+ }
6523
+ interface PreviewCancelRefundEmailRequest {
6654
6524
  /**
6655
- * ID of the app that created the gift card.
6656
- * @format GUID
6525
+ * @minLength 1
6526
+ * @maxLength 100
6657
6527
  */
6658
- appId?: string;
6528
+ orderId?: string;
6659
6529
  /**
6660
- * Whether the gift card is voided.
6661
- * @readonly
6662
- * @deprecated Whether the gift card is voided.
6663
- * @replacedBy payment.status
6664
- * @targetRemovalDate 2026-11-01
6530
+ * Personal note added to the email (optional)
6531
+ * @minLength 1
6532
+ * @maxLength 1000
6665
6533
  */
6666
- voided?: boolean;
6534
+ customMessage?: string | null;
6535
+ /** Refund amount */
6536
+ refundAmount?: Price;
6667
6537
  /**
6668
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6669
- * @maxLength 30
6670
- * @immutable
6538
+ * Refund ID. (Optional)
6539
+ * @format GUID
6671
6540
  */
6672
- obfuscatedCode?: string | null;
6541
+ refundId?: string | null;
6673
6542
  }
6674
- interface MembershipPaymentDetails {
6543
+ interface PreviewCancelRefundEmailResponse {
6544
+ emailPreview?: string;
6545
+ }
6546
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
6547
+ }
6548
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
6549
+ emailPreview?: string;
6550
+ }
6551
+ interface PreviewBuyerConfirmationEmailRequest {
6552
+ }
6553
+ interface PreviewBuyerConfirmationEmailResponse {
6554
+ emailPreview?: string;
6555
+ }
6556
+ interface PreviewBuyerPickupConfirmationEmailRequest {
6557
+ }
6558
+ interface PreviewBuyerPickupConfirmationEmailResponse {
6559
+ emailPreview?: string;
6560
+ }
6561
+ interface PreviewShippingConfirmationEmailRequest {
6562
+ }
6563
+ interface PreviewShippingConfirmationEmailResponse {
6564
+ emailPreview?: string;
6565
+ }
6566
+ interface PreviewResendDownloadLinksEmailRequest {
6567
+ }
6568
+ interface PreviewResendDownloadLinksEmailResponse {
6569
+ emailPreview?: string;
6570
+ }
6571
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6572
+ /** Emitted on a meta site creation. */
6573
+ siteCreated?: SiteCreated;
6574
+ /** Emitted on a meta site transfer completion. */
6575
+ siteTransferred?: SiteTransferred;
6576
+ /** Emitted on a meta site deletion. */
6577
+ siteDeleted?: SiteDeleted;
6578
+ /** Emitted on a meta site restoration. */
6579
+ siteUndeleted?: SiteUndeleted;
6580
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6581
+ sitePublished?: SitePublished;
6582
+ /** Emitted on a meta site unpublish. */
6583
+ siteUnpublished?: SiteUnpublished;
6584
+ /** Emitted when meta site is marked as template. */
6585
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6586
+ /** Emitted when meta site is marked as a WixSite. */
6587
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6588
+ /** Emitted when an application is provisioned (installed). */
6589
+ serviceProvisioned?: ServiceProvisioned;
6590
+ /** Emitted when an application is removed (uninstalled). */
6591
+ serviceRemoved?: ServiceRemoved;
6592
+ /** Emitted when meta site name (URL slug) is changed. */
6593
+ siteRenamedPayload?: SiteRenamed;
6594
+ /** Emitted when meta site was permanently deleted. */
6595
+ hardDeleted?: SiteHardDeleted;
6596
+ /** Emitted on a namespace change. */
6597
+ namespaceChanged?: NamespaceChanged;
6598
+ /** Emitted when Studio is attached. */
6599
+ studioAssigned?: StudioAssigned;
6600
+ /** Emitted when Studio is detached. */
6601
+ studioUnassigned?: StudioUnassigned;
6675
6602
  /**
6676
- * Membership ID.
6677
- * @maxLength 200
6603
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6604
+ * the actual URL.
6605
+ *
6606
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6607
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6678
6608
  */
6679
- membershipId?: string;
6609
+ urlChanged?: SiteUrlChanged;
6610
+ /** Site is marked as PurgedExternally */
6611
+ sitePurgedExternally?: SitePurgedExternally;
6612
+ /** Emitted when Odeditor is attached. */
6613
+ odeditorAssigned?: OdeditorAssigned;
6614
+ /** Emitted when Odeditor is detached. */
6615
+ odeditorUnassigned?: OdeditorUnassigned;
6616
+ /** Emitted when Picasso is attached. */
6617
+ picassoAssigned?: PicassoAssigned;
6618
+ /** Emitted when Picasso is detached. */
6619
+ picassoUnassigned?: PicassoUnassigned;
6620
+ /** Emitted when Wixel is attached. */
6621
+ wixelAssigned?: WixelAssigned;
6622
+ /** Emitted when Wixel is detached. */
6623
+ wixelUnassigned?: WixelUnassigned;
6624
+ /** Emitted when StudioTwo is attached. */
6625
+ studioTwoAssigned?: StudioTwoAssigned;
6626
+ /** Emitted when StudioTwo is detached. */
6627
+ studioTwoUnassigned?: StudioTwoUnassigned;
6628
+ /** Emitted when media from user domain is enabled. */
6629
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6630
+ /** Emitted when media from user domain is disabled. */
6631
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6632
+ /** Emitted when Editorless is attached. */
6633
+ editorlessAssigned?: EditorlessAssigned;
6634
+ /** Emitted when Editorless is detached. */
6635
+ editorlessUnassigned?: EditorlessUnassigned;
6680
6636
  /**
6681
- * ID of the line item this membership applies to.
6682
- * @minLength 1
6683
- * @maxLength 100
6637
+ * A meta site id.
6638
+ * @format GUID
6684
6639
  */
6685
- lineItemId?: string;
6686
- /**
6687
- * Payment status.
6688
- * @deprecated Payment status.
6689
- * @replacedBy payment.status
6690
- * @targetRemovalDate 2026-11-01
6640
+ metaSiteId?: string;
6641
+ /** A meta site version. Monotonically increasing. */
6642
+ version?: string;
6643
+ /** A timestamp of the event. */
6644
+ timestamp?: string;
6645
+ /**
6646
+ * TODO(meta-site): Change validation once validations are disabled for consumers
6647
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6648
+ * @maxSize 4000
6691
6649
  */
6692
- status?: MembershipPaymentStatusWithLiterals;
6693
- /** Membership name. */
6694
- name?: MembershipName;
6650
+ assets?: Asset[];
6651
+ }
6652
+ /** @oneof */
6653
+ interface MetaSiteSpecialEventPayloadOneOf {
6654
+ /** Emitted on a meta site creation. */
6655
+ siteCreated?: SiteCreated;
6656
+ /** Emitted on a meta site transfer completion. */
6657
+ siteTransferred?: SiteTransferred;
6658
+ /** Emitted on a meta site deletion. */
6659
+ siteDeleted?: SiteDeleted;
6660
+ /** Emitted on a meta site restoration. */
6661
+ siteUndeleted?: SiteUndeleted;
6662
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6663
+ sitePublished?: SitePublished;
6664
+ /** Emitted on a meta site unpublish. */
6665
+ siteUnpublished?: SiteUnpublished;
6666
+ /** Emitted when meta site is marked as template. */
6667
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6668
+ /** Emitted when meta site is marked as a WixSite. */
6669
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6670
+ /** Emitted when an application is provisioned (installed). */
6671
+ serviceProvisioned?: ServiceProvisioned;
6672
+ /** Emitted when an application is removed (uninstalled). */
6673
+ serviceRemoved?: ServiceRemoved;
6674
+ /** Emitted when meta site name (URL slug) is changed. */
6675
+ siteRenamedPayload?: SiteRenamed;
6676
+ /** Emitted when meta site was permanently deleted. */
6677
+ hardDeleted?: SiteHardDeleted;
6678
+ /** Emitted on a namespace change. */
6679
+ namespaceChanged?: NamespaceChanged;
6680
+ /** Emitted when Studio is attached. */
6681
+ studioAssigned?: StudioAssigned;
6682
+ /** Emitted when Studio is detached. */
6683
+ studioUnassigned?: StudioUnassigned;
6695
6684
  /**
6696
- * The transaction ID in the membership system. Can be used to void the transaction.
6697
- * @minLength 1
6698
- * @maxLength 100
6685
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6686
+ * the actual URL.
6687
+ *
6688
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6689
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6699
6690
  */
6700
- externalTransactionId?: string | null;
6691
+ urlChanged?: SiteUrlChanged;
6692
+ /** Site is marked as PurgedExternally */
6693
+ sitePurgedExternally?: SitePurgedExternally;
6694
+ /** Emitted when Odeditor is attached. */
6695
+ odeditorAssigned?: OdeditorAssigned;
6696
+ /** Emitted when Odeditor is detached. */
6697
+ odeditorUnassigned?: OdeditorUnassigned;
6698
+ /** Emitted when Picasso is attached. */
6699
+ picassoAssigned?: PicassoAssigned;
6700
+ /** Emitted when Picasso is detached. */
6701
+ picassoUnassigned?: PicassoUnassigned;
6702
+ /** Emitted when Wixel is attached. */
6703
+ wixelAssigned?: WixelAssigned;
6704
+ /** Emitted when Wixel is detached. */
6705
+ wixelUnassigned?: WixelUnassigned;
6706
+ /** Emitted when StudioTwo is attached. */
6707
+ studioTwoAssigned?: StudioTwoAssigned;
6708
+ /** Emitted when StudioTwo is detached. */
6709
+ studioTwoUnassigned?: StudioTwoUnassigned;
6710
+ /** Emitted when media from user domain is enabled. */
6711
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6712
+ /** Emitted when media from user domain is disabled. */
6713
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6714
+ /** Emitted when Editorless is attached. */
6715
+ editorlessAssigned?: EditorlessAssigned;
6716
+ /** Emitted when Editorless is detached. */
6717
+ editorlessUnassigned?: EditorlessUnassigned;
6718
+ }
6719
+ interface Asset {
6701
6720
  /**
6702
- * Whether the membership is voided.
6703
- * @readonly
6704
- * @deprecated Whether the membership is voided.
6705
- * @replacedBy payment.status
6706
- * @targetRemovalDate 2026-11-01
6721
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6722
+ * @maxLength 36
6707
6723
  */
6708
- voided?: boolean;
6724
+ appDefId?: string;
6709
6725
  /**
6710
- * ID of the application providing this payment option.
6711
- * @format GUID
6726
+ * An instance id. For legacy reasons may be UUID or a string.
6727
+ * @maxLength 200
6712
6728
  */
6713
- providerAppId?: string;
6714
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6715
- futureMembership?: FutureMembershipDetails;
6729
+ instanceId?: string;
6730
+ /** An application state. */
6731
+ state?: StateWithLiterals;
6716
6732
  }
6717
- declare enum MembershipPaymentStatus {
6718
- /** Payment was charged. */
6719
- CHARGED = "CHARGED",
6720
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6721
- CHARGE_FAILED = "CHARGE_FAILED",
6722
- /** Payment is pending. */
6723
- CHARGE_PENDING = "CHARGE_PENDING",
6724
- /** Payment was voided. */
6725
- VOIDED = "VOIDED"
6733
+ declare enum State {
6734
+ UNKNOWN = "UNKNOWN",
6735
+ ENABLED = "ENABLED",
6736
+ DISABLED = "DISABLED",
6737
+ PENDING = "PENDING",
6738
+ DEMO = "DEMO"
6726
6739
  }
6727
6740
  /** @enumType */
6728
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6729
- interface FutureMembershipDetails {
6741
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6742
+ interface SiteCreated {
6730
6743
  /**
6731
- * ID of the plan line item in the order from which the membership will be created.
6732
- * @format GUID
6744
+ * A template identifier (empty if not created from a template).
6745
+ * @maxLength 36
6733
6746
  */
6734
- lineItemId?: string;
6747
+ originTemplateId?: string;
6735
6748
  /**
6736
- * ID of the benefit the future membership will grant.
6737
- * @maxLength 200
6749
+ * An account id of the owner.
6750
+ * @format GUID
6738
6751
  */
6739
- benefitId?: string;
6740
- }
6741
- interface WixReceiptInfo {
6752
+ ownerId?: string;
6753
+ /** A context in which meta site was created. */
6754
+ context?: SiteCreatedContextWithLiterals;
6742
6755
  /**
6743
- * Receipt ID
6756
+ * A meta site id from which this site was created.
6757
+ *
6758
+ * In case of a creation from a template it's a template id.
6759
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6744
6760
  * @format GUID
6745
6761
  */
6746
- receiptId?: string;
6762
+ originMetaSiteId?: string | null;
6747
6763
  /**
6748
- * Display number of receipt
6749
- * @minLength 1
6750
- * @maxLength 40
6764
+ * A meta site name (URL slug).
6765
+ * @maxLength 20
6751
6766
  */
6752
- displayNumber?: string | null;
6767
+ siteName?: string;
6768
+ /** A namespace. */
6769
+ namespace?: NamespaceWithLiterals;
6753
6770
  }
6754
- interface ExternalReceiptInfo {
6755
- /**
6756
- * External receipt ID
6757
- * @maxLength 100
6758
- */
6759
- receiptId?: string | null;
6771
+ declare enum SiteCreatedContext {
6772
+ /** A valid option, we don't expose all reasons why site might be created. */
6773
+ OTHER = "OTHER",
6774
+ /** A meta site was created from template. */
6775
+ FROM_TEMPLATE = "FROM_TEMPLATE",
6776
+ /** A meta site was created by copying of the transfferred meta site. */
6777
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6778
+ /** A copy of existing meta site. */
6779
+ DUPLICATE = "DUPLICATE",
6780
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6781
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6782
+ /** deprecated A meta site was created for Flash editor. */
6783
+ FLASH = "FLASH"
6784
+ }
6785
+ /** @enumType */
6786
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6787
+ declare enum Namespace {
6788
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6789
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6790
+ WIX = "WIX",
6791
+ /** 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. */
6792
+ SHOUT_OUT = "SHOUT_OUT",
6793
+ /** 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. */
6794
+ ALBUMS = "ALBUMS",
6795
+ /** 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. */
6796
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6797
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6798
+ HOTELS = "HOTELS",
6799
+ /** 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. */
6800
+ CLUBS = "CLUBS",
6801
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6802
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6760
6803
  /**
6761
- * ID of the app providing the receipt
6762
- * @format GUID
6804
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6805
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6763
6806
  */
6764
- appId?: string | null;
6807
+ DEV_SITE = "DEV_SITE",
6808
+ /** 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. */
6809
+ LOGOS = "LOGOS",
6810
+ /** 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. */
6811
+ VIDEO_MAKER = "VIDEO_MAKER",
6812
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6813
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6814
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6815
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6765
6816
  /**
6766
- * Display number of receipt
6767
- * @minLength 1
6768
- * @maxLength 40
6817
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6818
+ *
6819
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
6769
6820
  */
6770
- displayNumber?: string | null;
6771
- }
6772
- interface CashRoundingDetails {
6821
+ HTML_DRAFT = "HTML_DRAFT",
6773
6822
  /**
6774
- * Payment amount before cash rounding was applied.
6775
- * When provided, balance and status calculations use this value instead of `amount`
6776
- * to prevent false overpayment or underpayment due to rounding.
6823
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6824
+ * Will be accessible from Site List and will not have a website app.
6825
+ * Once the user attaches a site, the site will become a regular wixsite.
6777
6826
  */
6778
- unroundedAmount?: Price;
6827
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
6828
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6829
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
6830
+ /** It is to be used in the Business First efforts. */
6831
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
6832
+ /** Bookings business flow with no site. */
6833
+ ANYWHERE = "ANYWHERE",
6834
+ /** Namespace for Headless Backoffice with no editor */
6835
+ HEADLESS = "HEADLESS",
6779
6836
  /**
6780
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6781
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6782
- * @readonly
6837
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6838
+ * The site will be used for account level CSM feature for enterprise
6783
6839
  */
6784
- roundingAdjustment?: CashRounding;
6785
- }
6786
- declare enum PaymentStatus {
6787
- /** Payment was charged successfully. */
6788
- APPROVED = "APPROVED",
6789
- /** Payment is being processed and hasn't been confirmed yet. */
6790
- PENDING = "PENDING",
6791
- /** 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. */
6792
- PENDING_MERCHANT = "PENDING_MERCHANT",
6793
- /** Payment was canceled before it was charged. */
6794
- CANCELED = "CANCELED",
6795
- /** Payment was declined by the payment provider. */
6796
- DECLINED = "DECLINED",
6797
- /** Payment was fully refunded. */
6798
- REFUNDED = "REFUNDED",
6799
- /** Part of the payment amount was refunded. */
6800
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6801
- /** 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. */
6802
- AUTHORIZED = "AUTHORIZED",
6840
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6841
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6842
+ RISE = "RISE",
6803
6843
  /**
6804
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6805
- *
6806
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6844
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6845
+ * There's a blank site behind the scene but it's blank).
6846
+ * The Mobile company will be the owner of this namespace.
6807
6847
  */
6808
- VOIDED = "VOIDED"
6809
- }
6810
- /** @enumType */
6811
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6812
- interface CanceledStatusDetails {
6813
- reason?: CanceledReasonWithLiterals;
6814
- }
6815
- declare enum CanceledReason {
6816
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6817
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6818
- /** Payment was not completed by user and expired. */
6819
- EXPIRED = "EXPIRED"
6820
- }
6821
- /** @enumType */
6822
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6823
- interface DeclinedStatusDetails {
6824
- reason?: DeclinedReasonWithLiterals;
6825
- }
6826
- declare enum DeclinedReason {
6827
- /** Corresponding charge failed. */
6828
- CHARGE_FAILED = "CHARGE_FAILED",
6829
- /** Payment details expired. */
6830
- EXPIRED = "EXPIRED",
6831
- /** Insufficient funds. */
6832
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6833
- /** Gift card was disabled before charge was attempted. */
6834
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6835
- }
6836
- /** @enumType */
6837
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6838
- interface VoidedStatusDetails {
6839
- reason?: VoidedReasonWithLiterals;
6840
- }
6841
- declare enum VoidedReason {
6842
- /** Payment was voided by merchant request. */
6843
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6844
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6845
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6846
- }
6847
- /** @enumType */
6848
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6849
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6850
- /** @internal */
6851
- canceled?: CanceledStatusDetails;
6852
- /** @internal */
6853
- declined?: DeclinedStatusDetails;
6854
- /** @internal */
6855
- voided?: VoidedStatusDetails;
6848
+ BRANDED_FIRST = "BRANDED_FIRST",
6849
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6850
+ NOWNIA = "NOWNIA",
6856
6851
  /**
6857
- * Reason code from the payment gateway.
6858
- * @internal
6859
- * @minLength 1
6860
- * @maxLength 10
6852
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
6853
+ * The Partners company owns this namespace.
6861
6854
  */
6862
- paymentGatewayReasonCode?: string | null;
6863
- }
6864
- /** @oneof */
6865
- interface PaymentStatusDetailsStatusDetailsOneOf {
6866
- /** @internal */
6867
- canceled?: CanceledStatusDetails;
6868
- /** @internal */
6869
- declined?: DeclinedStatusDetails;
6870
- /** @internal */
6871
- voided?: VoidedStatusDetails;
6872
- }
6873
- interface Refund {
6855
+ UGC_TEMPLATE = "UGC_TEMPLATE",
6856
+ /** Codux Headless Sites */
6857
+ CODUX = "CODUX",
6858
+ /** Bobb - AI Design Creator. */
6859
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6874
6860
  /**
6875
- * Refund ID.
6876
- * @format GUID
6877
- * @readonly
6861
+ * Shared Blog Site is a unique single site across Enterprise account,
6862
+ * This site will hold all Blog posts related to the Marketing product.
6878
6863
  */
6879
- _id?: string;
6864
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6865
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6866
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6867
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6868
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6869
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6870
+ MIMIR = "MIMIR",
6871
+ /** Wix Twins platform. */
6872
+ TWINS = "TWINS",
6873
+ /** Wix Nano. */
6874
+ NANO = "NANO",
6875
+ /** Base44 headless sites. */
6876
+ BASE44 = "BASE44",
6877
+ /** Wix Channels Sites */
6878
+ CHANNELS = "CHANNELS",
6879
+ /** Nautilus platform. */
6880
+ NAUTILUS = "NAUTILUS",
6880
6881
  /**
6881
- * List of transactions.
6882
- * @maxSize 50
6882
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6883
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6883
6884
  */
6884
- transactions?: RefundTransaction[];
6885
- /** Refund business details. */
6886
- details?: RefundDetails;
6885
+ SYMPHONY = "SYMPHONY",
6886
+ /** Nautilus platform app. */
6887
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6887
6888
  /**
6888
- * 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.
6889
- * @readonly
6890
- * @immutable
6889
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6890
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6891
6891
  */
6892
- _createdDate?: Date | null;
6892
+ VIBU = "VIBU",
6893
6893
  /**
6894
- * Aggregated refund summary.
6895
- *
6896
- * 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.
6897
- * @readonly
6894
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6895
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6896
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6897
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6898
6898
  */
6899
- summary?: AggregatedRefundSummary;
6899
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6900
6900
  /**
6901
- * ID of the app that initiated this refund.
6902
- * @format GUID
6903
- * @readonly
6904
- * @immutable
6901
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6902
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6905
6903
  */
6906
- requestingServiceAppId?: string | null;
6904
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6907
6905
  }
6908
- interface RefundTransaction {
6906
+ /** @enumType */
6907
+ 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';
6908
+ /** Site transferred to another user. */
6909
+ interface SiteTransferred {
6909
6910
  /**
6910
- * ID of the payment associated with this refund.
6911
+ * A previous owner id (user that transfers meta site).
6911
6912
  * @format GUID
6912
- * @immutable
6913
- */
6914
- paymentId?: string;
6915
- /**
6916
- * Refund amount.
6917
- * @immutable
6918
6913
  */
6919
- amount?: Price;
6920
- /** Refund status. */
6921
- refundStatus?: RefundStatusWithLiterals;
6922
- /** Optional details of current refund status. */
6923
- refundStatusInfo?: RefundStatusInfo;
6914
+ oldOwnerId?: string;
6924
6915
  /**
6925
- * Payment gateway's refund ID.
6926
- * This field is only returned when the value of `external_refund` is `false`.
6916
+ * A new owner id (user that accepts meta site).
6927
6917
  * @format GUID
6928
6918
  */
6929
- gatewayRefundId?: string | null;
6930
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6931
- providerRefundId?: string | null;
6919
+ newOwnerId?: string;
6920
+ }
6921
+ /** Soft deletion of the meta site. Could be restored. */
6922
+ interface SiteDeleted {
6923
+ /** A deletion context. */
6924
+ deleteContext?: DeleteContext;
6925
+ }
6926
+ interface DeleteContext {
6927
+ /** When the meta site was deleted. */
6928
+ dateDeleted?: Date | null;
6929
+ /** A status. */
6930
+ deleteStatus?: DeleteStatusWithLiterals;
6932
6931
  /**
6933
- * Whether refund was made externally and manually on the payment provider's side.
6934
- * @immutable
6932
+ * A reason (flow).
6933
+ * @maxLength 255
6935
6934
  */
6936
- externalRefund?: boolean;
6935
+ deleteOrigin?: string;
6937
6936
  /**
6938
- * Location where the refund was processed.
6939
- * @internal
6940
- * @format GUID
6941
- * @immutable
6937
+ * A service that deleted it.
6938
+ * @maxLength 255
6942
6939
  */
6943
- locationId?: string | null;
6940
+ initiatorId?: string | null;
6944
6941
  }
6945
- /** Refund transaction status. */
6946
- declare enum RefundStatus {
6947
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6948
- PENDING = "PENDING",
6949
- /** Refund transaction succeeded. */
6950
- SUCCEEDED = "SUCCEEDED",
6951
- /** Refund transaction failed. */
6952
- FAILED = "FAILED",
6953
- /** Refund request acknowledged, and will be executed soon. */
6954
- SCHEDULED = "SCHEDULED",
6955
- /** Refund was initiated on payment provider side. */
6956
- STARTED = "STARTED"
6942
+ declare enum DeleteStatus {
6943
+ UNKNOWN = "UNKNOWN",
6944
+ TRASH = "TRASH",
6945
+ DELETED = "DELETED",
6946
+ PENDING_PURGE = "PENDING_PURGE",
6947
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6957
6948
  }
6958
6949
  /** @enumType */
6959
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6960
- interface RefundStatusInfo {
6961
- /**
6962
- * Reason code for the refund's current status.
6963
- *
6964
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6965
- * @minLength 1
6966
- * @maxLength 10
6967
- */
6968
- paymentGatewayReasonCode?: string | null;
6950
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6951
+ /** Restoration of the meta site. */
6952
+ interface SiteUndeleted {
6953
+ }
6954
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6955
+ interface SitePublished {
6956
+ }
6957
+ interface SiteUnpublished {
6969
6958
  /**
6970
- * Free text explanation of current refund status.
6971
- * @minLength 1
6972
- * @maxLength 1000
6959
+ * A list of URLs previously associated with the meta site.
6960
+ * @maxLength 4000
6961
+ * @maxSize 10000
6973
6962
  */
6974
- description?: string | null;
6963
+ urls?: string[];
6975
6964
  }
6976
- interface AggregatedRefundSummary {
6977
- /** Total amount requested for refund. */
6978
- requestedRefund?: Price;
6979
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6980
- pendingRefund?: Price;
6981
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6982
- refunded?: Price;
6983
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6984
- failedRefundAmount?: Price;
6985
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6986
- pending?: boolean;
6987
- /** Breakdown of refunded items. Available only after refund is complete. */
6988
- breakdown?: RefundItemsBreakdown;
6965
+ interface SiteMarkedAsTemplate {
6989
6966
  }
6990
- interface RefundItemsBreakdown {
6967
+ interface SiteMarkedAsWixSite {
6968
+ }
6969
+ /**
6970
+ * Represents a service provisioned a site.
6971
+ *
6972
+ * Note on `origin_instance_id`:
6973
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6974
+ * This is because of the following scenario:
6975
+ *
6976
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6977
+ * such as a product catalog. When you create a site from this template, you inherit this
6978
+ * default product catalog. However, if the template's product catalog is modified,
6979
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6980
+ * your site remains consistent with what you initially received and does not include any
6981
+ * changes made to the original template afterward.
6982
+ * To ensure this, the TPA on the template gets a new instance_id.
6983
+ */
6984
+ interface ServiceProvisioned {
6991
6985
  /**
6992
- * Refunded line items and the amount refunded for each.
6993
- * @maxSize 300
6986
+ * Either UUID or EmbeddedServiceType.
6987
+ * @maxLength 36
6994
6988
  */
6995
- lineItems?: LineItemRefundSummary[];
6996
- }
6997
- interface LineItemRefundSummary {
6989
+ appDefId?: string;
6998
6990
  /**
6999
- * ID of the refunded line item.
7000
- * @format GUID
6991
+ * Not only UUID. Something here could be something weird.
6992
+ * @maxLength 36
7001
6993
  */
7002
- lineItemId?: string;
7003
- /** Total refunded amount for the line item. */
7004
- totalRefundedAmount?: Price;
7005
- }
7006
- interface CalculateRefundRequest {
6994
+ instanceId?: string;
7007
6995
  /**
7008
- * Order ID
7009
- * @minLength 1
7010
- * @maxLength 100
6996
+ * An instance id from which this instance is originated.
6997
+ * @maxLength 36
7011
6998
  */
7012
- ecomOrderId?: string;
6999
+ originInstanceId?: string;
7013
7000
  /**
7014
- * Refunded line items and quantity
7015
- * @maxSize 300
7001
+ * A version.
7002
+ * @maxLength 500
7016
7003
  */
7017
- refundItems?: CalculateRefundItemRequest[];
7018
- /** Should include shipping in refund calculation */
7019
- refundShipping?: boolean;
7020
- }
7021
- interface CalculateRefundItemRequest {
7004
+ version?: string | null;
7022
7005
  /**
7023
- * ID of the line item being refunded
7006
+ * The origin meta site id
7024
7007
  * @format GUID
7025
7008
  */
7026
- _id?: string;
7009
+ originMetaSiteId?: string | null;
7010
+ }
7011
+ interface ServiceRemoved {
7027
7012
  /**
7028
- * How much of that line item is being refunded
7029
- * @min 1
7030
- * @max 100000
7013
+ * Either UUID or EmbeddedServiceType.
7014
+ * @maxLength 36
7031
7015
  */
7032
- quantity?: number;
7033
- }
7034
- interface CalculateRefundResponse {
7035
- /** Total refundable amount */
7036
- total?: Price;
7037
- /** Tax cost of the order */
7038
- tax?: Price;
7039
- /** Discount given for this order */
7040
- discount?: Price;
7041
- /** Total cost of the order (without tax) */
7042
- subtotal?: Price;
7043
- /** Total shipping cost for order */
7044
- shipping?: Price;
7045
- /** Previous refund given on that order */
7046
- previouslyRefundedAmount?: Price;
7016
+ appDefId?: string;
7047
7017
  /**
7048
- * The refundable items of that order
7049
- * @maxSize 300
7018
+ * Not only UUID. Something here could be something weird.
7019
+ * @maxLength 36
7050
7020
  */
7051
- items?: CalculateRefundItemResponse[];
7052
- }
7053
- interface CalculateRefundItemResponse {
7021
+ instanceId?: string;
7054
7022
  /**
7055
- * Line item ID
7056
- * @format GUID
7023
+ * A version.
7024
+ * @maxLength 500
7057
7025
  */
7058
- _id?: string;
7059
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
7060
- price?: Price;
7026
+ version?: string | null;
7061
7027
  }
7062
- interface VoidAuthorizedPaymentsRequest {
7028
+ /** Rename of the site. Meaning, free public url has been changed as well. */
7029
+ interface SiteRenamed {
7063
7030
  /**
7064
- * Wix eCommerce order ID
7065
- * @minLength 1
7066
- * @maxLength 100
7031
+ * A new meta site name (URL slug).
7032
+ * @maxLength 20
7067
7033
  */
7068
- ecomOrderId: string;
7034
+ newSiteName?: string;
7069
7035
  /**
7070
- * Payment IDs
7071
- * @minSize 1
7072
- * @maxSize 100
7073
- * @format GUID
7036
+ * A previous meta site name (URL slug).
7037
+ * @maxLength 255
7074
7038
  */
7075
- paymentIds: string[];
7039
+ oldSiteName?: string;
7076
7040
  }
7077
- interface VoidAuthorizedPaymentsResponse {
7078
- /** All order's transactions after the void was triggered */
7079
- orderTransactions?: OrderTransactions;
7041
+ /**
7042
+ * Hard deletion of the meta site.
7043
+ *
7044
+ * Could not be restored. Therefore it's desirable to cleanup data.
7045
+ */
7046
+ interface SiteHardDeleted {
7047
+ /** A deletion context. */
7048
+ deleteContext?: DeleteContext;
7080
7049
  }
7081
- interface CaptureAuthorizedPaymentsRequest {
7082
- /**
7083
- * Wix eCommerce order ID
7084
- * @minLength 1
7085
- * @maxLength 100
7086
- */
7087
- ecomOrderId: string;
7050
+ interface NamespaceChanged {
7051
+ /** A previous namespace. */
7052
+ oldNamespace?: NamespaceWithLiterals;
7053
+ /** A new namespace. */
7054
+ newNamespace?: NamespaceWithLiterals;
7055
+ }
7056
+ /** Assigned Studio editor */
7057
+ interface StudioAssigned {
7058
+ }
7059
+ /** Unassigned Studio editor */
7060
+ interface StudioUnassigned {
7061
+ }
7062
+ /**
7063
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
7064
+ *
7065
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
7066
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
7067
+ *
7068
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
7069
+ */
7070
+ interface SiteUrlChanged {
7071
+ }
7072
+ /**
7073
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
7074
+ * Consumed by other teams to remove relevant data.
7075
+ */
7076
+ interface SitePurgedExternally {
7088
7077
  /**
7089
- * Capture payments information
7090
- * @minSize 1
7078
+ * @maxLength 2048
7091
7079
  * @maxSize 100
7080
+ * @deprecated
7081
+ * @targetRemovalDate 2025-04-15
7092
7082
  */
7093
- payments: PaymentCapture[];
7083
+ appDefId?: string[];
7094
7084
  }
7095
- interface PaymentCapture {
7096
- /**
7097
- * Payment ID
7098
- * @format GUID
7099
- */
7100
- paymentId?: string | null;
7101
- /**
7102
- * Capture amount.
7103
- * If not provided - full authorized amount will be captured.
7104
- */
7105
- amount?: Price;
7085
+ /** Assigned Odeditor */
7086
+ interface OdeditorAssigned {
7106
7087
  }
7107
- interface CaptureAuthorizedPaymentsResponse {
7108
- /** All order's transactions after the capture was triggered */
7109
- orderTransactions?: OrderTransactions;
7088
+ /** Unassigned Odeditor */
7089
+ interface OdeditorUnassigned {
7110
7090
  }
7111
- interface ChargeSavedPaymentMethodRequest {
7112
- /**
7113
- * Ecom Order ID.
7114
- * @minLength 1
7115
- * @maxLength 100
7116
- */
7117
- ecomOrderId?: string;
7118
- /** Amount to be charged */
7119
- amount?: Price;
7091
+ /** Assigned Picasso editor */
7092
+ interface PicassoAssigned {
7120
7093
  }
7121
- interface ChargeSavedPaymentMethodResponse {
7122
- /** Payment gateway's order ID (e.g Wix Payments) */
7123
- paymentGatewayOrderId?: string;
7094
+ /** Unassigned Picasso */
7095
+ interface PicassoUnassigned {
7124
7096
  }
7125
- interface V1TriggerReindexRequest {
7126
- /** @format GUID */
7127
- metasiteId?: string;
7128
- /**
7129
- * @minLength 1
7130
- * @maxLength 100
7131
- * @maxSize 100
7132
- */
7133
- orderIds?: string[];
7097
+ /** Assigned Wixel */
7098
+ interface WixelAssigned {
7134
7099
  }
7135
- interface V1TriggerReindexResponse {
7100
+ /** Unassigned Wixel */
7101
+ interface WixelUnassigned {
7136
7102
  }
7137
- interface V1TriggerReindexOrderRequest {
7138
- /** @format GUID */
7139
- metasiteId?: string;
7140
- /**
7141
- * @minLength 1
7142
- * @maxLength 100
7143
- */
7144
- orderId?: string;
7103
+ /** Assigned StudioTwo */
7104
+ interface StudioTwoAssigned {
7105
+ }
7106
+ /** Unassigned StudioTwo */
7107
+ interface StudioTwoUnassigned {
7108
+ }
7109
+ /** Media from user domain is enabled. */
7110
+ interface UserDomainMediaEnabled {
7111
+ }
7112
+ /** Media from user domain is disabled. */
7113
+ interface UserDomainMediaDisabled {
7114
+ }
7115
+ /** Assigned Editorless */
7116
+ interface EditorlessAssigned {
7117
+ }
7118
+ /** Unassigned Editorless */
7119
+ interface EditorlessUnassigned {
7120
+ }
7121
+ interface HasCustomEmailConfigurationsRequest {
7122
+ }
7123
+ interface HasCustomEmailConfigurationsResponse {
7124
+ hasCustomConfigurations?: boolean;
7125
+ }
7126
+ interface AddToAutomationMigrationPopulationRequest {
7127
+ /** When true, sends custom email configurations to automation system via email */
7128
+ sendCustomEmailConfigs?: boolean;
7129
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
7130
+ origin?: OriginWithLiterals;
7131
+ }
7132
+ declare enum Origin {
7133
+ OPT_IN = "OPT_IN",
7134
+ MIGRATION = "MIGRATION"
7135
+ }
7136
+ /** @enumType */
7137
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
7138
+ interface AddToAutomationMigrationPopulationResponse {
7139
+ success?: boolean;
7140
+ }
7141
+ interface IsInAutomationMigrationPopulationRequest {
7142
+ }
7143
+ interface IsInAutomationMigrationPopulationResponse {
7144
+ inPopulation?: boolean;
7145
7145
  }
7146
7146
  interface DiffmatokyPayload {
7147
7147
  left?: string;
@@ -10985,4 +10985,4 @@ interface BulkUpdateOrderTagsOptions {
10985
10985
  unassignTags?: TagsTags;
10986
10986
  }
10987
10987
 
10988
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, PredefinedPaymentMethod as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountValueType as aD, DiscountReason as aE, LineItemQuantityChangeType as aF, ActivityType as aG, OrderActivityTypeEnumActivityType as aH, AttributionSource as aI, ChannelType as aJ, AdditionalFeeSource as aK, OrderActionType as aL, SpecificItemsCouponBehavior as aM, ChargeType as aN, VersioningMode as aO, DeltaPaymentOptionType as aP, InventoryAction as aQ, WebhookIdentityType as aR, PreviewEmailType as aS, State as aT, SiteCreatedContext as aU, Namespace as aV, DeleteStatus as aW, Origin as aX, ScheduledAction as aY, DurationUnit as aZ, PaymentCollectabilityStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type ServiceProperties as b$, RefundableStatus as b0, NonRefundableReason as b1, ManuallyRefundableReason as b2, RestockType as b3, TransactionStatus as b4, AuthorizationCaptureStatus as b5, AuthorizationVoidStatus as b6, Reason as b7, ActionType as b8, ChargebackStatus as b9, type Dimensions as bA, type ItemType as bB, type ItemTypeItemTypeDataOneOf as bC, type RestockLocation as bD, type ItemTaxFullDetails as bE, type LineItemTaxInfo as bF, type LineItemTaxBreakdown as bG, type DigitalFile as bH, type SubscriptionInfo as bI, type SubscriptionTitle as bJ, type SubscriptionDescription as bK, type SubscriptionSettings as bL, type FreeTrialPeriod as bM, type BillingSettings as bN, type BillingAdjustment as bO, type BillingAdjustmentPriceSummary as bP, type CyclePriceOverride as bQ, type PriceDescription as bR, type LocationAndQuantity as bS, type TaxableAddress as bT, type TaxableAddressTaxableAddressDataOneOf as bU, type DecimalQuantity as bV, type DecimalQuantityUnitOneOf as bW, type TranslatableString as bX, type ExtendedFields as bY, type ModifierGroup as bZ, type ItemModifier as b_, MembershipPaymentStatus as ba, PaymentStatus as bb, CanceledReason as bc, DeclinedReason as bd, VoidedReason as be, RefundStatus as bf, SortOrder as bg, OrderApprovalStrategy as bh, Placement as bi, SubdivisionType as bj, SourceType as bk, CustomFieldGroup as bl, ValueType as bm, DepositType as bn, InvoiceStatus as bo, type OrderLineItem as bp, type ProductName as bq, type CatalogReference as br, type DescriptionLine as bs, type DescriptionLineValueOneOf as bt, type DescriptionLineDescriptionLineValueOneOf as bu, type DescriptionLineName as bv, type PlainTextValue as bw, type Color as bx, type FocalPoint as by, type PhysicalProperties as bz, type SetOrderNumberCounterApplicationErrors as c, type AuthorizedPaymentCreated as c$, type CrossBorderPriceAdjustment as c0, type BuyerInfo as c1, type BuyerInfoIdOneOf as c2, type CurrencyConversionDetails as c3, type CrossBorderRepricing as c4, type PriceSummary as c5, type AddressWithContact as c6, type Address as c7, type StreetAddress as c8, type AddressLocation as c9, type Activity as cA, type ActivityContentOneOf as cB, type CustomActivity as cC, type MerchantComment as cD, type OrderRefunded as cE, type OrderCreatedFromExchange as cF, type NewExchangeOrderCreated as cG, type LineItemExchangeData as cH, type DraftOrderChangesApplied as cI, type OrderChange as cJ, type OrderChangeValueOneOf as cK, type LineItemChanges as cL, type LineItemQuantityChange as cM, type LineItemPriceChange as cN, type LineItemProductNameChange as cO, type LineItemDescriptionLineChange as cP, type LineItemModifiersChange as cQ, type ManagedLineItem as cR, type ManagedDiscount as cS, type TranslatedValue as cT, type LineItemAmount as cU, type ManagedAdditionalFee as cV, type TotalPriceChange as cW, type ShippingInformationChange as cX, type ShippingInformation as cY, type PricesRecalculatedForDestination as cZ, type SavedPaymentMethod as c_, type FullAddressContactDetails as ca, type VatId as cb, type V1ShippingInformation as cc, type DeliveryLogistics as cd, type DeliveryLogisticsAddressOneOf as ce, type PickupDetails as cf, type PickupAddress as cg, type DeliveryTimeSlot as ch, type ShippingPrice as ci, type ShippingRegion as cj, type TaxSummary as ck, type OrderTaxInfo as cl, type OrderTaxBreakdown as cm, type CrossBorderCalculation as cn, type AppliedDiscount as co, type AppliedDiscountDiscountSourceOneOf as cp, type Coupon as cq, type CouponDiscountValueOneOf as cr, type MerchantDiscount as cs, type MerchantDiscountMerchantDiscountReasonOneOf as ct, type DiscountRule as cu, type DiscountRuleDiscountValueOneOf as cv, type DiscountRuleName as cw, type LineItemDiscount as cx, type ItemCombination as cy, type ItemCombinationLineItem as cz, type PreparePaymentCollectionOptions as d, type OrderRejectedEventOrderRejected as d$, type AuthorizedPaymentCaptured as d0, type AuthorizedPaymentVoided as d1, type RefundInitiated as d2, type RefundedPayment as d3, type RefundedPaymentKindOneOf as d4, type RegularPaymentRefund as d5, type GiftCardPaymentRefund as d6, type MembershipPaymentRefund as d7, type PaymentRefunded as d8, type PaymentRefundFailed as d9, type AdditionalFee as dA, type FulfillmentStatusesAggregate as dB, type Tags as dC, type TagList as dD, type Location as dE, type OrderSettings as dF, type OrderSettingsAllowedActionsOneOf as dG, type OrderSettingsEditableByOneOf as dH, type CustomAllowedActions as dI, type OwnerApps as dJ, type FormInfo as dK, type FormIdentifier as dL, type PlatformFeeSummary as dM, type PlatformFee as dN, type UpdateInternalDocumentsEvent as dO, type UpdateInternalDocumentsEventOperationOneOf as dP, type InternalDocument as dQ, type InternalDocumentUpdateOperation as dR, type DeleteByIdsOperation as dS, type DeleteByFilterOperation as dT, type InternalDocumentUpdateByFilterOperation as dU, type InternalUpdateExistingOperation as dV, type VersionedDocumentUpdateOperation as dW, type VersionedDeleteByIdsOperation as dX, type VersionedDocumentId as dY, type OrderApproved as dZ, type OrdersExperiments as d_, type RefundedAsStoreCredit as da, type PaymentPending as db, type PaymentPendingPaymentDetailsOneOf as dc, type RegularPayment as dd, type RegularPaymentPaymentMethodDetailsOneOf as de, type CreditCardDetails as df, type PaymentCanceled as dg, type PaymentCanceledPaymentDetailsOneOf as dh, type PaymentDeclined as di, type PaymentDeclinedPaymentDetailsOneOf as dj, type ReceiptCreated as dk, type ReceiptCreatedReceiptInfoOneOf as dl, type WixReceipt as dm, type ExternalReceipt as dn, type ReceiptSent as dp, type ReceiptSentReceiptInfoOneOf as dq, type ChargebackCreated as dr, type ChargebackReversed as ds, type CreatedBy as dt, type CreatedByStringOneOf as du, type ChannelInfo as dv, type CustomField as dw, type BalanceSummary as dx, type Balance as dy, type CashRounding as dz, type PreparePaymentCollectionResponse as e, type PreviewEmailByTypeResponse as e$, type OrderItemsRestocked as e0, type V1RestockItem as e1, type OrderImported as e2, type ImportedOrderDeleted as e3, type PaymentStatusUpdated as e4, type FulfillmentStatusUpdated as e5, type OrderCanceledEventOrderCanceled as e6, type OrderDeltasCommitted as e7, type CommittedDiffs as e8, type CommittedDiffsShippingUpdateInfoOneOf as e9, type AccountInfo as eA, type ImportOrderRequest as eB, type SetOrderNumberCounterRequest as eC, type BulkDeleteImportedOrdersRequest as eD, type SendBuyerConfirmationEmailRequest as eE, type SendBuyerConfirmationEmailResponse as eF, type SendBuyerPaymentsReceivedEmailRequest as eG, type SendBuyerPaymentsReceivedEmailResponse as eH, type SendBuyerPickupConfirmationEmailRequest as eI, type SendBuyerPickupConfirmationEmailResponse as eJ, type BulkSendBuyerPickupConfirmationEmailsRequest as eK, type BulkSendBuyerPickupConfirmationEmailsResponse as eL, type SendBuyerShippingConfirmationEmailRequest as eM, type SendBuyerShippingConfirmationEmailResponse as eN, type BulkSendBuyerShippingConfirmationEmailsRequest as eO, type BulkSendBuyerShippingConfirmationEmailsResponse as eP, type SendMerchantOrderReceivedNotificationRequest as eQ, type SendMerchantOrderReceivedNotificationResponse as eR, type SendCancelRefundEmailRequest as eS, type SendCancelRefundEmailResponse as eT, type SendRefundEmailRequest as eU, type SendRefundEmailResponse as eV, type SendFulfillmentEmailRequest as eW, type SendFulfillmentEmailResponse as eX, type SendMerchantOrderReceivedPushRequest as eY, type SendMerchantOrderReceivedPushResponse as eZ, type PreviewEmailByTypeRequest as e_, type ItemChangedDetails as ea, type OrderLineItemChangedDetails as eb, type DecimalQuantityUpdate as ec, type CrossBorderAdjustmentUpdate as ed, type LineItemDelta as ee, type LineItemDeltaDeltaOneOf as ef, type AppliedDiscountDelta as eg, type AppliedDiscountDeltaDeltaOneOf as eh, type AdditionalFeeDelta as ei, type AdditionalFeeDeltaDeltaOneOf as ej, type DraftOrderCommitSettings as ek, type InventoryUpdateDetails as el, type TriggerReindexRequest as em, type TriggerReindexResponse as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type Empty as ev, type TriggerReindexOrderRequest as ew, type MessageEnvelope as ex, type IdentificationData as ey, type IdentificationDataIdOneOf as ez, type PreparePaymentCollectionApplicationErrors as f, type Duration as f$, type PreviewRefundEmailRequest as f0, type RefundDetails as f1, type RefundItem as f2, type LineItemRefund as f3, type AdditionalFeeRefund as f4, type ShippingRefund as f5, type PreviewRefundEmailResponse as f6, type PreviewCancelEmailRequest as f7, type PreviewCancelEmailResponse as f8, type PreviewCancelRefundEmailRequest as f9, type SiteHardDeleted as fA, type NamespaceChanged as fB, type StudioAssigned as fC, type StudioUnassigned as fD, type SiteUrlChanged as fE, type SitePurgedExternally as fF, type OdeditorAssigned as fG, type OdeditorUnassigned as fH, type PicassoAssigned as fI, type PicassoUnassigned as fJ, type WixelAssigned as fK, type WixelUnassigned as fL, type StudioTwoAssigned as fM, type StudioTwoUnassigned as fN, type UserDomainMediaEnabled as fO, type UserDomainMediaDisabled as fP, type EditorlessAssigned as fQ, type EditorlessUnassigned as fR, type HasCustomEmailConfigurationsRequest as fS, type HasCustomEmailConfigurationsResponse as fT, type AddToAutomationMigrationPopulationRequest as fU, type AddToAutomationMigrationPopulationResponse as fV, type IsInAutomationMigrationPopulationRequest as fW, type IsInAutomationMigrationPopulationResponse as fX, type PreparePaymentCollectionRequest as fY, type RedirectUrls as fZ, type DelayedCaptureSettings as f_, type PreviewCancelRefundEmailResponse as fa, type PreviewBuyerPaymentsReceivedEmailRequest as fb, type PreviewBuyerPaymentsReceivedEmailResponse as fc, type PreviewBuyerConfirmationEmailRequest as fd, type PreviewBuyerConfirmationEmailResponse as fe, type PreviewBuyerPickupConfirmationEmailRequest as ff, type PreviewBuyerPickupConfirmationEmailResponse as fg, type PreviewShippingConfirmationEmailRequest as fh, type PreviewShippingConfirmationEmailResponse as fi, type PreviewResendDownloadLinksEmailRequest as fj, type PreviewResendDownloadLinksEmailResponse as fk, type MetaSiteSpecialEvent as fl, type MetaSiteSpecialEventPayloadOneOf as fm, type Asset as fn, type SiteCreated as fo, type SiteTransferred as fp, type SiteDeleted as fq, type DeleteContext as fr, type SiteUndeleted as fs, type SitePublished as ft, type SiteUnpublished as fu, type SiteMarkedAsTemplate as fv, type SiteMarkedAsWixSite as fw, type ServiceProvisioned as fx, type ServiceRemoved as fy, type SiteRenamed as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type ChargeSavedPaymentMethodResponse as g$, type GetPaymentCollectabilityStatusRequest as g0, type RecordManuallyCollectedPaymentRequest as g1, type UserDefinedPaymentMethodName as g2, type UserDefinedPaymentMethodNameKindOneOf as g3, type RecordManuallyCollectedPaymentResponse as g4, type MarkOrderAsPaidRequest as g5, type BulkMarkOrdersAsPaidRequest as g6, type BulkOrderResult as g7, type ItemMetadata as g8, type ApplicationError as g9, type V1ScheduledAction as gA, type Chargeback as gB, type PaymentMethodName as gC, type GiftCardPaymentDetails as gD, type MembershipPaymentDetails as gE, type FutureMembershipDetails as gF, type WixReceiptInfo as gG, type ExternalReceiptInfo as gH, type CashRoundingDetails as gI, type CanceledStatusDetails as gJ, type DeclinedStatusDetails as gK, type VoidedStatusDetails as gL, type PaymentStatusDetails as gM, type PaymentStatusDetailsStatusDetailsOneOf as gN, type Refund as gO, type RefundTransaction as gP, type RefundStatusInfo as gQ, type AggregatedRefundSummary as gR, type RefundItemsBreakdown as gS, type LineItemRefundSummary as gT, type CalculateRefundRequest as gU, type CalculateRefundItemRequest as gV, type CalculateRefundResponse as gW, type CalculateRefundItemResponse as gX, type VoidAuthorizedPaymentsRequest as gY, type CaptureAuthorizedPaymentsRequest as gZ, type ChargeSavedPaymentMethodRequest as g_, type BulkActionMetadata as ga, type GetRefundabilityStatusRequest as gb, type Refundability as gc, type RefundabilityAdditionalRefundabilityInfoOneOf as gd, type CreatePaymentGatewayOrderRequest as ge, type ChargedBy as gf, type ChargeMembershipsRequest as gg, type MembershipChargeItem as gh, type MembershipName as gi, type ChargeMembershipsResponse as gj, type TriggerRefundRequest as gk, type RefundSideEffects as gl, type RestockInfo as gm, type RestockItem as gn, type OrderTransactions as go, type Payment as gp, type PaymentPaymentDetailsOneOf as gq, type PaymentReceiptInfoOneOf as gr, type PaymentStatusDetailsOneOf as gs, type RegularPaymentDetails as gt, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gu, type CreditCardPaymentMethodDetails as gv, type AuthorizationDetails as gw, type AuthorizationCapture as gx, type AuthorizationActionFailureDetails as gy, type AuthorizationVoid as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type UpdateOrderLineItemsResponse as h$, type V1TriggerReindexRequest as h0, type V1TriggerReindexResponse as h1, type V1TriggerReindexOrderRequest as h2, type DiffmatokyPayload as h3, type ErrorInformation as h4, type GetOrderRequest as h5, type GetOrderResponse as h6, type InternalQueryOrdersRequest as h7, type PlatformQuery as h8, type PlatformQueryPagingMethodOneOf as h9, type V1LineItemDelta as hA, type V1LineItemDeltaDeltaOneOf as hB, type CommitDeltasResponse as hC, type ArchiveOrderRequest as hD, type ArchiveOrderResponse as hE, type BulkArchiveOrdersRequest as hF, type BulkArchiveOrdersResponse as hG, type BulkArchiveOrdersByFilterRequest as hH, type BulkArchiveOrdersByFilterResponse as hI, type UnArchiveOrderRequest as hJ, type UnArchiveOrderResponse as hK, type BulkUnArchiveOrdersRequest as hL, type BulkUnArchiveOrdersResponse as hM, type BulkUnArchiveOrdersByFilterRequest as hN, type BulkUnArchiveOrdersByFilterResponse as hO, type UpdateBuyerInfoRequest as hP, type BuyerInfoUpdate as hQ, type UpdateBuyerInfoResponse as hR, type UpdateBuyerEmailRequest as hS, type UpdateBuyerEmailResponse as hT, type UpdateOrderShippingAddressRequest as hU, type UpdateOrderShippingAddressResponse as hV, type UpdateBillingContactDetailsRequest as hW, type UpdateBillingContactDetailsResponse as hX, type UpdateOrderLineItemRequest as hY, type UpdateOrderLineItemsRequest as hZ, type MaskedOrderLineItem as h_, type Sorting as ha, type PlatformPaging as hb, type CursorPaging as hc, type InternalQueryOrdersResponse as hd, type PlatformPagingMetadata as he, type Cursors as hf, type QueryOrderRequest as hg, type QueryOrderResponse as hh, type SearchOrdersRequest as hi, type CursorSearch as hj, type CursorSearchPagingMethodOneOf as hk, type CursorPagingMetadata as hl, type CreateOrderRequest as hm, type OrderCreationSettings as hn, type OrderCreationSettingsEditableByOneOf as ho, type OrderCreateNotifications as hp, type CreateOrderResponse as hq, type UpdateOrderRequest as hr, type UpdateOrderResponse as hs, type BulkUpdateOrdersRequest as ht, type CommitDeltasRequest as hu, type DraftOrderDiffs as hv, type DraftOrderDiffsShippingUpdateInfoOneOf as hw, type DraftOrderDiffsBuyerUpdateInfoOneOf as hx, type DraftOrderDiffsBillingUpdateInfoOneOf as hy, type DraftOrderDiffsRecipientUpdateInfoOneOf as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type DecrementItemsQuantityResponse as i$, type AddInternalActivityRequest as i0, type InternalActivity as i1, type InternalActivityContentOneOf as i2, type OrderPlaced as i3, type OrderPaid as i4, type OrderFulfilled as i5, type OrderNotFulfilled as i6, type OrderCanceled as i7, type DownloadLinkSent as i8, type TrackingNumberAdded as i9, type UpdateOrderStatusRequest as iA, type MarkAsFulfilledRequest as iB, type MarkAsFulfilledResponse as iC, type BulkMarkAsFulfilledRequest as iD, type BulkMarkAsFulfilledResponse as iE, type BulkMarkAsFulfilledByFilterRequest as iF, type BulkMarkAsFulfilledByFilterResponse as iG, type MarkAsUnfulfilledRequest as iH, type MarkAsUnfulfilledResponse as iI, type BulkMarkAsUnfulfilledRequest as iJ, type BulkMarkAsUnfulfilledResponse as iK, type BulkMarkAsUnfulfilledByFilterRequest as iL, type BulkMarkAsUnfulfilledByFilterResponse as iM, type BulkSetBusinessLocationRequest as iN, type BulkSetBusinessLocationResponse as iO, type BulkSetBusinessLocationResult as iP, type V1MarkOrderAsPaidRequest as iQ, type V1MarkOrderAsPaidResponse as iR, type V1BulkMarkOrdersAsPaidRequest as iS, type V1BulkMarkOrdersAsPaidResponse as iT, type V1CreatePaymentGatewayOrderRequest as iU, type V1CreatePaymentGatewayOrderResponse as iV, type GetShipmentsRequest as iW, type GetShipmentsResponse as iX, type AggregateOrdersRequest as iY, type DecrementItemsQuantityRequest as iZ, type DecrementData as i_, type TrackingNumberEdited as ia, type TrackingLinkAdded as ib, type ShippingConfirmationEmailSent as ic, type InvoiceAdded as id, type InvoiceSent as ie, type FulfillerEmailSent as ig, type ShippingAddressEdited as ih, type EmailEdited as ii, type PickupReadyEmailSent as ij, type OrderPartiallyPaid as ik, type OrderPending as il, type OrderRejected as im, type AddInternalActivityResponse as io, type AddActivityRequest as ip, type PublicActivityContentOneOf as iq, type AddActivitiesRequest as ir, type UpdateActivityRequest as is, type DeleteActivityRequest as it, type UpdateLineItemsDescriptionLinesRequest as iu, type LineItemUpdate as iv, type UpdateLineItemsDescriptionLinesResponse as iw, type MarkOrderAsSeenByHumanRequest as ix, type MarkOrderAsSeenByHumanResponse as iy, type CancelOrderRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type RepriceStatusWithLiterals as j$, type BulkUpdateOrderTagsRequest as j0, type TagsTags as j1, type TagsTagList as j2, type BulkUpdateOrderTagsResult as j3, type SendOrderUpdatedDomainEventRequest as j4, type SendOrderUpdatedDomainEventResponse as j5, type Task as j6, type TaskKey as j7, type TaskAction as j8, type TaskActionActionOneOf as j9, type ItemizedFee as jA, type Discount as jB, type DiscountOneDiscountTypeOneOf as jC, type CalculatedTaxes as jD, type CalculatedTax as jE, type Payments as jF, type InvoicesPayment as jG, type MetaData as jH, type InvoiceDynamicPriceTotals as jI, type CustomFieldValue as jJ, type Value as jK, type Deposit as jL, type BaseEventMetadata as jM, type EventMetadata as jN, type AccountInfoMetadata as jO, type OrderSearchSpec as jP, utils as jQ, type DescriptionLineTypeWithLiterals as jR, type DimensionsUnitWithLiterals as jS, type ItemTypePresetWithLiterals as jT, type PaymentOptionTypeWithLiterals as jU, type JurisdictionTypeWithLiterals as jV, type SubscriptionFrequencyWithLiterals as jW, type ProductPeriodAlignmentWithLiterals as jX, type AdjustmentTypeWithLiterals as jY, type TaxableAddressTypeWithLiterals as jZ, type MeasurementUnitWithLiterals as j_, type Complete as ja, type Cancel as jb, type Reschedule as jc, type InvoiceSentEvent as jd, type IdAndVersion as je, type InvoiceFields as jf, type Customer as jg, type Email as jh, type QuotesAddress as ji, type AddressDescription as jj, type Phone as jk, type Company as jl, type CommonAddress as jm, type CommonAddressStreetOneOf as jn, type Subdivision as jo, type StandardDetails as jp, type ShippingContactDetails as jq, type InvoiceDates as jr, type LineItems as js, type LineItem as jt, type BigDecimalWrapper as ju, type LineItemTax as jv, type Source as jw, type LineItemMetaData as jx, type Locale as jy, type TotalPrice as jz, type GetRefundabilityStatusResponse as k, onOrderCreated as k$, type BaseRateSourceWithLiterals as k0, type PaymentStatusEnumPaymentStatusWithLiterals as k1, type FulfillmentStatusWithLiterals as k2, type WeightUnitWithLiterals as k3, type VatTypeWithLiterals as k4, type PickupMethodWithLiterals as k5, type CrossBorderNotApplicableReasonWithLiterals as k6, type CrossBorderRepricingModeWithLiterals as k7, type DiscountTypeWithLiterals as k8, type DiscountValueTypeWithLiterals as k9, type ManuallyRefundableReasonWithLiterals as kA, type RestockTypeWithLiterals as kB, type TransactionStatusWithLiterals as kC, type AuthorizationCaptureStatusWithLiterals as kD, type AuthorizationVoidStatusWithLiterals as kE, type ReasonWithLiterals as kF, type ActionTypeWithLiterals as kG, type ChargebackStatusWithLiterals as kH, type MembershipPaymentStatusWithLiterals as kI, type PaymentStatusWithLiterals as kJ, type CanceledReasonWithLiterals as kK, type DeclinedReasonWithLiterals as kL, type VoidedReasonWithLiterals as kM, type RefundStatusWithLiterals as kN, type SortOrderWithLiterals as kO, type OrderApprovalStrategyWithLiterals as kP, type PlacementWithLiterals as kQ, type SubdivisionTypeWithLiterals as kR, type SourceTypeWithLiterals as kS, type CustomFieldGroupWithLiterals as kT, type ValueTypeWithLiterals as kU, type DepositTypeWithLiterals as kV, type InvoiceStatusWithLiterals as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type DiscountReasonWithLiterals as ka, type LineItemQuantityChangeTypeWithLiterals as kb, type ActivityTypeWithLiterals as kc, type OrderActivityTypeEnumActivityTypeWithLiterals as kd, type AttributionSourceWithLiterals as ke, type ChannelTypeWithLiterals as kf, type AdditionalFeeSourceWithLiterals as kg, type OrderActionTypeWithLiterals as kh, type SpecificItemsCouponBehaviorWithLiterals as ki, type ChargeTypeWithLiterals as kj, type VersioningModeWithLiterals as kk, type DeltaPaymentOptionTypeWithLiterals as kl, type InventoryActionWithLiterals as km, type WebhookIdentityTypeWithLiterals as kn, type PreviewEmailTypeWithLiterals as ko, type StateWithLiterals as kp, type SiteCreatedContextWithLiterals as kq, type NamespaceWithLiterals as kr, type DeleteStatusWithLiterals as ks, type OriginWithLiterals as kt, type ScheduledActionWithLiterals as ku, type DurationUnitWithLiterals as kv, type PaymentCollectabilityStatusWithLiterals as kw, type PredefinedPaymentMethodWithLiterals as kx, type RefundableStatusWithLiterals as ky, type NonRefundableReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, recordManuallyCollectedPayment as la, paymentCollectionMarkOrderAsPaid as lb, paymentCollectionBulkMarkOrdersAsPaid as lc, getRefundabilityStatus as ld, paymentCollectionCreatePaymentGatewayOrder as le, chargeMemberships as lf, triggerRefund as lg, voidAuthorizedPayments as lh, captureAuthorizedPayments as li, getOrder as lj, createOrder as lk, updateOrder as ll, bulkUpdateOrders as lm, updateOrderLineItem as ln, addActivity as lo, addActivities as lp, updateActivity as lq, deleteActivity as lr, cancelOrder as ls, updateOrderStatus as lt, aggregateOrders as lu, bulkUpdateOrderTags as lv, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10988
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, AuthorizationCaptureStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountValueType as aD, DiscountReason as aE, LineItemQuantityChangeType as aF, ActivityType as aG, OrderActivityTypeEnumActivityType as aH, AttributionSource as aI, ChannelType as aJ, AdditionalFeeSource as aK, OrderActionType as aL, SpecificItemsCouponBehavior as aM, ChargeType as aN, VersioningMode as aO, DeltaPaymentOptionType as aP, InventoryAction as aQ, WebhookIdentityType as aR, ScheduledAction as aS, DurationUnit as aT, PaymentCollectabilityStatus as aU, PredefinedPaymentMethod as aV, RefundableStatus as aW, NonRefundableReason as aX, ManuallyRefundableReason as aY, RestockType as aZ, TransactionStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type ServiceProperties as b$, AuthorizationVoidStatus as b0, Reason as b1, ActionType as b2, ChargebackStatus as b3, MembershipPaymentStatus as b4, PaymentStatus as b5, CanceledReason as b6, DeclinedReason as b7, VoidedReason as b8, RefundStatus as b9, type Dimensions as bA, type ItemType as bB, type ItemTypeItemTypeDataOneOf as bC, type RestockLocation as bD, type ItemTaxFullDetails as bE, type LineItemTaxInfo as bF, type LineItemTaxBreakdown as bG, type DigitalFile as bH, type SubscriptionInfo as bI, type SubscriptionTitle as bJ, type SubscriptionDescription as bK, type SubscriptionSettings as bL, type FreeTrialPeriod as bM, type BillingSettings as bN, type BillingAdjustment as bO, type BillingAdjustmentPriceSummary as bP, type CyclePriceOverride as bQ, type PriceDescription as bR, type LocationAndQuantity as bS, type TaxableAddress as bT, type TaxableAddressTaxableAddressDataOneOf as bU, type DecimalQuantity as bV, type DecimalQuantityUnitOneOf as bW, type TranslatableString as bX, type ExtendedFields as bY, type ModifierGroup as bZ, type ItemModifier as b_, PreviewEmailType as ba, State as bb, SiteCreatedContext as bc, Namespace as bd, DeleteStatus as be, Origin as bf, SortOrder as bg, OrderApprovalStrategy as bh, Placement as bi, SubdivisionType as bj, SourceType as bk, CustomFieldGroup as bl, ValueType as bm, DepositType as bn, InvoiceStatus as bo, type OrderLineItem as bp, type ProductName as bq, type CatalogReference as br, type DescriptionLine as bs, type DescriptionLineValueOneOf as bt, type DescriptionLineDescriptionLineValueOneOf as bu, type DescriptionLineName as bv, type PlainTextValue as bw, type Color as bx, type FocalPoint as by, type PhysicalProperties as bz, type SetOrderNumberCounterApplicationErrors as c, type AuthorizedPaymentCreated as c$, type CrossBorderPriceAdjustment as c0, type BuyerInfo as c1, type BuyerInfoIdOneOf as c2, type CurrencyConversionDetails as c3, type CrossBorderRepricing as c4, type PriceSummary as c5, type AddressWithContact as c6, type Address as c7, type StreetAddress as c8, type AddressLocation as c9, type Activity as cA, type ActivityContentOneOf as cB, type CustomActivity as cC, type MerchantComment as cD, type OrderRefunded as cE, type OrderCreatedFromExchange as cF, type NewExchangeOrderCreated as cG, type LineItemExchangeData as cH, type DraftOrderChangesApplied as cI, type OrderChange as cJ, type OrderChangeValueOneOf as cK, type LineItemChanges as cL, type LineItemQuantityChange as cM, type LineItemPriceChange as cN, type LineItemProductNameChange as cO, type LineItemDescriptionLineChange as cP, type LineItemModifiersChange as cQ, type ManagedLineItem as cR, type ManagedDiscount as cS, type TranslatedValue as cT, type LineItemAmount as cU, type ManagedAdditionalFee as cV, type TotalPriceChange as cW, type ShippingInformationChange as cX, type ShippingInformation as cY, type PricesRecalculatedForDestination as cZ, type SavedPaymentMethod as c_, type FullAddressContactDetails as ca, type VatId as cb, type V1ShippingInformation as cc, type DeliveryLogistics as cd, type DeliveryLogisticsAddressOneOf as ce, type PickupDetails as cf, type PickupAddress as cg, type DeliveryTimeSlot as ch, type ShippingPrice as ci, type ShippingRegion as cj, type TaxSummary as ck, type OrderTaxInfo as cl, type OrderTaxBreakdown as cm, type CrossBorderCalculation as cn, type AppliedDiscount as co, type AppliedDiscountDiscountSourceOneOf as cp, type Coupon as cq, type CouponDiscountValueOneOf as cr, type MerchantDiscount as cs, type MerchantDiscountMerchantDiscountReasonOneOf as ct, type DiscountRule as cu, type DiscountRuleDiscountValueOneOf as cv, type DiscountRuleName as cw, type LineItemDiscount as cx, type ItemCombination as cy, type ItemCombinationLineItem as cz, type PreparePaymentCollectionOptions as d, type OrderRejectedEventOrderRejected as d$, type AuthorizedPaymentCaptured as d0, type AuthorizedPaymentVoided as d1, type RefundInitiated as d2, type RefundedPayment as d3, type RefundedPaymentKindOneOf as d4, type RegularPaymentRefund as d5, type GiftCardPaymentRefund as d6, type MembershipPaymentRefund as d7, type PaymentRefunded as d8, type PaymentRefundFailed as d9, type AdditionalFee as dA, type FulfillmentStatusesAggregate as dB, type Tags as dC, type TagList as dD, type Location as dE, type OrderSettings as dF, type OrderSettingsAllowedActionsOneOf as dG, type OrderSettingsEditableByOneOf as dH, type CustomAllowedActions as dI, type OwnerApps as dJ, type FormInfo as dK, type FormIdentifier as dL, type PlatformFeeSummary as dM, type PlatformFee as dN, type UpdateInternalDocumentsEvent as dO, type UpdateInternalDocumentsEventOperationOneOf as dP, type InternalDocument as dQ, type InternalDocumentUpdateOperation as dR, type DeleteByIdsOperation as dS, type DeleteByFilterOperation as dT, type InternalDocumentUpdateByFilterOperation as dU, type InternalUpdateExistingOperation as dV, type VersionedDocumentUpdateOperation as dW, type VersionedDeleteByIdsOperation as dX, type VersionedDocumentId as dY, type OrderApproved as dZ, type OrdersExperiments as d_, type RefundedAsStoreCredit as da, type PaymentPending as db, type PaymentPendingPaymentDetailsOneOf as dc, type RegularPayment as dd, type RegularPaymentPaymentMethodDetailsOneOf as de, type CreditCardDetails as df, type PaymentCanceled as dg, type PaymentCanceledPaymentDetailsOneOf as dh, type PaymentDeclined as di, type PaymentDeclinedPaymentDetailsOneOf as dj, type ReceiptCreated as dk, type ReceiptCreatedReceiptInfoOneOf as dl, type WixReceipt as dm, type ExternalReceipt as dn, type ReceiptSent as dp, type ReceiptSentReceiptInfoOneOf as dq, type ChargebackCreated as dr, type ChargebackReversed as ds, type CreatedBy as dt, type CreatedByStringOneOf as du, type ChannelInfo as dv, type CustomField as dw, type BalanceSummary as dx, type Balance as dy, type CashRounding as dz, type PreparePaymentCollectionResponse as e, type ChargeMembershipsRequest as e$, type OrderItemsRestocked as e0, type V1RestockItem as e1, type OrderImported as e2, type ImportedOrderDeleted as e3, type PaymentStatusUpdated as e4, type FulfillmentStatusUpdated as e5, type OrderCanceledEventOrderCanceled as e6, type OrderDeltasCommitted as e7, type CommittedDiffs as e8, type CommittedDiffsShippingUpdateInfoOneOf as e9, type AccountInfo as eA, type ImportOrderRequest as eB, type SetOrderNumberCounterRequest as eC, type BulkDeleteImportedOrdersRequest as eD, type V1TriggerReindexRequest as eE, type V1TriggerReindexResponse as eF, type V1TriggerReindexOrderRequest as eG, type PreparePaymentCollectionRequest as eH, type RedirectUrls as eI, type DelayedCaptureSettings as eJ, type Duration as eK, type GetPaymentCollectabilityStatusRequest as eL, type RecordManuallyCollectedPaymentRequest as eM, type UserDefinedPaymentMethodName as eN, type UserDefinedPaymentMethodNameKindOneOf as eO, type RecordManuallyCollectedPaymentResponse as eP, type MarkOrderAsPaidRequest as eQ, type BulkMarkOrdersAsPaidRequest as eR, type BulkOrderResult as eS, type ItemMetadata as eT, type ApplicationError as eU, type BulkActionMetadata as eV, type GetRefundabilityStatusRequest as eW, type Refundability as eX, type RefundabilityAdditionalRefundabilityInfoOneOf as eY, type CreatePaymentGatewayOrderRequest as eZ, type ChargedBy as e_, type ItemChangedDetails as ea, type OrderLineItemChangedDetails as eb, type DecimalQuantityUpdate as ec, type CrossBorderAdjustmentUpdate as ed, type LineItemDelta as ee, type LineItemDeltaDeltaOneOf as ef, type AppliedDiscountDelta as eg, type AppliedDiscountDeltaDeltaOneOf as eh, type AdditionalFeeDelta as ei, type AdditionalFeeDeltaDeltaOneOf as ej, type DraftOrderCommitSettings as ek, type InventoryUpdateDetails as el, type TriggerReindexRequest as em, type TriggerReindexResponse as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type Empty as ev, type TriggerReindexOrderRequest as ew, type MessageEnvelope as ex, type IdentificationData as ey, type IdentificationDataIdOneOf as ez, type PreparePaymentCollectionApplicationErrors as f, type BulkSendBuyerShippingConfirmationEmailsResponse as f$, type MembershipChargeItem as f0, type MembershipName as f1, type ChargeMembershipsResponse as f2, type TriggerRefundRequest as f3, type RefundDetails as f4, type RefundItem as f5, type LineItemRefund as f6, type AdditionalFeeRefund as f7, type ShippingRefund as f8, type RefundSideEffects as f9, type PaymentStatusDetails as fA, type PaymentStatusDetailsStatusDetailsOneOf as fB, type Refund as fC, type RefundTransaction as fD, type RefundStatusInfo as fE, type AggregatedRefundSummary as fF, type RefundItemsBreakdown as fG, type LineItemRefundSummary as fH, type CalculateRefundRequest as fI, type CalculateRefundItemRequest as fJ, type CalculateRefundResponse as fK, type CalculateRefundItemResponse as fL, type VoidAuthorizedPaymentsRequest as fM, type CaptureAuthorizedPaymentsRequest as fN, type ChargeSavedPaymentMethodRequest as fO, type ChargeSavedPaymentMethodResponse as fP, type SendBuyerConfirmationEmailRequest as fQ, type SendBuyerConfirmationEmailResponse as fR, type SendBuyerPaymentsReceivedEmailRequest as fS, type SendBuyerPaymentsReceivedEmailResponse as fT, type SendBuyerPickupConfirmationEmailRequest as fU, type SendBuyerPickupConfirmationEmailResponse as fV, type BulkSendBuyerPickupConfirmationEmailsRequest as fW, type BulkSendBuyerPickupConfirmationEmailsResponse as fX, type SendBuyerShippingConfirmationEmailRequest as fY, type SendBuyerShippingConfirmationEmailResponse as fZ, type BulkSendBuyerShippingConfirmationEmailsRequest as f_, type RestockInfo as fa, type RestockItem as fb, type OrderTransactions as fc, type Payment as fd, type PaymentPaymentDetailsOneOf as fe, type PaymentReceiptInfoOneOf as ff, type PaymentStatusDetailsOneOf as fg, type RegularPaymentDetails as fh, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fi, type CreditCardPaymentMethodDetails as fj, type AuthorizationDetails as fk, type AuthorizationCapture as fl, type AuthorizationActionFailureDetails as fm, type AuthorizationVoid as fn, type V1ScheduledAction as fo, type Chargeback as fp, type PaymentMethodName as fq, type GiftCardPaymentDetails as fr, type MembershipPaymentDetails as fs, type FutureMembershipDetails as ft, type WixReceiptInfo as fu, type ExternalReceiptInfo as fv, type CashRoundingDetails as fw, type CanceledStatusDetails as fx, type DeclinedStatusDetails as fy, type VoidedStatusDetails as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type AddToAutomationMigrationPopulationRequest as g$, type SendMerchantOrderReceivedNotificationRequest as g0, type SendMerchantOrderReceivedNotificationResponse as g1, type SendCancelRefundEmailRequest as g2, type SendCancelRefundEmailResponse as g3, type SendRefundEmailRequest as g4, type SendRefundEmailResponse as g5, type SendFulfillmentEmailRequest as g6, type SendFulfillmentEmailResponse as g7, type SendMerchantOrderReceivedPushRequest as g8, type SendMerchantOrderReceivedPushResponse as g9, type SitePublished as gA, type SiteUnpublished as gB, type SiteMarkedAsTemplate as gC, type SiteMarkedAsWixSite as gD, type ServiceProvisioned as gE, type ServiceRemoved as gF, type SiteRenamed as gG, type SiteHardDeleted as gH, type NamespaceChanged as gI, type StudioAssigned as gJ, type StudioUnassigned as gK, type SiteUrlChanged as gL, type SitePurgedExternally as gM, type OdeditorAssigned as gN, type OdeditorUnassigned as gO, type PicassoAssigned as gP, type PicassoUnassigned as gQ, type WixelAssigned as gR, type WixelUnassigned as gS, type StudioTwoAssigned as gT, type StudioTwoUnassigned as gU, type UserDomainMediaEnabled as gV, type UserDomainMediaDisabled as gW, type EditorlessAssigned as gX, type EditorlessUnassigned as gY, type HasCustomEmailConfigurationsRequest as gZ, type HasCustomEmailConfigurationsResponse as g_, type PreviewEmailByTypeRequest as ga, type PreviewEmailByTypeResponse as gb, type PreviewRefundEmailRequest as gc, type PreviewRefundEmailResponse as gd, type PreviewCancelEmailRequest as ge, type PreviewCancelEmailResponse as gf, type PreviewCancelRefundEmailRequest as gg, type PreviewCancelRefundEmailResponse as gh, type PreviewBuyerPaymentsReceivedEmailRequest as gi, type PreviewBuyerPaymentsReceivedEmailResponse as gj, type PreviewBuyerConfirmationEmailRequest as gk, type PreviewBuyerConfirmationEmailResponse as gl, type PreviewBuyerPickupConfirmationEmailRequest as gm, type PreviewBuyerPickupConfirmationEmailResponse as gn, type PreviewShippingConfirmationEmailRequest as go, type PreviewShippingConfirmationEmailResponse as gp, type PreviewResendDownloadLinksEmailRequest as gq, type PreviewResendDownloadLinksEmailResponse as gr, type MetaSiteSpecialEvent as gs, type MetaSiteSpecialEventPayloadOneOf as gt, type Asset as gu, type SiteCreated as gv, type SiteTransferred as gw, type SiteDeleted as gx, type DeleteContext as gy, type SiteUndeleted as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type UpdateOrderLineItemsResponse as h$, type AddToAutomationMigrationPopulationResponse as h0, type IsInAutomationMigrationPopulationRequest as h1, type IsInAutomationMigrationPopulationResponse as h2, type DiffmatokyPayload as h3, type ErrorInformation as h4, type GetOrderRequest as h5, type GetOrderResponse as h6, type InternalQueryOrdersRequest as h7, type PlatformQuery as h8, type PlatformQueryPagingMethodOneOf as h9, type V1LineItemDelta as hA, type V1LineItemDeltaDeltaOneOf as hB, type CommitDeltasResponse as hC, type ArchiveOrderRequest as hD, type ArchiveOrderResponse as hE, type BulkArchiveOrdersRequest as hF, type BulkArchiveOrdersResponse as hG, type BulkArchiveOrdersByFilterRequest as hH, type BulkArchiveOrdersByFilterResponse as hI, type UnArchiveOrderRequest as hJ, type UnArchiveOrderResponse as hK, type BulkUnArchiveOrdersRequest as hL, type BulkUnArchiveOrdersResponse as hM, type BulkUnArchiveOrdersByFilterRequest as hN, type BulkUnArchiveOrdersByFilterResponse as hO, type UpdateBuyerInfoRequest as hP, type BuyerInfoUpdate as hQ, type UpdateBuyerInfoResponse as hR, type UpdateBuyerEmailRequest as hS, type UpdateBuyerEmailResponse as hT, type UpdateOrderShippingAddressRequest as hU, type UpdateOrderShippingAddressResponse as hV, type UpdateBillingContactDetailsRequest as hW, type UpdateBillingContactDetailsResponse as hX, type UpdateOrderLineItemRequest as hY, type UpdateOrderLineItemsRequest as hZ, type MaskedOrderLineItem as h_, type Sorting as ha, type PlatformPaging as hb, type CursorPaging as hc, type InternalQueryOrdersResponse as hd, type PlatformPagingMetadata as he, type Cursors as hf, type QueryOrderRequest as hg, type QueryOrderResponse as hh, type SearchOrdersRequest as hi, type CursorSearch as hj, type CursorSearchPagingMethodOneOf as hk, type CursorPagingMetadata as hl, type CreateOrderRequest as hm, type OrderCreationSettings as hn, type OrderCreationSettingsEditableByOneOf as ho, type OrderCreateNotifications as hp, type CreateOrderResponse as hq, type UpdateOrderRequest as hr, type UpdateOrderResponse as hs, type BulkUpdateOrdersRequest as ht, type CommitDeltasRequest as hu, type DraftOrderDiffs as hv, type DraftOrderDiffsShippingUpdateInfoOneOf as hw, type DraftOrderDiffsBuyerUpdateInfoOneOf as hx, type DraftOrderDiffsBillingUpdateInfoOneOf as hy, type DraftOrderDiffsRecipientUpdateInfoOneOf as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type DecrementItemsQuantityResponse as i$, type AddInternalActivityRequest as i0, type InternalActivity as i1, type InternalActivityContentOneOf as i2, type OrderPlaced as i3, type OrderPaid as i4, type OrderFulfilled as i5, type OrderNotFulfilled as i6, type OrderCanceled as i7, type DownloadLinkSent as i8, type TrackingNumberAdded as i9, type UpdateOrderStatusRequest as iA, type MarkAsFulfilledRequest as iB, type MarkAsFulfilledResponse as iC, type BulkMarkAsFulfilledRequest as iD, type BulkMarkAsFulfilledResponse as iE, type BulkMarkAsFulfilledByFilterRequest as iF, type BulkMarkAsFulfilledByFilterResponse as iG, type MarkAsUnfulfilledRequest as iH, type MarkAsUnfulfilledResponse as iI, type BulkMarkAsUnfulfilledRequest as iJ, type BulkMarkAsUnfulfilledResponse as iK, type BulkMarkAsUnfulfilledByFilterRequest as iL, type BulkMarkAsUnfulfilledByFilterResponse as iM, type BulkSetBusinessLocationRequest as iN, type BulkSetBusinessLocationResponse as iO, type BulkSetBusinessLocationResult as iP, type V1MarkOrderAsPaidRequest as iQ, type V1MarkOrderAsPaidResponse as iR, type V1BulkMarkOrdersAsPaidRequest as iS, type V1BulkMarkOrdersAsPaidResponse as iT, type V1CreatePaymentGatewayOrderRequest as iU, type V1CreatePaymentGatewayOrderResponse as iV, type GetShipmentsRequest as iW, type GetShipmentsResponse as iX, type AggregateOrdersRequest as iY, type DecrementItemsQuantityRequest as iZ, type DecrementData as i_, type TrackingNumberEdited as ia, type TrackingLinkAdded as ib, type ShippingConfirmationEmailSent as ic, type InvoiceAdded as id, type InvoiceSent as ie, type FulfillerEmailSent as ig, type ShippingAddressEdited as ih, type EmailEdited as ii, type PickupReadyEmailSent as ij, type OrderPartiallyPaid as ik, type OrderPending as il, type OrderRejected as im, type AddInternalActivityResponse as io, type AddActivityRequest as ip, type PublicActivityContentOneOf as iq, type AddActivitiesRequest as ir, type UpdateActivityRequest as is, type DeleteActivityRequest as it, type UpdateLineItemsDescriptionLinesRequest as iu, type LineItemUpdate as iv, type UpdateLineItemsDescriptionLinesResponse as iw, type MarkOrderAsSeenByHumanRequest as ix, type MarkOrderAsSeenByHumanResponse as iy, type CancelOrderRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type RepriceStatusWithLiterals as j$, type BulkUpdateOrderTagsRequest as j0, type TagsTags as j1, type TagsTagList as j2, type BulkUpdateOrderTagsResult as j3, type SendOrderUpdatedDomainEventRequest as j4, type SendOrderUpdatedDomainEventResponse as j5, type Task as j6, type TaskKey as j7, type TaskAction as j8, type TaskActionActionOneOf as j9, type ItemizedFee as jA, type Discount as jB, type DiscountOneDiscountTypeOneOf as jC, type CalculatedTaxes as jD, type CalculatedTax as jE, type Payments as jF, type InvoicesPayment as jG, type MetaData as jH, type InvoiceDynamicPriceTotals as jI, type CustomFieldValue as jJ, type Value as jK, type Deposit as jL, type BaseEventMetadata as jM, type EventMetadata as jN, type AccountInfoMetadata as jO, type OrderSearchSpec as jP, utils as jQ, type DescriptionLineTypeWithLiterals as jR, type DimensionsUnitWithLiterals as jS, type ItemTypePresetWithLiterals as jT, type PaymentOptionTypeWithLiterals as jU, type JurisdictionTypeWithLiterals as jV, type SubscriptionFrequencyWithLiterals as jW, type ProductPeriodAlignmentWithLiterals as jX, type AdjustmentTypeWithLiterals as jY, type TaxableAddressTypeWithLiterals as jZ, type MeasurementUnitWithLiterals as j_, type Complete as ja, type Cancel as jb, type Reschedule as jc, type InvoiceSentEvent as jd, type IdAndVersion as je, type InvoiceFields as jf, type Customer as jg, type Email as jh, type QuotesAddress as ji, type AddressDescription as jj, type Phone as jk, type Company as jl, type CommonAddress as jm, type CommonAddressStreetOneOf as jn, type Subdivision as jo, type StandardDetails as jp, type ShippingContactDetails as jq, type InvoiceDates as jr, type LineItems as js, type LineItem as jt, type BigDecimalWrapper as ju, type LineItemTax as jv, type Source as jw, type LineItemMetaData as jx, type Locale as jy, type TotalPrice as jz, type GetRefundabilityStatusResponse as k, onOrderCreated as k$, type BaseRateSourceWithLiterals as k0, type PaymentStatusEnumPaymentStatusWithLiterals as k1, type FulfillmentStatusWithLiterals as k2, type WeightUnitWithLiterals as k3, type VatTypeWithLiterals as k4, type PickupMethodWithLiterals as k5, type CrossBorderNotApplicableReasonWithLiterals as k6, type CrossBorderRepricingModeWithLiterals as k7, type DiscountTypeWithLiterals as k8, type DiscountValueTypeWithLiterals as k9, type ActionTypeWithLiterals as kA, type ChargebackStatusWithLiterals as kB, type MembershipPaymentStatusWithLiterals as kC, type PaymentStatusWithLiterals as kD, type CanceledReasonWithLiterals as kE, type DeclinedReasonWithLiterals as kF, type VoidedReasonWithLiterals as kG, type RefundStatusWithLiterals as kH, type PreviewEmailTypeWithLiterals as kI, type StateWithLiterals as kJ, type SiteCreatedContextWithLiterals as kK, type NamespaceWithLiterals as kL, type DeleteStatusWithLiterals as kM, type OriginWithLiterals as kN, type SortOrderWithLiterals as kO, type OrderApprovalStrategyWithLiterals as kP, type PlacementWithLiterals as kQ, type SubdivisionTypeWithLiterals as kR, type SourceTypeWithLiterals as kS, type CustomFieldGroupWithLiterals as kT, type ValueTypeWithLiterals as kU, type DepositTypeWithLiterals as kV, type InvoiceStatusWithLiterals as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type DiscountReasonWithLiterals as ka, type LineItemQuantityChangeTypeWithLiterals as kb, type ActivityTypeWithLiterals as kc, type OrderActivityTypeEnumActivityTypeWithLiterals as kd, type AttributionSourceWithLiterals as ke, type ChannelTypeWithLiterals as kf, type AdditionalFeeSourceWithLiterals as kg, type OrderActionTypeWithLiterals as kh, type SpecificItemsCouponBehaviorWithLiterals as ki, type ChargeTypeWithLiterals as kj, type VersioningModeWithLiterals as kk, type DeltaPaymentOptionTypeWithLiterals as kl, type InventoryActionWithLiterals as km, type WebhookIdentityTypeWithLiterals as kn, type ScheduledActionWithLiterals as ko, type DurationUnitWithLiterals as kp, type PaymentCollectabilityStatusWithLiterals as kq, type PredefinedPaymentMethodWithLiterals as kr, type RefundableStatusWithLiterals as ks, type NonRefundableReasonWithLiterals as kt, type ManuallyRefundableReasonWithLiterals as ku, type RestockTypeWithLiterals as kv, type TransactionStatusWithLiterals as kw, type AuthorizationCaptureStatusWithLiterals as kx, type AuthorizationVoidStatusWithLiterals as ky, type ReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, recordManuallyCollectedPayment as la, paymentCollectionMarkOrderAsPaid as lb, paymentCollectionBulkMarkOrdersAsPaid as lc, getRefundabilityStatus as ld, paymentCollectionCreatePaymentGatewayOrder as le, chargeMemberships as lf, triggerRefund as lg, voidAuthorizedPayments as lh, captureAuthorizedPayments as li, getOrder as lj, createOrder as lk, updateOrder as ll, bulkUpdateOrders as lm, updateOrderLineItem as ln, addActivity as lo, addActivities as lp, updateActivity as lq, deleteActivity as lr, cancelOrder as ls, updateOrderStatus as lt, aggregateOrders as lu, bulkUpdateOrderTags as lv, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };