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