@wix/auto_sdk_ecom_orders 1.0.327 → 1.0.328

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