@wix/auto_sdk_ecom_orders 1.0.318 → 1.0.319

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-cwJXByV0.d.ts → ecom-v1-order-orders.universal-DkuT45RM.d.ts} +1694 -1684
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1694 -1684
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-cwJXByV0.d.mts → ecom-v1-order-orders.universal-DkuT45RM.d.mts} +1694 -1684
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1694 -1684
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-CaNCF4JV.d.ts → ecom-v1-order-orders.universal-CaKWoBtD.d.ts} +1830 -1820
  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 +1830 -1820
  25. package/build/internal/es/{ecom-v1-order-orders.universal-CaNCF4JV.d.mts → ecom-v1-order-orders.universal-CaKWoBtD.d.mts} +1830 -1820
  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 +1830 -1820
  29. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { e4 as ImportOrderRequest$1, I as ImportOrderResponse$1, e5 as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, e6 as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, ea as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ee as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ef as RecordManuallyCollectedPaymentRequest$1, ei as RecordManuallyCollectedPaymentResponse$1, ej as MarkOrderAsPaidRequest$1, ek as MarkOrderAsPaidResponse$1, el as BulkMarkOrdersAsPaidRequest$1, em as BulkMarkOrdersAsPaidResponse$1, er as GetRefundabilityStatusRequest$1, es as GetRefundabilityStatusResponse$1, ev as CreatePaymentGatewayOrderRequest$1, ex as CreatePaymentGatewayOrderResponse$1, ey as ChargeMembershipsRequest$1, eB as ChargeMembershipsResponse$1, eC as TriggerRefundRequest$1, eM as TriggerRefundResponse$1, fl as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fm as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gG as GetOrderRequest$1, gH as GetOrderResponse$1, gT as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gX as CreateOrderRequest$1, g$ as CreateOrderResponse$1, h0 as UpdateOrderRequest$1, h1 as UpdateOrderResponse$1, h2 as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, hx as UpdateOrderLineItemRequest$1, hy as UpdateOrderLineItemResponse$1, hZ as AddActivityRequest$1, i0 as AddActivityResponse$1, i1 as AddActivitiesRequest$1, r as AddActivitiesResponse$1, i2 as UpdateActivityRequest$1, i3 as UpdateActivityResponse$1, i4 as DeleteActivityRequest$1, i5 as DeleteActivityResponse$1, ib as CancelOrderRequest$1, t as CancelOrderResponse$1, ic as UpdateOrderStatusRequest$1, id as UpdateOrderStatusResponse$1, iD as AggregateOrdersRequest$1, iE as AggregateOrdersResponse$1, iI as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-cwJXByV0.mjs';
1
+ import { e4 as ImportOrderRequest$1, I as ImportOrderResponse$1, e5 as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, e6 as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fr as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fv as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fw as RecordManuallyCollectedPaymentRequest$1, fz as RecordManuallyCollectedPaymentResponse$1, fA as MarkOrderAsPaidRequest$1, fB as MarkOrderAsPaidResponse$1, fC as BulkMarkOrdersAsPaidRequest$1, fD as BulkMarkOrdersAsPaidResponse$1, fI as GetRefundabilityStatusRequest$1, fJ as GetRefundabilityStatusResponse$1, fM as CreatePaymentGatewayOrderRequest$1, fO as CreatePaymentGatewayOrderResponse$1, fP as ChargeMembershipsRequest$1, fS as ChargeMembershipsResponse$1, fT as TriggerRefundRequest$1, fY as TriggerRefundResponse$1, gx as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gy as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gG as GetOrderRequest$1, gH as GetOrderResponse$1, gT as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gX as CreateOrderRequest$1, g$ as CreateOrderResponse$1, h0 as UpdateOrderRequest$1, h1 as UpdateOrderResponse$1, h2 as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, hx as UpdateOrderLineItemRequest$1, hy as UpdateOrderLineItemResponse$1, hZ as AddActivityRequest$1, i0 as AddActivityResponse$1, i1 as AddActivitiesRequest$1, r as AddActivitiesResponse$1, i2 as UpdateActivityRequest$1, i3 as UpdateActivityResponse$1, i4 as DeleteActivityRequest$1, i5 as DeleteActivityResponse$1, ib as CancelOrderRequest$1, t as CancelOrderResponse$1, ic as UpdateOrderStatusRequest$1, id as UpdateOrderStatusResponse$1, iD as AggregateOrdersRequest$1, iE as AggregateOrdersResponse$1, iI as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DkuT45RM.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -730,10 +730,16 @@ interface DigitalFile {
730
730
  interface SubscriptionInfo {
731
731
  /**
732
732
  * Subscription ID.
733
+ *
734
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
735
+ * To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
733
736
  * @format GUID
734
737
  */
735
738
  id?: string | null;
736
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
739
+ /**
740
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
741
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
742
+ */
737
743
  cycleNumber?: number;
738
744
  /**
739
745
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -788,7 +794,7 @@ interface SubscriptionDescription {
788
794
  translated?: string | null;
789
795
  }
790
796
  interface SubscriptionSettings {
791
- /** Frequency of recurring payment. */
797
+ /** Frequency unit of the billing cycle. */
792
798
  frequency?: SubscriptionFrequencyWithLiterals;
793
799
  /**
794
800
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -796,16 +802,20 @@ interface SubscriptionSettings {
796
802
  * @max 3650
797
803
  */
798
804
  interval?: number | null;
799
- /** Whether subscription is renewed automatically at the end of each period. */
805
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
800
806
  autoRenewal?: boolean;
801
807
  /**
802
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
808
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
803
809
  * @min 1
804
810
  */
805
811
  billingCycles?: number | null;
806
- /** Whether to allow the customer to cancel the subscription. */
812
+ /** Whether the buyer can cancel the subscription. */
807
813
  enableCustomerCancellation?: boolean;
808
- /** Period until first cycle starts. If None => no free trial */
814
+ /**
815
+ * Free trial period before the first billing cycle starts.
816
+ *
817
+ * Returned only when the subscription has a free trial.
818
+ */
809
819
  freeTrialPeriod?: FreeTrialPeriod;
810
820
  }
811
821
  /** Frequency unit of recurring payment */
@@ -819,7 +829,7 @@ declare enum SubscriptionFrequency {
819
829
  /** @enumType */
820
830
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
821
831
  interface FreeTrialPeriod {
822
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
832
+ /** Frequency unit of the free trial period. */
823
833
  frequency?: SubscriptionFrequencyWithLiterals;
824
834
  /**
825
835
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -4080,461 +4090,163 @@ interface BulkDeleteImportedOrdersResponse {
4080
4090
  */
4081
4091
  jobId?: string;
4082
4092
  }
4083
- interface V1TriggerReindexRequest {
4093
+ interface SendBuyerConfirmationEmailRequest {
4084
4094
  /** @format GUID */
4085
- metasiteId?: string;
4086
- /**
4087
- * @minLength 1
4088
- * @maxLength 100
4089
- * @maxSize 100
4090
- */
4091
- orderIds?: string[];
4095
+ orderId?: string;
4092
4096
  }
4093
- interface V1TriggerReindexResponse {
4097
+ interface SendBuyerConfirmationEmailResponse {
4094
4098
  }
4095
- interface V1TriggerReindexOrderRequest {
4096
- /** @format GUID */
4097
- metasiteId?: string;
4099
+ interface SendBuyerPaymentsReceivedEmailRequest {
4098
4100
  /**
4099
4101
  * @minLength 1
4100
4102
  * @maxLength 100
4101
4103
  */
4102
4104
  orderId?: string;
4103
4105
  }
4104
- interface PreparePaymentCollectionRequest {
4106
+ interface SendBuyerPaymentsReceivedEmailResponse {
4107
+ }
4108
+ interface SendBuyerPickupConfirmationEmailRequest {
4105
4109
  /**
4106
- * Ecom order ID.
4107
4110
  * @minLength 1
4108
4111
  * @maxLength 100
4109
4112
  */
4110
- ecomOrderId: string;
4111
- /** Amount to collect */
4112
- amount: Price;
4113
- /**
4114
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4115
- * Existing payment gateway order will be updated with a new amount.
4116
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4117
- */
4118
- paymentGatewayOrderId?: string | null;
4119
- /**
4120
- * Whether to delay capture of the payment.
4121
- * Default: false
4122
- * @deprecated Whether to delay capture of the payment.
4123
- * Default: false
4124
- * @replacedBy delayed_capture_settings.scheduled_action
4125
- * @targetRemovalDate 2024-09-30
4126
- */
4127
- delayedCapture?: boolean;
4128
- /** Delayed capture payment settings */
4129
- delayedCaptureSettings?: DelayedCaptureSettings;
4113
+ orderId?: string;
4130
4114
  }
4131
- interface RedirectUrls {
4132
- /**
4133
- * URL to redirect buyer in case of approved (successful) transaction
4134
- * @format WEB_URL
4135
- */
4136
- successUrl?: string | null;
4137
- /**
4138
- * URL to redirect buyer in case of buyer canceled the transaction
4139
- * @format WEB_URL
4140
- */
4141
- cancelUrl?: string | null;
4115
+ interface SendBuyerPickupConfirmationEmailResponse {
4116
+ }
4117
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4142
4118
  /**
4143
- * URL to redirect buyer in case of failed/rejected transaction
4144
- * @format WEB_URL
4119
+ * IDs of orders to send pickup emails for.
4120
+ * @minSize 1
4121
+ * @maxSize 300
4145
4122
  */
4146
- errorUrl?: string | null;
4123
+ orderIds?: string[];
4124
+ }
4125
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4126
+ }
4127
+ interface SendBuyerShippingConfirmationEmailRequest {
4147
4128
  /**
4148
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4149
- * @format WEB_URL
4129
+ * @minLength 1
4130
+ * @maxLength 100
4150
4131
  */
4151
- pendingUrl?: string | null;
4152
- }
4153
- interface DelayedCaptureSettings {
4154
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4155
- scheduledAction?: ScheduledActionWithLiterals;
4156
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4157
- delayDuration?: Duration;
4132
+ orderId?: string;
4158
4133
  }
4159
- declare enum ScheduledAction {
4160
- /** Whether payment will be auto-voided when duration passes */
4161
- VOID = "VOID",
4162
- /** Whether payment will be auto-captured when duration passes */
4163
- CAPTURE = "CAPTURE"
4134
+ interface SendBuyerShippingConfirmationEmailResponse {
4164
4135
  }
4165
- /** @enumType */
4166
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4167
- interface Duration {
4136
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4168
4137
  /**
4169
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4170
- * @min 1
4138
+ * IDs of orders to send pickup emails for.
4139
+ * @minSize 1
4140
+ * @maxSize 300
4171
4141
  */
4172
- count?: number;
4173
- /** Duration unit: MINUTES, HOURS and DAYS */
4174
- unit?: DurationUnitWithLiterals;
4175
- }
4176
- declare enum DurationUnit {
4177
- MINUTES = "MINUTES",
4178
- HOURS = "HOURS",
4179
- DAYS = "DAYS"
4142
+ orderIds?: string[];
4180
4143
  }
4181
- /** @enumType */
4182
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4183
- interface PreparePaymentCollectionResponse {
4184
- /** Payment gateway order id which is associated with given payment */
4185
- paymentGatewayOrderId?: string;
4144
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4186
4145
  }
4187
- interface GetPaymentCollectabilityStatusRequest {
4146
+ interface SendMerchantOrderReceivedNotificationRequest {
4188
4147
  /**
4189
- * Ecom order ID.
4190
4148
  * @minLength 1
4191
4149
  * @maxLength 100
4192
4150
  */
4193
- ecomOrderId: string;
4194
- }
4195
- interface GetPaymentCollectabilityStatusResponse {
4196
- /** Payment collectability status */
4197
- status?: PaymentCollectabilityStatusWithLiterals;
4198
- /** Collectable order amount */
4199
- amount?: Price;
4151
+ orderId?: string;
4200
4152
  }
4201
- declare enum PaymentCollectabilityStatus {
4202
- UNKNOWN = "UNKNOWN",
4203
- COLLECTABLE = "COLLECTABLE",
4204
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4205
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4206
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4207
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4208
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4209
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4210
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4211
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4212
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4213
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4214
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4153
+ interface SendMerchantOrderReceivedNotificationResponse {
4215
4154
  }
4216
- /** @enumType */
4217
- 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';
4218
- interface RecordManuallyCollectedPaymentRequest {
4155
+ interface SendCancelRefundEmailRequest {
4219
4156
  /**
4220
- * Order ID.
4157
+ * The ID of order that is canceled/refunded
4221
4158
  * @minLength 1
4222
4159
  * @maxLength 100
4223
4160
  */
4224
- orderId: string;
4225
- /** Amount to be recorded as approved manual payment for given order */
4226
- amount: Price;
4227
- }
4228
- /**
4229
- * User-defined payment method name.
4230
- * Allows specifying either a predefined type or a custom name.
4231
- */
4232
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4233
- /** Predefined payment method. */
4234
- predefined?: PredefinedPaymentMethodWithLiterals;
4161
+ orderId?: string;
4235
4162
  /**
4236
- * Custom payment method name provided by user.
4237
- *
4238
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4163
+ * Personal note added to the email (optional)
4239
4164
  * @minLength 1
4240
- * @maxLength 150
4165
+ * @maxLength 1000
4241
4166
  */
4242
- custom?: string | null;
4167
+ customMessage?: string | null;
4168
+ /** Refund amount */
4169
+ refundAmount?: Price;
4170
+ /**
4171
+ * Refund ID. (Optional)
4172
+ * @format GUID
4173
+ */
4174
+ refundId?: string | null;
4243
4175
  }
4244
- /** @oneof */
4245
- interface UserDefinedPaymentMethodNameKindOneOf {
4246
- /** Predefined payment method. */
4247
- predefined?: PredefinedPaymentMethodWithLiterals;
4176
+ interface SendCancelRefundEmailResponse {
4177
+ }
4178
+ interface SendRefundEmailRequest {
4248
4179
  /**
4249
- * Custom payment method name provided by user.
4250
- *
4251
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4180
+ * The ID of order that is refunded
4181
+ * @format GUID
4182
+ */
4183
+ orderId?: string;
4184
+ /**
4185
+ * Refund ID
4186
+ * @format GUID
4187
+ */
4188
+ refundId?: string;
4189
+ /**
4190
+ * Personal note added to the email (optional)
4252
4191
  * @minLength 1
4253
- * @maxLength 150
4192
+ * @maxLength 1000
4254
4193
  */
4255
- custom?: string | null;
4194
+ customMessage?: string | null;
4256
4195
  }
4257
- /** Predefined payment method types for offline/manual payments. */
4258
- declare enum PredefinedPaymentMethod {
4259
- /** Cash payment. */
4260
- CASH = "CASH",
4261
- /** Bank transfer. */
4262
- BANK_TRANSFER = "BANK_TRANSFER",
4263
- /** Payment by check. */
4264
- CHECK = "CHECK"
4196
+ interface SendRefundEmailResponse {
4265
4197
  }
4266
- /** @enumType */
4267
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4268
- interface RecordManuallyCollectedPaymentResponse {
4198
+ interface SendFulfillmentEmailRequest {
4199
+ /** @format GUID */
4200
+ orderId?: string;
4201
+ /** @format GUID */
4202
+ fulfillerId?: string;
4269
4203
  }
4270
- interface MarkOrderAsPaidRequest {
4204
+ interface SendFulfillmentEmailResponse {
4205
+ }
4206
+ interface SendMerchantOrderReceivedPushRequest {
4271
4207
  /**
4272
- * Ecom order ID.
4273
4208
  * @minLength 1
4274
4209
  * @maxLength 100
4275
4210
  */
4276
- ecomOrderId: string;
4211
+ orderId?: string;
4277
4212
  }
4278
- interface MarkOrderAsPaidResponse {
4279
- /** Updated order. */
4280
- order?: Order;
4213
+ interface SendMerchantOrderReceivedPushResponse {
4281
4214
  }
4282
- interface BulkMarkOrdersAsPaidRequest {
4215
+ interface PreviewEmailByTypeRequest {
4216
+ emailType?: PreviewEmailTypeWithLiterals;
4217
+ }
4218
+ declare enum PreviewEmailType {
4219
+ ORDER_PLACED = "ORDER_PLACED",
4220
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4221
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4222
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4223
+ }
4224
+ /** @enumType */
4225
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4226
+ interface PreviewEmailByTypeResponse {
4227
+ emailPreview?: string;
4228
+ }
4229
+ interface PreviewRefundEmailRequest {
4283
4230
  /**
4284
- * IDs of orders to mark as paid.
4285
- * @minSize 1
4286
- * @maxSize 100
4287
4231
  * @minLength 1
4288
4232
  * @maxLength 100
4289
4233
  */
4290
- ecomOrderIds: string[];
4291
- }
4292
- interface BulkMarkOrdersAsPaidResponse {
4234
+ orderId?: string;
4235
+ /** Refund amount */
4236
+ refundAmount?: Price;
4237
+ /** Refund business details */
4238
+ details?: RefundDetails;
4293
4239
  /**
4294
- * Items updated by the bulk action.
4295
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4296
- */
4297
- results?: BulkOrderResult[];
4298
- /** Bulk action metadata. */
4299
- bulkActionMetadata?: BulkActionMetadata;
4300
- }
4301
- interface BulkOrderResult {
4302
- /** Item metadata. */
4303
- itemMetadata?: ItemMetadata;
4304
- /**
4305
- * Updated order.
4306
- *
4307
- * Returned when `returnFullEntity = true`.
4308
- */
4309
- item?: Order;
4310
- }
4311
- interface ItemMetadata {
4312
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4313
- id?: string | null;
4314
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4315
- originalIndex?: number;
4316
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4317
- success?: boolean;
4318
- /** Details about the error in case of failure. */
4319
- error?: ApplicationError;
4320
- }
4321
- interface ApplicationError {
4322
- /** Error code. */
4323
- code?: string;
4324
- /** Description of the error. */
4325
- description?: string;
4326
- /** Data related to the error. */
4327
- data?: Record<string, any> | null;
4328
- }
4329
- interface BulkActionMetadata {
4330
- /** Number of items that were successfully processed. */
4331
- totalSuccesses?: number;
4332
- /** Number of items that couldn't be processed. */
4333
- totalFailures?: number;
4334
- /** Number of failures without details because detailed failure threshold was exceeded. */
4335
- undetailedFailures?: number;
4336
- }
4337
- interface GetRefundabilityStatusRequest {
4338
- /**
4339
- * Order ID.
4340
- * @minLength 1
4341
- * @maxLength 100
4342
- */
4343
- ecomOrderId: string;
4344
- }
4345
- interface GetRefundabilityStatusResponse {
4346
- /**
4347
- * Refundability details.
4348
- * @maxSize 300
4349
- */
4350
- refundabilities?: Refundability[];
4351
- /**
4352
- * Whether the order supports refunding per item.
4353
- * @deprecated
4354
- */
4355
- refundablePerItem?: boolean;
4356
- }
4357
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4358
- /** Reason why payment is not refundable. */
4359
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4360
- /** Reason why payment is only refundable manually. */
4361
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4362
- /** Payment ID. */
4363
- paymentId?: string;
4364
- /** Payment refundability status. */
4365
- refundabilityStatus?: RefundableStatusWithLiterals;
4366
- /** Link to payment provider dashboard. */
4367
- providerLink?: string | null;
4368
- }
4369
- /** @oneof */
4370
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4371
- /** Reason why payment is not refundable. */
4372
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4373
- /** Reason why payment is only refundable manually. */
4374
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4375
- }
4376
- declare enum RefundableStatus {
4377
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4378
- MANUAL = "MANUAL",
4379
- REFUNDABLE = "REFUNDABLE"
4380
- }
4381
- /** @enumType */
4382
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4383
- declare enum NonRefundableReason {
4384
- NONE = "NONE",
4385
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4386
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4387
- INTERNAL_ERROR = "INTERNAL_ERROR",
4388
- NOT_PAID = "NOT_PAID",
4389
- ACCESS_DENIED = "ACCESS_DENIED",
4390
- ZERO_PRICE = "ZERO_PRICE",
4391
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4392
- PENDING_REFUND = "PENDING_REFUND",
4393
- FORBIDDEN = "FORBIDDEN",
4394
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4395
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4396
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4397
- }
4398
- /** @enumType */
4399
- 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';
4400
- declare enum ManuallyRefundableReason {
4401
- EXPIRED = "EXPIRED",
4402
- NOT_SUPPORTED = "NOT_SUPPORTED",
4403
- OFFLINE = "OFFLINE",
4404
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4405
- }
4406
- /** @enumType */
4407
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4408
- interface CreatePaymentGatewayOrderRequest {
4409
- /**
4410
- * Ecom order ID.
4411
- * @minLength 1
4412
- * @maxLength 100
4413
- */
4414
- ecomOrderId: string;
4415
- /** Information about the user who initiated the payment. */
4416
- chargedBy?: ChargedBy;
4417
- }
4418
- interface ChargedBy {
4419
- /**
4420
- * ID - id of the user who initiated the payment
4421
- * @format GUID
4422
- */
4423
- id?: string;
4424
- /**
4425
- * Full name - name of the user who initiated the payment
4426
- * @minLength 1
4427
- * @maxLength 200
4428
- */
4429
- fullName?: string | null;
4430
- }
4431
- interface CreatePaymentGatewayOrderResponse {
4432
- /** ID of the order created in the payment gateway */
4433
- paymentGatewayOrderId?: string;
4434
- }
4435
- interface ChargeMembershipsRequest {
4436
- /**
4437
- * Order ID.
4438
- * @minLength 1
4439
- * @maxLength 100
4440
- */
4441
- ecomOrderId: string;
4442
- /**
4443
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4444
- * but a user which is using the membership on behalf of the a member
4445
- * @format GUID
4446
- */
4447
- memberId: string;
4448
- /**
4449
- * List of items to be paid by memberships
4450
- * @minSize 1
4451
- * @maxSize 300
4452
- */
4453
- membershipCharges?: MembershipChargeItem[];
4454
- }
4455
- interface MembershipChargeItem {
4456
- /**
4457
- * The id of used membership
4458
- * @minLength 1
4459
- * @maxLength 100
4460
- */
4461
- membershipId?: string;
4462
- /**
4463
- * ID of the application providing this payment option
4464
- * @format GUID
4465
- */
4466
- appId?: string;
4467
- /** The name of used membership */
4468
- membershipName?: MembershipName;
4469
- /** Additional data about this membership */
4470
- membershipAdditionalData?: Record<string, any> | null;
4471
- /** Catalog and item reference info. */
4472
- catalogReference?: CatalogReference;
4473
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4474
- serviceProperties?: ServiceProperties;
4475
- /**
4476
- * Usually would be the same as catalogReference.catalogItemId
4477
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4478
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4479
- * @minLength 1
4480
- * @maxLength 36
4481
- */
4482
- rootCatalogItemId?: string | null;
4483
- /**
4484
- * line item id of Checkout/Order line item
4485
- * @minLength 1
4486
- * @maxLength 100
4487
- */
4488
- lineItemId?: string;
4489
- }
4490
- interface MembershipName {
4491
- /**
4492
- * Membership name in the site's original language.
4493
- * @maxLength 100
4494
- */
4495
- original?: string;
4496
- /**
4497
- * Membership name translated into the buyer's language.
4498
- *
4499
- * Default: The value of `original`
4500
- * @maxLength 100
4501
- */
4502
- translated?: string | null;
4503
- }
4504
- interface ChargeMembershipsResponse {
4505
- }
4506
- interface TriggerRefundRequest {
4507
- /**
4508
- * The order this refund related to
4240
+ * Personal note added to the email (optional)
4509
4241
  * @minLength 1
4510
- * @maxLength 100
4511
- */
4512
- ecomOrderId: string;
4513
- /**
4514
- * Refund operations information
4515
- * @minSize 1
4516
- * @maxSize 1
4242
+ * @maxLength 1000
4517
4243
  */
4518
- payments: PaymentRefund[];
4519
- /** Business model of a refund */
4520
- details?: RefundDetails;
4521
- /** Side effect details related to refund */
4522
- sideEffects?: RefundSideEffects;
4523
- }
4524
- interface PaymentRefund {
4244
+ customMessage?: string | null;
4525
4245
  /**
4526
- * Specific payment within the order to refund
4246
+ * Refund ID. (Optional)
4527
4247
  * @format GUID
4528
4248
  */
4529
- paymentId?: string;
4530
- /** Refund amount. Not relevant for membership and gift card refunds. */
4531
- amount?: Price;
4532
- /**
4533
- * Whether refund is made externally and manually (on the payment provider's side)
4534
- * 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.
4535
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4536
- */
4537
- externalRefund?: boolean;
4249
+ refundId?: string | null;
4538
4250
  }
4539
4251
  /** Business model of a refund request */
4540
4252
  interface RefundDetails {
@@ -4611,1645 +4323,1943 @@ interface ShippingRefund {
4611
4323
  */
4612
4324
  amount?: Price;
4613
4325
  }
4614
- interface RefundSideEffects {
4615
- /** Inventory restock details as part of this refund. */
4616
- restockInfo?: RestockInfo;
4617
- /** Whether to send a refund confirmation email to the customer. */
4618
- sendOrderRefundedEmail?: boolean;
4326
+ interface PreviewRefundEmailResponse {
4327
+ emailPreview?: string;
4328
+ }
4329
+ interface PreviewCancelEmailRequest {
4619
4330
  /**
4620
- * Custom message added to the refund confirmation email.
4621
4331
  * @minLength 1
4622
- * @maxLength 1000
4332
+ * @maxLength 100
4623
4333
  */
4624
- customMessage?: string | null;
4625
- }
4626
- interface RestockInfo {
4627
- /** Restock type. */
4628
- type?: RestockTypeWithLiterals;
4334
+ orderId?: string;
4335
+ /**
4336
+ * Personal note added to the email (optional)
4337
+ * @minLength 1
4338
+ * @maxLength 1000
4339
+ */
4340
+ customMessage?: string | null;
4341
+ }
4342
+ interface PreviewCancelEmailResponse {
4343
+ emailPreview?: string;
4344
+ }
4345
+ interface PreviewCancelRefundEmailRequest {
4346
+ /**
4347
+ * @minLength 1
4348
+ * @maxLength 100
4349
+ */
4350
+ orderId?: string;
4351
+ /**
4352
+ * Personal note added to the email (optional)
4353
+ * @minLength 1
4354
+ * @maxLength 1000
4355
+ */
4356
+ customMessage?: string | null;
4357
+ /** Refund amount */
4358
+ refundAmount?: Price;
4359
+ /**
4360
+ * Refund ID. (Optional)
4361
+ * @format GUID
4362
+ */
4363
+ refundId?: string | null;
4364
+ }
4365
+ interface PreviewCancelRefundEmailResponse {
4366
+ emailPreview?: string;
4367
+ }
4368
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4369
+ }
4370
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4371
+ emailPreview?: string;
4372
+ }
4373
+ interface PreviewBuyerConfirmationEmailRequest {
4374
+ }
4375
+ interface PreviewBuyerConfirmationEmailResponse {
4376
+ emailPreview?: string;
4377
+ }
4378
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4379
+ }
4380
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4381
+ emailPreview?: string;
4382
+ }
4383
+ interface PreviewShippingConfirmationEmailRequest {
4384
+ }
4385
+ interface PreviewShippingConfirmationEmailResponse {
4386
+ emailPreview?: string;
4387
+ }
4388
+ interface PreviewResendDownloadLinksEmailRequest {
4389
+ }
4390
+ interface PreviewResendDownloadLinksEmailResponse {
4391
+ emailPreview?: string;
4392
+ }
4393
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4394
+ /** Emitted on a meta site creation. */
4395
+ siteCreated?: SiteCreated;
4396
+ /** Emitted on a meta site transfer completion. */
4397
+ siteTransferred?: SiteTransferred;
4398
+ /** Emitted on a meta site deletion. */
4399
+ siteDeleted?: SiteDeleted;
4400
+ /** Emitted on a meta site restoration. */
4401
+ siteUndeleted?: SiteUndeleted;
4402
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4403
+ sitePublished?: SitePublished;
4404
+ /** Emitted on a meta site unpublish. */
4405
+ siteUnpublished?: SiteUnpublished;
4406
+ /** Emitted when meta site is marked as template. */
4407
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4408
+ /** Emitted when meta site is marked as a WixSite. */
4409
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4410
+ /** Emitted when an application is provisioned (installed). */
4411
+ serviceProvisioned?: ServiceProvisioned;
4412
+ /** Emitted when an application is removed (uninstalled). */
4413
+ serviceRemoved?: ServiceRemoved;
4414
+ /** Emitted when meta site name (URL slug) is changed. */
4415
+ siteRenamedPayload?: SiteRenamed;
4416
+ /** Emitted when meta site was permanently deleted. */
4417
+ hardDeleted?: SiteHardDeleted;
4418
+ /** Emitted on a namespace change. */
4419
+ namespaceChanged?: NamespaceChanged;
4420
+ /** Emitted when Studio is attached. */
4421
+ studioAssigned?: StudioAssigned;
4422
+ /** Emitted when Studio is detached. */
4423
+ studioUnassigned?: StudioUnassigned;
4424
+ /**
4425
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4426
+ * the actual URL.
4427
+ *
4428
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4429
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4430
+ */
4431
+ urlChanged?: SiteUrlChanged;
4432
+ /** Site is marked as PurgedExternally */
4433
+ sitePurgedExternally?: SitePurgedExternally;
4434
+ /** Emitted when Odeditor is attached. */
4435
+ odeditorAssigned?: OdeditorAssigned;
4436
+ /** Emitted when Odeditor is detached. */
4437
+ odeditorUnassigned?: OdeditorUnassigned;
4438
+ /** Emitted when Picasso is attached. */
4439
+ picassoAssigned?: PicassoAssigned;
4440
+ /** Emitted when Picasso is detached. */
4441
+ picassoUnassigned?: PicassoUnassigned;
4442
+ /** Emitted when Wixel is attached. */
4443
+ wixelAssigned?: WixelAssigned;
4444
+ /** Emitted when Wixel is detached. */
4445
+ wixelUnassigned?: WixelUnassigned;
4446
+ /** Emitted when StudioTwo is attached. */
4447
+ studioTwoAssigned?: StudioTwoAssigned;
4448
+ /** Emitted when StudioTwo is detached. */
4449
+ studioTwoUnassigned?: StudioTwoUnassigned;
4450
+ /** Emitted when media from user domain is enabled. */
4451
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4452
+ /** Emitted when media from user domain is disabled. */
4453
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4454
+ /** Emitted when Editorless is attached. */
4455
+ editorlessAssigned?: EditorlessAssigned;
4456
+ /** Emitted when Editorless is detached. */
4457
+ editorlessUnassigned?: EditorlessUnassigned;
4458
+ /**
4459
+ * A meta site id.
4460
+ * @format GUID
4461
+ */
4462
+ metaSiteId?: string;
4463
+ /** A meta site version. Monotonically increasing. */
4464
+ version?: string;
4465
+ /** A timestamp of the event. */
4466
+ timestamp?: string;
4467
+ /**
4468
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4469
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4470
+ * @maxSize 4000
4471
+ */
4472
+ assets?: Asset[];
4473
+ }
4474
+ /** @oneof */
4475
+ interface MetaSiteSpecialEventPayloadOneOf {
4476
+ /** Emitted on a meta site creation. */
4477
+ siteCreated?: SiteCreated;
4478
+ /** Emitted on a meta site transfer completion. */
4479
+ siteTransferred?: SiteTransferred;
4480
+ /** Emitted on a meta site deletion. */
4481
+ siteDeleted?: SiteDeleted;
4482
+ /** Emitted on a meta site restoration. */
4483
+ siteUndeleted?: SiteUndeleted;
4484
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4485
+ sitePublished?: SitePublished;
4486
+ /** Emitted on a meta site unpublish. */
4487
+ siteUnpublished?: SiteUnpublished;
4488
+ /** Emitted when meta site is marked as template. */
4489
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4490
+ /** Emitted when meta site is marked as a WixSite. */
4491
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4492
+ /** Emitted when an application is provisioned (installed). */
4493
+ serviceProvisioned?: ServiceProvisioned;
4494
+ /** Emitted when an application is removed (uninstalled). */
4495
+ serviceRemoved?: ServiceRemoved;
4496
+ /** Emitted when meta site name (URL slug) is changed. */
4497
+ siteRenamedPayload?: SiteRenamed;
4498
+ /** Emitted when meta site was permanently deleted. */
4499
+ hardDeleted?: SiteHardDeleted;
4500
+ /** Emitted on a namespace change. */
4501
+ namespaceChanged?: NamespaceChanged;
4502
+ /** Emitted when Studio is attached. */
4503
+ studioAssigned?: StudioAssigned;
4504
+ /** Emitted when Studio is detached. */
4505
+ studioUnassigned?: StudioUnassigned;
4506
+ /**
4507
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4508
+ * the actual URL.
4509
+ *
4510
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4511
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4512
+ */
4513
+ urlChanged?: SiteUrlChanged;
4514
+ /** Site is marked as PurgedExternally */
4515
+ sitePurgedExternally?: SitePurgedExternally;
4516
+ /** Emitted when Odeditor is attached. */
4517
+ odeditorAssigned?: OdeditorAssigned;
4518
+ /** Emitted when Odeditor is detached. */
4519
+ odeditorUnassigned?: OdeditorUnassigned;
4520
+ /** Emitted when Picasso is attached. */
4521
+ picassoAssigned?: PicassoAssigned;
4522
+ /** Emitted when Picasso is detached. */
4523
+ picassoUnassigned?: PicassoUnassigned;
4524
+ /** Emitted when Wixel is attached. */
4525
+ wixelAssigned?: WixelAssigned;
4526
+ /** Emitted when Wixel is detached. */
4527
+ wixelUnassigned?: WixelUnassigned;
4528
+ /** Emitted when StudioTwo is attached. */
4529
+ studioTwoAssigned?: StudioTwoAssigned;
4530
+ /** Emitted when StudioTwo is detached. */
4531
+ studioTwoUnassigned?: StudioTwoUnassigned;
4532
+ /** Emitted when media from user domain is enabled. */
4533
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4534
+ /** Emitted when media from user domain is disabled. */
4535
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4536
+ /** Emitted when Editorless is attached. */
4537
+ editorlessAssigned?: EditorlessAssigned;
4538
+ /** Emitted when Editorless is detached. */
4539
+ editorlessUnassigned?: EditorlessUnassigned;
4540
+ }
4541
+ interface Asset {
4542
+ /**
4543
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4544
+ * @maxLength 36
4545
+ */
4546
+ appDefId?: string;
4547
+ /**
4548
+ * An instance id. For legacy reasons may be UUID or a string.
4549
+ * @maxLength 200
4550
+ */
4551
+ instanceId?: string;
4552
+ /** An application state. */
4553
+ state?: StateWithLiterals;
4554
+ }
4555
+ declare enum State {
4556
+ UNKNOWN = "UNKNOWN",
4557
+ ENABLED = "ENABLED",
4558
+ DISABLED = "DISABLED",
4559
+ PENDING = "PENDING",
4560
+ DEMO = "DEMO"
4561
+ }
4562
+ /** @enumType */
4563
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4564
+ interface SiteCreated {
4565
+ /**
4566
+ * A template identifier (empty if not created from a template).
4567
+ * @maxLength 36
4568
+ */
4569
+ originTemplateId?: string;
4570
+ /**
4571
+ * An account id of the owner.
4572
+ * @format GUID
4573
+ */
4574
+ ownerId?: string;
4575
+ /** A context in which meta site was created. */
4576
+ context?: SiteCreatedContextWithLiterals;
4577
+ /**
4578
+ * A meta site id from which this site was created.
4579
+ *
4580
+ * In case of a creation from a template it's a template id.
4581
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4582
+ * @format GUID
4583
+ */
4584
+ originMetaSiteId?: string | null;
4585
+ /**
4586
+ * A meta site name (URL slug).
4587
+ * @maxLength 20
4588
+ */
4589
+ siteName?: string;
4590
+ /** A namespace. */
4591
+ namespace?: NamespaceWithLiterals;
4592
+ }
4593
+ declare enum SiteCreatedContext {
4594
+ /** A valid option, we don't expose all reasons why site might be created. */
4595
+ OTHER = "OTHER",
4596
+ /** A meta site was created from template. */
4597
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4598
+ /** A meta site was created by copying of the transfferred meta site. */
4599
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4600
+ /** A copy of existing meta site. */
4601
+ DUPLICATE = "DUPLICATE",
4602
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4603
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4604
+ /** deprecated A meta site was created for Flash editor. */
4605
+ FLASH = "FLASH"
4606
+ }
4607
+ /** @enumType */
4608
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4609
+ declare enum Namespace {
4610
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4611
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4612
+ WIX = "WIX",
4613
+ /** 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. */
4614
+ SHOUT_OUT = "SHOUT_OUT",
4615
+ /** 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. */
4616
+ ALBUMS = "ALBUMS",
4617
+ /** 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. */
4618
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4619
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4620
+ HOTELS = "HOTELS",
4621
+ /** 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. */
4622
+ CLUBS = "CLUBS",
4623
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4624
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4629
4625
  /**
4630
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4631
- * @maxSize 300
4626
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4627
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4632
4628
  */
4633
- items?: RestockItem[];
4634
- }
4635
- declare enum RestockType {
4636
- NO_ITEMS = "NO_ITEMS",
4637
- ALL_ITEMS = "ALL_ITEMS",
4638
- SOME_ITEMS = "SOME_ITEMS"
4639
- }
4640
- /** @enumType */
4641
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4642
- interface RestockItem {
4629
+ DEV_SITE = "DEV_SITE",
4630
+ /** 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. */
4631
+ LOGOS = "LOGOS",
4632
+ /** 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. */
4633
+ VIDEO_MAKER = "VIDEO_MAKER",
4634
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4635
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4636
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4637
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4643
4638
  /**
4644
- * ID of the line item being restocked.
4645
- * @format GUID
4639
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4640
+ *
4641
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4646
4642
  */
4647
- lineItemId?: string;
4643
+ HTML_DRAFT = "HTML_DRAFT",
4648
4644
  /**
4649
- * Line item quantity being restocked.
4650
- * @min 1
4651
- * @max 100000
4645
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4646
+ * Will be accessible from Site List and will not have a website app.
4647
+ * Once the user attaches a site, the site will become a regular wixsite.
4652
4648
  */
4653
- quantity?: number;
4654
- }
4655
- interface TriggerRefundResponse {
4656
- /** All order's transactions after the refunds were added */
4657
- orderTransactions?: OrderTransactions;
4658
- /** Created refund ID */
4659
- refundId?: string | null;
4660
- /** Payment ID's that the refund execution had failed for */
4661
- failedPaymentIds?: ItemMetadata[];
4662
- }
4663
- /**
4664
- * A record of all payments and refunds associated with an order.
4665
- *
4666
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4667
- */
4668
- interface OrderTransactions {
4649
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
4650
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4651
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
4652
+ /** It is to be used in the Business First efforts. */
4653
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
4654
+ /** Bookings business flow with no site. */
4655
+ ANYWHERE = "ANYWHERE",
4656
+ /** Namespace for Headless Backoffice with no editor */
4657
+ HEADLESS = "HEADLESS",
4669
4658
  /**
4670
- * Order ID.
4671
- * @format GUID
4659
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4660
+ * The site will be used for account level CSM feature for enterprise
4672
4661
  */
4673
- orderId?: string;
4662
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4663
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4664
+ RISE = "RISE",
4674
4665
  /**
4675
- * Record of payments made to the merchant.
4676
- * @maxSize 100
4666
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4667
+ * There's a blank site behind the scene but it's blank).
4668
+ * The Mobile company will be the owner of this namespace.
4677
4669
  */
4678
- payments?: Payment[];
4670
+ BRANDED_FIRST = "BRANDED_FIRST",
4671
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4672
+ NOWNIA = "NOWNIA",
4679
4673
  /**
4680
- * Record of refunds made to the buyer.
4681
- * @maxSize 300
4674
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
4675
+ * The Partners company owns this namespace.
4682
4676
  */
4683
- refunds?: Refund[];
4684
- }
4685
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4686
- /** Regular payment details. */
4687
- regularPaymentDetails?: RegularPaymentDetails;
4688
- /** Gift card payment details. */
4689
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4690
- /** Membership payment details. */
4691
- membershipPaymentDetails?: MembershipPaymentDetails;
4677
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4678
+ /** Codux Headless Sites */
4679
+ CODUX = "CODUX",
4680
+ /** Bobb - AI Design Creator. */
4681
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4692
4682
  /**
4693
- * Payment ID.
4694
- * @format GUID
4695
- * @readonly
4683
+ * Shared Blog Site is a unique single site across Enterprise account,
4684
+ * This site will hold all Blog posts related to the Marketing product.
4696
4685
  */
4697
- id?: string | null;
4698
- /** 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. */
4699
- createdDate?: Date | null;
4686
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4687
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4688
+ STANDALONE_FORMS = "STANDALONE_FORMS",
4689
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4690
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
4691
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4692
+ MIMIR = "MIMIR",
4693
+ /** Wix Twins platform. */
4694
+ TWINS = "TWINS",
4695
+ /** Wix Nano. */
4696
+ NANO = "NANO",
4697
+ /** Base44 headless sites. */
4698
+ BASE44 = "BASE44",
4699
+ /** Wix Channels Sites */
4700
+ CHANNELS = "CHANNELS",
4701
+ /** Nautilus platform. */
4702
+ NAUTILUS = "NAUTILUS",
4700
4703
  /**
4701
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4702
- * @readonly
4704
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4705
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4703
4706
  */
4704
- updatedDate?: Date | null;
4705
- /** Payment amount. */
4706
- amount?: Price;
4707
+ SYMPHONY = "SYMPHONY",
4708
+ /** Nautilus platform app. */
4709
+ NAUTILUS_APPS = "NAUTILUS_APPS",
4707
4710
  /**
4708
- * Whether refunds for this payment are disabled.
4709
- * + `true`: This payment is not refundable.
4710
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4711
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4712
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4711
4713
  */
4712
- refundDisabled?: boolean;
4714
+ VIBU = "VIBU",
4713
4715
  /**
4714
- * Whether receipt generation is allowed for this payment.
4715
- * + `true`: This payment supports receipt generation.
4716
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4717
- * @readonly
4716
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4717
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
4718
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4719
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
4718
4720
  */
4719
- supportReceiptGeneration?: boolean;
4720
- /** Details about cash rounding applied to this payment, when relevant. */
4721
- cashRounding?: CashRoundingDetails;
4721
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4722
4722
  /**
4723
- * Overall payment status.
4724
- *
4725
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4723
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
4724
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4726
4725
  */
4727
- status?: PaymentStatusWithLiterals;
4726
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4727
+ }
4728
+ /** @enumType */
4729
+ 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';
4730
+ /** Site transferred to another user. */
4731
+ interface SiteTransferred {
4728
4732
  /**
4729
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4733
+ * A previous owner id (user that transfers meta site).
4730
4734
  * @format GUID
4731
4735
  */
4732
- chargeCorrelationId?: string | null;
4736
+ oldOwnerId?: string;
4737
+ /**
4738
+ * A new owner id (user that accepts meta site).
4739
+ * @format GUID
4740
+ */
4741
+ newOwnerId?: string;
4733
4742
  }
4734
- /** @oneof */
4735
- interface PaymentPaymentDetailsOneOf {
4736
- /** Regular payment details. */
4737
- regularPaymentDetails?: RegularPaymentDetails;
4738
- /** Gift card payment details. */
4739
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4740
- /** Membership payment details. */
4741
- membershipPaymentDetails?: MembershipPaymentDetails;
4743
+ /** Soft deletion of the meta site. Could be restored. */
4744
+ interface SiteDeleted {
4745
+ /** A deletion context. */
4746
+ deleteContext?: DeleteContext;
4742
4747
  }
4743
- /** @oneof */
4744
- interface PaymentReceiptInfoOneOf {
4748
+ interface DeleteContext {
4749
+ /** When the meta site was deleted. */
4750
+ dateDeleted?: Date | null;
4751
+ /** A status. */
4752
+ deleteStatus?: DeleteStatusWithLiterals;
4753
+ /**
4754
+ * A reason (flow).
4755
+ * @maxLength 255
4756
+ */
4757
+ deleteOrigin?: string;
4758
+ /**
4759
+ * A service that deleted it.
4760
+ * @maxLength 255
4761
+ */
4762
+ initiatorId?: string | null;
4745
4763
  }
4746
- /** @oneof */
4747
- interface PaymentStatusDetailsOneOf {
4764
+ declare enum DeleteStatus {
4765
+ UNKNOWN = "UNKNOWN",
4766
+ TRASH = "TRASH",
4767
+ DELETED = "DELETED",
4768
+ PENDING_PURGE = "PENDING_PURGE",
4769
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4748
4770
  }
4749
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4750
- /** Credit card details. */
4751
- creditCardDetails?: CreditCardPaymentMethodDetails;
4771
+ /** @enumType */
4772
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4773
+ /** Restoration of the meta site. */
4774
+ interface SiteUndeleted {
4775
+ }
4776
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4777
+ interface SitePublished {
4778
+ }
4779
+ interface SiteUnpublished {
4752
4780
  /**
4753
- * Wix Payments order ID.
4754
- * @maxLength 100
4781
+ * A list of URLs previously associated with the meta site.
4782
+ * @maxLength 4000
4783
+ * @maxSize 10000
4755
4784
  */
4756
- paymentOrderId?: string | null;
4785
+ urls?: string[];
4786
+ }
4787
+ interface SiteMarkedAsTemplate {
4788
+ }
4789
+ interface SiteMarkedAsWixSite {
4790
+ }
4791
+ /**
4792
+ * Represents a service provisioned a site.
4793
+ *
4794
+ * Note on `origin_instance_id`:
4795
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4796
+ * This is because of the following scenario:
4797
+ *
4798
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
4799
+ * such as a product catalog. When you create a site from this template, you inherit this
4800
+ * default product catalog. However, if the template's product catalog is modified,
4801
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
4802
+ * your site remains consistent with what you initially received and does not include any
4803
+ * changes made to the original template afterward.
4804
+ * To ensure this, the TPA on the template gets a new instance_id.
4805
+ */
4806
+ interface ServiceProvisioned {
4757
4807
  /**
4758
- * Payment gateway's transaction ID.
4759
- * This field is only returned when the value of `offline_payment` is `false`.
4760
- * @maxLength 100
4808
+ * Either UUID or EmbeddedServiceType.
4809
+ * @maxLength 36
4761
4810
  */
4762
- gatewayTransactionId?: string | null;
4811
+ appDefId?: string;
4763
4812
  /**
4764
- * Payment method.
4765
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4766
- * Non-exhaustive list of supported values:
4767
- * + `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`
4768
- * @maxLength 150
4769
- * @deprecated Payment method.
4770
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4771
- * Non-exhaustive list of supported values:
4772
- * + `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`
4773
- * @replacedBy payment_method_name
4774
- * @targetRemovalDate 2026-07-01
4813
+ * Not only UUID. Something here could be something weird.
4814
+ * @maxLength 36
4775
4815
  */
4776
- paymentMethod?: string | null;
4816
+ instanceId?: string;
4777
4817
  /**
4778
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4779
- * @maxLength 100
4818
+ * An instance id from which this instance is originated.
4819
+ * @maxLength 36
4780
4820
  */
4781
- providerTransactionId?: string | null;
4782
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4783
- offlinePayment?: boolean;
4821
+ originInstanceId?: string;
4784
4822
  /**
4785
- * Payment status.
4786
- * @deprecated Payment status.
4787
- * @replacedBy payment.status
4788
- * @targetRemovalDate 2026-11-01
4823
+ * A version.
4824
+ * @maxLength 500
4789
4825
  */
4790
- status?: TransactionStatusWithLiterals;
4791
- /** Whether there is a payment agreement that allows for future charges. */
4792
- savedPaymentMethod?: boolean;
4793
- /** Authorization details. */
4794
- authorizationDetails?: AuthorizationDetails;
4826
+ version?: string | null;
4795
4827
  /**
4796
- * Record of chargebacks made by the buyer.
4797
- * @maxSize 6
4828
+ * The origin meta site id
4829
+ * @format GUID
4798
4830
  */
4799
- chargebacks?: Chargeback[];
4800
- /** Platform fee amount associated with this payment. */
4801
- platformFee?: Price;
4831
+ originMetaSiteId?: string | null;
4832
+ }
4833
+ interface ServiceRemoved {
4802
4834
  /**
4803
- * Payment method with buyer and optional owner translations.
4804
- * Non-exhaustive list of supported values:
4805
- * + `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`
4835
+ * Either UUID or EmbeddedServiceType.
4836
+ * @maxLength 36
4806
4837
  */
4807
- paymentMethodName?: PaymentMethodName;
4808
- }
4809
- /** @oneof */
4810
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4811
- /** Credit card details. */
4812
- creditCardDetails?: CreditCardPaymentMethodDetails;
4813
- }
4814
- declare enum TransactionStatus {
4815
- UNDEFINED = "UNDEFINED",
4816
- APPROVED = "APPROVED",
4817
- PENDING = "PENDING",
4818
- PENDING_MERCHANT = "PENDING_MERCHANT",
4819
- CANCELED = "CANCELED",
4820
- DECLINED = "DECLINED",
4821
- REFUNDED = "REFUNDED",
4822
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4823
- AUTHORIZED = "AUTHORIZED",
4824
- VOIDED = "VOIDED"
4825
- }
4826
- /** @enumType */
4827
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4828
- interface CreditCardPaymentMethodDetails {
4838
+ appDefId?: string;
4829
4839
  /**
4830
- * The last 4 digits of the card number.
4831
- * @maxLength 4
4840
+ * Not only UUID. Something here could be something weird.
4841
+ * @maxLength 36
4832
4842
  */
4833
- lastFourDigits?: string | null;
4843
+ instanceId?: string;
4834
4844
  /**
4835
- * Card issuer's brand.
4836
- * @maxLength 100
4845
+ * A version.
4846
+ * @maxLength 500
4837
4847
  */
4838
- brand?: string | null;
4848
+ version?: string | null;
4839
4849
  }
4840
- interface AuthorizationDetails {
4850
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4851
+ interface SiteRenamed {
4841
4852
  /**
4842
- * Whether the authorized payment is of a delayed capture.
4843
- * @readonly
4853
+ * A new meta site name (URL slug).
4854
+ * @maxLength 20
4844
4855
  */
4845
- delayedCapture?: boolean;
4846
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4847
- authorizedDate?: Date | null;
4856
+ newSiteName?: string;
4848
4857
  /**
4849
- * List of captures associated with payment
4850
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4851
- * @maxSize 1
4858
+ * A previous meta site name (URL slug).
4859
+ * @maxLength 255
4852
4860
  */
4853
- captures?: AuthorizationCapture[];
4854
- /** Void associated with payment */
4855
- void?: AuthorizationVoid;
4856
- /** Scheduled action for this transaction */
4857
- scheduledAction?: V1ScheduledAction;
4861
+ oldSiteName?: string;
4858
4862
  }
4859
- interface AuthorizationCapture {
4860
- /**
4861
- * Capture ID.
4862
- * @format GUID
4863
- * @readonly
4864
- */
4865
- id?: string | null;
4866
- /** Status of this capture action */
4867
- status?: AuthorizationCaptureStatusWithLiterals;
4863
+ /**
4864
+ * Hard deletion of the meta site.
4865
+ *
4866
+ * Could not be restored. Therefore it's desirable to cleanup data.
4867
+ */
4868
+ interface SiteHardDeleted {
4869
+ /** A deletion context. */
4870
+ deleteContext?: DeleteContext;
4871
+ }
4872
+ interface NamespaceChanged {
4873
+ /** A previous namespace. */
4874
+ oldNamespace?: NamespaceWithLiterals;
4875
+ /** A new namespace. */
4876
+ newNamespace?: NamespaceWithLiterals;
4877
+ }
4878
+ /** Assigned Studio editor */
4879
+ interface StudioAssigned {
4880
+ }
4881
+ /** Unassigned Studio editor */
4882
+ interface StudioUnassigned {
4883
+ }
4884
+ /**
4885
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4886
+ *
4887
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4888
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4889
+ *
4890
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4891
+ */
4892
+ interface SiteUrlChanged {
4893
+ }
4894
+ /**
4895
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4896
+ * Consumed by other teams to remove relevant data.
4897
+ */
4898
+ interface SitePurgedExternally {
4868
4899
  /**
4869
- * Amount of this capture
4870
- * @immutable
4900
+ * @maxLength 2048
4901
+ * @maxSize 100
4902
+ * @deprecated
4903
+ * @targetRemovalDate 2025-04-15
4871
4904
  */
4872
- amount?: Price;
4873
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4874
- createdDate?: Date | null;
4875
- /** In case of status is FAILED may contain failure details */
4876
- failureDetails?: AuthorizationActionFailureDetails;
4905
+ appDefId?: string[];
4877
4906
  }
4878
- declare enum AuthorizationCaptureStatus {
4879
- /** Capture operation still in progress. */
4880
- PENDING = "PENDING",
4881
- /** Capture operation succeeded. */
4882
- SUCCEEDED = "SUCCEEDED",
4883
- /** Capture operation failed. */
4884
- FAILED = "FAILED"
4907
+ /** Assigned Odeditor */
4908
+ interface OdeditorAssigned {
4885
4909
  }
4886
- /** @enumType */
4887
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4888
- interface AuthorizationActionFailureDetails {
4889
- /** @maxLength 100 */
4890
- failureCode?: string;
4910
+ /** Unassigned Odeditor */
4911
+ interface OdeditorUnassigned {
4891
4912
  }
4892
- interface AuthorizationVoid {
4893
- /** Status of this void action */
4894
- status?: AuthorizationVoidStatusWithLiterals;
4895
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4896
- voidedDate?: Date | null;
4897
- /** In case of status is FAILED may contain failure details */
4898
- failureDetails?: AuthorizationActionFailureDetails;
4899
- /** Reason of void action */
4900
- reason?: ReasonWithLiterals;
4913
+ /** Assigned Picasso editor */
4914
+ interface PicassoAssigned {
4901
4915
  }
4902
- declare enum AuthorizationVoidStatus {
4903
- /** Void operation still in progress. */
4904
- PENDING = "PENDING",
4905
- /** Void operation succeeded. */
4906
- SUCCEEDED = "SUCCEEDED",
4907
- /** Void operation failed. */
4908
- FAILED = "FAILED"
4916
+ /** Unassigned Picasso */
4917
+ interface PicassoUnassigned {
4918
+ }
4919
+ /** Assigned Wixel */
4920
+ interface WixelAssigned {
4921
+ }
4922
+ /** Unassigned Wixel */
4923
+ interface WixelUnassigned {
4924
+ }
4925
+ /** Assigned StudioTwo */
4926
+ interface StudioTwoAssigned {
4927
+ }
4928
+ /** Unassigned StudioTwo */
4929
+ interface StudioTwoUnassigned {
4930
+ }
4931
+ /** Media from user domain is enabled. */
4932
+ interface UserDomainMediaEnabled {
4933
+ }
4934
+ /** Media from user domain is disabled. */
4935
+ interface UserDomainMediaDisabled {
4936
+ }
4937
+ /** Assigned Editorless */
4938
+ interface EditorlessAssigned {
4939
+ }
4940
+ /** Unassigned Editorless */
4941
+ interface EditorlessUnassigned {
4942
+ }
4943
+ interface HasCustomEmailConfigurationsRequest {
4944
+ }
4945
+ interface HasCustomEmailConfigurationsResponse {
4946
+ hasCustomConfigurations?: boolean;
4947
+ }
4948
+ interface AddToAutomationMigrationPopulationRequest {
4949
+ /** When true, sends custom email configurations to automation system via email */
4950
+ sendCustomEmailConfigs?: boolean;
4951
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4952
+ origin?: OriginWithLiterals;
4953
+ }
4954
+ declare enum Origin {
4955
+ OPT_IN = "OPT_IN",
4956
+ MIGRATION = "MIGRATION"
4909
4957
  }
4910
4958
  /** @enumType */
4911
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4912
- /** Reason the authorization was voided. */
4913
- declare enum Reason {
4914
- /** Authorization was voided by user. */
4915
- MANUAL = "MANUAL",
4916
- /** Authorization passed execution date. */
4917
- SCHEDULED = "SCHEDULED"
4959
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4960
+ interface AddToAutomationMigrationPopulationResponse {
4961
+ success?: boolean;
4918
4962
  }
4919
- /** @enumType */
4920
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4921
- interface V1ScheduledAction {
4922
- /** Type of the action. */
4923
- actionType?: ActionTypeWithLiterals;
4924
- /** The date and time of the action. */
4925
- executionDate?: Date | null;
4963
+ interface IsInAutomationMigrationPopulationRequest {
4926
4964
  }
4927
- declare enum ActionType {
4928
- VOID = "VOID",
4929
- CAPTURE = "CAPTURE"
4965
+ interface IsInAutomationMigrationPopulationResponse {
4966
+ inPopulation?: boolean;
4930
4967
  }
4931
- /** @enumType */
4932
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4933
- interface Chargeback {
4968
+ interface PreparePaymentCollectionRequest {
4934
4969
  /**
4935
- * Chargeback ID.
4936
- * @format GUID
4937
- * @readonly
4938
- * @immutable
4970
+ * Ecom order ID.
4971
+ * @minLength 1
4972
+ * @maxLength 100
4939
4973
  */
4940
- id?: string;
4974
+ ecomOrderId: string;
4975
+ /** Amount to collect */
4976
+ amount: Price;
4941
4977
  /**
4942
- * 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.
4943
- * @readonly
4944
- * @immutable
4978
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4979
+ * Existing payment gateway order will be updated with a new amount.
4980
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4945
4981
  */
4946
- createdDate?: Date | null;
4982
+ paymentGatewayOrderId?: string | null;
4947
4983
  /**
4948
- * 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.
4949
- * @readonly
4984
+ * Whether to delay capture of the payment.
4985
+ * Default: false
4986
+ * @deprecated Whether to delay capture of the payment.
4987
+ * Default: false
4988
+ * @replacedBy delayed_capture_settings.scheduled_action
4989
+ * @targetRemovalDate 2024-09-30
4950
4990
  */
4951
- updatedDate?: Date | null;
4991
+ delayedCapture?: boolean;
4992
+ /** Delayed capture payment settings */
4993
+ delayedCaptureSettings?: DelayedCaptureSettings;
4994
+ }
4995
+ interface RedirectUrls {
4952
4996
  /**
4953
- * Amount.
4954
- * @readonly
4955
- * @immutable
4997
+ * URL to redirect buyer in case of approved (successful) transaction
4998
+ * @format WEB_URL
4956
4999
  */
4957
- amount?: Price;
5000
+ successUrl?: string | null;
4958
5001
  /**
4959
- * Reversal amount. Present only when status is REVERSED.
4960
- * @readonly
5002
+ * URL to redirect buyer in case of buyer canceled the transaction
5003
+ * @format WEB_URL
4961
5004
  */
4962
- reversalAmount?: Price;
5005
+ cancelUrl?: string | null;
4963
5006
  /**
4964
- * Status.
4965
- *
4966
- * Default: `"APPROVED"`.
5007
+ * URL to redirect buyer in case of failed/rejected transaction
5008
+ * @format WEB_URL
4967
5009
  */
4968
- status?: ChargebackStatusWithLiterals;
5010
+ errorUrl?: string | null;
4969
5011
  /**
4970
- * External chargeback ID.
4971
- * @format GUID
4972
- * @readonly
4973
- * @immutable
5012
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5013
+ * @format WEB_URL
4974
5014
  */
4975
- externalId?: string | null;
5015
+ pendingUrl?: string | null;
4976
5016
  }
4977
- declare enum ChargebackStatus {
4978
- /** Chargeback was approved. */
4979
- APPROVED = "APPROVED",
4980
- /** Chargeback was reversed. */
4981
- REVERSED = "REVERSED"
5017
+ interface DelayedCaptureSettings {
5018
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5019
+ scheduledAction?: ScheduledActionWithLiterals;
5020
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5021
+ delayDuration?: Duration;
5022
+ }
5023
+ declare enum ScheduledAction {
5024
+ /** Whether payment will be auto-voided when duration passes */
5025
+ VOID = "VOID",
5026
+ /** Whether payment will be auto-captured when duration passes */
5027
+ CAPTURE = "CAPTURE"
4982
5028
  }
4983
5029
  /** @enumType */
4984
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4985
- interface PaymentMethodName {
4986
- /**
4987
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
4988
- * @maxLength 150
4989
- */
4990
- buyerLanguageName?: string | null;
4991
- /**
4992
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
4993
- *
4994
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
4995
- * @maxLength 150
4996
- */
4997
- siteLanguageName?: string | null;
5030
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5031
+ interface Duration {
4998
5032
  /**
4999
- * User-provided payment method name.
5000
- *
5001
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5033
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5034
+ * @min 1
5002
5035
  */
5003
- userDefinedName?: UserDefinedPaymentMethodName;
5036
+ count?: number;
5037
+ /** Duration unit: MINUTES, HOURS and DAYS */
5038
+ unit?: DurationUnitWithLiterals;
5004
5039
  }
5005
- interface GiftCardPaymentDetails {
5006
- /**
5007
- * Gift card payment ID.
5008
- * @maxLength 100
5009
- */
5010
- giftCardPaymentId?: string;
5011
- /**
5012
- * ID of the app that created the gift card.
5013
- * @format GUID
5014
- */
5015
- appId?: string;
5016
- /**
5017
- * Whether the gift card is voided.
5018
- * @readonly
5019
- * @deprecated Whether the gift card is voided.
5020
- * @replacedBy payment.status
5021
- * @targetRemovalDate 2026-11-01
5022
- */
5023
- voided?: boolean;
5024
- /**
5025
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5026
- * @maxLength 30
5027
- * @immutable
5028
- */
5029
- obfuscatedCode?: string | null;
5040
+ declare enum DurationUnit {
5041
+ MINUTES = "MINUTES",
5042
+ HOURS = "HOURS",
5043
+ DAYS = "DAYS"
5030
5044
  }
5031
- interface MembershipPaymentDetails {
5032
- /**
5033
- * Membership ID.
5034
- * @maxLength 200
5035
- */
5036
- membershipId?: string;
5045
+ /** @enumType */
5046
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5047
+ interface PreparePaymentCollectionResponse {
5048
+ /** Payment gateway order id which is associated with given payment */
5049
+ paymentGatewayOrderId?: string;
5050
+ }
5051
+ interface GetPaymentCollectabilityStatusRequest {
5037
5052
  /**
5038
- * ID of the line item this membership applies to.
5053
+ * Ecom order ID.
5039
5054
  * @minLength 1
5040
5055
  * @maxLength 100
5041
5056
  */
5042
- lineItemId?: string;
5043
- /**
5044
- * Payment status.
5045
- * @deprecated Payment status.
5046
- * @replacedBy payment.status
5047
- * @targetRemovalDate 2026-11-01
5048
- */
5049
- status?: MembershipPaymentStatusWithLiterals;
5050
- /** Membership name. */
5051
- name?: MembershipName;
5057
+ ecomOrderId: string;
5058
+ }
5059
+ interface GetPaymentCollectabilityStatusResponse {
5060
+ /** Payment collectability status */
5061
+ status?: PaymentCollectabilityStatusWithLiterals;
5062
+ /** Collectable order amount */
5063
+ amount?: Price;
5064
+ }
5065
+ declare enum PaymentCollectabilityStatus {
5066
+ UNKNOWN = "UNKNOWN",
5067
+ COLLECTABLE = "COLLECTABLE",
5068
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5069
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5070
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5071
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5072
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5073
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5074
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5075
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5076
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5077
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5078
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5079
+ }
5080
+ /** @enumType */
5081
+ 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';
5082
+ interface RecordManuallyCollectedPaymentRequest {
5052
5083
  /**
5053
- * The transaction ID in the membership system. Can be used to void the transaction.
5084
+ * Order ID.
5054
5085
  * @minLength 1
5055
5086
  * @maxLength 100
5056
5087
  */
5057
- externalTransactionId?: string | null;
5088
+ orderId: string;
5089
+ /** Amount to be recorded as approved manual payment for given order */
5090
+ amount: Price;
5091
+ }
5092
+ /**
5093
+ * User-defined payment method name.
5094
+ * Allows specifying either a predefined type or a custom name.
5095
+ */
5096
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5097
+ /** Predefined payment method. */
5098
+ predefined?: PredefinedPaymentMethodWithLiterals;
5058
5099
  /**
5059
- * Whether the membership is voided.
5060
- * @readonly
5061
- * @deprecated Whether the membership is voided.
5062
- * @replacedBy payment.status
5063
- * @targetRemovalDate 2026-11-01
5100
+ * Custom payment method name provided by user.
5101
+ *
5102
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5103
+ * @minLength 1
5104
+ * @maxLength 150
5064
5105
  */
5065
- voided?: boolean;
5106
+ custom?: string | null;
5107
+ }
5108
+ /** @oneof */
5109
+ interface UserDefinedPaymentMethodNameKindOneOf {
5110
+ /** Predefined payment method. */
5111
+ predefined?: PredefinedPaymentMethodWithLiterals;
5066
5112
  /**
5067
- * ID of the application providing this payment option.
5068
- * @format GUID
5113
+ * Custom payment method name provided by user.
5114
+ *
5115
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5116
+ * @minLength 1
5117
+ * @maxLength 150
5069
5118
  */
5070
- providerAppId?: string;
5071
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5072
- futureMembership?: FutureMembershipDetails;
5119
+ custom?: string | null;
5073
5120
  }
5074
- declare enum MembershipPaymentStatus {
5075
- /** Payment was charged. */
5076
- CHARGED = "CHARGED",
5077
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5078
- CHARGE_FAILED = "CHARGE_FAILED",
5079
- /** Payment is pending. */
5080
- CHARGE_PENDING = "CHARGE_PENDING",
5081
- /** Payment was voided. */
5082
- VOIDED = "VOIDED"
5121
+ /** Predefined payment method types for offline/manual payments. */
5122
+ declare enum PredefinedPaymentMethod {
5123
+ /** Cash payment. */
5124
+ CASH = "CASH",
5125
+ /** Bank transfer. */
5126
+ BANK_TRANSFER = "BANK_TRANSFER",
5127
+ /** Payment by check. */
5128
+ CHECK = "CHECK"
5083
5129
  }
5084
5130
  /** @enumType */
5085
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5086
- interface FutureMembershipDetails {
5087
- /**
5088
- * ID of the plan line item in the order from which the membership will be created.
5089
- * @format GUID
5090
- */
5091
- lineItemId?: string;
5092
- /**
5093
- * ID of the benefit the future membership will grant.
5094
- * @maxLength 200
5095
- */
5096
- benefitId?: string;
5131
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5132
+ interface RecordManuallyCollectedPaymentResponse {
5097
5133
  }
5098
- interface WixReceiptInfo {
5134
+ interface MarkOrderAsPaidRequest {
5099
5135
  /**
5100
- * Receipt ID
5101
- * @format GUID
5136
+ * Ecom order ID.
5137
+ * @minLength 1
5138
+ * @maxLength 100
5102
5139
  */
5103
- receiptId?: string;
5140
+ ecomOrderId: string;
5141
+ }
5142
+ interface MarkOrderAsPaidResponse {
5143
+ /** Updated order. */
5144
+ order?: Order;
5145
+ }
5146
+ interface BulkMarkOrdersAsPaidRequest {
5104
5147
  /**
5105
- * Display number of receipt
5148
+ * IDs of orders to mark as paid.
5149
+ * @minSize 1
5150
+ * @maxSize 100
5106
5151
  * @minLength 1
5107
- * @maxLength 40
5152
+ * @maxLength 100
5108
5153
  */
5109
- displayNumber?: string | null;
5154
+ ecomOrderIds: string[];
5110
5155
  }
5111
- interface ExternalReceiptInfo {
5156
+ interface BulkMarkOrdersAsPaidResponse {
5112
5157
  /**
5113
- * External receipt ID
5114
- * @maxLength 100
5158
+ * Items updated by the bulk action.
5159
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5115
5160
  */
5116
- receiptId?: string | null;
5161
+ results?: BulkOrderResult[];
5162
+ /** Bulk action metadata. */
5163
+ bulkActionMetadata?: BulkActionMetadata;
5164
+ }
5165
+ interface BulkOrderResult {
5166
+ /** Item metadata. */
5167
+ itemMetadata?: ItemMetadata;
5117
5168
  /**
5118
- * ID of the app providing the receipt
5119
- * @format GUID
5169
+ * Updated order.
5170
+ *
5171
+ * Returned when `returnFullEntity = true`.
5120
5172
  */
5121
- appId?: string | null;
5173
+ item?: Order;
5174
+ }
5175
+ interface ItemMetadata {
5176
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5177
+ id?: string | null;
5178
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5179
+ originalIndex?: number;
5180
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5181
+ success?: boolean;
5182
+ /** Details about the error in case of failure. */
5183
+ error?: ApplicationError;
5184
+ }
5185
+ interface ApplicationError {
5186
+ /** Error code. */
5187
+ code?: string;
5188
+ /** Description of the error. */
5189
+ description?: string;
5190
+ /** Data related to the error. */
5191
+ data?: Record<string, any> | null;
5192
+ }
5193
+ interface BulkActionMetadata {
5194
+ /** Number of items that were successfully processed. */
5195
+ totalSuccesses?: number;
5196
+ /** Number of items that couldn't be processed. */
5197
+ totalFailures?: number;
5198
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5199
+ undetailedFailures?: number;
5200
+ }
5201
+ interface GetRefundabilityStatusRequest {
5122
5202
  /**
5123
- * Display number of receipt
5203
+ * Order ID.
5124
5204
  * @minLength 1
5125
- * @maxLength 40
5205
+ * @maxLength 100
5126
5206
  */
5127
- displayNumber?: string | null;
5207
+ ecomOrderId: string;
5128
5208
  }
5129
- interface CashRoundingDetails {
5209
+ interface GetRefundabilityStatusResponse {
5130
5210
  /**
5131
- * Payment amount before cash rounding was applied.
5132
- * When provided, balance and status calculations use this value instead of `amount`
5133
- * to prevent false overpayment or underpayment due to rounding.
5211
+ * Refundability details.
5212
+ * @maxSize 300
5134
5213
  */
5135
- unroundedAmount?: Price;
5214
+ refundabilities?: Refundability[];
5136
5215
  /**
5137
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5138
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5139
- * @readonly
5216
+ * Whether the order supports refunding per item.
5217
+ * @deprecated
5140
5218
  */
5141
- roundingAdjustment?: CashRounding;
5219
+ refundablePerItem?: boolean;
5142
5220
  }
5143
- declare enum PaymentStatus {
5144
- /** Payment was charged successfully. */
5145
- APPROVED = "APPROVED",
5146
- /** Payment is being processed and hasn't been confirmed yet. */
5147
- PENDING = "PENDING",
5148
- /** 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. */
5149
- PENDING_MERCHANT = "PENDING_MERCHANT",
5150
- /** Payment was canceled before it was charged. */
5151
- CANCELED = "CANCELED",
5152
- /** Payment was declined by the payment provider. */
5153
- DECLINED = "DECLINED",
5154
- /** Payment was fully refunded. */
5155
- REFUNDED = "REFUNDED",
5156
- /** Part of the payment amount was refunded. */
5157
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5158
- /** 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. */
5159
- AUTHORIZED = "AUTHORIZED",
5160
- /**
5161
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5162
- *
5163
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5164
- */
5165
- VOIDED = "VOIDED"
5221
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5222
+ /** Reason why payment is not refundable. */
5223
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5224
+ /** Reason why payment is only refundable manually. */
5225
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5226
+ /** Payment ID. */
5227
+ paymentId?: string;
5228
+ /** Payment refundability status. */
5229
+ refundabilityStatus?: RefundableStatusWithLiterals;
5230
+ /** Link to payment provider dashboard. */
5231
+ providerLink?: string | null;
5166
5232
  }
5167
- /** @enumType */
5168
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5169
- interface CanceledStatusDetails {
5170
- reason?: CanceledReasonWithLiterals;
5233
+ /** @oneof */
5234
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5235
+ /** Reason why payment is not refundable. */
5236
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5237
+ /** Reason why payment is only refundable manually. */
5238
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5171
5239
  }
5172
- declare enum CanceledReason {
5173
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5174
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5175
- /** Payment was not completed by user and expired. */
5176
- EXPIRED = "EXPIRED"
5240
+ declare enum RefundableStatus {
5241
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5242
+ MANUAL = "MANUAL",
5243
+ REFUNDABLE = "REFUNDABLE"
5177
5244
  }
5178
5245
  /** @enumType */
5179
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5180
- interface DeclinedStatusDetails {
5181
- reason?: DeclinedReasonWithLiterals;
5182
- }
5183
- declare enum DeclinedReason {
5184
- /** Corresponding charge failed. */
5185
- CHARGE_FAILED = "CHARGE_FAILED",
5186
- /** Payment details expired. */
5187
- EXPIRED = "EXPIRED",
5188
- /** Insufficient funds. */
5189
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5190
- /** Gift card was disabled before charge was attempted. */
5191
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5246
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5247
+ declare enum NonRefundableReason {
5248
+ NONE = "NONE",
5249
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5250
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5251
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5252
+ NOT_PAID = "NOT_PAID",
5253
+ ACCESS_DENIED = "ACCESS_DENIED",
5254
+ ZERO_PRICE = "ZERO_PRICE",
5255
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5256
+ PENDING_REFUND = "PENDING_REFUND",
5257
+ FORBIDDEN = "FORBIDDEN",
5258
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5259
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5260
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5192
5261
  }
5193
5262
  /** @enumType */
5194
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5195
- interface VoidedStatusDetails {
5196
- reason?: VoidedReasonWithLiterals;
5197
- }
5198
- declare enum VoidedReason {
5199
- /** Payment was voided by merchant request. */
5200
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5201
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5202
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5263
+ 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';
5264
+ declare enum ManuallyRefundableReason {
5265
+ EXPIRED = "EXPIRED",
5266
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5267
+ OFFLINE = "OFFLINE",
5268
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5203
5269
  }
5204
5270
  /** @enumType */
5205
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5206
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5207
- }
5208
- /** @oneof */
5209
- interface PaymentStatusDetailsStatusDetailsOneOf {
5271
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5272
+ interface CreatePaymentGatewayOrderRequest {
5273
+ /**
5274
+ * Ecom order ID.
5275
+ * @minLength 1
5276
+ * @maxLength 100
5277
+ */
5278
+ ecomOrderId: string;
5279
+ /** Information about the user who initiated the payment. */
5280
+ chargedBy?: ChargedBy;
5210
5281
  }
5211
- interface Refund {
5282
+ interface ChargedBy {
5212
5283
  /**
5213
- * Refund ID.
5284
+ * ID - id of the user who initiated the payment
5214
5285
  * @format GUID
5215
- * @readonly
5216
5286
  */
5217
5287
  id?: string;
5218
5288
  /**
5219
- * List of transactions.
5220
- * @maxSize 50
5289
+ * Full name - name of the user who initiated the payment
5290
+ * @minLength 1
5291
+ * @maxLength 200
5221
5292
  */
5222
- transactions?: RefundTransaction[];
5223
- /** Refund business details. */
5224
- details?: RefundDetails;
5293
+ fullName?: string | null;
5294
+ }
5295
+ interface CreatePaymentGatewayOrderResponse {
5296
+ /** ID of the order created in the payment gateway */
5297
+ paymentGatewayOrderId?: string;
5298
+ }
5299
+ interface ChargeMembershipsRequest {
5225
5300
  /**
5226
- * 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.
5227
- * @readonly
5228
- * @immutable
5301
+ * Order ID.
5302
+ * @minLength 1
5303
+ * @maxLength 100
5304
+ */
5305
+ ecomOrderId: string;
5306
+ /**
5307
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5308
+ * but a user which is using the membership on behalf of the a member
5309
+ * @format GUID
5310
+ */
5311
+ memberId: string;
5312
+ /**
5313
+ * List of items to be paid by memberships
5314
+ * @minSize 1
5315
+ * @maxSize 300
5229
5316
  */
5230
- createdDate?: Date | null;
5317
+ membershipCharges?: MembershipChargeItem[];
5318
+ }
5319
+ interface MembershipChargeItem {
5231
5320
  /**
5232
- * Aggregated refund summary.
5233
- * @readonly
5321
+ * The id of used membership
5322
+ * @minLength 1
5323
+ * @maxLength 100
5234
5324
  */
5235
- summary?: AggregatedRefundSummary;
5325
+ membershipId?: string;
5236
5326
  /**
5237
- * ID of the app that initiated this refund.
5327
+ * ID of the application providing this payment option
5238
5328
  * @format GUID
5239
- * @readonly
5240
- * @immutable
5241
5329
  */
5242
- requestingServiceAppId?: string | null;
5243
- }
5244
- interface RefundTransaction {
5330
+ appId?: string;
5331
+ /** The name of used membership */
5332
+ membershipName?: MembershipName;
5333
+ /** Additional data about this membership */
5334
+ membershipAdditionalData?: Record<string, any> | null;
5335
+ /** Catalog and item reference info. */
5336
+ catalogReference?: CatalogReference;
5337
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5338
+ serviceProperties?: ServiceProperties;
5245
5339
  /**
5246
- * ID of the payment associated with this refund.
5247
- * @format GUID
5248
- * @immutable
5340
+ * Usually would be the same as catalogReference.catalogItemId
5341
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5342
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5343
+ * @minLength 1
5344
+ * @maxLength 36
5249
5345
  */
5250
- paymentId?: string;
5346
+ rootCatalogItemId?: string | null;
5251
5347
  /**
5252
- * Refund amount.
5253
- * @immutable
5348
+ * line item id of Checkout/Order line item
5349
+ * @minLength 1
5350
+ * @maxLength 100
5254
5351
  */
5255
- amount?: Price;
5256
- /** Refund status. */
5257
- refundStatus?: RefundStatusWithLiterals;
5258
- /** Optional details of current refund status. */
5259
- refundStatusInfo?: RefundStatusInfo;
5352
+ lineItemId?: string;
5353
+ }
5354
+ interface MembershipName {
5260
5355
  /**
5261
- * Payment gateway's refund ID.
5262
- * This field is only returned when the value of `external_refund` is `false`.
5263
- * @format GUID
5356
+ * Membership name in the site's original language.
5357
+ * @maxLength 100
5264
5358
  */
5265
- gatewayRefundId?: string | null;
5266
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5267
- providerRefundId?: string | null;
5359
+ original?: string;
5268
5360
  /**
5269
- * Whether refund was made externally and manually on the payment provider's side.
5270
- * @immutable
5361
+ * Membership name translated into the buyer's language.
5362
+ *
5363
+ * Default: The value of `original`
5364
+ * @maxLength 100
5271
5365
  */
5272
- externalRefund?: boolean;
5366
+ translated?: string | null;
5273
5367
  }
5274
- /** Refund transaction status. */
5275
- declare enum RefundStatus {
5276
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5277
- PENDING = "PENDING",
5278
- /** Refund transaction succeeded. */
5279
- SUCCEEDED = "SUCCEEDED",
5280
- /** Refund transaction failed. */
5281
- FAILED = "FAILED",
5282
- /** Refund request acknowledged, and will be executed soon. */
5283
- SCHEDULED = "SCHEDULED",
5284
- /** Refund was initiated on payment provider side. */
5285
- STARTED = "STARTED"
5368
+ interface ChargeMembershipsResponse {
5286
5369
  }
5287
- /** @enumType */
5288
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5289
- interface RefundStatusInfo {
5370
+ interface TriggerRefundRequest {
5290
5371
  /**
5291
- * Reason code for the refund's current status.
5292
- *
5293
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5372
+ * The order this refund related to
5294
5373
  * @minLength 1
5295
- * @maxLength 10
5374
+ * @maxLength 100
5296
5375
  */
5297
- paymentGatewayReasonCode?: string | null;
5376
+ ecomOrderId: string;
5298
5377
  /**
5299
- * Free text explanation of current refund status.
5300
- * @minLength 1
5301
- * @maxLength 1000
5378
+ * Refund operations information
5379
+ * @minSize 1
5380
+ * @maxSize 1
5302
5381
  */
5303
- description?: string | null;
5304
- }
5305
- interface AggregatedRefundSummary {
5306
- /** Total amount requested for refund. */
5307
- requestedRefund?: Price;
5308
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5309
- pendingRefund?: Price;
5310
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5311
- refunded?: Price;
5312
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5313
- failedRefundAmount?: Price;
5314
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5315
- pending?: boolean;
5316
- /** Breakdown of refunded items. Available only after refund is complete. */
5317
- breakdown?: RefundItemsBreakdown;
5382
+ payments: PaymentRefund[];
5383
+ /** Business model of a refund */
5384
+ details?: RefundDetails;
5385
+ /** Side effect details related to refund */
5386
+ sideEffects?: RefundSideEffects;
5318
5387
  }
5319
- interface RefundItemsBreakdown {
5388
+ interface PaymentRefund {
5320
5389
  /**
5321
- * Refunded line items and the amount refunded for each.
5322
- * @maxSize 300
5390
+ * Specific payment within the order to refund
5391
+ * @format GUID
5323
5392
  */
5324
- lineItems?: LineItemRefundSummary[];
5325
- }
5326
- interface LineItemRefundSummary {
5393
+ paymentId?: string;
5394
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5395
+ amount?: Price;
5327
5396
  /**
5328
- * ID of the refunded line item.
5329
- * @format GUID
5397
+ * Whether refund is made externally and manually (on the payment provider's side)
5398
+ * 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.
5399
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5330
5400
  */
5331
- lineItemId?: string;
5332
- /** Total refunded amount for the line item. */
5333
- totalRefundedAmount?: Price;
5401
+ externalRefund?: boolean;
5334
5402
  }
5335
- interface CalculateRefundRequest {
5403
+ interface RefundSideEffects {
5404
+ /** Inventory restock details as part of this refund. */
5405
+ restockInfo?: RestockInfo;
5406
+ /** Whether to send a refund confirmation email to the customer. */
5407
+ sendOrderRefundedEmail?: boolean;
5336
5408
  /**
5337
- * Order ID
5409
+ * Custom message added to the refund confirmation email.
5338
5410
  * @minLength 1
5339
- * @maxLength 100
5411
+ * @maxLength 1000
5340
5412
  */
5341
- ecomOrderId?: string;
5413
+ customMessage?: string | null;
5414
+ }
5415
+ interface RestockInfo {
5416
+ /** Restock type. */
5417
+ type?: RestockTypeWithLiterals;
5342
5418
  /**
5343
- * Refunded line items and quantity
5419
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5344
5420
  * @maxSize 300
5345
5421
  */
5346
- refundItems?: CalculateRefundItemRequest[];
5347
- /** Should include shipping in refund calculation */
5348
- refundShipping?: boolean;
5422
+ items?: RestockItem[];
5349
5423
  }
5350
- interface CalculateRefundItemRequest {
5424
+ declare enum RestockType {
5425
+ NO_ITEMS = "NO_ITEMS",
5426
+ ALL_ITEMS = "ALL_ITEMS",
5427
+ SOME_ITEMS = "SOME_ITEMS"
5428
+ }
5429
+ /** @enumType */
5430
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5431
+ interface RestockItem {
5351
5432
  /**
5352
- * ID of the line item being refunded
5433
+ * ID of the line item being restocked.
5353
5434
  * @format GUID
5354
5435
  */
5355
- id?: string;
5436
+ lineItemId?: string;
5356
5437
  /**
5357
- * How much of that line item is being refunded
5438
+ * Line item quantity being restocked.
5358
5439
  * @min 1
5359
5440
  * @max 100000
5360
5441
  */
5361
5442
  quantity?: number;
5362
5443
  }
5363
- interface CalculateRefundResponse {
5364
- /** Total refundable amount */
5365
- total?: Price;
5366
- /** Tax cost of the order */
5367
- tax?: Price;
5368
- /** Discount given for this order */
5369
- discount?: Price;
5370
- /** Total cost of the order (without tax) */
5371
- subtotal?: Price;
5372
- /** Total shipping cost for order */
5373
- shipping?: Price;
5374
- /** Previous refund given on that order */
5375
- previouslyRefundedAmount?: Price;
5376
- /**
5377
- * The refundable items of that order
5378
- * @maxSize 300
5379
- */
5380
- items?: CalculateRefundItemResponse[];
5444
+ interface TriggerRefundResponse {
5445
+ /** All order's transactions after the refunds were added */
5446
+ orderTransactions?: OrderTransactions;
5447
+ /** Created refund ID */
5448
+ refundId?: string | null;
5449
+ /** Payment ID's that the refund execution had failed for */
5450
+ failedPaymentIds?: ItemMetadata[];
5381
5451
  }
5382
- interface CalculateRefundItemResponse {
5452
+ /**
5453
+ * A record of all payments and refunds associated with an order.
5454
+ *
5455
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5456
+ */
5457
+ interface OrderTransactions {
5383
5458
  /**
5384
- * Line item ID
5459
+ * Order ID.
5385
5460
  * @format GUID
5386
5461
  */
5387
- id?: string;
5388
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5389
- price?: Price;
5390
- }
5391
- interface VoidAuthorizedPaymentsRequest {
5462
+ orderId?: string;
5392
5463
  /**
5393
- * Wix eCommerce order ID
5394
- * @minLength 1
5395
- * @maxLength 100
5464
+ * Record of payments made to the merchant.
5465
+ * @maxSize 100
5396
5466
  */
5397
- ecomOrderId: string;
5467
+ payments?: Payment[];
5398
5468
  /**
5399
- * Payment IDs
5400
- * @minSize 1
5401
- * @maxSize 100
5402
- * @format GUID
5469
+ * Record of refunds made to the buyer.
5470
+ * @maxSize 300
5403
5471
  */
5404
- paymentIds: string[];
5405
- }
5406
- interface VoidAuthorizedPaymentsResponse {
5407
- /** All order's transactions after the void was triggered */
5408
- orderTransactions?: OrderTransactions;
5472
+ refunds?: Refund[];
5409
5473
  }
5410
- interface CaptureAuthorizedPaymentsRequest {
5474
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5475
+ /** Regular payment details. */
5476
+ regularPaymentDetails?: RegularPaymentDetails;
5477
+ /** Gift card payment details. */
5478
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5479
+ /** Membership payment details. */
5480
+ membershipPaymentDetails?: MembershipPaymentDetails;
5411
5481
  /**
5412
- * Wix eCommerce order ID
5413
- * @minLength 1
5414
- * @maxLength 100
5482
+ * Payment ID.
5483
+ * @format GUID
5484
+ * @readonly
5485
+ */
5486
+ id?: string | null;
5487
+ /** 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. */
5488
+ createdDate?: Date | null;
5489
+ /**
5490
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5491
+ * @readonly
5415
5492
  */
5416
- ecomOrderId: string;
5493
+ updatedDate?: Date | null;
5494
+ /** Payment amount. */
5495
+ amount?: Price;
5417
5496
  /**
5418
- * Capture payments information
5419
- * @minSize 1
5420
- * @maxSize 100
5497
+ * Whether refunds for this payment are disabled.
5498
+ * + `true`: This payment is not refundable.
5499
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5421
5500
  */
5422
- payments: PaymentCapture[];
5423
- }
5424
- interface PaymentCapture {
5501
+ refundDisabled?: boolean;
5425
5502
  /**
5426
- * Payment ID
5427
- * @format GUID
5503
+ * Whether receipt generation is allowed for this payment.
5504
+ * + `true`: This payment supports receipt generation.
5505
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5506
+ * @readonly
5428
5507
  */
5429
- paymentId?: string | null;
5508
+ supportReceiptGeneration?: boolean;
5509
+ /** Details about cash rounding applied to this payment, when relevant. */
5510
+ cashRounding?: CashRoundingDetails;
5430
5511
  /**
5431
- * Capture amount.
5432
- * If not provided - full authorized amount will be captured.
5512
+ * Overall payment status.
5513
+ *
5514
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5433
5515
  */
5434
- amount?: Price;
5435
- }
5436
- interface CaptureAuthorizedPaymentsResponse {
5437
- /** All order's transactions after the capture was triggered */
5438
- orderTransactions?: OrderTransactions;
5439
- }
5440
- interface ChargeSavedPaymentMethodRequest {
5516
+ status?: PaymentStatusWithLiterals;
5441
5517
  /**
5442
- * Ecom Order ID.
5443
- * @minLength 1
5444
- * @maxLength 100
5518
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5519
+ * @format GUID
5445
5520
  */
5446
- ecomOrderId?: string;
5447
- /** Amount to be charged */
5448
- amount?: Price;
5521
+ chargeCorrelationId?: string | null;
5449
5522
  }
5450
- interface ChargeSavedPaymentMethodResponse {
5451
- /** Payment gateway's order ID (e.g Wix Payments) */
5452
- paymentGatewayOrderId?: string;
5523
+ /** @oneof */
5524
+ interface PaymentPaymentDetailsOneOf {
5525
+ /** Regular payment details. */
5526
+ regularPaymentDetails?: RegularPaymentDetails;
5527
+ /** Gift card payment details. */
5528
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5529
+ /** Membership payment details. */
5530
+ membershipPaymentDetails?: MembershipPaymentDetails;
5453
5531
  }
5454
- interface SendBuyerConfirmationEmailRequest {
5455
- /** @format GUID */
5456
- orderId?: string;
5532
+ /** @oneof */
5533
+ interface PaymentReceiptInfoOneOf {
5457
5534
  }
5458
- interface SendBuyerConfirmationEmailResponse {
5535
+ /** @oneof */
5536
+ interface PaymentStatusDetailsOneOf {
5459
5537
  }
5460
- interface SendBuyerPaymentsReceivedEmailRequest {
5538
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5539
+ /** Credit card details. */
5540
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5461
5541
  /**
5462
- * @minLength 1
5542
+ * Wix Payments order ID.
5463
5543
  * @maxLength 100
5464
5544
  */
5465
- orderId?: string;
5466
- }
5467
- interface SendBuyerPaymentsReceivedEmailResponse {
5468
- }
5469
- interface SendBuyerPickupConfirmationEmailRequest {
5545
+ paymentOrderId?: string | null;
5470
5546
  /**
5471
- * @minLength 1
5547
+ * Payment gateway's transaction ID.
5548
+ * This field is only returned when the value of `offline_payment` is `false`.
5472
5549
  * @maxLength 100
5473
5550
  */
5474
- orderId?: string;
5475
- }
5476
- interface SendBuyerPickupConfirmationEmailResponse {
5477
- }
5478
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5551
+ gatewayTransactionId?: string | null;
5479
5552
  /**
5480
- * IDs of orders to send pickup emails for.
5481
- * @minSize 1
5482
- * @maxSize 300
5553
+ * Payment method.
5554
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5555
+ * Non-exhaustive list of supported values:
5556
+ * + `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`
5557
+ * @maxLength 150
5558
+ * @deprecated Payment method.
5559
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5560
+ * Non-exhaustive list of supported values:
5561
+ * + `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`
5562
+ * @replacedBy payment_method_name
5563
+ * @targetRemovalDate 2026-07-01
5483
5564
  */
5484
- orderIds?: string[];
5485
- }
5486
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5487
- }
5488
- interface SendBuyerShippingConfirmationEmailRequest {
5565
+ paymentMethod?: string | null;
5489
5566
  /**
5490
- * @minLength 1
5567
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5491
5568
  * @maxLength 100
5492
5569
  */
5493
- orderId?: string;
5494
- }
5495
- interface SendBuyerShippingConfirmationEmailResponse {
5496
- }
5497
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
5570
+ providerTransactionId?: string | null;
5571
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5572
+ offlinePayment?: boolean;
5498
5573
  /**
5499
- * IDs of orders to send pickup emails for.
5500
- * @minSize 1
5501
- * @maxSize 300
5574
+ * Payment status.
5575
+ * @deprecated Payment status.
5576
+ * @replacedBy payment.status
5577
+ * @targetRemovalDate 2026-11-01
5502
5578
  */
5503
- orderIds?: string[];
5579
+ status?: TransactionStatusWithLiterals;
5580
+ /** Whether there is a payment agreement that allows for future charges. */
5581
+ savedPaymentMethod?: boolean;
5582
+ /** Authorization details. */
5583
+ authorizationDetails?: AuthorizationDetails;
5584
+ /**
5585
+ * Record of chargebacks made by the buyer.
5586
+ * @maxSize 6
5587
+ */
5588
+ chargebacks?: Chargeback[];
5589
+ /** Platform fee amount associated with this payment. */
5590
+ platformFee?: Price;
5591
+ /**
5592
+ * Payment method with buyer and optional owner translations.
5593
+ * Non-exhaustive list of supported values:
5594
+ * + `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`
5595
+ */
5596
+ paymentMethodName?: PaymentMethodName;
5504
5597
  }
5505
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5598
+ /** @oneof */
5599
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5600
+ /** Credit card details. */
5601
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5506
5602
  }
5507
- interface SendMerchantOrderReceivedNotificationRequest {
5603
+ declare enum TransactionStatus {
5604
+ UNDEFINED = "UNDEFINED",
5605
+ APPROVED = "APPROVED",
5606
+ PENDING = "PENDING",
5607
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5608
+ CANCELED = "CANCELED",
5609
+ DECLINED = "DECLINED",
5610
+ REFUNDED = "REFUNDED",
5611
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5612
+ AUTHORIZED = "AUTHORIZED",
5613
+ VOIDED = "VOIDED"
5614
+ }
5615
+ /** @enumType */
5616
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5617
+ interface CreditCardPaymentMethodDetails {
5508
5618
  /**
5509
- * @minLength 1
5619
+ * The last 4 digits of the card number.
5620
+ * @maxLength 4
5621
+ */
5622
+ lastFourDigits?: string | null;
5623
+ /**
5624
+ * Card issuer's brand.
5510
5625
  * @maxLength 100
5511
5626
  */
5512
- orderId?: string;
5513
- }
5514
- interface SendMerchantOrderReceivedNotificationResponse {
5627
+ brand?: string | null;
5515
5628
  }
5516
- interface SendCancelRefundEmailRequest {
5629
+ interface AuthorizationDetails {
5517
5630
  /**
5518
- * The ID of order that is canceled/refunded
5519
- * @minLength 1
5520
- * @maxLength 100
5631
+ * Whether the authorized payment is of a delayed capture.
5632
+ * @readonly
5521
5633
  */
5522
- orderId?: string;
5634
+ delayedCapture?: boolean;
5635
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5636
+ authorizedDate?: Date | null;
5523
5637
  /**
5524
- * Personal note added to the email (optional)
5525
- * @minLength 1
5526
- * @maxLength 1000
5638
+ * List of captures associated with payment
5639
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5640
+ * @maxSize 1
5527
5641
  */
5528
- customMessage?: string | null;
5529
- /** Refund amount */
5530
- refundAmount?: Price;
5642
+ captures?: AuthorizationCapture[];
5643
+ /** Void associated with payment */
5644
+ void?: AuthorizationVoid;
5645
+ /** Scheduled action for this transaction */
5646
+ scheduledAction?: V1ScheduledAction;
5647
+ }
5648
+ interface AuthorizationCapture {
5531
5649
  /**
5532
- * Refund ID. (Optional)
5650
+ * Capture ID.
5533
5651
  * @format GUID
5652
+ * @readonly
5534
5653
  */
5535
- refundId?: string | null;
5654
+ id?: string | null;
5655
+ /** Status of this capture action */
5656
+ status?: AuthorizationCaptureStatusWithLiterals;
5657
+ /**
5658
+ * Amount of this capture
5659
+ * @immutable
5660
+ */
5661
+ amount?: Price;
5662
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5663
+ createdDate?: Date | null;
5664
+ /** In case of status is FAILED may contain failure details */
5665
+ failureDetails?: AuthorizationActionFailureDetails;
5666
+ }
5667
+ declare enum AuthorizationCaptureStatus {
5668
+ /** Capture operation still in progress. */
5669
+ PENDING = "PENDING",
5670
+ /** Capture operation succeeded. */
5671
+ SUCCEEDED = "SUCCEEDED",
5672
+ /** Capture operation failed. */
5673
+ FAILED = "FAILED"
5674
+ }
5675
+ /** @enumType */
5676
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5677
+ interface AuthorizationActionFailureDetails {
5678
+ /** @maxLength 100 */
5679
+ failureCode?: string;
5680
+ }
5681
+ interface AuthorizationVoid {
5682
+ /** Status of this void action */
5683
+ status?: AuthorizationVoidStatusWithLiterals;
5684
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5685
+ voidedDate?: Date | null;
5686
+ /** In case of status is FAILED may contain failure details */
5687
+ failureDetails?: AuthorizationActionFailureDetails;
5688
+ /** Reason of void action */
5689
+ reason?: ReasonWithLiterals;
5690
+ }
5691
+ declare enum AuthorizationVoidStatus {
5692
+ /** Void operation still in progress. */
5693
+ PENDING = "PENDING",
5694
+ /** Void operation succeeded. */
5695
+ SUCCEEDED = "SUCCEEDED",
5696
+ /** Void operation failed. */
5697
+ FAILED = "FAILED"
5698
+ }
5699
+ /** @enumType */
5700
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5701
+ /** Reason the authorization was voided. */
5702
+ declare enum Reason {
5703
+ /** Authorization was voided by user. */
5704
+ MANUAL = "MANUAL",
5705
+ /** Authorization passed execution date. */
5706
+ SCHEDULED = "SCHEDULED"
5536
5707
  }
5537
- interface SendCancelRefundEmailResponse {
5708
+ /** @enumType */
5709
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5710
+ interface V1ScheduledAction {
5711
+ /** Type of the action. */
5712
+ actionType?: ActionTypeWithLiterals;
5713
+ /** The date and time of the action. */
5714
+ executionDate?: Date | null;
5538
5715
  }
5539
- interface SendRefundEmailRequest {
5716
+ declare enum ActionType {
5717
+ VOID = "VOID",
5718
+ CAPTURE = "CAPTURE"
5719
+ }
5720
+ /** @enumType */
5721
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5722
+ interface Chargeback {
5540
5723
  /**
5541
- * The ID of order that is refunded
5724
+ * Chargeback ID.
5542
5725
  * @format GUID
5726
+ * @readonly
5727
+ * @immutable
5543
5728
  */
5544
- orderId?: string;
5729
+ id?: string;
5545
5730
  /**
5546
- * Refund ID
5547
- * @format GUID
5731
+ * 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.
5732
+ * @readonly
5733
+ * @immutable
5548
5734
  */
5549
- refundId?: string;
5735
+ createdDate?: Date | null;
5550
5736
  /**
5551
- * Personal note added to the email (optional)
5552
- * @minLength 1
5553
- * @maxLength 1000
5737
+ * 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.
5738
+ * @readonly
5554
5739
  */
5555
- customMessage?: string | null;
5556
- }
5557
- interface SendRefundEmailResponse {
5558
- }
5559
- interface SendFulfillmentEmailRequest {
5560
- /** @format GUID */
5561
- orderId?: string;
5562
- /** @format GUID */
5563
- fulfillerId?: string;
5564
- }
5565
- interface SendFulfillmentEmailResponse {
5566
- }
5567
- interface SendMerchantOrderReceivedPushRequest {
5740
+ updatedDate?: Date | null;
5568
5741
  /**
5569
- * @minLength 1
5570
- * @maxLength 100
5742
+ * Amount.
5743
+ * @readonly
5744
+ * @immutable
5571
5745
  */
5572
- orderId?: string;
5573
- }
5574
- interface SendMerchantOrderReceivedPushResponse {
5575
- }
5576
- interface PreviewEmailByTypeRequest {
5577
- emailType?: PreviewEmailTypeWithLiterals;
5578
- }
5579
- declare enum PreviewEmailType {
5580
- ORDER_PLACED = "ORDER_PLACED",
5581
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5582
- ORDER_SHIPPED = "ORDER_SHIPPED",
5583
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5584
- }
5585
- /** @enumType */
5586
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5587
- interface PreviewEmailByTypeResponse {
5588
- emailPreview?: string;
5589
- }
5590
- interface PreviewRefundEmailRequest {
5746
+ amount?: Price;
5591
5747
  /**
5592
- * @minLength 1
5593
- * @maxLength 100
5748
+ * Reversal amount. Present only when status is REVERSED.
5749
+ * @readonly
5594
5750
  */
5595
- orderId?: string;
5596
- /** Refund amount */
5597
- refundAmount?: Price;
5598
- /** Refund business details */
5599
- details?: RefundDetails;
5751
+ reversalAmount?: Price;
5600
5752
  /**
5601
- * Personal note added to the email (optional)
5602
- * @minLength 1
5603
- * @maxLength 1000
5753
+ * Status.
5754
+ *
5755
+ * Default: `"APPROVED"`.
5604
5756
  */
5605
- customMessage?: string | null;
5757
+ status?: ChargebackStatusWithLiterals;
5606
5758
  /**
5607
- * Refund ID. (Optional)
5759
+ * External chargeback ID.
5608
5760
  * @format GUID
5761
+ * @readonly
5762
+ * @immutable
5609
5763
  */
5610
- refundId?: string | null;
5764
+ externalId?: string | null;
5611
5765
  }
5612
- interface PreviewRefundEmailResponse {
5613
- emailPreview?: string;
5766
+ declare enum ChargebackStatus {
5767
+ /** Chargeback was approved. */
5768
+ APPROVED = "APPROVED",
5769
+ /** Chargeback was reversed. */
5770
+ REVERSED = "REVERSED"
5614
5771
  }
5615
- interface PreviewCancelEmailRequest {
5772
+ /** @enumType */
5773
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5774
+ interface PaymentMethodName {
5616
5775
  /**
5617
- * @minLength 1
5618
- * @maxLength 100
5776
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5777
+ * @maxLength 150
5619
5778
  */
5620
- orderId?: string;
5779
+ buyerLanguageName?: string | null;
5621
5780
  /**
5622
- * Personal note added to the email (optional)
5623
- * @minLength 1
5624
- * @maxLength 1000
5781
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5782
+ *
5783
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5784
+ * @maxLength 150
5625
5785
  */
5626
- customMessage?: string | null;
5627
- }
5628
- interface PreviewCancelEmailResponse {
5629
- emailPreview?: string;
5630
- }
5631
- interface PreviewCancelRefundEmailRequest {
5786
+ siteLanguageName?: string | null;
5632
5787
  /**
5633
- * @minLength 1
5634
- * @maxLength 100
5788
+ * User-provided payment method name.
5789
+ *
5790
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5635
5791
  */
5636
- orderId?: string;
5792
+ userDefinedName?: UserDefinedPaymentMethodName;
5793
+ }
5794
+ interface GiftCardPaymentDetails {
5637
5795
  /**
5638
- * Personal note added to the email (optional)
5639
- * @minLength 1
5640
- * @maxLength 1000
5796
+ * Gift card payment ID.
5797
+ * @maxLength 100
5641
5798
  */
5642
- customMessage?: string | null;
5643
- /** Refund amount */
5644
- refundAmount?: Price;
5799
+ giftCardPaymentId?: string;
5645
5800
  /**
5646
- * Refund ID. (Optional)
5801
+ * ID of the app that created the gift card.
5647
5802
  * @format GUID
5648
5803
  */
5649
- refundId?: string | null;
5650
- }
5651
- interface PreviewCancelRefundEmailResponse {
5652
- emailPreview?: string;
5653
- }
5654
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5655
- }
5656
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5657
- emailPreview?: string;
5658
- }
5659
- interface PreviewBuyerConfirmationEmailRequest {
5660
- }
5661
- interface PreviewBuyerConfirmationEmailResponse {
5662
- emailPreview?: string;
5663
- }
5664
- interface PreviewBuyerPickupConfirmationEmailRequest {
5665
- }
5666
- interface PreviewBuyerPickupConfirmationEmailResponse {
5667
- emailPreview?: string;
5668
- }
5669
- interface PreviewShippingConfirmationEmailRequest {
5670
- }
5671
- interface PreviewShippingConfirmationEmailResponse {
5672
- emailPreview?: string;
5673
- }
5674
- interface PreviewResendDownloadLinksEmailRequest {
5675
- }
5676
- interface PreviewResendDownloadLinksEmailResponse {
5677
- emailPreview?: string;
5678
- }
5679
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5680
- /** Emitted on a meta site creation. */
5681
- siteCreated?: SiteCreated;
5682
- /** Emitted on a meta site transfer completion. */
5683
- siteTransferred?: SiteTransferred;
5684
- /** Emitted on a meta site deletion. */
5685
- siteDeleted?: SiteDeleted;
5686
- /** Emitted on a meta site restoration. */
5687
- siteUndeleted?: SiteUndeleted;
5688
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5689
- sitePublished?: SitePublished;
5690
- /** Emitted on a meta site unpublish. */
5691
- siteUnpublished?: SiteUnpublished;
5692
- /** Emitted when meta site is marked as template. */
5693
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5694
- /** Emitted when meta site is marked as a WixSite. */
5695
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5696
- /** Emitted when an application is provisioned (installed). */
5697
- serviceProvisioned?: ServiceProvisioned;
5698
- /** Emitted when an application is removed (uninstalled). */
5699
- serviceRemoved?: ServiceRemoved;
5700
- /** Emitted when meta site name (URL slug) is changed. */
5701
- siteRenamedPayload?: SiteRenamed;
5702
- /** Emitted when meta site was permanently deleted. */
5703
- hardDeleted?: SiteHardDeleted;
5704
- /** Emitted on a namespace change. */
5705
- namespaceChanged?: NamespaceChanged;
5706
- /** Emitted when Studio is attached. */
5707
- studioAssigned?: StudioAssigned;
5708
- /** Emitted when Studio is detached. */
5709
- studioUnassigned?: StudioUnassigned;
5710
- /**
5711
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5712
- * the actual URL.
5713
- *
5714
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5715
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5716
- */
5717
- urlChanged?: SiteUrlChanged;
5718
- /** Site is marked as PurgedExternally */
5719
- sitePurgedExternally?: SitePurgedExternally;
5720
- /** Emitted when Odeditor is attached. */
5721
- odeditorAssigned?: OdeditorAssigned;
5722
- /** Emitted when Odeditor is detached. */
5723
- odeditorUnassigned?: OdeditorUnassigned;
5724
- /** Emitted when Picasso is attached. */
5725
- picassoAssigned?: PicassoAssigned;
5726
- /** Emitted when Picasso is detached. */
5727
- picassoUnassigned?: PicassoUnassigned;
5728
- /** Emitted when Wixel is attached. */
5729
- wixelAssigned?: WixelAssigned;
5730
- /** Emitted when Wixel is detached. */
5731
- wixelUnassigned?: WixelUnassigned;
5732
- /** Emitted when StudioTwo is attached. */
5733
- studioTwoAssigned?: StudioTwoAssigned;
5734
- /** Emitted when StudioTwo is detached. */
5735
- studioTwoUnassigned?: StudioTwoUnassigned;
5736
- /** Emitted when media from user domain is enabled. */
5737
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5738
- /** Emitted when media from user domain is disabled. */
5739
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5740
- /** Emitted when Editorless is attached. */
5741
- editorlessAssigned?: EditorlessAssigned;
5742
- /** Emitted when Editorless is detached. */
5743
- editorlessUnassigned?: EditorlessUnassigned;
5804
+ appId?: string;
5744
5805
  /**
5745
- * A meta site id.
5746
- * @format GUID
5806
+ * Whether the gift card is voided.
5807
+ * @readonly
5808
+ * @deprecated Whether the gift card is voided.
5809
+ * @replacedBy payment.status
5810
+ * @targetRemovalDate 2026-11-01
5747
5811
  */
5748
- metaSiteId?: string;
5749
- /** A meta site version. Monotonically increasing. */
5750
- version?: string;
5751
- /** A timestamp of the event. */
5752
- timestamp?: string;
5812
+ voided?: boolean;
5753
5813
  /**
5754
- * TODO(meta-site): Change validation once validations are disabled for consumers
5755
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5756
- * @maxSize 4000
5814
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5815
+ * @maxLength 30
5816
+ * @immutable
5757
5817
  */
5758
- assets?: Asset[];
5818
+ obfuscatedCode?: string | null;
5759
5819
  }
5760
- /** @oneof */
5761
- interface MetaSiteSpecialEventPayloadOneOf {
5762
- /** Emitted on a meta site creation. */
5763
- siteCreated?: SiteCreated;
5764
- /** Emitted on a meta site transfer completion. */
5765
- siteTransferred?: SiteTransferred;
5766
- /** Emitted on a meta site deletion. */
5767
- siteDeleted?: SiteDeleted;
5768
- /** Emitted on a meta site restoration. */
5769
- siteUndeleted?: SiteUndeleted;
5770
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5771
- sitePublished?: SitePublished;
5772
- /** Emitted on a meta site unpublish. */
5773
- siteUnpublished?: SiteUnpublished;
5774
- /** Emitted when meta site is marked as template. */
5775
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5776
- /** Emitted when meta site is marked as a WixSite. */
5777
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5778
- /** Emitted when an application is provisioned (installed). */
5779
- serviceProvisioned?: ServiceProvisioned;
5780
- /** Emitted when an application is removed (uninstalled). */
5781
- serviceRemoved?: ServiceRemoved;
5782
- /** Emitted when meta site name (URL slug) is changed. */
5783
- siteRenamedPayload?: SiteRenamed;
5784
- /** Emitted when meta site was permanently deleted. */
5785
- hardDeleted?: SiteHardDeleted;
5786
- /** Emitted on a namespace change. */
5787
- namespaceChanged?: NamespaceChanged;
5788
- /** Emitted when Studio is attached. */
5789
- studioAssigned?: StudioAssigned;
5790
- /** Emitted when Studio is detached. */
5791
- studioUnassigned?: StudioUnassigned;
5820
+ interface MembershipPaymentDetails {
5792
5821
  /**
5793
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5794
- * the actual URL.
5795
- *
5796
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5797
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5822
+ * Membership ID.
5823
+ * @maxLength 200
5798
5824
  */
5799
- urlChanged?: SiteUrlChanged;
5800
- /** Site is marked as PurgedExternally */
5801
- sitePurgedExternally?: SitePurgedExternally;
5802
- /** Emitted when Odeditor is attached. */
5803
- odeditorAssigned?: OdeditorAssigned;
5804
- /** Emitted when Odeditor is detached. */
5805
- odeditorUnassigned?: OdeditorUnassigned;
5806
- /** Emitted when Picasso is attached. */
5807
- picassoAssigned?: PicassoAssigned;
5808
- /** Emitted when Picasso is detached. */
5809
- picassoUnassigned?: PicassoUnassigned;
5810
- /** Emitted when Wixel is attached. */
5811
- wixelAssigned?: WixelAssigned;
5812
- /** Emitted when Wixel is detached. */
5813
- wixelUnassigned?: WixelUnassigned;
5814
- /** Emitted when StudioTwo is attached. */
5815
- studioTwoAssigned?: StudioTwoAssigned;
5816
- /** Emitted when StudioTwo is detached. */
5817
- studioTwoUnassigned?: StudioTwoUnassigned;
5818
- /** Emitted when media from user domain is enabled. */
5819
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5820
- /** Emitted when media from user domain is disabled. */
5821
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5822
- /** Emitted when Editorless is attached. */
5823
- editorlessAssigned?: EditorlessAssigned;
5824
- /** Emitted when Editorless is detached. */
5825
- editorlessUnassigned?: EditorlessUnassigned;
5826
- }
5827
- interface Asset {
5825
+ membershipId?: string;
5828
5826
  /**
5829
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5830
- * @maxLength 36
5827
+ * ID of the line item this membership applies to.
5828
+ * @minLength 1
5829
+ * @maxLength 100
5831
5830
  */
5832
- appDefId?: string;
5831
+ lineItemId?: string;
5833
5832
  /**
5834
- * An instance id. For legacy reasons may be UUID or a string.
5835
- * @maxLength 200
5833
+ * Payment status.
5834
+ * @deprecated Payment status.
5835
+ * @replacedBy payment.status
5836
+ * @targetRemovalDate 2026-11-01
5836
5837
  */
5837
- instanceId?: string;
5838
- /** An application state. */
5839
- state?: StateWithLiterals;
5838
+ status?: MembershipPaymentStatusWithLiterals;
5839
+ /** Membership name. */
5840
+ name?: MembershipName;
5841
+ /**
5842
+ * The transaction ID in the membership system. Can be used to void the transaction.
5843
+ * @minLength 1
5844
+ * @maxLength 100
5845
+ */
5846
+ externalTransactionId?: string | null;
5847
+ /**
5848
+ * Whether the membership is voided.
5849
+ * @readonly
5850
+ * @deprecated Whether the membership is voided.
5851
+ * @replacedBy payment.status
5852
+ * @targetRemovalDate 2026-11-01
5853
+ */
5854
+ voided?: boolean;
5855
+ /**
5856
+ * ID of the application providing this payment option.
5857
+ * @format GUID
5858
+ */
5859
+ providerAppId?: string;
5860
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5861
+ futureMembership?: FutureMembershipDetails;
5840
5862
  }
5841
- declare enum State {
5842
- UNKNOWN = "UNKNOWN",
5843
- ENABLED = "ENABLED",
5844
- DISABLED = "DISABLED",
5845
- PENDING = "PENDING",
5846
- DEMO = "DEMO"
5863
+ declare enum MembershipPaymentStatus {
5864
+ /** Payment was charged. */
5865
+ CHARGED = "CHARGED",
5866
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5867
+ CHARGE_FAILED = "CHARGE_FAILED",
5868
+ /** Payment is pending. */
5869
+ CHARGE_PENDING = "CHARGE_PENDING",
5870
+ /** Payment was voided. */
5871
+ VOIDED = "VOIDED"
5847
5872
  }
5848
5873
  /** @enumType */
5849
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5850
- interface SiteCreated {
5874
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5875
+ interface FutureMembershipDetails {
5851
5876
  /**
5852
- * A template identifier (empty if not created from a template).
5853
- * @maxLength 36
5877
+ * ID of the plan line item in the order from which the membership will be created.
5878
+ * @format GUID
5854
5879
  */
5855
- originTemplateId?: string;
5880
+ lineItemId?: string;
5856
5881
  /**
5857
- * An account id of the owner.
5858
- * @format GUID
5882
+ * ID of the benefit the future membership will grant.
5883
+ * @maxLength 200
5859
5884
  */
5860
- ownerId?: string;
5861
- /** A context in which meta site was created. */
5862
- context?: SiteCreatedContextWithLiterals;
5885
+ benefitId?: string;
5886
+ }
5887
+ interface WixReceiptInfo {
5863
5888
  /**
5864
- * A meta site id from which this site was created.
5865
- *
5866
- * In case of a creation from a template it's a template id.
5867
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5889
+ * Receipt ID
5868
5890
  * @format GUID
5869
5891
  */
5870
- originMetaSiteId?: string | null;
5892
+ receiptId?: string;
5871
5893
  /**
5872
- * A meta site name (URL slug).
5873
- * @maxLength 20
5894
+ * Display number of receipt
5895
+ * @minLength 1
5896
+ * @maxLength 40
5874
5897
  */
5875
- siteName?: string;
5876
- /** A namespace. */
5877
- namespace?: NamespaceWithLiterals;
5878
- }
5879
- declare enum SiteCreatedContext {
5880
- /** A valid option, we don't expose all reasons why site might be created. */
5881
- OTHER = "OTHER",
5882
- /** A meta site was created from template. */
5883
- FROM_TEMPLATE = "FROM_TEMPLATE",
5884
- /** A meta site was created by copying of the transfferred meta site. */
5885
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5886
- /** A copy of existing meta site. */
5887
- DUPLICATE = "DUPLICATE",
5888
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5889
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5890
- /** deprecated A meta site was created for Flash editor. */
5891
- FLASH = "FLASH"
5898
+ displayNumber?: string | null;
5892
5899
  }
5893
- /** @enumType */
5894
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5895
- declare enum Namespace {
5896
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5897
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5898
- WIX = "WIX",
5899
- /** 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. */
5900
- SHOUT_OUT = "SHOUT_OUT",
5901
- /** 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. */
5902
- ALBUMS = "ALBUMS",
5903
- /** 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. */
5904
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5905
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5906
- HOTELS = "HOTELS",
5907
- /** 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. */
5908
- CLUBS = "CLUBS",
5909
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5910
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5900
+ interface ExternalReceiptInfo {
5911
5901
  /**
5912
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5913
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5902
+ * External receipt ID
5903
+ * @maxLength 100
5914
5904
  */
5915
- DEV_SITE = "DEV_SITE",
5916
- /** 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. */
5917
- LOGOS = "LOGOS",
5918
- /** 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. */
5919
- VIDEO_MAKER = "VIDEO_MAKER",
5920
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5921
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5922
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5923
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5905
+ receiptId?: string | null;
5924
5906
  /**
5925
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5926
- *
5927
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5907
+ * ID of the app providing the receipt
5908
+ * @format GUID
5928
5909
  */
5929
- HTML_DRAFT = "HTML_DRAFT",
5910
+ appId?: string | null;
5930
5911
  /**
5931
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5932
- * Will be accessible from Site List and will not have a website app.
5933
- * Once the user attaches a site, the site will become a regular wixsite.
5912
+ * Display number of receipt
5913
+ * @minLength 1
5914
+ * @maxLength 40
5934
5915
  */
5935
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5936
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5937
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5938
- /** It is to be used in the Business First efforts. */
5939
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5940
- /** Bookings business flow with no site. */
5941
- ANYWHERE = "ANYWHERE",
5942
- /** Namespace for Headless Backoffice with no editor */
5943
- HEADLESS = "HEADLESS",
5916
+ displayNumber?: string | null;
5917
+ }
5918
+ interface CashRoundingDetails {
5944
5919
  /**
5945
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5946
- * The site will be used for account level CSM feature for enterprise
5920
+ * Payment amount before cash rounding was applied.
5921
+ * When provided, balance and status calculations use this value instead of `amount`
5922
+ * to prevent false overpayment or underpayment due to rounding.
5947
5923
  */
5948
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5949
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5950
- RISE = "RISE",
5924
+ unroundedAmount?: Price;
5951
5925
  /**
5952
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5953
- * There's a blank site behind the scene but it's blank).
5954
- * The Mobile company will be the owner of this namespace.
5926
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5927
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5928
+ * @readonly
5955
5929
  */
5956
- BRANDED_FIRST = "BRANDED_FIRST",
5957
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5958
- NOWNIA = "NOWNIA",
5930
+ roundingAdjustment?: CashRounding;
5931
+ }
5932
+ declare enum PaymentStatus {
5933
+ /** Payment was charged successfully. */
5934
+ APPROVED = "APPROVED",
5935
+ /** Payment is being processed and hasn't been confirmed yet. */
5936
+ PENDING = "PENDING",
5937
+ /** 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. */
5938
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5939
+ /** Payment was canceled before it was charged. */
5940
+ CANCELED = "CANCELED",
5941
+ /** Payment was declined by the payment provider. */
5942
+ DECLINED = "DECLINED",
5943
+ /** Payment was fully refunded. */
5944
+ REFUNDED = "REFUNDED",
5945
+ /** Part of the payment amount was refunded. */
5946
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5947
+ /** 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. */
5948
+ AUTHORIZED = "AUTHORIZED",
5959
5949
  /**
5960
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5961
- * The Partners company owns this namespace.
5950
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5951
+ *
5952
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5962
5953
  */
5963
- UGC_TEMPLATE = "UGC_TEMPLATE",
5964
- /** Codux Headless Sites */
5965
- CODUX = "CODUX",
5966
- /** Bobb - AI Design Creator. */
5967
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5954
+ VOIDED = "VOIDED"
5955
+ }
5956
+ /** @enumType */
5957
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5958
+ interface CanceledStatusDetails {
5959
+ reason?: CanceledReasonWithLiterals;
5960
+ }
5961
+ declare enum CanceledReason {
5962
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5963
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5964
+ /** Payment was not completed by user and expired. */
5965
+ EXPIRED = "EXPIRED"
5966
+ }
5967
+ /** @enumType */
5968
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5969
+ interface DeclinedStatusDetails {
5970
+ reason?: DeclinedReasonWithLiterals;
5971
+ }
5972
+ declare enum DeclinedReason {
5973
+ /** Corresponding charge failed. */
5974
+ CHARGE_FAILED = "CHARGE_FAILED",
5975
+ /** Payment details expired. */
5976
+ EXPIRED = "EXPIRED",
5977
+ /** Insufficient funds. */
5978
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5979
+ /** Gift card was disabled before charge was attempted. */
5980
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5981
+ }
5982
+ /** @enumType */
5983
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5984
+ interface VoidedStatusDetails {
5985
+ reason?: VoidedReasonWithLiterals;
5986
+ }
5987
+ declare enum VoidedReason {
5988
+ /** Payment was voided by merchant request. */
5989
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5990
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5991
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5992
+ }
5993
+ /** @enumType */
5994
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5995
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5996
+ }
5997
+ /** @oneof */
5998
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5999
+ }
6000
+ interface Refund {
5968
6001
  /**
5969
- * Shared Blog Site is a unique single site across Enterprise account,
5970
- * This site will hold all Blog posts related to the Marketing product.
6002
+ * Refund ID.
6003
+ * @format GUID
6004
+ * @readonly
5971
6005
  */
5972
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5973
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5974
- STANDALONE_FORMS = "STANDALONE_FORMS",
5975
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5976
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5977
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5978
- MIMIR = "MIMIR",
5979
- /** Wix Twins platform. */
5980
- TWINS = "TWINS",
5981
- /** Wix Nano. */
5982
- NANO = "NANO",
5983
- /** Base44 headless sites. */
5984
- BASE44 = "BASE44",
5985
- /** Wix Channels Sites */
5986
- CHANNELS = "CHANNELS",
5987
- /** Nautilus platform. */
5988
- NAUTILUS = "NAUTILUS",
6006
+ id?: string;
5989
6007
  /**
5990
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5991
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6008
+ * List of transactions.
6009
+ * @maxSize 50
5992
6010
  */
5993
- SYMPHONY = "SYMPHONY",
5994
- /** Nautilus platform app. */
5995
- NAUTILUS_APPS = "NAUTILUS_APPS",
6011
+ transactions?: RefundTransaction[];
6012
+ /** Refund business details. */
6013
+ details?: RefundDetails;
5996
6014
  /**
5997
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5998
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6015
+ * 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.
6016
+ * @readonly
6017
+ * @immutable
5999
6018
  */
6000
- VIBU = "VIBU",
6019
+ createdDate?: Date | null;
6001
6020
  /**
6002
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6003
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6004
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6005
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6021
+ * Aggregated refund summary.
6022
+ * @readonly
6006
6023
  */
6007
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6024
+ summary?: AggregatedRefundSummary;
6008
6025
  /**
6009
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6010
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6026
+ * ID of the app that initiated this refund.
6027
+ * @format GUID
6028
+ * @readonly
6029
+ * @immutable
6011
6030
  */
6012
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6031
+ requestingServiceAppId?: string | null;
6013
6032
  }
6014
- /** @enumType */
6015
- 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';
6016
- /** Site transferred to another user. */
6017
- interface SiteTransferred {
6033
+ interface RefundTransaction {
6018
6034
  /**
6019
- * A previous owner id (user that transfers meta site).
6035
+ * ID of the payment associated with this refund.
6020
6036
  * @format GUID
6037
+ * @immutable
6021
6038
  */
6022
- oldOwnerId?: string;
6039
+ paymentId?: string;
6023
6040
  /**
6024
- * A new owner id (user that accepts meta site).
6025
- * @format GUID
6041
+ * Refund amount.
6042
+ * @immutable
6026
6043
  */
6027
- newOwnerId?: string;
6028
- }
6029
- /** Soft deletion of the meta site. Could be restored. */
6030
- interface SiteDeleted {
6031
- /** A deletion context. */
6032
- deleteContext?: DeleteContext;
6033
- }
6034
- interface DeleteContext {
6035
- /** When the meta site was deleted. */
6036
- dateDeleted?: Date | null;
6037
- /** A status. */
6038
- deleteStatus?: DeleteStatusWithLiterals;
6044
+ amount?: Price;
6045
+ /** Refund status. */
6046
+ refundStatus?: RefundStatusWithLiterals;
6047
+ /** Optional details of current refund status. */
6048
+ refundStatusInfo?: RefundStatusInfo;
6039
6049
  /**
6040
- * A reason (flow).
6041
- * @maxLength 255
6050
+ * Payment gateway's refund ID.
6051
+ * This field is only returned when the value of `external_refund` is `false`.
6052
+ * @format GUID
6042
6053
  */
6043
- deleteOrigin?: string;
6054
+ gatewayRefundId?: string | null;
6055
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6056
+ providerRefundId?: string | null;
6044
6057
  /**
6045
- * A service that deleted it.
6046
- * @maxLength 255
6058
+ * Whether refund was made externally and manually on the payment provider's side.
6059
+ * @immutable
6047
6060
  */
6048
- initiatorId?: string | null;
6061
+ externalRefund?: boolean;
6049
6062
  }
6050
- declare enum DeleteStatus {
6051
- UNKNOWN = "UNKNOWN",
6052
- TRASH = "TRASH",
6053
- DELETED = "DELETED",
6054
- PENDING_PURGE = "PENDING_PURGE",
6055
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6063
+ /** Refund transaction status. */
6064
+ declare enum RefundStatus {
6065
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6066
+ PENDING = "PENDING",
6067
+ /** Refund transaction succeeded. */
6068
+ SUCCEEDED = "SUCCEEDED",
6069
+ /** Refund transaction failed. */
6070
+ FAILED = "FAILED",
6071
+ /** Refund request acknowledged, and will be executed soon. */
6072
+ SCHEDULED = "SCHEDULED",
6073
+ /** Refund was initiated on payment provider side. */
6074
+ STARTED = "STARTED"
6056
6075
  }
6057
6076
  /** @enumType */
6058
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6059
- /** Restoration of the meta site. */
6060
- interface SiteUndeleted {
6061
- }
6062
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6063
- interface SitePublished {
6064
- }
6065
- interface SiteUnpublished {
6077
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6078
+ interface RefundStatusInfo {
6066
6079
  /**
6067
- * A list of URLs previously associated with the meta site.
6068
- * @maxLength 4000
6069
- * @maxSize 10000
6080
+ * Reason code for the refund's current status.
6081
+ *
6082
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6083
+ * @minLength 1
6084
+ * @maxLength 10
6070
6085
  */
6071
- urls?: string[];
6072
- }
6073
- interface SiteMarkedAsTemplate {
6074
- }
6075
- interface SiteMarkedAsWixSite {
6086
+ paymentGatewayReasonCode?: string | null;
6087
+ /**
6088
+ * Free text explanation of current refund status.
6089
+ * @minLength 1
6090
+ * @maxLength 1000
6091
+ */
6092
+ description?: string | null;
6076
6093
  }
6077
- /**
6078
- * Represents a service provisioned a site.
6079
- *
6080
- * Note on `origin_instance_id`:
6081
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6082
- * This is because of the following scenario:
6083
- *
6084
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6085
- * such as a product catalog. When you create a site from this template, you inherit this
6086
- * default product catalog. However, if the template's product catalog is modified,
6087
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6088
- * your site remains consistent with what you initially received and does not include any
6089
- * changes made to the original template afterward.
6090
- * To ensure this, the TPA on the template gets a new instance_id.
6091
- */
6092
- interface ServiceProvisioned {
6094
+ interface AggregatedRefundSummary {
6095
+ /** Total amount requested for refund. */
6096
+ requestedRefund?: Price;
6097
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6098
+ pendingRefund?: Price;
6099
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6100
+ refunded?: Price;
6101
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6102
+ failedRefundAmount?: Price;
6103
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6104
+ pending?: boolean;
6105
+ /** Breakdown of refunded items. Available only after refund is complete. */
6106
+ breakdown?: RefundItemsBreakdown;
6107
+ }
6108
+ interface RefundItemsBreakdown {
6093
6109
  /**
6094
- * Either UUID or EmbeddedServiceType.
6095
- * @maxLength 36
6110
+ * Refunded line items and the amount refunded for each.
6111
+ * @maxSize 300
6096
6112
  */
6097
- appDefId?: string;
6113
+ lineItems?: LineItemRefundSummary[];
6114
+ }
6115
+ interface LineItemRefundSummary {
6098
6116
  /**
6099
- * Not only UUID. Something here could be something weird.
6100
- * @maxLength 36
6117
+ * ID of the refunded line item.
6118
+ * @format GUID
6101
6119
  */
6102
- instanceId?: string;
6120
+ lineItemId?: string;
6121
+ /** Total refunded amount for the line item. */
6122
+ totalRefundedAmount?: Price;
6123
+ }
6124
+ interface CalculateRefundRequest {
6103
6125
  /**
6104
- * An instance id from which this instance is originated.
6105
- * @maxLength 36
6126
+ * Order ID
6127
+ * @minLength 1
6128
+ * @maxLength 100
6106
6129
  */
6107
- originInstanceId?: string;
6130
+ ecomOrderId?: string;
6108
6131
  /**
6109
- * A version.
6110
- * @maxLength 500
6132
+ * Refunded line items and quantity
6133
+ * @maxSize 300
6111
6134
  */
6112
- version?: string | null;
6135
+ refundItems?: CalculateRefundItemRequest[];
6136
+ /** Should include shipping in refund calculation */
6137
+ refundShipping?: boolean;
6138
+ }
6139
+ interface CalculateRefundItemRequest {
6113
6140
  /**
6114
- * The origin meta site id
6141
+ * ID of the line item being refunded
6115
6142
  * @format GUID
6116
6143
  */
6117
- originMetaSiteId?: string | null;
6118
- }
6119
- interface ServiceRemoved {
6144
+ id?: string;
6120
6145
  /**
6121
- * Either UUID or EmbeddedServiceType.
6122
- * @maxLength 36
6146
+ * How much of that line item is being refunded
6147
+ * @min 1
6148
+ * @max 100000
6123
6149
  */
6124
- appDefId?: string;
6150
+ quantity?: number;
6151
+ }
6152
+ interface CalculateRefundResponse {
6153
+ /** Total refundable amount */
6154
+ total?: Price;
6155
+ /** Tax cost of the order */
6156
+ tax?: Price;
6157
+ /** Discount given for this order */
6158
+ discount?: Price;
6159
+ /** Total cost of the order (without tax) */
6160
+ subtotal?: Price;
6161
+ /** Total shipping cost for order */
6162
+ shipping?: Price;
6163
+ /** Previous refund given on that order */
6164
+ previouslyRefundedAmount?: Price;
6125
6165
  /**
6126
- * Not only UUID. Something here could be something weird.
6127
- * @maxLength 36
6166
+ * The refundable items of that order
6167
+ * @maxSize 300
6128
6168
  */
6129
- instanceId?: string;
6169
+ items?: CalculateRefundItemResponse[];
6170
+ }
6171
+ interface CalculateRefundItemResponse {
6130
6172
  /**
6131
- * A version.
6132
- * @maxLength 500
6173
+ * Line item ID
6174
+ * @format GUID
6133
6175
  */
6134
- version?: string | null;
6176
+ id?: string;
6177
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6178
+ price?: Price;
6135
6179
  }
6136
- /** Rename of the site. Meaning, free public url has been changed as well. */
6137
- interface SiteRenamed {
6180
+ interface VoidAuthorizedPaymentsRequest {
6138
6181
  /**
6139
- * A new meta site name (URL slug).
6140
- * @maxLength 20
6182
+ * Wix eCommerce order ID
6183
+ * @minLength 1
6184
+ * @maxLength 100
6141
6185
  */
6142
- newSiteName?: string;
6186
+ ecomOrderId: string;
6143
6187
  /**
6144
- * A previous meta site name (URL slug).
6145
- * @maxLength 255
6188
+ * Payment IDs
6189
+ * @minSize 1
6190
+ * @maxSize 100
6191
+ * @format GUID
6146
6192
  */
6147
- oldSiteName?: string;
6148
- }
6149
- /**
6150
- * Hard deletion of the meta site.
6151
- *
6152
- * Could not be restored. Therefore it's desirable to cleanup data.
6153
- */
6154
- interface SiteHardDeleted {
6155
- /** A deletion context. */
6156
- deleteContext?: DeleteContext;
6157
- }
6158
- interface NamespaceChanged {
6159
- /** A previous namespace. */
6160
- oldNamespace?: NamespaceWithLiterals;
6161
- /** A new namespace. */
6162
- newNamespace?: NamespaceWithLiterals;
6163
- }
6164
- /** Assigned Studio editor */
6165
- interface StudioAssigned {
6166
- }
6167
- /** Unassigned Studio editor */
6168
- interface StudioUnassigned {
6193
+ paymentIds: string[];
6169
6194
  }
6170
- /**
6171
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6172
- *
6173
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6174
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6175
- *
6176
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6177
- */
6178
- interface SiteUrlChanged {
6195
+ interface VoidAuthorizedPaymentsResponse {
6196
+ /** All order's transactions after the void was triggered */
6197
+ orderTransactions?: OrderTransactions;
6179
6198
  }
6180
- /**
6181
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6182
- * Consumed by other teams to remove relevant data.
6183
- */
6184
- interface SitePurgedExternally {
6199
+ interface CaptureAuthorizedPaymentsRequest {
6185
6200
  /**
6186
- * @maxLength 2048
6201
+ * Wix eCommerce order ID
6202
+ * @minLength 1
6203
+ * @maxLength 100
6204
+ */
6205
+ ecomOrderId: string;
6206
+ /**
6207
+ * Capture payments information
6208
+ * @minSize 1
6187
6209
  * @maxSize 100
6188
- * @deprecated
6189
- * @targetRemovalDate 2025-04-15
6190
6210
  */
6191
- appDefId?: string[];
6192
- }
6193
- /** Assigned Odeditor */
6194
- interface OdeditorAssigned {
6195
- }
6196
- /** Unassigned Odeditor */
6197
- interface OdeditorUnassigned {
6198
- }
6199
- /** Assigned Picasso editor */
6200
- interface PicassoAssigned {
6201
- }
6202
- /** Unassigned Picasso */
6203
- interface PicassoUnassigned {
6204
- }
6205
- /** Assigned Wixel */
6206
- interface WixelAssigned {
6207
- }
6208
- /** Unassigned Wixel */
6209
- interface WixelUnassigned {
6210
- }
6211
- /** Assigned StudioTwo */
6212
- interface StudioTwoAssigned {
6213
- }
6214
- /** Unassigned StudioTwo */
6215
- interface StudioTwoUnassigned {
6216
- }
6217
- /** Media from user domain is enabled. */
6218
- interface UserDomainMediaEnabled {
6219
- }
6220
- /** Media from user domain is disabled. */
6221
- interface UserDomainMediaDisabled {
6222
- }
6223
- /** Assigned Editorless */
6224
- interface EditorlessAssigned {
6225
- }
6226
- /** Unassigned Editorless */
6227
- interface EditorlessUnassigned {
6211
+ payments: PaymentCapture[];
6228
6212
  }
6229
- interface HasCustomEmailConfigurationsRequest {
6213
+ interface PaymentCapture {
6214
+ /**
6215
+ * Payment ID
6216
+ * @format GUID
6217
+ */
6218
+ paymentId?: string | null;
6219
+ /**
6220
+ * Capture amount.
6221
+ * If not provided - full authorized amount will be captured.
6222
+ */
6223
+ amount?: Price;
6230
6224
  }
6231
- interface HasCustomEmailConfigurationsResponse {
6232
- hasCustomConfigurations?: boolean;
6225
+ interface CaptureAuthorizedPaymentsResponse {
6226
+ /** All order's transactions after the capture was triggered */
6227
+ orderTransactions?: OrderTransactions;
6233
6228
  }
6234
- interface AddToAutomationMigrationPopulationRequest {
6235
- /** When true, sends custom email configurations to automation system via email */
6236
- sendCustomEmailConfigs?: boolean;
6237
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6238
- origin?: OriginWithLiterals;
6229
+ interface ChargeSavedPaymentMethodRequest {
6230
+ /**
6231
+ * Ecom Order ID.
6232
+ * @minLength 1
6233
+ * @maxLength 100
6234
+ */
6235
+ ecomOrderId?: string;
6236
+ /** Amount to be charged */
6237
+ amount?: Price;
6239
6238
  }
6240
- declare enum Origin {
6241
- OPT_IN = "OPT_IN",
6242
- MIGRATION = "MIGRATION"
6239
+ interface ChargeSavedPaymentMethodResponse {
6240
+ /** Payment gateway's order ID (e.g Wix Payments) */
6241
+ paymentGatewayOrderId?: string;
6243
6242
  }
6244
- /** @enumType */
6245
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6246
- interface AddToAutomationMigrationPopulationResponse {
6247
- success?: boolean;
6243
+ interface V1TriggerReindexRequest {
6244
+ /** @format GUID */
6245
+ metasiteId?: string;
6246
+ /**
6247
+ * @minLength 1
6248
+ * @maxLength 100
6249
+ * @maxSize 100
6250
+ */
6251
+ orderIds?: string[];
6248
6252
  }
6249
- interface IsInAutomationMigrationPopulationRequest {
6253
+ interface V1TriggerReindexResponse {
6250
6254
  }
6251
- interface IsInAutomationMigrationPopulationResponse {
6252
- inPopulation?: boolean;
6255
+ interface V1TriggerReindexOrderRequest {
6256
+ /** @format GUID */
6257
+ metasiteId?: string;
6258
+ /**
6259
+ * @minLength 1
6260
+ * @maxLength 100
6261
+ */
6262
+ orderId?: string;
6253
6263
  }
6254
6264
  interface DiffmatokyPayload {
6255
6265
  left?: string;