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