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