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