@wix/auto_sdk_ecom_orders 1.0.310 → 1.0.311

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